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

2022/07/18 2023/12/28

CakeDC/Usersの Usersテーブルへの接続、バリデーションのカスタマイズ方法解説

　
「CakePHP4のユーザ管理・ログイン認証プラグインCakeDC/Usersのインストール解説」の記事で、CakePHP4で CakeDC/Usersを使ってログイン認証機能を実装する手順を解説しました。
また、「CakePHP4のCakeDC/Usersの画面、メール本文テンプレートのカスタマイズ方法解説」の記事で、HTMLのテンプレートを変更する解説をしました。
　
今回の記事では、その時に解説できなかった、入力画面でのバリデーションのカスタマイズ方法について解説します。
　
　
また、CakeDC/Usersをインストールすると、CakeDC/Usersで使用する Usersテーブルの Modelは「/vendor/cakedc/users/src/Model/Table/UsersTable.php」に作成されます。
　
ですが、このままではアソシエーション（モデルの結合）ができません。
　
例えば、ユーザの詳細情報を「user_details」というテーブルに生成し、「users」テーブルと結合しようと思っても「Table class for alias Users could not be found.」と言うエラーが発生します。
　
このエラーを解消し、アソシエーション（モデルの結合）をする方法を解説します。
　
　

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

　
CakeDC/Usersのバリデーションが記載されているファイルは、以下のファイルになります。
　/vendor/cakedc/users/src/Model/Table/UsersTable.php
　
このファイルに記述されているバリデーションの内容を変更することで、バリデーションのカスタマイズを行うことは可能です。
　
ですが、一般的にはこのファイルはプラグイン「CakeDC/Users」のコアファイルになりますので、このファイルを直接更新することはせず、オーバーライドする処理を構築します。
　
　

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

１．/src/Application.phpの編集

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

        // CakeDC/Usersのプラグインのロード
        $this->addPlugin(\CakeDC\Users\Plugin::class);

        // CakeDC/Usersの設定ファイル読み込み
        Configure::write('Users.config', ['users']);

// CakeDC/Usersのプラグインのロード

$this->addPlugin(\CakeDC\Users\Plugin::class);

// CakeDC/Usersの設定ファイル読み込み

Configure::write('Users.config', ['users']);

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

２．users.phpの編集

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

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

<?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' => [

//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
{
}

<?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
    {
        $validator
            ->allowEmptyString('id', null, 'create');

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

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

        $validator
//          ->allowEmptyString('first_name');
            ->notEmptyString('first_name');

        $validator
            ->allowEmptyString('last_name');

        $validator
            ->allowEmptyString('token');

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

        $validator
            ->allowEmptyString('api_token');

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

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

        return $validator;
    }

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

{

$validator

->allowEmptyString('id', null, 'create');

$validator

->requirePresence('username', 'create')

->notEmptyString('username');

$validator

->requirePresence('password', 'create')

->notEmptyString('password');

$validator

// ->allowEmptyString('first_name');

->notEmptyString('first_name');

$validator

->allowEmptyString('last_name');

$validator

->allowEmptyString('token');

$validator

->add('token_expires', 'valid', ['rule' => 'datetime'])

->allowEmptyDateTime('token_expires');

$validator

->allowEmptyString('api_token');

$validator

->add('activation_date', 'valid', ['rule' => 'datetime'])

->allowEmptyDateTime('activation_date');

$validator

->add('tos_date', 'valid', ['rule' => 'datetime'])

->allowEmptyDateTime('tos_date');

return $validator;

}

　
17行目以降の「validationDefault()」の内容は、下記のプラグインの標準設定の内容をコピペしてからカスタマイズしています。
　/vendor/cakedc/users/src/Model/Table/UsersTable.php
　
上記の例では、32行目の処理で、「first_name」を必須項目にする、という処理に変更してみています。
　
　
これで、プラグインのファイルを触らずに、バリデーションをカスタマイズすることができるようになります。
　
　

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

　
/vendor/cakedc/users/src/Model/Table/UsersTable.php
の「public function buildRules(RulesChecker $rules): RulesChecker」には
「パスワード」と「パスワード確認用」の入力値が同じかどうかチェック
「ユーザ名」「メールアドレス」がすでに使用されていないかどうかチェック
のバリデーションも含まれています。
　
これもバリデーションとして使われていますが、エラーのときのメッセージが英語で表示されます。
　
　
この英語のメッセージを変更する方法の一つとして、
/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;
    }

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;

}

　
　
CakePHP4、CakePHP5のメッセージ日本語化の設定（国際化と地域化の機能の使い方の解説）
また、上記の記事では、CakePHP4全体のメッセージを日本語化する方法について記載をしています。
あわせて参考にしてください。
　
　

Usersテーブルへの接続方法

　
今回のこの記事の「２．users.phpの編集」から「４．Model/Table/UsersTable.phpの編集」の対応を行うことで、
　/src/Model/Entity/User.php
　/src/Model/Table/UsersTable.php
のファイルを使う設定、および、それぞれのファイルの作成を行いました。
　
これによって、Usersテーブルをアソシエーション（モデルの結合）して使うことができる様になります。
　
　

　
この設定がないと、上記の画面のようにエラーとなります。
「Table class for alias Users could not be found.」
「Cake\ORM\Exception\MissingTableClassException」
　
このエラーが発生したときは、「/src/Model/Entity/User.php」「/src/Model/Table/UsersTable.php」を使える様にするために、「２」から「４」の対応を行ってください。
　
　

CakePHP4のCakeDC/Usersの関連記事

　
CakePHP4の CakeDC/Usersを使うために、基本となるインストールの方法から入力画面のテンプレートのカスタマイズや、リダイレクトの設定など、CakeDC/Usersに関する記事を下記に書いています。
あわせて参考にしてみてください。
　
CakePHP4のユーザ管理・ログイン認証プラグインCakeDC/Usersのインストール解説
 CakePHP4のCakeDC/Usersの画面、メール本文テンプレートのカスタマイズ方法解説
 CakePHP4のCakeDC/Usersのログイン時のリダイレクトとユーザ権限管理の設定解説
　
　

- CakePHP 3.x 4.x 5.x CakePHP4

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

Message コメントをキャンセル

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

: CakePHP 2.3で PDFを作成する方法を調査「mpdf」「TCPDF」「FPDF」

CakePHPで PDFを編集、出力するには「mpdf」「TCPDF」「FPDF」といったプラグインがあり、使い勝手を比較検討しました。TCPDFが一番良さそうでした。

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

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

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

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

: CakePHP3でモデルなしフォームからCSVをアップロードしレコードを更新する方法解説

CakePHP3でCSVファイルをアップロードしレコードを追加、更新する処理の作成方法の解説。モデルとは直接関連しないフォームからCSVファイルをアップロードするため汎用的に使用可能。

: CakePHP4、5のnewEmptyEntityで作成したオブジェクトは空なのか、確認してみた

CakePHPでレコードを新規登録をする際にnewEmptyEntity()を使って空のEntityを作成するが、これのempty、is_nullなどのでの判定結果がtrueかfalseか確認してみた。

: CakePHP 2.3　Search Pluginで検索処理　その２表示件数を動的に変える方法

CakePHPの検索プラグイン Search Pluginの検索処理の中で動的に表示件数を変える方法です。

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

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

: CakePHP3、CakePHP4のキャッシュをクリアする方法「bin/cake cache clear_all」を使う

CakePHP3、CakePHP4では処理を高速化する手法の一つとしてキャッシュを利用している。しかし、その情報は元の情報を更新しても反映されない場合がある。そんなときはキャッシュを削除する必要がある。

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

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