Tariqa
3.0
|
Public Member Functions | |
__construct ($config) | |
run () | |
canProcessRequest () | |
hasUpdatedConfiguration () | |
getConfiguration () | |
getInfo () | |
getHeaders () | |
getDefaultTemplateFile () | |
Protected Member Functions | |
onInitialize () | |
onDestroy () | |
onExecute () | |
Protected Attributes | |
$title = '' | |
$description = '' | |
$config = array() |
__construct | ( | $ | config | ) |
Constructor
array | $config | A multidimentionnal array containing the configuration |
Reimplemented in Preferences, Briefcase, Countries, Search, Archive, Themes, Article, Help, NewsWires, Streaming, Ajax, Timeouts, tariqa3ModuleSectionManager, ECASLogoff, RiskMap, Analysis, Training, Dummy, FlashEarth, Home, Oxweb, and newsResults.
canProcessRequest | ( | ) | [abstract] |
Request the module to test if it can handle the current request ($_POST, $_GET, $_SERVER['argv'])
Reimplemented in Ajax, Briefcase, Preferences, Article, Search, Sharing, Themes, Countries, Dummy, Archive, Navigation, Streaming, SpecialPage, Help, ECASLogoff, tariqa3ModuleSection, RiskMap, NewsWires, Timeouts, Training, Analysis, Oxweb, FlashEarth, and Home.
getConfiguration | ( | ) | [final] |
Returns the configuration array If hasUpdatedConfiguration() returns true, the caller application will use this method to get a copy of the new configuration. Therefore, the onDestroy() method should NEVER erase the $config member variable (This is not an issue anyway, as it is only a member variable, that get's automatically destroyed with the object)
getHeaders | ( | ) |
getInfo | ( | ) |
Returns an associative array of strings giving information about the module
Reimplemented in BaseModule.
hasUpdatedConfiguration | ( | ) | [abstract] |
If the modules modifies the configuration, this method should return true to allow the caller application to modify the configuration file
Reimplemented in BaseModule, tariqa3Module, and ECASLogoff.
onDestroy | ( | ) | [protected] |
Free resources used by the module. It is called after onExecute() (or after an exception has been caught) You might override this method. This method should not throw any exception
Reimplemented in tariqa3Module, and tariqa3ModuleContent.
onExecute | ( | ) | [abstract, protected] |
Core logic of the module Place here the code of your module, and return the data that is to be displayed in the application
Reimplemented in Ajax, Sharing, tariqa3Module, tariqa3ModuleSection, Navigation, ECASLogoff, and tariqa3ModuleContent.
onInitialize | ( | ) | [protected] |
Initializes the module. It is called prior to onExecute() You might override this method. Throw an exception in this method to abort module's execution
Reimplemented in Preferences, Search, Countries, Themes, RSS, tariqa3Module, SpecialPage, Article, Briefcase, RiskMap, Redirect, Archive, Login, Streaming, NewsWires, BaseModuleWithAuthentication, Oxweb, Timeouts, WebOffice, Help, MultiPages, BaseModule, Screencasts, Training, Analysis, ECASLogoff, BaseModuleWithAuthenticationAndLanguages, tariqa3ModuleContent, baseModule_RELEX_TARIQAEC, baseModule_RELEX_TARIQAMS, baseModule_RELEX_TARIQANG, and baseModule_RELEX_TARIQARX.
run | ( | ) | [final] |
Execute the module and returns its output
$config = array() [protected] |
Reimplemented in FullLexisNexis.
$description = '' [protected] |