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

Class: BasicModule

Source Location: /module/BasicModule.class.php

Class Overview




Variables

Methods


Child classes:


Class Details

[line 3]


[ Top ]


Class Variables

$cdir =  null

[line 12]


Type:   mixed


[ Top ]

$configuration =  null

[line 9]



Tags:

access:  protected

Type:   mixed


[ Top ]

$directory =  null

[line 10]


Type:   mixed


[ Top ]

$ltdir =  null

[line 15]


Type:   mixed


[ Top ]

$mdir =  null

[line 14]


Type:   mixed


[ Top ]

$sl =  null

[line 11]


Type:   mixed


[ Top ]

$vdir =  null

[line 13]


Type:   mixed


[ Top ]

$vtdir =  null

[line 16]


Type:   mixed


[ Top ]



Class Methods


constructor __construct [line 20]

BasicModule __construct( mixed $directory, ServiceLocator $sl)



Tags:

access:  public


Overridden in child classes as:

GlobalModule::__construct()

[ Top ]

method executeSetup [line 326]

true executeSetup( )

Execute module setup



Tags:

return:  on success, false otherwise
access:  public


[ Top ]

method executeUninstall [line 351]

true executeUninstall( )

Execute module uninstall



Tags:

return:  on success, false otherwise
access:  public


[ Top ]

method getConfiguration [line 233]

Configuration getConfiguration( )

Retrieve module configuration



Tags:

access:  public


[ Top ]

method getController [line 94]

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 284]

mixed getControllerDirectory( )

Retrieve the controller directory



Tags:

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


[ Top ]

method getLayoutTemplate [line 155]

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 298]

mixed getLayoutTemplateDirectory( )

Retrieve the layout template directory



Tags:

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


[ Top ]

method getModel [line 113]

Model getModel( string $name)

Retrieve a model



Tags:

access:  public
throws:  InvalidModelExceptionn
throws:  NonexistentModelException


Parameters:

string   $name  

[ Top ]

method getModuleDirectory [line 256]

mixed getModuleDirectory( )

Retrieve the module directory



Tags:

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


[ Top ]

method getParentModule [line 224]

Module getParentModule( )

Retrieve the parent module of the current module



Tags:

access:  public
throws:  NonexistentModuleException
throws:  InvalidModuleException


[ Top ]

method getSubmodule [line 212]

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 132]

View getView( string $name)

Retrieve a view



Tags:

access:  public
throws:  NonexistentViewException
throws:  InvalidViewException


Parameters:

string   $name   A view name

[ Top ]

method getViewDirectory [line 270]

mixed getViewDirectory( )

Retrieve the view directory



Tags:

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


[ Top ]

method getViewTemplate [line 183]

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 312]

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:37 +0900 by phpDocumentor 1.3.0RC5