Tariqa
3.0
|
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 |
__construct | ( | $ | config, |
$ | set_infos = true , |
||
$ | custom_authentication = null |
||
) |
Construct the Module object
array | $config | The multidimentionnal array containing the application's configuration |
boolean | $set_infos | If false, do not set the stylesheets and javascripts [OPTIONAL] |
iCustomAuthentication | $custom_authentication | If true, then the ECAS authentication is skipped [OPTIONAL] |
Reimplemented in SpecialPage, and tariqa3ModuleSection.
addMultiAjaxCall | ( | $ | call | ) |
Adds a multi AJAX call to the page
multiAjaxCall | $call | The multi ajax call public |
briefcaseSelectFolder | ( | $ | type_id | ) | [protected] |
Sets the briefcase select folder form
int | $type_id | The type identifier protected |
displayMenu | ( | ) |
Indicates if the module should display the application's menu public
getBreadCrumb | ( | ) | [abstract] |
Return the items of the current breadcrumb path
Reimplemented in Briefcase, Preferences, Article, Search, Themes, Countries, RiskMap, Dummy, Archive, Streaming, SpecialPage, Help, Timeouts, tariqa3ModuleSection, Training, Analysis, NewsWires, FlashEarth, Oxweb, and Home.
getBreakingNewsQuery | ( | ) | [protected] |
Gets the breaking news query (if it exists) protected
getDescription | ( | ) | [abstract] |
Returns the description of the module (used in html/head/description)
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)
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)
Reimplemented in Briefcase, Preferences, Article, Search, Themes, Countries, RiskMap, Dummy, Archive, Streaming, SpecialPage, Help, Training, tariqa3ModuleSection, Analysis, NewsWires, FlashEarth, Timeouts, Oxweb, and Home.
getPageContent | ( | ) | [abstract] |
Render the module's page (will be embedded in general layout)
Reimplemented in NewsSection, Search, UploadSection, Preferences, Briefcase, Countries, NewsWires, Themes, Timeouts, ThemeTopicsSection, Oxweb, Article, SpecialPage, RiskMap, Archive, Home, FullSearch, ThemeTextsSection, MapsSection, Help, Streaming, Training, Analysis, FlashEarth, Dummy, and ThemesListSection.
getTitle | ( | ) | [abstract] |
Returns the title of the module (used in html/head/title)
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
Reimplemented from BaseModule.
isMenuable | ( | ) | [final] |
Indicates if the module should be displayed in the application's menu
onDestroy | ( | ) | [protected] |
Release resources, closes the database connection
Reimplemented from mModule.
Reimplemented in tariqa3ModuleContent.
onExecute | ( | ) | [protected] |
Render the module
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
multiAjaxSearch[] | $searches The multi AJAX searches to be performed | |
string | $onBegin | The javascript code to be called before the search is performed |
string | $onEnd | The javascript code to be called after the search is performed |
boolean | $refresh | If true, then refresh the news [OPTIONAL] protected |
setDefaultLayout | ( | $ | layout | ) | [final] |
Sets the default layout
string | $layout | The new default layout public |
setMoreInfos | ( | $ | infos | ) | [protected] |
Gets the infos from a module and integrates them into the current module
array | $infos | The module protected |
setMultiAjax | ( | ) | [protected] |
Sets the code for multi AJAX calls protected
$_displayMenu = null [protected] |
$_isMenuable = true [protected] |
$currentLanguage |
$db |
$defaultLanguage |
$languageList |
$layout = 'layout.html' [protected] |
$moduleDescriptors |