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

2017/04/15 2017/10/28

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

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

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

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

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

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

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

１．bootstrap.phpの編集

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

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]);

　
すでに 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;

<?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
　
下記の処理を編集します。

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

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

<?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」を必須項目にする、という処理に変更してみています。
　
　
これで、プラグインのファイルを触らずに、バリデーションをカスタマイズすることができるようになります。
　
　

CakePHP3のCakeDC/Usersの関連記事

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

- CakePHP 2.x　3.x CakePHP3

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

Message コメントをキャンセル

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

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

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

: CakePHP3のユーザ管理・認証プラグイン CakeDC/Usersの導入・機能解説・3.1.5対応

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

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

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

: CakePHP 2.3でファイルのアップロード処理を作る

CakePHPでプラグインを使わないファイルアップロード処理を解説します。簡単です。DBにファイルを格納する方法も。

: CakePHP3でWarning Error: SplFileInfo::openFile()エラーが発生した場合の対処方法

CakePHP3のキャッシュファイルのパーミッションエラー Error: SplFileInfo::openFile()が発生した場合の対応方法解説。app.phpにキャッシュファイルのパーミッション設定を行い、既存のファイルは削除。

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

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

: CakePHP3ログファイルの出力方法・$this->log()の解説

コントロール、モデルの変数の中身を見るときはログに出力する方法が有効です。$this->log()を利用すると変数だけじゃなく、連想配列、オブジェクトも簡単にログ出力ができます。

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

CakeDC謹製Usersプラグインの紹介。UserHelperを利用し、ログアウトのリンクや権限があるときのみ表示されるリンク、プロフィールページへのリンク、reCAPTCHAの設置方法などを解説。

: CakePHP3のバージョンを指定してインストールする詳細な手順を解説

CakePHP3のバージョンを指定してインストールする方法を詳細解説。CakePHP3のインストールはComposerを使うため設定もほぼ自動で完了。データベースの接続情報を記載すればアプリ開発のベースが整う。

: CakePHP 2.3 コマンドラインからPHPのシェル実行の方法解説

CakePHP 2.3でコマンドラインから CakePHPで記述した処理を実行する方法を解説します。

PREV: Google reCAPTCHAのSite key、Secret keyの取得方法・20170408バージョン
NEXT: 路線・駅検索のために緯度経度からPHPで2点間の距離を計算する処理解説

日	月	火	水	木	金	土
« 7月
			1	2	3	4
5	6	7	8	9	10	11
12	13	14	15	16	17	18
19	20	21	22	23	24	25
26	27	28	29	30	31

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

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

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

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

１．bootstrap.phpの編集

２．users.phpの編集

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

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

CakePHP3のCakeDC/Usersの関連記事

CakePHP3の関連記事

GoogleAdwords

GoogleAdwords

Message コメントをキャンセル

関連記事

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

CakePHP3のユーザ管理・認証プラグイン CakeDC/Usersの導入・機能解説・3.1.5対応

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

CakePHP 2.3でファイルのアップロード処理を作る

CakePHP3でWarning Error: SplFileInfo::openFile()エラーが発生した場合の対処方法

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

CakePHP3ログファイルの出力方法・$this->log()の解説

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

CakePHP3のバージョンを指定してインストールする詳細な手順を解説

CakePHP 2.3 コマンドラインからPHPのシェル実行の方法解説

WordPress投稿にPHPを記述するショートコードの使い方add_shortcode

コピーコンテンツ対策.htaccessで直リンク禁止しリダイレクトで対応

評価点投票プラグイン10個を比較！WordPressで口コミサイトを構築

BackWPupでバックアップ・リストア（復元）の具体的手順

コンパクトキーボード・KEK-EA9AU・FKB1420の魅力