default
[ class tree: default ] [ index: default ] [ all elements ]

Class: Module

Source Location: /module/Module.iface.php

Interface Overview




Methods



Class Details

[line 3]


[ Top ]


Class Methods


method executeSetup [line 159]

true executeSetup( )

Execute module setup



Tags:

return:  on success, false otherwise
access:  public


[ Top ]

method executeUninstall [line 168]

true executeUninstall( )

Execute module uninstall



Tags:

return:  on success, false otherwise
access:  public


[ Top ]

method getConfiguration [line 105]

Configuration getConfiguration( )

Retrieve module configuration



Tags:

access:  public


[ Top ]

method getController [line 16]

Controller getController( string $name)

Retrieve a controller from this module



Tags:

access:  public
throws:  InvalidControllerException
throws:  NonexistentControllerException


Parameters:

string   $name   A controller name

[ Top ]

method getControllerDirectory [line 132]

mixed getControllerDirectory( )

Retrieve the controller directory



Tags:

return:  string path on success, false otherwise
access:  public


[ Top ]

method getLayoutTemplate [line 57]

string getLayoutTemplate( string $name)

Retrieve a layout template



Tags:

return:  the full path to the layout template
access:  public
throws:  NonexistentTemplateException


Parameters:

string   $name   a template name

[ Top ]

method getLayoutTemplateDirectory [line 141]

mixed getLayoutTemplateDirectory( )

Retrieve the layout template directory



Tags:

return:  string path on success, false otherwise
access:  public


[ Top ]

method getModel [line 30]

Model getModel( string $name)

Retrieve a model



Tags:

access:  public
throws:  InvalidModelExceptionn
throws:  NonexistentModelException


Parameters:

string   $name  

[ Top ]

method getModuleDirectory [line 114]

mixed getModuleDirectory( )

Retrieve the module directory



Tags:

return:  string path on success, false otherwise
access:  public


[ Top ]

method getParentModule [line 96]

Module getParentModule( )

Retrieve the parent module of the current module



Tags:

access:  public
throws:  NonexistentModuleException
throws:  InvalidModuleException


[ Top ]

method getSubmodule [line 84]

Module getSubmodule( string $name)

Retrieve a submodule of the current module



Tags:

access:  public
throws:  NonexistentModuleException
throws:  InvalidModuleException


Parameters:

string   $name   a module name

[ Top ]

method getView [line 44]

View getView( string $name)

Retrieve a view



Tags:

access:  public
throws:  NonexistentViewException
throws:  InvalidViewException


Parameters:

string   $name   A view name

[ Top ]

method getViewDirectory [line 123]

mixed getViewDirectory( )

Retrieve the view directory



Tags:

return:  string path on success, false otherwise
access:  public


[ Top ]

method getViewTemplate [line 70]

string getViewTemplate( string $name)

Retrieve a view template



Tags:

return:  the full path to the layout template
access:  public
throws:  NonexistentTemplateException


Parameters:

string   $name   a template name

[ Top ]

method getViewTemplateDirectory [line 150]

mixed getViewTemplateDirectory( )

Retrieve the view template directory



Tags:

return:  string path on success, false otherwise
access:  public


[ Top ]


Documentation generated on Tue, 21 Feb 2006 02:29:53 +0900 by phpDocumentor 1.3.0RC5