eZ Publish  [4.0]
Public Member Functions | Static Public Member Functions | Public Attributes
eZUserLoginHandler Class Reference

The class eZUserLoginHandler does. More...

List of all members.

Public Member Functions

 eZUserLoginHandler ()

Static Public Member Functions

static checkUser (&$siteBasics, &$url)
static forceLogin ()
static instance ($protocol="standard")
static sessionCleanup ()

Public Attributes

const AVAILABLE_ARRAY = 'eZLoginHandlerAvailbleArray'
const FORCE_LOGIN = 'eZLoginHandlerForceLogin'
const LAST_CHECK_REDIRECT = 'eZLoginHandlerLastCheckRedirect'
const LAST_HANDLER_NAME = 'eZLoginHandlerLastHandlerName'
const STEP = 'eZLoginHandlerStep'
const STEP_CHECK_USER = 3
const STEP_LOGIN_USER = 4
const STEP_POST_COLLECT_USER_INFO = 2
const STEP_PRE_CHECK_USER_INFO = 0
const STEP_PRE_COLLECT_USER_INFO = 1
const USER_INFO = 'eZLoginHandlerUserInfo'

Detailed Description

The class eZUserLoginHandler does.

Definition at line 41 of file ezuserloginhandler.php.

Member Function Documentation

static eZUserLoginHandler::checkUser ( &$  siteBasics,
&$  url 
) [static]

Check user redirection for current loginhandler.

Parameters:
siteBasics
possibleredirect url
loginhandler, standard by default. If set to false, handler type will be fetched from ini settings.
Returns:
true if user is logged in successfully. null or false if failed. redirect specification, array ( module, view ).

Definition at line 169 of file ezuserloginhandler.php.

eZUserLoginHandler::eZUserLoginHandler ( )

Constructor

Definition at line 59 of file ezuserloginhandler.php.

static eZUserLoginHandler::forceLogin ( ) [static]

Set session variable to force login

Definition at line 320 of file ezuserloginhandler.php.

static eZUserLoginHandler::instance ( $  protocol = "standard") [static]

Fetch object instance of specified login handler.

Parameters:
loginhandler name
Returns:
Login handler object

Definition at line 109 of file ezuserloginhandler.php.

Referenced by checkUser(), forceLogin(), and sessionCleanup().

static eZUserLoginHandler::sessionCleanup ( ) [static]

Clean up session variables used by the login procedure.

Definition at line 67 of file ezuserloginhandler.php.

Referenced by checkUser().

Member Data Documentation

const eZUserLoginHandler::AVAILABLE_ARRAY = 'eZLoginHandlerAvailbleArray'

Definition at line 43 of file ezuserloginhandler.php.

const eZUserLoginHandler::FORCE_LOGIN = 'eZLoginHandlerForceLogin'

Definition at line 47 of file ezuserloginhandler.php.

const eZUserLoginHandler::LAST_CHECK_REDIRECT = 'eZLoginHandlerLastCheckRedirect'

Definition at line 46 of file ezuserloginhandler.php.

const eZUserLoginHandler::LAST_HANDLER_NAME = 'eZLoginHandlerLastHandlerName'

Definition at line 48 of file ezuserloginhandler.php.

const eZUserLoginHandler::STEP = 'eZLoginHandlerStep'

Definition at line 44 of file ezuserloginhandler.php.

const eZUserLoginHandler::STEP_CHECK_USER = 3

Definition at line 53 of file ezuserloginhandler.php.

const eZUserLoginHandler::STEP_LOGIN_USER = 4

Definition at line 54 of file ezuserloginhandler.php.

const eZUserLoginHandler::STEP_POST_COLLECT_USER_INFO = 2

Definition at line 52 of file ezuserloginhandler.php.

const eZUserLoginHandler::STEP_PRE_CHECK_USER_INFO = 0

Definition at line 50 of file ezuserloginhandler.php.

const eZUserLoginHandler::STEP_PRE_COLLECT_USER_INFO = 1

Definition at line 51 of file ezuserloginhandler.php.

Referenced by checkUser().

const eZUserLoginHandler::USER_INFO = 'eZLoginHandlerUserInfo'

Definition at line 45 of file ezuserloginhandler.php.

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