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 コメントをキャンセル

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

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

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

: CakePHP3のcontroller内でテンプレート、レイアウトを変更する際の指定方法

CakePHP3でテンプレートファイルやレイアウトファイルをデフォルトのものから別のものに変更したい場合の指定方法を解説。

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

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

: CakePHP3でDocumentRootやwebroot、imgフォルダのURLやドメイン、パスを取得

URLやドメイン、フォルダへのパスの取得は、ビューではUrlHelperを使い、コントローラーではRouterクラスを使います。第2引数の指定でURLを取得することも可能。

: CakePHP 2.3　Search Pluginで検索処理　その４前方一致検索、後方一致検索、不等号による検索、between句による範囲検索

CakePHPの検索プラグイン Search Pluginの検索処理の中で前方一致検索、後方一致検索、不等号による検索、between句による範囲検索の解説です。

: CakePHP 2.3 Model、Controllerの見たい変数の中身をログ出力

CakePHPの Modelや Controllerの変数の中身をログとして出力して見る方法を提供します。

: CakePHP3でページごとに読み込むJavaScript、CSSを変える処理の解説

CakePHP3でJavaScriptやCSSを編集する基本形から、それらやテンプレート（エレメント）を特定のテンプレートを読み込んだときのみ編集、実行するための方法、ブロック化について解説。

: CakePHP3でファイルのアップロード処理を自作・解説付き・その１

CakePHP3でファイルをアップロードする処理を、php.netにある「エラーを起こさない」と説明がある処理を参考に作成。サンプルソースとその解説付きで、コピペでも動くし、カスタマイズも簡単！

: CakePHP 2.3でOn Duplicate Key構文を実装

CakePHPで On Duplicate Key構文を Queryを利用して実装する方法をサンプルソース付きで解説します。

: CakePHP2の検索Plugin CakeDC/Searchで重複を省くgroup by（distinct）の実装方法

CakePHP2の検索プラグイン「CakeDC/Search」で、重複レコードを省くgroup by、distinctを使う方法についての解説。設定する場所はpaginatorの条件とするので、find()関数と同じ。

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

日	月	火	水	木	金	土
« 3月
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

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 コメントをキャンセル

関連記事

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

CakePHP3のcontroller内でテンプレート、レイアウトを変更する際の指定方法

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

CakePHP3でDocumentRootやwebroot、imgフォルダのURLやドメイン、パスを取得

CakePHP 2.3　Search Pluginで検索処理　その４前方一致検索、後方一致検索、不等号による検索、between句による範囲検索

CakePHP 2.3 Model、Controllerの見たい変数の中身をログ出力

CakePHP3でページごとに読み込むJavaScript、CSSを変える処理の解説

CakePHP3でファイルのアップロード処理を自作・解説付き・その１

CakePHP 2.3でOn Duplicate Key構文を実装

CakePHP2の検索Plugin CakeDC/Searchで重複を省くgroup by（distinct）の実装方法

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

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

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

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

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