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 コメントをキャンセル

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

: CakePHP3でデータを保存する save()で発生するエラーを確認する方法を解説

CakePHP3でデータ保存処理のログを取得する方法。save()では true、falseの戻り値しか取得できないが、saveOrFail()と try…catch文を使いエラーログ、エンティティを取得し、不具合の解析を行う。

: CakePHP3チュートリアルで日付と時刻のDateTimeでエラーが出たときの対処方法

CakePHP3のブックマークチュートリアルには記載ミスもあり、そのまま動かない個所もある。CakePHP3では namespaceを使うようになったので、classを呼び出すときに￥を追加する必要が！

: CakePHP3のユーザ管理・ログイン認証プラグインCakeDC/Usersのインストール解説・3.6以降対応

CakePHP3のユーザ管理プラグイン Usersは、ユーザ登録、メール認証、ログイン認証、ユーザ管理、権限管理、reCAPTCHAなど会員制のサイトを簡単に実現可能。その導入方法、カスタマイズ方法を解説。

: CakePHP3のUpload Plugin 3.0をバリデーションなど実運用向けのカスタマイズ方法解説・その２

CakePHP3でファイル、画像をアップロードするプラグイン、upload plugin 3を導入する手順を解説した記事。3部作のその2でバリデーションなどの実用的なカスタマイズ方法を解説。

: CakePHP3の検索プラグイン「friendsofcake/search」の設置方法・CakePHP3.6対応

CakePHP3で検索を担うプラグイン「friendsofcake/search」の紹介。基本的な設置方法の紹介のほか、処理の記述方法のバリエーション、エラーの解説など。CakeDC/searchより導入は簡単！

: CakePHP4で「app_local.php」「.env」を利用して環境ごとの定数を振り分ける方法

CakePHP4で.env、app_local.phpに定数を定義してそれを呼び出す方法の解説。Gitでは管理せず本番環境と開発環境とで異なる定数を定義するためそれを利用する方法。

: CakePHP4系でJSONレスポンスの処理ではwithStringBodyを使う。3との違い解説

responseの値を指定する方法は3系では「body」だが、4系では「withStringBody」になりる。加えてJSON形式なら「withType」で指定するなど4系では結構異なる処理がある。