Plugins
[ class tree: Plugins ] [ index: Plugins ] [ all elements ]

Class: ClientAuth

Source Location: /plugins/auth/client/ClientAuth.php

Class Overview

PluginBase
   |
   --ClientPlugin
      |
      --ClientAuth

Client authentification plugin based on PEAR:Auth


Variables

Constants

Methods


Inherited Variables

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::getCartoclient()
ClientPlugin::getConfig()
ClientPlugin::getHttpValue()
Returns the user-submitted $key data if it is set.
ClientPlugin::initializeConfig()
Initializes plugin configuration

Class: PluginBase

PluginBase::__construct()
Constructor
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 200]
Client authentification plugin based on PEAR:Auth



[ Top ]


Class Variables

$auth =

[line 206]

Pear::Auth object for managing the authentication



Tags:

access:  protected

Type:   Auth


[ Top ]

$isFormDisplayed =  false

[line 218]

Avoids to display the login form twice in some cases.



Tags:

access:  protected

Type:   boolean


[ Top ]

$loginFailed =

[line 212]

True to store the fact that the user authentication failed.



Tags:

access:  protected

Type:   boolean


[ Top ]



Class Methods


method authCallback [line 231]

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 420]

void buildRequest( )



Tags:

access:  public
see:  ServerCaller::buildRequest()


[ Top ]

method drawAuth [line 394]

void 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 274]

void failedLoginCallback( )

Callback for Pear::Auth, when the login failed



Tags:

access:  public


[ Top ]

method getSecurityContainer [line 284]

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 365]

void handleHttpCommonRequest( mixed $request)

Handles Get and Post requests



Tags:

access:  protected


[ Top ]

method handleHttpGetRequest [line 386]

void handleHttpGetRequest( mixed $request)



Tags:

access:  public
see:  GuiProvider::handleHttpGetRequest()


[ Top ]

method handleHttpPostRequest [line 379]

void handleHttpPostRequest( mixed $request)



Tags:

access:  public
see:  GuiProvider::handleHttpPostRequest()


[ Top ]

method handleResult [line 434]

void handleResult( mixed $outlineResult)



Tags:

access:  public
see:  ServerCaller::handleResult()


[ Top ]

method initialize [line 303]

void initialize( )



Tags:

access:  public
see:  PluginBase::initialize()


Overrides PluginBase::initialize() (Plugin initialization (can be extended in custom plugins))

[ Top ]

method initializeResult [line 427]

void initializeResult( mixed $result)



Tags:

access:  public
see:  ServerCaller::initializeResult()


[ Top ]

method interruptFlow [line 345]

void interruptFlow( )

Interrupts CartoWeb flow of operation. Necessary, when displaying the login/logout page.



Tags:

access:  protected


[ Top ]

method loginCallback [line 258]

void loginCallback( )

Callback for Pear::Auth, when the user logs in



Tags:

access:  public


[ Top ]

method logoutCallback [line 266]

void logoutCallback( )

Callback for Pear::Auth, when the user logs out



Tags:

access:  public


[ Top ]

method renderForm [line 407]

void renderForm( Smarty $smarty)



Tags:

access:  public
see:  GuiProvider::renderForm()


[ Top ]

method showLogin [line 354]

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 223]

Auth session name prefix


[ Top ]



Documentation generated on Mon, 13 Feb 2006 11:43:26 +0100 by phpDocumentor 1.3.0RC3