Tariqa  3.0
 All Data Structures Namespaces Files Functions Variables Enumerations
mApplication Class Reference
Inheritance diagram for mApplication:
mBaseApplication mModularApplication Application

Public Member Functions

 __construct ($application_config)
 getConfig ()
 setAutoSaveConfig ($auto_save)

Protected Member Functions

 onInitialize ()
 onDestroy ()

Protected Attributes

 $config
 $auto_save_config = false
 $auto_save_config_path = false
 $auto_save_config_format = 'xml'

Constructor & Destructor Documentation

__construct ( application_config)

Object Constructor

Parameters:
array | string$application_configAn associative array containing the configuration OR the path to a configuration file
string$config_formatOptional, (Ignored/invalid if the first argument is not a string), the format of the configuration file (can be 'xml', 'inf', ...)

Reimplemented in Application, and mModularApplication.


Member Function Documentation

getConfig ( ) [final]

Returns the multidimentionnal array containing the configuration of the application

Returns:
array
onDestroy ( ) [protected]

This method must be implemented in the derivated class This method is called last (after the onExecute() method) No exception should be thrown within this method, its only goal is to possibly free some resources protected

Reimplemented from mBaseApplication.

Reimplemented in mModularApplication.

onInitialize ( ) [protected]

This method must be implemented in the derivated class It is called first (prior to the onExecute() method) Throw an Exception from this method to immediatelly stop the application (in which case onDestroy() will be gracefuly called) protected

Reimplemented from mBaseApplication.

Reimplemented in Application, and mModularApplication.

setAutoSaveConfig ( auto_save) [final]

Set the auto-save option for the configuration file

Parameters:
bool$auto_saveIf set to true, the configuration file will be saved when the application exists

Field Documentation

$auto_save_config = false [protected]
$auto_save_config_format = 'xml' [protected]
$auto_save_config_path = false [protected]
$config [protected]

The documentation for this class was generated from the following file: