PHP Class CakeDC\Users\Controller\Component\RememberMeComponent

Saves a cookie to keep the user logged into the application even when the session expires
Inheritance: extends Cake\Controller\Component
Show file Open project: cakedc/users

Public Properties

Property Type Description
$components array Components

Protected Properties

Property Type Description
$_cookieName string Name of the cookie

Public Methods

Method Description
beforeFilter ( Cake\Event\Event $event ) : mixed Reads the stored cookie and auto login the user if present
destroy ( Cake\Event\Event $event ) : void Destroys the remember me cookie
initialize ( array $config ) : void Initialize config data and properties.
setCookieOptions ( ) : void Sets cookie configuration options
setLoginCookie ( Cake\Event\Event $event ) : void Sets the login cookie that handles the remember me feature

Protected Methods

Method Description
_attachEvents ( ) : void Attach the afterLogin and beforeLogount events
_validateConfig ( ) : void Validate component config

Method Details

_attachEvents() protected method

Attach the afterLogin and beforeLogount events
protected _attachEvents ( ) : void
return void

_validateConfig() protected method

Validate component config
protected _validateConfig ( ) : void
return void

beforeFilter() public method

Reads the stored cookie and auto login the user if present
public beforeFilter ( Cake\Event\Event $event ) : mixed
$event Cake\Event\Event event
return mixed

destroy() public method

Destroys the remember me cookie
public destroy ( Cake\Event\Event $event ) : void
$event Cake\Event\Event event
return void

initialize() public method

Initialize config data and properties.
public initialize ( array $config ) : void
$config array The config data.
return void

setCookieOptions() public method

Sets cookie configuration options
public setCookieOptions ( ) : void
return void

setLoginCookie() public method

Sets the login cookie that handles the remember me feature
public setLoginCookie ( Cake\Event\Event $event ) : void
$event Cake\Event\Event event
return void

Property Details

$_cookieName protected property

Name of the cookie
protected string $_cookieName
return string

$components public property

Components
public array $components
return array