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

Public Member Functions

 __construct ($config, $set_infos=true, $custom_authentication=null)
 addMultiAjaxCall ($call)
 hasUpdatedConfiguration ()
 getPageContent ()
 getName ()
 getTitle ()
 getDescription ()
 getLink ()
 getBreadCrumb ()
 isMenuable ()
 displayMenu ()
 setDefaultLayout ($layout)

Data Fields

 $moduleDescriptors
 $db
 $currentLanguage
 $defaultLanguage
 $languageList

Protected Member Functions

 setMoreInfos ($infos)
 performMultiAjaxSearch ($searches, $onBegin, $onEnd, $refresh=false)
 onDestroy ()
 onInitialize ()
 setMultiAjax ()
 getBreakingNewsQuery ()
 briefcaseSelectFolder ($type_id)
 onExecute ()

Protected Attributes

 $layout = 'layout.html'
 $_isMenuable = true
 $_displayMenu = null

Constructor & Destructor Documentation

__construct ( config,
set_infos = true,
custom_authentication = null 
)

Construct the Module object

Parameters:
array$configThe multidimentionnal array containing the application's configuration
boolean$set_infosIf false, do not set the stylesheets and javascripts [OPTIONAL]
iCustomAuthentication$custom_authenticationIf true, then the ECAS authentication is skipped [OPTIONAL]

Reimplemented in SpecialPage, and tariqa3ModuleSection.


Member Function Documentation

addMultiAjaxCall ( call)

Adds a multi AJAX call to the page

Parameters:
multiAjaxCall$callThe multi ajax call public
Returns:
return
briefcaseSelectFolder ( type_id) [protected]

Sets the briefcase select folder form

Parameters:
int$type_idThe type identifier protected
Returns:
string

Indicates if the module should display the application's menu public

Returns:
boolean
getBreadCrumb ( ) [abstract]
getBreakingNewsQuery ( ) [protected]

Gets the breaking news query (if it exists) protected

Returns:
Query
getDescription ( ) [abstract]

Returns the description of the module (used in html/head/description)

Returns:
string

Reimplemented in Briefcase, Preferences, Search, Article, Themes, Countries, RiskMap, Dummy, Archive, Streaming, SpecialPage, Help, tariqa3ModuleSection, Training, Analysis, NewsWires, FlashEarth, Timeouts, Oxweb, and Home.

getLink ( ) [abstract]

Returns the url to the current module (used in menus)

Returns:
string

Reimplemented in Briefcase, Preferences, Search, Article, Themes, Countries, RiskMap, Dummy, Archive, Streaming, SpecialPage, Timeouts, Help, tariqa3ModuleSection, Training, Analysis, NewsWires, FlashEarth, Oxweb, and Home.

getName ( ) [abstract]

Returns the short name of the module (used by menus)

Returns:
string

Reimplemented in Briefcase, Preferences, Article, Search, Themes, Countries, RiskMap, Dummy, Archive, Streaming, SpecialPage, Help, Training, tariqa3ModuleSection, Analysis, NewsWires, FlashEarth, Timeouts, Oxweb, and Home.

getTitle ( ) [abstract]

Returns the title of the module (used in html/head/title)

Returns:
string

Reimplemented in Briefcase, Preferences, Article, Search, Themes, Countries, RiskMap, Dummy, Archive, Streaming, SpecialPage, Help, tariqa3ModuleSection, Training, Analysis, NewsWires, FlashEarth, Timeouts, Oxweb, and Home.

Informs the application wether this module have updated the configuration data

Returns:
bool public

Reimplemented from BaseModule.

isMenuable ( ) [final]

Indicates if the module should be displayed in the application's menu

Returns:
bool
onDestroy ( ) [protected]

Release resources, closes the database connection

Reimplemented from mModule.

Reimplemented in tariqa3ModuleContent.

onExecute ( ) [protected]

Render the module

Returns:
string

Reimplemented from mModule.

Reimplemented in tariqa3ModuleSection, and tariqa3ModuleContent.

onInitialize ( ) [protected]

Initialize the module (Connects to the database, check user rights, ...)

Reimplemented from baseModule_RELEX_TARIQANG.

Reimplemented in Preferences, Search, Countries, Themes, RSS, SpecialPage, Article, Briefcase, RiskMap, Redirect, Archive, Login, Streaming, NewsWires, Oxweb, Timeouts, WebOffice, Help, MultiPages, Screencasts, Training, Analysis, and tariqa3ModuleContent.

performMultiAjaxSearch ( searches,
onBegin,
onEnd,
refresh = false 
) [protected]

Generates the javascript code and inserts it into the HTML body to perform a multi AJAX search

Parameters:
multiAjaxSearch[]$searches The multi AJAX searches to be performed
string$onBeginThe javascript code to be called before the search is performed
string$onEndThe javascript code to be called after the search is performed
boolean$refreshIf true, then refresh the news [OPTIONAL] protected
Returns:
void
setDefaultLayout ( layout) [final]

Sets the default layout

Parameters:
string$layoutThe new default layout public
Returns:
void
setMoreInfos ( infos) [protected]

Gets the infos from a module and integrates them into the current module

Parameters:
array$infosThe module protected
Returns:
void
setMultiAjax ( ) [protected]

Sets the code for multi AJAX calls protected

Returns:
void

Field Documentation

$_displayMenu = null [protected]
$_isMenuable = true [protected]
$currentLanguage
$db
$defaultLanguage
$languageList
$layout = 'layout.html' [protected]
$moduleDescriptors

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