CakePHP3のCakeDC/UsersのUserHelperでログアウトやreCAPTCHAをカスタマイズ

2017/04/11 2019/03/26

CakeDC/Usersでログアウトやリンク、reCAPTCHAを実装

　
「CakePHP3のユーザ管理・認証プラグイン CakeDC/Usersの導入・機能解説・3.6.0以降対応」の記事で、CakePHP3で CakeDC/Usersを使ってログイン認証機能を実装する手順を解説しました。
また「CakePHP3のCakeDC/Usersの画面、メール本文テンプレートのカスタマイズ方法解説」の記事では、ユーザ登録の流れをベースにテンプレートのカスタマイズの解説をしました。
　
今回の記事では、「CakePHP3のCakeDC/Usersの画面、メール本文テンプレートのカスタマイズ方法解説」の記事では解説しきれていなかった、UserHelperを活用したテンプレートのカスタマイズ方法を解説します。
　
　

CakeDC/Usersの UserHelperを使用

　
UserHelperを使うには、AppView.phpにヘルパーをロードする設定を行います。
　
設定を行う対象ファイルは以下になります。
　/src/view/AppView.php
　
AppView.phpに下記の 5～6行目のコードを追記します。

class AppView extends View
{
    public function initialize()
    {
        parent::initialize();
        $this->loadHelper('CakeDC/Users.User');
    }
}

class AppView extends View

{

public function initialize()

{

parent::initialize();

$this->loadHelper('CakeDC/Users.User');

}

　
この記述は、CakeDC/Usersの関連ページで UsersHelperを使う場合にはなくても問題ありません。
ですが、CakeDC/Users以外のページで UsersHelperを使う場合には必要になります。
　
　

Logout link

　
ログアウトのリンクを編集する場合は、下記のコードを追加します。
ログアウトのリンクは、このリンクをクリックするとログアウト処理が実行されるリンクで、アプリケーションのどこにでも追加可能です。

$this->User->logout();

1	$this->User->logout();

RBAC link

　
リンク先のページにアクセス権があるかどうかをチェックして、権限があればリンクを設定するリンク設定です。

【CakePHP3.2.0まで】
$this->User->link();

【CakePHP3.2.1以降】
$this->AuthLink->link();

【具体的なリンクの設定方法】
$this->AuthLink->link(__d('CakeDC/Users', 'New {0}', $tableAlias), ['action' => 'add'])

【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）へのリンクが設定されます。
　

$this->User->welcome();

1	$this->User->welcome();

PHPフレームワーク CakePHP 3入門

CakeDC/Usersで reCAPTCHAを使う方法

CakeDC/Usersにあらかじめ設定されている reCAPTCHA

　
CakeDC/Usersでは、あらかじめ、ユーザ登録時とログイン時に reCAPTCHAが使えるように設定されています。
　
ユーザ新規登録画面
　http://example.com/users/users/register
　
ログイン画面
　http://example.com/login
　

　
　

reCAPTCHAの設定手順１・/config/users.phpを編集

　
reCAPTCHAを有効にするには、「/config/users.php」に下記の内容を追記します。
　

<?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;

<?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行目の記述を追加します。

Configure::write('Users.config', ['users']);
Plugin::load('Users', ['routes' => true, 'bootstrap' => true]);

1 2	Configure::write('Users.config', ['users']); Plugin::load('Users', ['routes' => true, 'bootstrap' => true]);

　
詳しくは「CakePHP3のCakeDC/Usersのログイン後のリダイレクトとユーザ権限管理の設定解説」を参照してください。
　
　

reCAPTCHAの設定手順２・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の設定手順３・google/recaptchaのインストール方法の解説

　
手順２までを終わらせると、reCAPTCHAの画像が表示されるようになります。
最後に reCAPTCHAを動作させるために必要なプラグインをインストールします。
　
SSHで接続し、CakePHP3をインストールしているルートフォルダに移動して、下記のコマンドを実行し「google/recaptcha」をインストールします。
　

$ composer require google/recaptcha

1	$ composer require google/recaptcha

CakeDC/Usersでの reCAPTCHAの基本形

　
ユーザの新規登録時や、ログイン時に reCAPTCHAを利用する場合は、Site key、Secret keyを指定するだけで利用できるようになっています。
　
ですが、それ以外のテンプレートで使用したい場合は、下記の 2つのコマンドを追加することで利用することもできます。
　

$this->User->addReCaptchaScript();
$this->User->addReCaptcha();

1 2	$this->User->addReCaptchaScript(); $this->User->addReCaptcha();

　
詳しい使い方は、新規登録画面、ログイン画面の処理を参考にするといいでしょう。
　
　

CakePHP3のCakeDC/Usersの関連記事

　
CakePHP3の CakeDC/Usersを使うために、基本となるインストールの方法から入力画面のテンプレートのカスタマイズや、リダイレクトの設定など、CakeDC/Usersに関する記事を下記に書いています。
あわせて参考にしてみてください。
　CakePHP3のユーザ管理・認証プラグイン CakeDC/Usersの導入・機能解説・3.6.0以降対応
　 CakePHP3のCakeDC/Usersの画面、メール本文テンプレートのカスタマイズ方法解説
　 CakePHP3のCakeDC/Usersのログイン後のリダイレクトとユーザ権限管理の設定解説
　 Google reCAPTCHAのSite key、Secret keyの取得方法・20170408バージョン
　 CakePHP3のCakeDC/Usersのバリデーションのカスタマイズ方法解説
　
　

- CakePHP 2.x　3.x CakePHP3

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

Message コメントをキャンセル

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

: CakePHP3でDocumentRootやtmp、webroot、logsなどのフォルダへのパスの定数

CakePHP3で特定フォルダのパスの定数を解説。root、DocumentRoot、app、config、webroot、tests、tmp、cache、vendor、コア、コアの srcが設定済み。realpath()関数を使うと柔軟なパス指定が可能。

: CakePHP3で生の SQLの実行はConnectionManagerを使う

CakePHP3で生の SQL文を実行する方法を解説。クリエビルダーを使う場合は TableRegistryを利用するが、SQLを実行する場合は ConnectionManagerを使う。プリペアードステートメントの使用方法も解説。

: CakePHP3のアソシエーション機能を使い関連レコードをまとめて削除

CakePHP3でレコードを削除する際に関連するレコードをまとめて削除する機能の解説。フレームワークのメリットを存分に発揮し、コマンドを1行追加するだけで実装可能。

: CakePHP 2.3　bakeの超初心者向けフォロー講座

CakePHP 2.3　bakeの超初心者向けフォロー講座

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

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

: CakePHP3でユーザ定義の定数、変数を設定し、読み込む方法解説

CakePHP3で定数や共通で使う変数をまとめて設定し、プログラム内で読み込む方法を、bootstrap.phpに直接記述する方法と定数ファイルを分ける方法の3つの方法で解説。

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

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

: CakePHP3のCakeDC/Usersの画面、メール本文テンプレートのカスタマイズ方法解説

CakeDC謹製Usersプラグインの紹介。ユーザ新規登録の流れを紹介しつつテンプレートファイルがどこにあるか、設定情報ファイルがどこにあるか、を説明しつつカスタマイズの方法を解説します。

: CakePHP3のCakeDC/Usersのログイン後のリダイレクトとユーザ権限管理の設定解説

CakeDC謹製Usersプラグインの紹介。ログイン認証後にリダイレクトする先の設定方法についての解説と実運用するために必要なコツを解説。便利な仕組みも仕様の理解があって初めてうまく使いこなせる。