Loads a module component. Components are the building blocks of the site and include controllers which build up the pages we see and blocks that build up the controllers.

return: Return the component object if it exists, otherwise FALSE.
access: public

mixed getComponent (string $sClass, [array $aParams = array()], [string $sType = 'block'])

string $sClass: Name of the component to load.
array $aParams: (Optional) Custom params you can pass to the component.
string $sType: (Optional) Identify if this component is a block or a controller.

getComponentSetting (line 1421)

Gets any custom component settings for a specific user.

return: Setting value or default value is returned.
access: public

mixed getComponentSetting (int $iUserId, string $sVarName, mixed $mDefaultValue)

int $iUserId: User ID
string $sVarName: Var name for the setting.
mixed $mDefaultValue: Default value in case the setting is not found.

getController (line 367)

Loads and outputs the current page based on the controller we loaded with the method setController().

see: self::setController()
access: public

void getController ()

getControllerName (line 655)

Get the name of the current controller we are using.

access: public

string getControllerName ()

getControllerTemplate (line 389)

Gets the controllers template. We do this automatically since each controller has a specific template that it loads to output data to the site.

return: NULL if we were able to load a template and FALSE if such a template does not exist.
access: public

mixed getControllerTemplate ()

getFullControllerName (line 378)

Gets the full name of the controller we are using including the module prefix.

access: public

string getFullControllerName ()

getModuleBlocks (line 428)

Gets all the blocks for a specific location on a specific page.

return: Returns a list of blocks for that page and in a specific order.
access: public

array getModuleBlocks (int $iId, [bool $bForce = false])

int $iId: Position on the template.
bool $bForce: (Optional) If blocks are already loaded set this to TRUE to reload them anyway.

getModuleFiles (line 1108)

Get all the modules found within the module folder.

return: ARRAY of modules.
access: public

array getModuleFiles ()

getModuleId (line 225)

Returns the module ID. Since Alpha versions of phpFox we changed modules to have unique string IDs so this function basically returns the same ID you are passing with the first argument.

return: Returns the unique module ID.
deprecated: 2.0.0beta1
access: public

string getModuleId (string $sName)

string $sName: Module name.

getModuleName (line 645)

Get the module name of the current controller we are using.

access: public

string getModuleName ()

getModules (line 1057)

Get all the active modules.

access: public

array getModules ()

getModuleTables (line 1075)

Get all the tables part of each of the active modules.

return: ARRAY of all the tables.
access: public

array getModuleTables (string $sPrefix)

string $sPrefix: Prefix of the database table name.

getService (line 668)

Loads a service class. Service classes are module based class that interact with the database and runs general PHP logic that is not needed to be found with components.

return: On success we return the class object, on failure we return FALSE.
access: public

mixed getService (string $sClass, [array $aParams = array()])

string $sClass: Name of the service class to load.
array $aParams: (Optional) ARRAY of params to pass to that class.

hasCallback (line 1290)

Checks if a specific module has a specific callback method.

return: TRUE if callback exists, otherwise FALSE if not.
access: public

bool hasCallback (string $sModule, string $sMethod)

string $sModule: Module name/ID.
string $sMethod: Callback method.

init (line 1329)

Loads a init class file that each module has and returns a specified property which has information about the module.

return: FALSE if property value or module is not valid or the property value which can differ. Usually it is a STRING or ARRAY.
access: public

mixed init (string $sModule, string $sProperty)

string $sModule: Module name/ID.
string $sProperty: Property name to return.

initMethod (line 1370)

Loads a init class file that each module has and executes a specific method.

return: NULL if property value or module is not valid or the property value which can differ.
access: public

mixed initMethod (string $sModule, string $sMethod)

string $sModule: Module name/ID.
string $sMethod: Method name.

isModule (line 207)

Checks if a module is valid or not (IF EXISTS OR IF EXISTS AND IS VALUE)

return: TRUE if it exists, FALSE if it does not.
access: public

bool isModule (string $sModule)

string $sModule: Module name.

massCallback (line 1228)

Performs a callback on all the modules that have the method being executed.

return: Array of return values with the module ID as the unique key.
access: public

array massCallback (string $sMethod, [array $aParams = array()])

string $sMethod: Method to execute on all modules.
array $aParams: Params you can pass to your callback.

setCacheBlockData (line 980)

Sets the cache blocks data.

access: public

void setCacheBlockData (array $aCacheBlockData)

array $aCacheBlockData: ARRAY of information to cache.

setController (line 241)

Sets the controller for the page we are on. This method controlls what component to load, which will be used to display the content on that page.

access: public

void setController ([string $sController = ''])

string $sController: (Optional) We find the controller by default, however you can override our default findings by passing the name of the controller with this argument.

setNoTemplate (line 1047)

Identify that the controller we are loading is not to load its template.

access: public

void setNoTemplate ()

_cacheModuleBlocks (line 1499)

Cache all module blocks.

access: private

void _cacheModuleBlocks ()

_cacheModules (line 1446)

Cache all the active modules based on the package the client is using.

access: private

void _cacheModules ()

_getItemCacheData (line 1559)

Get all the drag/drop information from a specific table for a specific user.

access: private

void _getItemCacheData ()

Documentation generated on Tue, 28 Sep 2010 10:36:41 +0200 by phpDocumentor 1.4.0a2