Tariqa  3.0
 All Data Structures Namespaces Files Functions Variables Enumerations
SpecialPage Class Reference
Inheritance diagram for SpecialPage:
tariqa3Module baseModule_RELEX_TARIQANG BaseModuleWithAuthenticationAndLanguages BaseModuleWithAuthentication BaseModule mModule Ifs Login MultiPages Redirect RSS Screencasts WebOffice

Public Member Functions

 __construct ($page_id, $config, $custom_authentication=null)
 getPageContent ()
 canProcessRequest ()
 getName ()
 getTitle ()
 getDescription ()
 getLink ()
 getBreadCrumb ()

Static Public Member Functions

static getQueries ($own_config, $flavours)
static getFlavours ($own_config)

Protected Member Functions

 setTemplate ($file)
 getNews ()
 onInitialize ()
 getDocumentRepository ($id, $root_folder= '', $title=null)

Protected Attributes

 $template
 $page_id
 $own_config

Constructor & Destructor Documentation

__construct ( page_id,
config,
custom_authentication = null 
)

Constructs the object

Parameters:
string$page_idThe page identifier
array$configThe configuration array of the application
iCustomAuthentication$custom_authenticationIf true, then the ECAS authentication is skipped [OPTIONAL] public
Returns:
void

Reimplemented from tariqa3Module.


Member Function Documentation

Process all requests (this is the default module)

Reimplemented from mModule.

Return the items of the current breadcrumb path

Returns:
tariqa3ModuleDescriptor[]

Reimplemented from tariqa3Module.

Returns the description of the page public

Returns:
string

Reimplemented from tariqa3Module.

getDocumentRepository ( id,
root_folder = '',
title = null 
) [protected]

Gets a document repository object (the HTML code)

Parameters:
string$idThe HTML identifier
string$root_folderThe root folder (relative path to the folder set through config file) [OPTIONAL]
string$titleThe title of the document repository [OPTIONAL] protected
Returns:
string
static getFlavours ( own_config) [static]

Gets the list of flavours for the news

Parameters:
array$own_configThe page own config

public

Returns:
Flavour[]
getLink ( )

Gets the link of the module public

Returns:
string

Reimplemented from tariqa3Module.

getName ( )

Returns the name of the class (what it should appear in the menu public

Returns:
string

Reimplemented from tariqa3Module.

getNews ( ) [protected]

Gets a news section for a special page protected

Returns:
string

Gets the page content public

Returns:
void

Reimplemented from tariqa3Module.

static getQueries ( own_config,
flavours 
) [static]

Gets the list of queries for the news

Parameters:
array$own_configThe page own config
Flavour[]$flavours The list of flavours

public

Returns:
Query[][]
getTitle ( )

Returns the title of the page public

Returns:
string

Reimplemented from tariqa3Module.

onInitialize ( ) [protected]

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

Reimplemented from tariqa3Module.

Reimplemented in RSS, Redirect, Login, WebOffice, MultiPages, and Screencasts.

setTemplate ( file) [protected]

Sets the page template

Parameters:
string$file_pathThe template file name protected
Returns:
void

Field Documentation

$own_config [protected]
$page_id [protected]
$template [protected]

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