Docs For Class jCoordinator

Description

the main class of the jelix core

this is the "chief orchestra" of the framework. Its goal is to load the configuration, to get the request parameters used to instancie the correspondant controllers and to run the right method.

Located in /core/jCoordinator.class.php (line 23)

Variable Summary

jSelectorAct $action

string $actionName

array $errorMessages

array $logMessages

string $moduleName

array $plugins

jRequest $request

jResponse $response

Method Summary

jCoordinator __construct (string $configFile)

boolean addErrorMsg (string $type, integer $code, string $message, string $file, integer $line)

void addLogMsg (string $message, [ $type = 'default'])

string getModulePath (string $module)

jICoordPlugin getPlugin (string $pluginName, [boolean $required = true])

mixed initDefaultResponseOfRequest ([boolean $originalResponse = false])

boolean isModuleEnabled (string $moduleName)

boolean isPluginEnabled (string $pluginName)

void process (jRequest $request)

Variables

jSelectorAct $action = null (line 47)

the selector of the current action

access: public

string $actionName (line 59)

the current action name

access: public

array $errorMessages = array() (line 65)

List of all errors

access: public

array $logMessages = array() (line 72)

List of all log messages

since: 1.0
access: public

string $moduleName (line 53)

the current module name

access: public

array $plugins = array() (line 29)

plugin list

access: public

jRequest $request = null (line 41)

current request object

access: public

jResponse $response = null (line 35)

current response object

access: public

Methods

Constructor __construct (line 77)

jCoordinator __construct (string $configFile)

string $configFile: name of the ini file to configure the framework

addErrorMsg (line 135)

Store an error/warning/notice message. Responses object should take care of the errorMessages properties to display them.

return: true= the process should stop now, false = the error manager do its job
access: public

boolean addErrorMsg (string $type, integer $code, string $message, string $file, integer $line)

string $type: error type : 'error', 'warning', 'notice'
integer $code: error code
string $message: error message
string $file: the file name where the error appear
integer $line: the line number where the error appear

addLogMsg (line 149)

Store a log message. Responses object should take care of the logMessages properties to display them.

since: 1.0
access: public

void addLogMsg (string $message, [ $type = 'default'])

string $message: error message
$type

getModulePath (line 355)

return the real path of a module

return: the corresponding path
access: public

string getModulePath (string $module)

string $module: a module name

getPlugin (line 318)

gets a given plugin if registered

access: public

jICoordPlugin getPlugin (string $pluginName, [boolean $required = true])

string $pluginName: the name of the plugin
boolean $required: says if the plugin is required or not. If true, will generate an exception if the plugin is not registered.

initDefaultResponseOfRequest (line 279)

instancy a response object corresponding to the default response type

of the current resquest

return: error string or false
access: public

mixed initDefaultResponseOfRequest ([boolean $originalResponse = false])

boolean $originalResponse: TRUE to get the original, non overloaded response

isModuleEnabled (line 345)

Says if the given module $name is enabled

return: true : module is ok
access: public

boolean isModuleEnabled (string $moduleName)

string $moduleName

isPluginEnabled (line 336)

Says if the given plugin $name is enabled

return: true : plugin is ok
access: public

boolean isPluginEnabled (string $pluginName)

string $pluginName

process (line 159)

main method : launch the execution of the action.

This method should be called in a entry point.

access: public

void process (jRequest $request)

jRequest $request: the request object