phantomwatson/cakephp-autologin

CakePHP AutoLogin Component

v1.1.1 2017-06-22 20:29 UTC

Requires

• cakephp/cakephp: 3.*

Requires (Dev)

• cakephp/cakephp-codesniffer: *
• phpunit/phpunit: *

MIT

• Graham Watson

• cakephp
• autologin

README

This uses CakePHP's Cookie component in order to store a user's login data and automatically restore any sessions after they expire.

Compatibility:

Tested in CakePHP 3.0.0. This component will not work with CakePHP versions 1.x or 2.x.

Installation:

Manual installation:

• Download this repository and add its contents to plugins/AutoLogin

Or with Composer:

• Run composer require phantomwatson/cakephp-autologin in your application root

Then:

• Add Plugin::load('AutoLogin'); to your application's bootstrap.php (unless if you're already using Plugin::loadAll();)
• Add $this->loadComponent('AutoLogin.AutoLogin'); to AppController::initialize() after $this->loadComponent('Auth')
• Add $this->AutoLogin->setCookie(); after $this->Auth->setUser($user); wherever you log your users in
• Add $this->AutoLogin->destroyCookie(); where you log your users out (e.g. in UsersController::logout())

Configuration:

This component takes the following options:

• autoLogin - If true, attempts to logs the user in with cookie data. (Default: true)
• cookieKey - The name of the variable that the user's AutoLogin data is placed under in the cookie. (Default: 'autoLogin')
• cookieSettings - An array of cookie configuration settings for overriding the existing cookie configuration for the AutoLogin cookie variable. Possible options: 'expires', 'path', 'domain', 'secure', 'key', 'httpOnly', and 'encryption'. (Default: [])
• fields - The field names relevant to user authentication in your application. If your password field is called 'pass', you'll need to change this to something like ['username', 'pass']. (Default: ['email', 'username', 'password'])

For information about how to set these options, visit the Configuring Components section of the CakePHP 3 docs.

Note that these settings must be set in your controller's initialize() method, because AutoLogin cookie configuration and session restoration both take place before your controller's beforeFilter() method fires.

Notes:

It is strongly recommended that you use encrypted cookies. CakePHP 3 uses AES-encrypted cookies by default, so this just means don't turn off cookie encryption.