Arbit - project tracking

Arbit - project tracking

API documentation :: Docs For Class arbitModuleDefinitionLocator

Core::Module::arbitModuleDefinitionLocator

Class arbitModuleDefinitionLocator

Module locator, which finds and loads module definitions

Module locator, which finds and loads module definitions

Author(s):
Version:   $Revision: 1236 $
License:   GPL

Member Variables

protected array $moduleClass = array(
'core' => 'arbitCoreDefinition',
)

Set a module class name, if the class name does not obey the defined naming scheme.

Set a module class name, if the class name does not obey the defined naming scheme.

protected array $moduleFile = array(
'core' => 'classes/module/core.php',
)

Set a module definition file name, if the file name does not obey the defined naming scheme.

Set a module definition file name, if the file name does not obey the defined naming scheme.

Method Summary

public string findModuleClass( $moduleName )
Find the module definition class in the filesystem.
protected string getClassName( $moduleName )
Get classname for module definition class
protected string getFileName( $moduleName )
Get filename for module definition file Get the file name for a module name either from the exception list, if defined there, or by creating the path matching the convention, which points to modules/<name>/definition.
public void setModuleClassName( $moduleName , $moduleClassName )
Set exception for module class name Set the definition class name for a module, which does not obey the defined naming scheme for module definition classes.
public void setModuleFileName( $moduleName , $moduleFileName )
Set exception for module file name Set the definition file name for a module, which does not obey the defined naming scheme for module definition filees.

Methods

findModuleClass

string findModuleClass( string $moduleName )

Find the module definition class in the filesystem.

Find the module definition class in the filesystem. Locates the file using either the defined conventions or the exception list, and includes the definitions. The checks if the class has been defined, and returns the module definition class name, if successfully found.

Parameters:
Name Type Description
$moduleName string

getClassName

string getClassName( string $moduleName )

Get classname for module definition class

Get classname for module definition class Get the class name for a module name either from the exception list, if defined there, or by creating the name matching the convention, which is arbitModule<Name>Definition

Parameters:
Name Type Description
$moduleName string

getFileName

string getFileName( string $moduleName )

Get filename for module definition file Get the file name for a module name either from the exception list, if defined there, or by creating the path matching the convention, which points to modules/<name>/definition.

Get filename for module definition file Get the file name for a module name either from the exception list, if defined there, or by creating the path matching the convention, which points to modules/<name>/definition.php.

Parameters:
Name Type Description
$moduleName string

setModuleClassName

void setModuleClassName( string $moduleName , string $moduleClassName )

Set exception for module class name Set the definition class name for a module, which does not obey the defined naming scheme for module definition classes.

Set exception for module class name Set the definition class name for a module, which does not obey the defined naming scheme for module definition classes.

Parameters:
Name Type Description
$moduleName string
$moduleClassName string

setModuleFileName

void setModuleFileName( string $moduleName , string $moduleFileName )

Set exception for module file name Set the definition file name for a module, which does not obey the defined naming scheme for module definition filees.

Set exception for module file name Set the definition file name for a module, which does not obey the defined naming scheme for module definition filees.

Parameters:
Name Type Description
$moduleName string
$moduleFileName string
Documentation generated on Mon, 05 Apr 2010 14:02:02 +0200 by phpDocumentor 1.4.3