CakePHP3のCakeDC/Usersのバリデーションのカスタマイズ方法解説

CakeDC/Usersのバリデーションのカスタマイズ方法解説

　
「CakePHP3のユーザ管理・ログイン認証プラグインCakeDC/Usersのインストール解説・3.6以降対応」の記事で、CakePHP3で CakeDC/Usersを使ってログイン認証機能を実装する手順を解説しました。
また、「CakePHP3のCakeDC/Usersの画面、メール本文テンプレートのカスタマイズ方法解説」の記事で、HTMLのテンプレートを変更する解説をしました。
　
今回の記事では、その時に解説できなかった、入力画面でのバリデーションのカスタマイズ方法について解説します。
　
　

CakeDC/Usersのバリデーションが記載されているファイル

　
CakeDC/Usersのバリデーションが記載されているファイルは、以下のファイルになります。
　/vendor/cakedc/users/src/Model/Table/UsersTable.php
　
このファイルに記述されているバリデーションの内容を変更することで、バリデーションのカスタマイズを行うことは可能です。

ですが、一般的にはこのファイルはプラグイン「CakeDC/Users」のコアファイルになりますので、このファイルを直接更新することはせず、オーバーライドする処理を構築します。
　
　

CakeDC/Usersのバリデーションをオーバーライドでカスタマイズする

１．bootstrap.phpの編集

　
下記のファイルに編集を行います。
　/config/bootstrap.php
　
下記の、configファイルとして「/config/users.php」も利用する処理を記述します。

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

　
すでに Usersプラグインのロード処理を記述している場合は、1行目のみ追記します。
　
これは、「CakePHP3のCakeDC/Usersのログイン後のリダイレクトとユーザ権限管理の設定解説」の記事で、リダイレクトの処理の設定をする際にも記述しますので、リダイレクトなどほかの設定ですでに記述している場合もあるかと思います。
　
　

２．users.phpの編集

　
下記のファイルに編集を行います。該当のファイルがない場合は、新規作成をします。
/config/users.php
　
下記の値を編集します。

<?php
use Cake\Core\Configure;
use Cake\Routing\Router;
$config = [
    'Users' => [
        'table' => 'Users',
    ],
];
return $config;

　
　
標準設定は、「/vendor/cakedc/users/config/users.php」に下記の様に記載されています。

$config = [
    'Users' => [
        //Table used to manage users
        'table' => 'CakeDC/Users.Users',
         ：

　
「/config/users.php」は、「CakePHP3のCakeDC/UsersのUserHelperでログアウトやreCAPTCHAをカスタマイズ」で解説をした reCAPTCHAでも利用しますので、すでに設定がある場合もあるでしょう。
　
　

３．Model/Entity/User.phpの編集

　
下記のファイルに編集を行います。該当のファイルがない場合は、新規作成をします。
/src/Model/Entity/User.php
　
下記の処理を編集します。

<?php
namespace App\Model\Entity;

use CakeDC\Users\Model\Entity\User as UserParent;

use Cake\Core\Configure;
use Cake\I18n\Time;
use Cake\ORM\Entity;
use Cake\Utility\Text;
use DateTime;

class User extends UserParent
{
}

　
この内容は、プラグインの Entity「/vendor/cakedc/users/src/Model/Entity/User.php」の内容を流用しています。
　
　

４．Model/Table/UsersTable.phpの編集

　
下記のファイルに編集を行います。該当のファイルがない場合は、新規作成をします。
/src/Model/Table/UsersTable.php
　
そして、ようやく、バリデーションの処理を記載します。

<?php
namespace App\Model\Table;

use CakeDC\Users\Model\Table\UsersTable as UsersTableParent;

use Cake\ORM\Query;
use Cake\ORM\RulesChecker;
use Cake\ORM\Table;
use Cake\Utility\Hash;
use Cake\Validation\Validator;

/**
 * Users Model
 */
class UsersTable extends UsersTableParent
{

    public function validationDefault(Validator $validator)
    {
        $validator
            ->allowEmpty('id', 'create');

        $validator
            ->requirePresence('username', 'create')
            ->notEmpty('username');

        $validator
            ->requirePresence('password', 'create')
            ->notEmpty('password');

        $validator
//          ->allowEmpty('first_name');
            ->notEmpty('first_name');

        $validator
            ->allowEmpty('last_name');

        $validator
            ->allowEmpty('token');

        $validator
            ->add('token_expires', 'valid', ['rule' => 'datetime'])
            ->allowEmpty('token_expires');

        $validator
            ->allowEmpty('api_token');

        $validator
            ->add('activation_date', 'valid', ['rule' => 'datetime'])
            ->allowEmpty('activation_date');

        $validator
            ->add('tos_date', 'valid', ['rule' => 'datetime'])
            ->allowEmpty('tos_date');

        return $validator;
    }
}

　
18行目以降の「validationDefault()」の内容は、下記のプラグインの標準設定の内容をコピペしてからカスタマイズしています。
　/vendor/cakedc/users/src/Model/Table/UsersTable.php
　
上記の例では、33行目の処理で、「first_name」を必須項目にする、という処理に変更してみています。
　
　
これで、プラグインのファイルを触らずに、バリデーションをカスタマイズすることができるようになります。
　
　
※サンプルソースを修正しました（2019.03.27）
　
上記のサンプルソースをそのままコピペした場合、下記のエラーが発生する場合がありました。
　
Error: Class 'CakeDC\Users\Model\table\UsersTable' not found
File /home/ss-giken/ttt.onl/public_html/src/Model/Table/UsersTable.php
　
そのため、下記の点を修正しました。
　

// 修正前
use CakeDC\Users\Model\table\UsersTable as UsersTableParent;

// 修正後
use CakeDC\Users\Model\Table\UsersTable as UsersTableParent;

　
修正点は「Model\Table」の部分の「T」を小文字から大文字にしました。
　
ローカル（Windows）の XAMPP環境では問題ありませんでしたが、LAMP環境のサーバにアップしたらエラーが発生しました。
　
　

既存のバリデーションの英語のメッセージを日本語化する

　
/vendor/cakedc/users/src/Model/Table/UsersTable.php
には、
「パスワード」と「パスワード確認用」の入力値が同じかどうかチェック
「ユーザ名」「メールアドレス」がすでに使用されていないかどうかチェック
のバリデーションも含まれています。
　
これもバリデーションとして使われていますが、エラーのときのメッセージが英語で表示されます。
　
　
この英語のメッセージを変更する方法の一つとして、
/src/Model/Table/UsersTable.php
に、下記の関数部分のソースコードをコピペして、エラーメッセージ部分の「Username already exists」を日本語に変えることで対応することができます。
　

    public function buildRules(RulesChecker $rules)
    {
        $rules->add($rules->isUnique(['username']), '_isUnique', [
            'errorField' => 'username',
            'message' => __d('CakeDC/Users', 'Username already exists')
        ]);

        if ($this->isValidateEmail) {
            $rules->add($rules->isUnique(['email']), '_isUnique', [
                'errorField' => 'email',
                'message' => __d('CakeDC/Users', 'Email already exists')
            ]);
        }

        return $rules;
    }

CakePHP3のCakeDC/Usersの関連記事

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

CakePHP3の関連記事