PHP Class Contao\FrontendUser

Inheritance: extends User
Mostra file Open project: contao/core-bundle Class Usage Examples

Protected Properties

Property Type Description
$arrGroups array Groups
$objInstance FrontendUser Current object instance (do not remove)
$strCookie string Name of the current cookie
$strLoginPage string Group login page
$strTable string Name of the corresponding table

Public Methods

Method Description
__get ( string $strKey ) : mixed Extend parent getter class and modify some parameters
__set ( string $strKey, mixed $varValue ) Extend parent setter class and modify some parameters
authenticate ( ) : boolean Authenticate a user
findBy ( string $strColumn, mixed $varValue ) : boolean Save the original group membership
login ( ) : boolean Add the auto login resources
logout ( ) : boolean Remove the auto login resources
save ( ) Restore the original group membership

Protected Methods

Method Description
__construct ( ) Initialize the object
setUserFromDb ( ) Set all user properties from a database record

Method Details

__construct() protected method

Initialize the object
protected __construct ( )

__get() public method

Extend parent getter class and modify some parameters
public __get ( string $strKey ) : mixed
$strKey string
return mixed

__set() public method

Extend parent setter class and modify some parameters
public __set ( string $strKey, mixed $varValue )
$strKey string
$varValue mixed

authenticate() public method

Authenticate a user
public authenticate ( ) : boolean
return boolean

findBy() public method

Save the original group membership
public findBy ( string $strColumn, mixed $varValue ) : boolean
$strColumn string
$varValue mixed
return boolean

login() public method

Add the auto login resources
public login ( ) : boolean
return boolean

logout() public method

Remove the auto login resources
public logout ( ) : boolean
return boolean

save() public method

Restore the original group membership
public save ( )

setUserFromDb() protected method

Set all user properties from a database record
protected setUserFromDb ( )

Property Details

$arrGroups protected_oe property

Groups
protected array $arrGroups
return array

$objInstance protected_oe static_oe property

Current object instance (do not remove)
protected static FrontendUser,contao $objInstance
return FrontendUser

$strCookie protected_oe property

Name of the current cookie
protected string $strCookie
return string

$strLoginPage protected_oe property

Group login page
protected string $strLoginPage
return string

$strTable protected_oe property

Name of the corresponding table
protected string $strTable
return string