Public Member Functions |
| __construct ($config, $charset='UTF-8') |
| getInfo () |
| hasUpdatedConfiguration () |
| getTemplatesFolder () |
| getTemplateFilePath ($template_file) |
| getTemplatesUrl () |
| getTemplateFileUrl ($template_file) |
| getThemeUrl () |
| getThemeFileUrl ($template_file) |
| getThemePath () |
| getThemeFilePath ($template_file) |
| getModuleFolder () |
| getModuleUrl () |
Protected Member Functions |
| onInitialize () |
| info_setTitle ($value, $ignore_blacklist=false) |
| info_setDescription ($value, $ignore_blacklist=false) |
| info_setContentType ($type, $ignore_blacklist=false) |
| info_setAuthor ($value, $ignore_blacklist=false) |
| info_setLastUpdated ($value=false, $ignore_blacklist=false) |
| info_setCopyright ($value, $ignore_blacklist=false) |
| info_setBodyOnLoad ($value, $ignore_blacklist=false) |
| info_setRawHeaders ($value, $ignore_blacklist=false) |
| info_setBodyOnUnload ($value, $ignore_blacklist=false) |
| info_setStyleSheet ($path, $ignore_blacklist=false) |
| info_setJavascript ($path, $ignore_blacklist=false) |
| info_setInlineStylesheet ($css, $ignore_blacklist=false) |
| info_setInlineJavascript ($js, $ignore_blacklist=false) |
| info_setCustom ($key, $data, $ignore_blacklist=false) |
Protected Attributes |
| $infos = array() |
| $blacklisted_infos = array() |
| $base_folder = '' |
| $prevent_cache = false |
Constructor & Destructor Documentation
Build the module and parse the config file
- Parameters:
-
array | $config | The multidimentionnal config array |
string | $charset | The characterset to use in the webpage |
Reimplemented in WebOffice, RSS, Sharing, BaseModuleWithAuthentication, MultiPages, BaseModuleWithAuthenticationAndLanguages, Redirect, Screencasts, Ifs, Login, baseModule_RELEX_TARIQAEC, baseModule_RELEX_TARIQAMS, baseModule_RELEX_TARIQANG, baseModule_RELEX_TARIQARX, and tariqa3ModuleContent.
Member Function Documentation
Returns an associative array of strings giving information about the module
- Returns:
- array
Reimplemented from mModule.
Returns the Full path to the modules folder of this application (no trailing slash) public
- Returns:
- string
Returns the base url to the modules folder of this application (no trailing slash) public
- Returns:
- string
Returns the full path to a specific template file of the application
- Parameters:
-
string | $template_file | Template file's name |
- Returns:
- string public
Returns the full url to a specific template file of the application's specific module
- Parameters:
-
string | $template_file | Template file's name |
- Returns:
- string public
Returns the Full path to the templates folder of this application (no trailing slash) public
- Returns:
- string
Returns the base url to the templates folder of this application's specific module (no trailing slash) public
- Returns:
- string
Returns the full url to a specific template file of the application
- Parameters:
-
string | $template_file | Template file's name |
- Returns:
- string public
Returns the full url to a specific template file of the application
- Parameters:
-
string | $template_file | Template file's name |
- Returns:
- string public
Returns the base url to the templates folder of the application (no trailing slash) public
- Returns:
- string
Returns the base url to the templates folder of the application (no trailing slash) public
- Returns:
- string
The logoff module do not update the configuration
Reimplemented from mModule.
Reimplemented in tariqa3Module.
info_setAuthor |
( |
$ |
value, |
|
|
$ |
ignore_blacklist = false |
|
) |
| [final, protected] |
Set information for the template: Author of the webpage
- Parameters:
-
string | $value | Author of the webpage |
boolean | $ignore_blacklist | If true, then ignore the blacklisted infos [OPTIONAL] protected |
Set information for the template: onload javascript code for HTML/BODY
- Parameters:
-
string | $value | onload javascript code for HTML/BODY |
boolean | $ignore_blacklist | If true, then ignore the blacklisted infos [OPTIONAL] protected |
Set information for the template: onunload javascript code for HTML/BODY
- Parameters:
-
string | $value | onunload javascript code for HTML/BODY |
boolean | $ignore_blacklist | If true, then ignore the blacklisted infos [OPTIONAL] protected |
Set information for the template: Content-Type and charset of the webpage
- Parameters:
-
string | $type | Content-Type of the webpage |
boolean | $ignore_blacklist | If true, then ignore the blacklisted infos [OPTIONAL] protected |
Set information for the template: Copyright of the webpage
- Parameters:
-
string | $value | Copyright of the webpage |
boolean | $ignore_blacklist | If true, then ignore the blacklisted infos [OPTIONAL] protected |
info_setCustom |
( |
$ |
key, |
|
|
$ |
data, |
|
|
$ |
ignore_blacklist = false |
|
) |
| [final, protected] |
Set information for the tempate: Custom information
- Parameters:
-
string | $key | The key of the template value |
mixed | $data | The value |
boolean | $ignore_blacklist | If true, then ignore the blacklisted infos [OPTIONAL] protected |
Set information for the template: Description of the webpage
- Parameters:
-
string | $value | Description of the webpage |
boolean | $ignore_blacklist | If true, then ignore the blacklisted infos [OPTIONAL] protected |
Set information for the template: List of inline javascript code to use
- Parameters:
-
mixed | $js | A block of javscript code, or an array of block of javascript code. |
boolean | $ignore_blacklist | If true, then ignore the blacklisted infos [OPTIONAL] protected |
Set information for the template: List of inline stylesheets to use
- Parameters:
-
mixed | $css | A block of css, or an array of blocks of css. |
boolean | $ignore_blacklist | If true, then ignore the blacklisted infos [OPTIONAL] protected |
Set information for the template: List of external javascript sources to use
- Parameters:
-
mixed | $path | The path to a javascript file, or an array of pathes to javascript files. |
boolean | $ignore_blacklist | If true, then ignore the blacklisted infos [OPTIONAL] protected |
Set information for the template: Lastu-pdated date of the webpage
- Parameters:
-
string | $value | Last-updated date of the webpage. Default: current time |
boolean | $ignore_blacklist | If true, then ignore the blacklisted infos [OPTIONAL] protected |
Sets the raw headers (free text to be added in the <head> section of the document before any other header)
- Parameters:
-
string | $value | The headers |
boolean | $ignore_blacklist | If true, then ignore the blacklisted infos [OPTIONAL] protected |
- Returns:
- void
Set information for the template: List of external stylesheets to use
- Parameters:
-
mixed | $path | The path to a css file, or an array of pathes to css files. |
boolean | $ignore_blacklist | If true, then ignore the blacklisted infos [OPTIONAL] protected |
info_setTitle |
( |
$ |
value, |
|
|
$ |
ignore_blacklist = false |
|
) |
| [final, protected] |
Set information for the template: Title of the webpage
- Parameters:
-
string | $value | Title of the webpage |
boolean | $ignore_blacklist | If true, then ignore the blacklisted infos [OPTIONAL] 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 from mModule.
Reimplemented in Preferences, Search, Countries, Themes, RSS, tariqa3Module, SpecialPage, Article, Briefcase, RiskMap, Redirect, Archive, Login, Streaming, NewsWires, BaseModuleWithAuthentication, Oxweb, Timeouts, WebOffice, Help, MultiPages, Screencasts, Training, Analysis, BaseModuleWithAuthenticationAndLanguages, tariqa3ModuleContent, baseModule_RELEX_TARIQAEC, baseModule_RELEX_TARIQAMS, baseModule_RELEX_TARIQANG, and baseModule_RELEX_TARIQARX.
Field Documentation
$base_folder = '' [protected] |
$blacklisted_infos = array() [protected] |
$infos = array() [protected] |
Informations returned by the getInfo() method It can contains the title and description of the module, the http-headers, and specific html informations to put in the page header
protected
$prevent_cache = false [protected] |
The documentation for this class was generated from the following file: