eZ Publish  [trunk]
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")
 Returns a new instance of the eZUser class pr $protocol.
static preCheck (array &$siteBasics, eZURI $uri)
 Check if user login is required.
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 18 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 176 of file ezuserloginhandler.php.

Referenced by eZCheckUser(), and preCheck().

eZUserLoginHandler::eZUserLoginHandler ( )

Constructor

Definition at line 36 of file ezuserloginhandler.php.

static eZUserLoginHandler::forceLogin ( ) [static]

Set session variable to force login

Definition at line 327 of file ezuserloginhandler.php.

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

Returns a new instance of the eZUser class pr $protocol.

Parameters:
string$protocolIf not set to 'standard' (default), then the code will look for handler first in kernel/classes/datatypes/ezuser/, then according to site.ini[UserSettings]ExtensionDirectory settings
Returns:
eZUser

Definition at line 87 of file ezuserloginhandler.php.

Referenced by eZWebDAVContentBackendAuth\authenticateBasic(), checkUser(), forceLogin(), preCheck(), and sessionCleanup().

static eZUserLoginHandler::preCheck ( array &$  siteBasics,
eZURI $  uri 
) [static]

Check if user login is required.

If so, use login handler to redirect user.

Since:
4.4
Parameters:
array$siteBasics
eZURI$uri
Returns:
array|true|false|null An associative array on redirect with 'module' and 'function' keys, true on successful and false/null on #fail.

Definition at line 142 of file ezuserloginhandler.php.

static eZUserLoginHandler::sessionCleanup ( ) [static]

Clean up session variables used by the login procedure.

Definition at line 44 of file ezuserloginhandler.php.

Referenced by checkUser().

Member Data Documentation

const eZUserLoginHandler::AVAILABLE_ARRAY = 'eZLoginHandlerAvailbleArray'

Definition at line 20 of file ezuserloginhandler.php.

const eZUserLoginHandler::FORCE_LOGIN = 'eZLoginHandlerForceLogin'

Definition at line 24 of file ezuserloginhandler.php.

Referenced by eZCheckUser().

const eZUserLoginHandler::LAST_CHECK_REDIRECT = 'eZLoginHandlerLastCheckRedirect'

Definition at line 23 of file ezuserloginhandler.php.

const eZUserLoginHandler::LAST_HANDLER_NAME = 'eZLoginHandlerLastHandlerName'

Definition at line 25 of file ezuserloginhandler.php.

const eZUserLoginHandler::STEP = 'eZLoginHandlerStep'

Definition at line 21 of file ezuserloginhandler.php.

const eZUserLoginHandler::STEP_CHECK_USER = 3

Definition at line 30 of file ezuserloginhandler.php.

const eZUserLoginHandler::STEP_LOGIN_USER = 4

Definition at line 31 of file ezuserloginhandler.php.

const eZUserLoginHandler::STEP_POST_COLLECT_USER_INFO = 2

Definition at line 29 of file ezuserloginhandler.php.

const eZUserLoginHandler::STEP_PRE_CHECK_USER_INFO = 0

Definition at line 27 of file ezuserloginhandler.php.

const eZUserLoginHandler::STEP_PRE_COLLECT_USER_INFO = 1

Definition at line 28 of file ezuserloginhandler.php.

Referenced by checkUser().

const eZUserLoginHandler::USER_INFO = 'eZLoginHandlerUserInfo'

Definition at line 22 of file ezuserloginhandler.php.

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