CakePHP3のCakeDC/UsersのUserHelperでログアウトやreCAPTCHAをカスタマイズ
2019/03/26
CakeDC/Usersでログアウトやリンク、reCAPTCHAを実装
「CakePHP3のユーザ管理・ログイン認証プラグインCakeDC/Usersのインストール解説・3.6以降対応」の記事で、CakePHP3で CakeDC/Usersを使ってログイン認証機能を実装する手順を解説しました。
また「CakePHP3のCakeDC/Usersの画面、メール本文テンプレートのカスタマイズ方法解説」の記事では、ユーザ登録の流れをベースにテンプレートのカスタマイズの解説をしました。
今回の記事では、「CakePHP3のCakeDC/Usersの画面、メール本文テンプレートのカスタマイズ方法解説」の記事では解説しきれていなかった、UserHelperを活用したテンプレートのカスタマイズ方法を解説します。
CakeDC/Usersの UserHelperを使用
UserHelperを使うには、AppView.phpにヘルパーをロードする設定を行います。
設定を行う対象ファイルは以下になります。
/src/view/AppView.php
AppView.phpに下記の 5~6行目のコードを追記します。
1 2 3 4 5 6 7 8 |
class AppView extends View { public function initialize() { parent::initialize(); $this->loadHelper('CakeDC/Users.User'); } } |
この記述は、CakeDC/Usersの関連ページで UsersHelperを使う場合にはなくても問題ありません。
ですが、CakeDC/Users以外のページで UsersHelperを使う場合には必要になります。
Logout link
ログアウトのリンクを編集する場合は、下記のコードを追加します。
ログアウトのリンクは、このリンクをクリックするとログアウト処理が実行されるリンクで、アプリケーションのどこにでも追加可能です。
1 |
$this->User->logout(); |
RBAC link
リンク先のページにアクセス権があるかどうかをチェックして、権限があればリンクを設定するリンク設定です。
1 2 3 4 5 6 7 8 |
【CakePHP3.2.0まで】 $this->User->link(); 【CakePHP3.2.1以降】 $this->AuthLink->link(); 【具体的なリンクの設定方法】 $this->AuthLink->link(__d('CakeDC/Users', 'New {0}', $tableAlias), ['action' => 'add']) |
RBAC linkは、CakePHPの 3.2.1の以前、以降で推奨されている記述の方法が変更になっています。
CakePHP3.2.1 以降では、UserHelper::link() は推奨されていませんので、AuthLinkHelper::link() を使いましょう。
※下記の GitHubのドキュメントでは、まだ CakePHP3.2.1以降で推奨設定が変更になったことの記載がありません。
https://github.com/CakeDC/users/blob/3.1.5/Docs/Documentation/UserHelper.md
Welcome and profile link
このリンクを書くと「Welcome, ユーザ名」のメッセージとともに、プロフィールページ(http://example.com/users/users/profile)へのリンクが設定されます。
1 |
$this->User->welcome(); |
CakeDC/Usersで reCAPTCHAを使う方法
CakeDC/Usersにあらかじめ設定されている reCAPTCHA
CakeDC/Usersでは、あらかじめ、ユーザ登録時とログイン時に reCAPTCHAが使えるように設定されています。
ユーザ新規登録画面
http://example.com/users/users/register
ログイン画面
http://example.com/login
reCAPTCHAの設定手順1・/config/users.phpを編集
reCAPTCHAを有効にするには、「/config/users.php」に下記の内容を追記します。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 |
<?php use Cake\Core\Configure; use Cake\Routing\Router; $config = [ 'Users' => [ 'reCaptcha' => [ //reCaptcha key goes here 'key' => "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA", //reCaptcha secret 'secret' => "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA", //use reCaptcha in registration 'registration' => true, //use reCaptcha in login, valid values are false, true 'login' => true, ], ], ]; return $config; |
上記の reCAPTCHAの設定情報は、CakeDC/Usersの標準設定情報が保存されている「/vendor/cakedc/users/config/users.php」にもありますので、そちらを変更しても動作します。
ですが、通常は標準設定情報は変更せず、「/config/users.php」にファイルを作成し、こちらに変更した設定情報を追加していく方法を採ります。
「/config/users.php」ファイルがない場合は新規作成をし、すでにある場合は 6~17行目を追記してください。
また、「/config/users.php」を有効にするには「bootstrap.php」に追記が必要です。
編集するファイルは下記になります。
/config/bootstrap.php
下記の 1行目の記述を追加します。
1 2 |
Configure::write('Users.config', ['users']); Plugin::load('Users', ['routes' => true, 'bootstrap' => true]); |
詳しくは「CakePHP3のCakeDC/Usersのログイン後のリダイレクトとユーザ権限管理の設定解説」を参照してください。
reCAPTCHAの設定手順2・users.phpの編集内容の解説
「key」「secret」の値は、サイトごとに固有の値を設定します。
Googleの reCAPTCHAの登録ページからサイトを登録して、そのサイト用の値を取得してください。
取得の方法は「Google reCAPTCHAのSite key、Secret keyの取得方法・20170408バージョン」に記載しましたので参照してください。
また、「registration」「login」は、それぞれ、ユーザ新規登録時の画面、ログイン画面での reCAPTCHAを使用するか、使用しないかを設定する項目です。
trueにすると使用する設定になり、falseは使用しません。
ちなみに、「key」「secret」を nullのまま「registration」「login」を trueにすると、「reCaptcha is not configured! Please configure Users.reCaptcha.key」というエラー画面になります。
間違った「key」「secret」を設定すると「サイト所有者のエラー:サイトキーが無効です」のエラー画面になります。
登録したドメインと違うドメインの場合は「localhost は、このサイトキーでサポートされているドメインのリストに含まれていません。」というエラーになります。
reCAPTCHAの設定手順3・google/recaptchaのインストール方法の解説
手順2までを終わらせると、reCAPTCHAの画像が表示されるようになります。
最後に reCAPTCHAを動作させるために必要なプラグインをインストールします。
SSHで接続し、CakePHP3をインストールしているルートフォルダに移動して、下記のコマンドを実行し「google/recaptcha」をインストールします。
1 |
$ composer require google/recaptcha |
CakeDC/Usersでの reCAPTCHAの基本形
ユーザの新規登録時や、ログイン時に reCAPTCHAを利用する場合は、Site key、Secret keyを指定するだけで利用できるようになっています。
ですが、それ以外のテンプレートで使用したい場合は、下記の 2つのコマンドを追加することで利用することもできます。
1 2 |
$this->User->addReCaptchaScript(); $this->User->addReCaptcha(); |
詳しい使い方は、新規登録画面、ログイン画面の処理を参考にするといいでしょう。
CakePHP3のCakeDC/Usersの関連記事
CakePHP3の CakeDC/Usersを使うために、基本となるインストールの方法から入力画面のテンプレートのカスタマイズや、リダイレクトの設定など、CakeDC/Usersに関する記事を下記に書いています。
あわせて参考にしてみてください。
CakePHP3のユーザ管理・ログイン認証プラグインCakeDC/Usersのインストール解説・3.6以降対応
CakePHP3のCakeDC/Usersの画面、メール本文テンプレートのカスタマイズ方法解説
CakePHP3のCakeDC/Usersのログイン後のリダイレクトとユーザ権限管理の設定解説
Google reCAPTCHAのSite key、Secret keyの取得方法・20170408バージョン
CakePHP3のCakeDC/Usersのバリデーションのカスタマイズ方法解説
CakePHP3の関連記事
CakePHP4のCSS、JavaScript、画像のブラウザへのキャッシュをコントロールするCakePHP3でレコードを保存(追加、更新、Insert、Update)する複数の方法を紹介
CakePHP3でモデルなしフォームからCSVをアップロードしレコードを更新する方法解説
CakePHP3でPHP Simple HTML DOM Parserを使ってスクレイピングする方法
CakePHP3のInsert On Duplicate Key Update(upsert)構文を解説・バルク処理も
CakePHP3の1対多での連携を中間テーブルを使った多対多の連携に変更するときの手順
CakePHP3でデフォルトのソート条件を設定してユーザの選択肢たソート条件を有効にする方法
CakePHP3で Ajaxを使う方法の解説。3.6以降対応。Successとthenの両方を解説。
CakePHP3でパンくずの指定は HTMLヘルパーを使って指定する方法を解説
CakePHP3にOGPをfetch、asignを利用してテンプレートごとに指定する方法を解説
その他の「CakePHP3」に関する記事一覧
GoogleAdwords
GoogleAdwords
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです!
関連記事
-
CakePHP3で /Layout/defult.ctpにある titleタグ、h1タグを編集する方法
CakePHP3でtitleタグ、h1タグのテキストをデフォルトから変更する方法を解説。テンプレートファイルに「$this->assign()」でテキストを指定して「/Layout/defult.ctp」で受け取る。
-
VirtualBoxにCakePHP3を設置。必要なCentOS、Apache、PHP、MySQL、Composerをインストールし設定する
VirtualBoxにCentOS、Apache、MySQL、PHPをインストールするところから初めてCakePHP3の開発環境を構築する手順を詳細解説。この記事1つで全ての設定が完了する。
-
CakePHP3のForm Helperの使い方のまとめ
CakePHP3になりフォームヘルパーの使い方も大きく変わりましたので、使い方をまとめました。基本的な使い方からプラスアルファの便利な使い方まで紹介。
-
CakePHP 2.3 Search Pluginで検索処理 その6ORDER、sortソートの機能
CakePHPの検索プラグイン Search Pluginの検索処理の中で order、ソートについての解説です。
-
CakePHP4 のコマンドプログラムからコンポーネントを読み込む方法解説
CakePHP4でコマンドプログラムからコンポーネントを呼び出す方法を解説。コントローラーから呼び出すときと大差はないが、use句でコンポーネントを指定する事がポイント。
-
CakePHP3で静的ページの作成は webrootか pagesを使う。トップページを参考に解説
CakePHP3で静的なページを設置する場合の方法(webrootとpagesとを活用する方法)を解説。pagesの解説はデフォルトのトップページがどう表示されているかを参考に解説。ルーティングの機能も。
-
CakePHP3の画像、ファイルアップロードプラグインUpload Plugin 3.0の設置解説・その1
CakePHP3でファイル、画像をアップロードするプラグイン、upload plugin 3を導入する手順を解説した記事。3部作のその1で基本的な導入方法の解説で読みながら簡単に導入が可能。
-
Google Analytics APIを CakePHP3で動かしてレポートデータを取得する方法の解説
CakePHP3で Google Analytics APIからレポートデータを取得する処理の解説。PHPのサンプルソースをCakePHP3で動くように改造。加えて、ディメンションやメトリックスを条件に設定する方法なども。
-
CakePHP3でデータを保存する save()で発生するエラーを確認する方法を解説
CakePHP3でデータ保存処理のログを取得する方法。save()では true、falseの戻り値しか取得できないが、saveOrFail()と try…catch文を使いエラーログ、エンティティを取得し、不具合の解析を行う。
-
CakePHP4のユーザ管理・ログイン認証プラグインCakeDC/Usersのインストール解説
CakePHP4のユーザ管理プラグイン Usersは、ユーザ登録、メール認証、ログイン認証、ユーザ管理、権限管理、reCAPTCHAなど会員制のサイトを簡単に実現可能。その導入方法、カスタマイズ方法を解説。