Plugins

# Class: ClientAuth Source Location: /plugins/auth/client/ClientAuth.php
### Class Overview
    PluginBase
       |
       --ClientPlugin
          |
          --ClientAuth
Client authentication plugin based on PEAR:Auth | ### Variables $auth $isFormDisplayed $loginFailed | ### Constants AUTH_SESSION_KEY | ### Methods authCallback buildRequest drawAuth failedLoginCallback getSecurityContainer handleHttpCommonRequest handleHttpGetRequest handleHttpPostRequest handleResult initialize initializeResult interruptFlow loginCallback logoutCallback renderForm showLogin
### Inherited Constants #### Class: ClientPlugin ClientPlugin::ENABLE_LEVEL_FULL ClientPlugin::ENABLE_LEVEL_LOAD ClientPlugin::ENABLE_LEVEL_PROCESS ClientPlugin::ENABLE_LEVEL_SERVERCALL | ### Inherited Variables #### Class: ClientPlugin ClientPlugin::$cartoclient ClientPlugin::$config ClientPlugin::$enabledLevel ClientPlugin::$log #### Class: PluginBase PluginBase::$basePath PluginBase::$name PluginBase::$overriddenRequest | ### Inherited Methods #### Class: ClientPlugin ClientPlugin::__construct() Constructor ClientPlugin::checkBool() Checks if variable $variable has a boolean (0 or 1) value $value. ClientPlugin::checkInt() Checks if variable $variable has an integer positive or zero value $value. ClientPlugin::checkNumeric() Checks if variable $variable has a numeric value $value. ClientPlugin::disable() Sets the enable level to ClientPlugin::ENABLE_LEVEL_SERVERCALL. ClientPlugin::enable() Sets the enable level to ClientPlugin::ENABLE_LEVEL_FULL. ClientPlugin::getCartoclient() ClientPlugin::getConfig() ClientPlugin::getEnabledLevel() Returns the enable level. ClientPlugin::getHttpValue() Returns the user-submitted $key data if it is set. ClientPlugin::initializeConfig() Initializes plugin configuration ClientPlugin::isEnabledAtLevel() Sets the enable level to ClientPlugin::ENABLE_LEVEL_FULL. ClientPlugin::setEnableLevel() Sets the enable level (to be used with the AJAX mode). #### Class: PluginBase PluginBase::__construct() Constructor PluginBase::account() Records an accounting message for plugins PluginBase::getBasePath() PluginBase::getExtendedName() PluginBase::getName() PluginBase::getRequest() Get plugin's request or result out of MapRequest or MapResult PluginBase::initialize() Plugin initialization (can be extended in custom plugins) PluginBase::initializeConfig() Initializes plugin PluginBase::preInitialize() Plugin pre initialization. In most cases, plugins should use PluginBase::replacePlugin() Returns name of parent plugin in case of plugin extension PluginBase::setBasePath() PluginBase::setExtendedName() PluginBase::setName()
### Class Details [line 378] Client authentication plugin based on PEAR:Auth [ Top ] ### Class Variables #### $auth = [line 384] Pear::Auth object for managing the authentication #### Tags:
access: | protected
Type: | Auth
[ Top ] #### $isFormDisplayed = false [line 396] Avoids to display the login form twice in some cases. #### Tags:
access: | protected
Type: | boolean
[ Top ] #### $loginFailed = [line 390] True to store the fact that the user authentication failed. #### Tags:
access: | protected
Type: | boolean
[ Top ] ### Class Methods ### method authCallback [line 409]
`string authCallback( string $reason)`
Common code called by all Pear::Auth callbacks. It handles the login page display. #### Tags:
return: | Smarty result
access: | protected
#### Parameters:
string | $reason | reason the page is called for
[ Top ] ### method buildRequest [line 599]
`void buildRequest( )`
#### Tags:
access: | public
see: | ServerCaller::buildRequest()
[ Top ] ### method drawAuth [line 573]
`string drawAuth( )`
Draws the login/logout buttons. Their availibility depends on whether the user is logged in or not. #### Tags:
access: | protected
[ Top ] ### method failedLoginCallback [line 452]
`void failedLoginCallback( )`
Callback for Pear::Auth, when the login failed #### Tags:
access: | public
[ Top ] ### method getSecurityContainer [line 462]
`SecurityContainer getSecurityContainer( )`
Returns the security container. The security container class to use is chosen from the securityContainer config parameter. #### Tags:
access: | protected
[ Top ] ### method handleHttpCommonRequest [line 543]
`void handleHttpCommonRequest( mixed $request)`
Handles Get and Post requests #### Tags:
access: | protected
[ Top ] ### method handleHttpGetRequest [line 564]
`void handleHttpGetRequest( mixed $request)`
#### Tags:
access: | public
see: | GuiProvider::handleHttpGetRequest()
[ Top ] ### method handleHttpPostRequest [line 557]
`void handleHttpPostRequest( mixed $request)`
#### Tags:
access: | public
see: | GuiProvider::handleHttpPostRequest()
[ Top ] ### method handleResult [line 613]
`void handleResult( mixed $outlineResult)`
#### Tags:
access: | public
see: | ServerCaller::handleResult()
[ Top ] ### method initialize [line 481]
`void initialize( )`
#### Tags:
access: | public
see: | PluginBase::initialize()
Overrides PluginBase::initialize() (Plugin initialization (can be extended in custom plugins)) [ Top ] ### method initializeResult [line 606]
`void initializeResult( mixed $result)`
#### Tags:
access: | public
see: | ServerCaller::initializeResult()
[ Top ] ### method interruptFlow [line 523]
`void interruptFlow( )`
Interrupts CartoWeb flow of operation. Necessary, when displaying the login/logout page. #### Tags:
access: | protected
[ Top ] ### method loginCallback [line 436]
`void loginCallback( )`
Callback for Pear::Auth, when the user logs in #### Tags:
access: | public
[ Top ] ### method logoutCallback [line 444]
`void logoutCallback( )`
Callback for Pear::Auth, when the user logs out #### Tags:
access: | public
[ Top ] ### method renderForm [line 586]
`void renderForm( Smarty $smarty)`
#### Tags:
access: | public
see: | GuiProvider::renderForm()
[ Top ] ### method showLogin [line 532]
`void showLogin( )`
Displays the Pear::Auth login page. It interrupts cartoweb flow. #### Tags:
access: | protected
[ Top ] ### Class Constants #### AUTH_SESSION_KEY = 'CW3_auth_session_key' [line 401] Auth session name prefix [ Top ] Documentation generated on Fri, 21 Sep 2007 13:30:34 +0200 by phpDocumentor 1.3.0RC3