Tariqa  3.0
 All Data Structures Namespaces Files Functions Variables Enumerations
BaseModuleWithAuthentication Class Reference
Inheritance diagram for BaseModuleWithAuthentication:
BaseModule mModule 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, $charset= 'UTF-8')

Data Fields

 $require_auth = true

Protected Member Functions

 onInitialize ()
 getUserData ($data_key)
 setUserData ($data_key, $data_value)
 unsetUserData ($data_key)
 canReadArticle ($user, $id)

Protected Attributes

 $auth = false
 $user = false

Constructor & Destructor Documentation

__construct ( config,
charset = 'UTF-8' 
)

Build the module and parse the config file

Parameters:
array$configThe multidimentionnal config array
string$charsetCharacter set of the module's output

Reimplemented from BaseModule.

Reimplemented in WebOffice, RSS, Sharing, MultiPages, BaseModuleWithAuthenticationAndLanguages, Redirect, Screencasts, Ifs, Login, baseModule_RELEX_TARIQAEC, baseModule_RELEX_TARIQAMS, baseModule_RELEX_TARIQANG, baseModule_RELEX_TARIQARX, and tariqa3ModuleContent.


Member Function Documentation

canReadArticle ( user,
id 
) [protected]

If true, it means that the user has access to the requested article

Parameters:
tariqaUser$userThe user
string$idThe article identifier protected
Returns:
boolean
getUserData ( data_key) [protected]

Get a piece of data from the session

Parameters:
string$data_keyThe data identifier
Returns:
string|false Retuns the piece of data, or FALSE if it does not exists protected
setUserData ( data_key,
data_value 
) [protected]

Set a piece of data into the session

Parameters:
string$data_keyThe data identifier
string$data_valueThe data itself protected
unsetUserData ( data_key) [protected]

Unset a piece of data from the session

Parameters:
string$data_keyThe data identifier protected

Field Documentation

$auth = false [protected]
$require_auth = true
$user = false [protected]

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