Constructor & Destructor Documentation
Object Constructor
- Parameters:
-
array | $application_config | The application params. The array should be an associative array If you want to send the config path and the config format just send an array like array('path' => 'my_path', 'format' => 'my_format') If you want to send the config array directly, just send an array like array('config' => $my_config) |
bool | $auto_save_config | If set to true, the application will automatically save the configuration file on exit |
Reimplemented from mApplication.
Reimplemented in Application.
Member Function Documentation
Add a mModule object to the list of modules of the application
- Parameters:
-
mModule | $module | The module object |
bool | $is_default | If set to true, set the new module as the default module |
Get the list of modules
- Returns:
- mModule[]
Returns the full path to a specific template file of the application
- Parameters:
-
string | $template_file | Template file's name |
- Returns:
- string public
Returns the Full path to the templates folder of this application (no trailing slash) public
- Returns:
- string
This method is called last (after the execution of the module) No exception should be thrown within this method, its only goal is to possibly free some resources protected
Reimplemented from mApplication.
This method must be implemented in the derivated class This method is called whenever an exceptions occurs in onInitialize or onExecute Please note that the onDestroy() method will still be called afterwards. protected
Reimplemented from mBaseApplication.
Reimplemented in Application.
onExecuteModule |
( |
$ |
module_result, |
|
|
$ |
module_info, |
|
|
$ |
module_template = self::default_template_file , |
|
|
$ |
module_headers = null |
|
) |
| [protected] |
This method is called after the execution of a module, allowing the application to draw itself, including module's results. $ Throw an exception in this method to terminate the application protected
- Parameters:
-
string | $module_results | The resulting output of the module's execution |
array | $module_info | An indexed array of strings containing informations about the module |
string | $module_template | Default template file (default = index.html) |
array | null | $module_headers | Null or headers set by the module |
It is called prior to the execution of the module Throw an Exception from this method to immediatelly stop the application (in which case onDestroy() will be gracefuly called) protected
Reimplemented from mApplication.
Reimplemented in Application.
Field Documentation
$base_folder = false [protected] |
$default_module = false [protected] |
The index of the default module, in the array of modules
$modules = array() [protected] |
$template = false [protected] |
The documentation for this class was generated from the following file: