CakePHP3 Authコンポーネントでログイン・ログアウト機能

投稿日：2017年11月27日更新日：2018年2月25日

CakePHP3 Authコンポーネントでログイン・ログアウト機能のサンプルコード。

● 使用例のテーブル定義(usersテーブル)

// ユーザーテーブル
// status 0:仮登録 1:本登録 2:退会
CREATE TABLE `users` (
`id` int(11) unsigned NOT NULL AUTO_INCREMENT PRIMARY KEY,
`email` varchar(255) NOT NULL,
`password` varchar(255) NOT NULL,
`status` char(1) DEFAULT 0,
`created` DATETIME DEFAULT NULL,
`modified` DATETIME DEFAULT NULL
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;
// テストデータ
INSERT INTO `users` (`id`, `email`, `password`, `status`, `created`, `modified`) VALUES 
(NULL, '001@cakephp3.com', '001', '0', NULL, NULL),
(NULL, '002@cakephp3.com', '002', '1', NULL, NULL);

// ユーザーテーブル

// status 0:仮登録 1:本登録 2:退会

CREATE TABLE `users` (

`id` int(11) unsigned NOT NULL AUTO_INCREMENT PRIMARY KEY,

`email` varchar(255) NOT NULL,

`password` varchar(255) NOT NULL,

`status` char(1) DEFAULT 0,

`created` DATETIME DEFAULT NULL,

`modified` DATETIME DEFAULT NULL

) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;

// テストデータ

INSERT INTO `users` (`id`, `email`, `password`, `status`, `created`, `modified`) VALUES

(NULL, '001@cakephp3.com', '001', '0', NULL, NULL),

(NULL, '002@cakephp3.com', '002', '1', NULL, NULL);

◯「AppController.php」にAuth定義実装【サンプル】

class AppController extends Controller
{
public function initialize()
{
parent::initialize();
// ・・・
$this->loadComponent('Auth', [
'authenticate' => [
// ユーザー認証に使用するカラム(email, password)
'Form' => [
'fields' => [
'username' => 'email',
'password' => 'password'
]
]
// ユーザー認証に使用するカラム(email, password, status[1のみ])
// 'Form' => [
//     'fields' => [
//         'username' => 'email',
//         'password' => 'password'
//     ],
//     'scope' => ['status' => 1]
// ],
// 
// 認証テーブル users -> admins切替(デフォルト:Users)
// 'userModel' => 'Admins'
],
// ログインを扱うコントローラーとアクション(デフォルト:/users/login)
'loginAction' => [
'controller' => 'Users',
'action' => 'login'
],
// ログイン後のリダイレクト先(コントローラーとアクション)
'loginRedirect' => [
'controller' => 'Users',
'action' => 'index'
],
// ログアウト後のリダイレクト先(コントローラーとアクション)
'logoutRedirect' => [
'controller' => 'Users',
'action' => 'index'
],
// 未ログイン時にログイン必須ページを閲覧した際のMSG
'authError' => __('ログインしてください。')
]);
// ・・・
}
}

class AppController extends Controller

{

public function initialize()

{

parent::initialize();

// ・・・

$this->loadComponent('Auth', [

'authenticate' => [

// ユーザー認証に使用するカラム(email, password)

'Form' => [

'fields' => [

'username' => 'email',

'password' => 'password'

]

// ユーザー認証に使用するカラム(email, password, status[1のみ])

// 'Form' => [

// 'fields' => [

// 'username' => 'email',

// 'password' => 'password'

// ],

// 'scope' => ['status' => 1]

// ],

// 認証テーブル users -> admins切替(デフォルト:Users)

// 'userModel' => 'Admins'

// ログインを扱うコントローラーとアクション(デフォルト:/users/login)

'loginAction' => [

'controller' => 'Users',

'action' => 'login'

// ログイン後のリダイレクト先(コントローラーとアクション)

'loginRedirect' => [

'controller' => 'Users',

'action' => 'index'

// ログアウト後のリダイレクト先(コントローラーとアクション)

'logoutRedirect' => [

'controller' => 'Users',

'action' => 'index'

// 未ログイン時にログイン必須ページを閲覧した際のMSG

'authError' => __('ログインしてください。')

]);

// ・・・

}

◯「UsersController.php」にログイン・ログアウト実装【サンプル】

・・・
use Cake\Event\Event;
・・・
class UsersController extends AppController
{
public function beforeFilter(Event $event)
{
parent::beforeFilter($event);
// 未ログイン時にすべてのアクションを許可
$this->Auth->allow();
}
public function index()
{
}
// ログイン
public function login()
{
if ($this->request->is('post')) {
// ユーザー認証
// usersテーブルのusernameとpasswordが一致したレコード取得
$user = $this->Auth->identify();
if ($user) {
// メソッドに渡されたデータを持つユーザーとしてログイン
$this->Auth->setUser($user);
// $this->Auth->redirectUrl(): ログイン後のリダイレクト先URLを返す(loginRedirect)
return $this->redirect($this->Auth->redirectUrl());
} else {
$this->Flash->error(__('emailまたはpasswordが間違っています。'));
}
}
}
// ログアウト
public function logout()
{
// $this->Auth->logout(): ユーザー認証を解除し、ログアウト後のリダイレクト先URLを返す(logoutRedirect)
return $this->redirect($this->Auth->logout());
}
}

・・・

use Cake\Event\Event;

・・・

class UsersController extends AppController

{

public function beforeFilter(Event $event)

{

parent::beforeFilter($event);

// 未ログイン時にすべてのアクションを許可

$this->Auth->allow();

}

public function index()

{

}

// ログイン

public function login()

{

if ($this->request->is('post')) {

// ユーザー認証

// usersテーブルのusernameとpasswordが一致したレコード取得

$user = $this->Auth->identify();

if ($user) {

// メソッドに渡されたデータを持つユーザーとしてログイン

$this->Auth->setUser($user);

// $this->Auth->redirectUrl(): ログイン後のリダイレクト先URLを返す(loginRedirect)

return $this->redirect($this->Auth->redirectUrl());

} else {

$this->Flash->error(__('emailまたはpasswordが間違っています。'));

}

// ログアウト

public function logout()

{

// $this->Auth->logout(): ユーザー認証を解除し、ログアウト後のリダイレクト先URLを返す(logoutRedirect)

return $this->redirect($this->Auth->logout());

}

-コントローラー(Controller)
-Authコンポーネント, loadComponent, サンプルコード, ログアウト, ログイン

執筆者：管理人

comment コメントをキャンセル

このサイトはスパムを低減するために Akismet を使っています。コメントデータの処理方法の詳細はこちらをご覧ください。

: CakePHP3 自動ログイン機能のサンプルコード
CakePHP3 自動ログイン(オートログイン)機能のサンプルコードです。 =簡易メモ= ・ユーザーログイン画面にて自動ログインにチェックされていた場合、Cookie(AUTO_LOGIN)セットする …

全てのキャッシュ(Cache)無効化する方法

全てのキャッシュ読み取りと書き込みを無効にする。 ◯「config/bootstrap.php」の末尾に追記する。

// キャッシュ無効化
Cache::disable();

1 2	// キャッシュ無効化 Cache::disable();

CakePHP3 セッション(session)使い方

CakePHP3 コントローラーでのセッション(session)の使い方です。

// ローカル変数にする
$session = $this->request->getSession();　// CakePHP 3.5~
$session = $this->request->session();　　　// CakePHP ~3.4
// セッション書き込み
$session->write('Config.language', 'ja');
// セッション読み込み
$session->read();　// 全て
$session->read('Config.language');　// キー指定
ex)
var_dump($session->read());　// array('Config' => array('time' => int 1511915063 , 'language' => string 'ja'))
var_dump($session->read('Config.language'));　// 'ja'
// セッション読み込み後に削除
$session->consume('Config.language');　// キー指定
ex)
var_dump($session->read());　// array('Config' => array('time' => int 1511915063 , 'language' => string 'ja'))
$session->consume('Config.language');
var_dump($session->read());　// array('Config' => array('time' => int 1511915063))
// セッション削除(キー指定)
$session->delete('Config.language');
// セッション破棄
$session->destroy();
// セッション存在確認(キー指定)
$session->check('Config.language'); // 存在する: true, 存在しない: false

// ローカル変数にする

$session = $this->request->getSession();　// CakePHP 3.5~

$session = $this->request->session();　　　// CakePHP ~3.4

// セッション書き込み

$session->write('Config.language', 'ja');

// セッション読み込み

$session->read();　// 全て

$session->read('Config.language');　// キー指定

ex)

var_dump($session->read());　// array('Config' => array('time' => int 1511915063 , 'language' => string 'ja'))

var_dump($session->read('Config.language'));　// 'ja'

// セッション読み込み後に削除

$session->consume('Config.language');　// キー指定

ex)

var_dump($session->read());　// array('Config' => array('time' => int 1511915063 , 'language' => string 'ja'))

$session->consume('Config.language');

var_dump($session->read());　// array('Config' => array('time' => int 1511915063))

// セッション削除(キー指定)

$session->delete('Config.language');

// セッション破棄

$session->destroy();

// セッション存在確認(キー指定)

$session->check('Config.language'); // 存在する: true, 存在しない: false

: トレイリングスラッシュメソッド (末尾スラッシュ)
「AppController.php」などにトレイリングスラッシュ(trailing slash)のメソッド定義し、生成URLにメソッドを利用することによって末尾スラッシュありに統一する。 [cray …

CakePHP3 ImageMagickで写真(画像)圧縮するサンプルコード

◯ CakePHP3 ImageMagickで写真(画像)圧縮するサンプルコードです。

// サンプルコード
//  対象ファイル：JPEG,PNG,GIF
//  圧縮品質：80
// 写真パス
$photo_file_path = '写真パス';
// 写真拡張子取得
$file_extension = pathinfo($photo_file_path, PATHINFO_EXTENSION);
// 写真読み込み
$imagick_img = new \Imagick($photo_file_path);
// 写真圧縮設定
if ($file_extension == 'jpeg' || $file_extension == 'jpg') {
$imagick_img->setImageFormat('jpg');
$imagick_img->setImageCompression(\Imagick::COMPRESSION_JPEG);
} elseif ($file_extension == 'png') {
$imagick_img->setImageFormat('png');
$imagick_img->setImageCompression(\Imagick::COMPRESSION_UNDEFINED);
} else {
$imagick_img->setImageFormat('gif');
$imagick_img->setImageCompression(\Imagick::COMPRESSION_UNDEFINED);
}
$imagick_img->setImageCompressionQuality(80);
// 写真上書き保存
if (!$imagick_img->writeImage($photo_file_path)) {
// 上書き保存エラー
}
// Imagick clear
$imagick_img->clear();

// サンプルコード

// 対象ファイル：JPEG,PNG,GIF

// 圧縮品質：80

// 写真パス

$photo_file_path = '写真パス';

// 写真拡張子取得

$file_extension = pathinfo($photo_file_path, PATHINFO_EXTENSION);

// 写真読み込み

$imagick_img = new \Imagick($photo_file_path);

// 写真圧縮設定

if ($file_extension == 'jpeg' || $file_extension == 'jpg') {

$imagick_img->setImageFormat('jpg');

$imagick_img->setImageCompression(\Imagick::COMPRESSION_JPEG);

} elseif ($file_extension == 'png') {

$imagick_img->setImageFormat('png');

$imagick_img->setImageCompression(\Imagick::COMPRESSION_UNDEFINED);

} else {

$imagick_img->setImageFormat('gif');

$imagick_img->setImageCompression(\Imagick::COMPRESSION_UNDEFINED);

}

$imagick_img->setImageCompressionQuality(80);

// 写真上書き保存

if (!$imagick_img->writeImage($photo_file_path)) {

// 上書き保存エラー

}

// Imagick clear

$imagick_img->clear();