CakePHP3のCakeDC/Users、Authでログインなしでもアクセスを許可する設定

2018/07/01 2019/03/16

CakePHP3のユーザ管理・認証システムでログインなしでもアクセスを許可する設定

　
CakePHP3の CakeDC/Usersプラグインを利用して、ユーザ管理・認証システムを構築してする際に、ログインしていなくてもアクセスをできるページを設定する方法を解説します。
　
　
実際の検証では、CakePHP3の CakeDC/Usersプラグインを利用したユーザ管理・認証システムを作成中に確認していますが、AuthComponentによる認証処理は CakePHP3の標準のものと変わらないはずですので、同じように設定ができると思います。
（同じように設定できない場合は連絡をお願いします。）
　
　

各コントローラーに `$this->Auth->allow()`を記述

　
アクセスがあった場合、ユーザ認証をしていなくてもページを表示させる許可を設定する場合は、下記の様に記述します。
　
記述するファイルは、許可を与えるコントローラーのファイルです。
　

	public function beforeFilter(Event $event){
		parent::beforeFilter($event);

		// 認証なしでアクセスできるアクションの指定
		$this->Auth->allow(["index","add"]);
	}

public function beforeFilter(Event $event){

parent::beforeFilter($event);

// 認証なしでアクセスできるアクションの指定

$this->Auth->allow(["index","add"]);

}

　
5行目を追加することで、記述したコントローラー内のアクションに対して、ログインしていなくてもアクセスをする許可を与えることができます。
　
上記の記述をする際、下記の use句が記述されているかも確認してください。

use Cake\Event\Event;

1	use Cake\Event\Event;

　
この use句がないと下記のエラーが発生します。
逆に、下記のエラーが発生している場合は、use句が記述されているかを確認してください。
　
Strict (2048): Declaration of App\Controller\PagesController::beforeFilter() should be compatible with App\Controller\AppController::beforeFilter(Cake\Event\Event $event) [APP/Controller\PagesController.php, line 30]
　
　
また、細かくは下記の様に該当のアクションを指定することができます。
　

// すべてのアクションを許可する場合
$this->Auth->allow();
　
// index アクションのみ許可する場合
$this->Auth->allow("index");
　
// view と index アクションのみ許可する場合
$this->Auth->allow(["index","add"]);

// すべてのアクションを許可する場合

$this->Auth->allow();

// index アクションのみ許可する場合

$this->Auth->allow("index");

// view と index アクションのみ許可する場合

$this->Auth->allow(["index","add"]);

AppController.phpに `$this->Auth->allow()`をまとめて記述

　
先の設定方法では、各コントローラーに「$this->Auth->allow()」を記述していく必要がありますので、大きなシステムになった場合、管理が面倒になります。
開発途中で、ログインなしでもアクセスできるページを確認しようとする場合、各コントローラーのファイルを確認する必要があるためです。
　
これを解消するためには、/src/Controller/AppController.phpに下記の様に設定を行う方法があります。
　

	public function beforeFilter(){
		if ($this->request->controller == "Topics"){
			$this->Auth->allow(["index","add"]);
		}
	}

	// CakePHP3.4 以降の推奨の書き方
	public function beforeFilter(){
		if ($this->request->getParam("controller") == "Topics"){
			$this->Auth->allow(["index","add"]);
		}
	}

public function beforeFilter(){

if ($this->request->controller == "Topics"){

$this->Auth->allow(["index","add"]);

}

// CakePHP3.4 以降の推奨の書き方

public function beforeFilter(){

if ($this->request->getParam("controller") == "Topics"){

$this->Auth->allow(["index","add"]);

}

　
「$this->Auth->allow(["home","index"]);」の部分は、先に紹介した各コントローラーに記述方法と同じで、パラメーターに設定する内容も、アクションの指定をしない設定方法も同じです。
　
また、コントローラーの指定を下記の様に「in_array()」関数を使えば、複数のコントローラーをまとめて設定することも可能になります。
　

if (in_array($this->request->controller,["Topics","News"]) ) {
	$this->Auth->allow();
}

// CakePHP3.4以降推奨の書き方
if (in_array($this->request->getParam("controller"),["Topics","News"]) ) {
	$this->Auth->allow();
}

if (in_array($this->request->controller,["Topics","News"]) ) {

$this->Auth->allow();

}

// CakePHP3.4以降推奨の書き方

if (in_array($this->request->getParam("controller"),["Topics","News"]) ) {

$this->Auth->allow();

}

　
「$this->request->controller」は、動作しているコントローラー名を取得する処理ですが、詳しくは「CakePHP3で現在処理しているコントローラー名、アクション名を取得する方法」に記事を書いていますので、あわせて参考にしてください。
　
また、CakePHP3.4以降では「$this->request->getParam("controller")」の記述方法が採用されました。
今後はこの記述方法が推奨され、CakePHP3.7以降では「$this->request->controller」を記述では、「Deprecated (16384): Accessing routing parameters through controller will removed in 4.0.0. Use getParam() instead.」のエラーが出るようになりました。
　
　
ちなみに、上記の例では、「コントローラー：Topics」「アクション：index、add」に許可を与える設定になっています。
また、「/topics/inde」を「/」にルーティング設定をしている場合は、「/topics/inde」と「/」のいずれもログインしていなくても表示されるページとなります。
　
　

参考サイトは CakePHP3の Cookbook

　
最後になりましたが、ここで解説をした内容は、下記のオフィシャルの Cookbookを参考にしています。
　
リクエストとレスポンスオブジェクト
https://book.cakephp.org/3.0/ja/controllers/components/authentication.html#id28

- CakePHP 3.x 4.x 5.x

最後までお読みいただきましてありがとうございます。
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです！

Message コメントをキャンセル

※入力いただいたコメントは管理者の承認後に掲載されます。

: CakePHP4のクリエビルダーを使用してOR条件をAND条件でつなぐSQL文を作る方法

CakePHP4のクリエビルダーを使って複数のOR条件をANDでつなぐSQL文を作成する方法を解説。OR条件を記述したwhere句を2つつなげて記述する。

: CakePHP3でassociatedを使って関連データをまとめて保存する方法（hasOne、hasMany、belongsTo）

CakePHP3で関連データをまとめて保存する方法。hasOne、hasMany、belongsTo等の関連データはassociatedを追加することでまとめて保存することができます。

: CakePHP3のInsert On Duplicate Key Update（upsert）構文を解説・バルク処理も

CakePHP3で Insert … On Duplicate Key Update構文（upsert）を実行する方法を解説。バルク処理の方法も用意されているため大量処理の場合も対応可能。

: CakePHP3にデイトピッカー jQuery UI DatePickerを実装する手順の解説

CakePHP3にjQuery UIのDatePickerを実装する手順を説明。併せて、デイトピッカーを設置に関連するCakePHP3の解説と、テーマを変更したり、表記を変更するカスタマイズする方法なども紹介。

: CakePHPで同一テーブル内の値を比較する条件でレコードを取得する方法

CakePHPの同一テーブルにある項目の値を比較し条件に合致するレコードを取得する方法を解説。［”項目名”=>”値”]ではなく[”項目名 = 項目名”］と書くところがポイント。

: CakePHP3でComposerでインストールできないプラグイン、外部ライブラリを vendorに入れて手動で読み込む方法

CakePHP3にComposerからインストールできないプラグインやライブラリなどを利用する方法、vendorにファイルを設置し、composer.jsonを更新し、それを呼び出す方法を詳細に解説。

: CakePHP 2.3　Search Pluginで検索処理　その３入力エリア一つで複数の項目を同時に検索する方法

CakePHPの検索プラグイン Search Pluginの検索処理の中で入力エリア一つで複数の項目を同時に検索する方法を解説。

: 国際化と地域化の翻訳機能「__()」を使って定数に変数を埋め込む方法

CakePHP4で定数に変数を埋め込み、翻訳機能「__()」で変数に値を入れる方法を紹介。定型の文章の一部だけを置換したい場合に利用すると便利。

: CakePHP3でPHP Simple HTML DOM Parserを使ってスクレイピングする方法

CakePHP3でPHP Simple HTML DOM Parserを使ってスクレイピングをする方法を解説。インストール方法、読み込み方法。および、具体的なスクレイピングを実行するサンプルソースも。

: CakePHP3でWarning Error: SplFileInfo::openFile()エラーが発生した場合の対処方法

CakePHP3のキャッシュファイルのパーミッションエラー Error: SplFileInfo::openFile()が発生した場合の対応方法解説。app.phpにキャッシュファイルのパーミッション設定を行い、既存のファイルは削除。