Tariqa  3.0
 All Data Structures Namespaces Files Functions Variables Enumerations
mModule Class Reference
Inheritance diagram for mModule:
BaseModule ECASLogoff BaseModuleWithAuthentication Navigation BaseModuleWithAuthenticationAndLanguages baseModule_RELEX_TARIQAEC baseModule_RELEX_TARIQAMS baseModule_RELEX_TARIQANG baseModule_RELEX_TARIQARX Ajax Sharing tariqa3Module Article Briefcase Dummy FlashEarth Home newsResults Oxweb SpecialPage tariqa3ModuleContent tariqa3ModuleSection tariqa3ModuleSectionManager Timeouts

Public Member Functions

 __construct ($config)
 run ()
 canProcessRequest ()
 hasUpdatedConfiguration ()
 getConfiguration ()
 getInfo ()
 getHeaders ()
 getDefaultTemplateFile ()

Protected Member Functions

 onInitialize ()
 onDestroy ()
 onExecute ()

Protected Attributes

 $title = ''
 $description = ''
 $config = array()

Constructor & Destructor Documentation

__construct ( config)

Constructor

Parameters:
array$configA 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.


Member Function Documentation

canProcessRequest ( ) [abstract]

Request the module to test if it can handle the current request ($_POST, $_GET, $_SERVER['argv'])

Returns:
bool True if the module can handle the request, false otherwise

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)

Returns:
array

Returns the application default template file public

Returns:
string|null

Reimplemented in Ajax, Briefcase, Sharing, RSS, RiskMap, and Navigation.

Returns the user defined headers of the application public

Returns:
array|null

Reimplemented in Ajax, Briefcase, RSS, RiskMap, WebOffice, Navigation, and Oxweb.

getInfo ( )

Returns an associative array of strings giving information about the module

Returns:
array

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

Returns:
bool

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

Returns:
string

Reimplemented in Ajax, Sharing, tariqa3Module, tariqa3ModuleSection, Navigation, ECASLogoff, and tariqa3ModuleContent.

run ( ) [final]

Execute the module and returns its output

Returns:
string

Field Documentation

$config = array() [protected]

Reimplemented in FullLexisNexis.

$description = '' [protected]
$title = '' [protected]

Reimplemented in WebOffice, and RSS.


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