eZPublishCommunityProject(LegacyStack)  2013.9
eZUserLoginHandler Class Reference

The class eZUserLoginHandler does. More...

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. More...
 
static preCheck (array &$siteBasics, eZURI $uri)
 Check if user login is required. More...
 
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.

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 ).
eZUserLoginHandler::eZUserLoginHandler ( )

Constructor

static eZUserLoginHandler::forceLogin ( )
static

Set session variable to force login

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

Referenced by eZWebDAVContentBackendAuth\authenticateBasic(), checkUser(), 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.

Referenced by ezpKernelWeb\requestInit().

static eZUserLoginHandler::sessionCleanup ( )
static

Clean up session variables used by the login procedure.

Referenced by checkUser().

Member Data Documentation

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

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