cakephp3 カスタムバリデーションを簡易的に実装する方法

2019/04/29 2019/08/24

CakePHP3のカスタムバリデーションの実装方法の一例

バリデーションファイルを作成する方が汎用性が高いルールとして設置できる

　
CakePHP3では、あらかじめ用意されたバリデーションのルール以外のオリジナルのバリデーションを行いたい場合の方法がいくつか用意されています。
　
ブログなどでよく紹介されているのは、
/src/Model/Validation/CustomValidation.php
ファイルを作成し、その中にバリデーションルールを作成して、それを呼び出す、というような方法です。
　
　
この方法は、汎用性が高く、複数のテーブルクラスで利用することができる有用な方法です。
　
ですが、今回は、他の処理では使わないであろう、と思われるバリデーションルールを、テーブルクラス内に簡単に記述する、という方法の紹介です。
　
　

テーブルファイル内に処理する関数も記述する方法

　
具体的には、下記の後半部分がオリジナルで追加したバリデーションになります。
　
通常の入力処理は前半のバリデーションで行い、さらにバリデーションを行いたい処理を後半に追加しています。
　
「function(){}」の中にチェックしたい内容を記述する方法ですので、理解しやすく、他に流用しやすいのではないか、と思います。
　
　
/src/Model/Table/TestsTable.php
　

        $validator
            ->scalar('url')
            ->maxLength('url', 1000)
            ->requirePresence('url', 'create')
            ->url('url',"http、httpsから URLを入力してください。")
            ->allowEmptyString('url', false);

        // 追加したオリジナルのバリデーション
        $validator
            ->add("url", "custom",[
                "rule"=>
                    function($value, $context){
                        if ( !$value ) {
                            return false;
                        }
                        if ( preg_match("/^https?:\/\/(www\.)?ttt\.onl/i", $value) ) {
                            return false;
                        }
                        return true;
                    },
                "message" => __('当サイトの URLを指定することはできません。')
            ]);

$validator

->scalar('url')

->maxLength('url', 1000)

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

->url('url',"http、httpsから URLを入力してください。")

->allowEmptyString('url', false);

// 追加したオリジナルのバリデーション

$validator

->add("url", "custom",[

"rule"=>

function($value, $context){

if ( !$value ) {

return false;

}

if ( preg_match("/^https?:\/\/(www\.)?ttt\.onl/i", $value) ) {

return false;

}

return true;

"message" => __('当サイトの URLを指定することはできません。')

]);

　
今回のこの処理は、「URL短縮サービス・TTTオンライン（https://ttt.onl）」の URLを入力する箇所に設定しているバリデーションですが、「https://ttt.onl」が入力されたか否かをチェックするバリデーションは他で使う可能性がないので、テーブルクラスの中に簡単に記述したいな、と思いこの方法を採用しました。
　
returnで戻す値は「true」「false」を設定する必要があります。
　
　
また、上記の中で URLのバリデーションは下記のように使い分けができます。
　

            // http://、https:// はあってもなくても OK
            ->url("url")

            // http://、https:// は必須
            ->urlWithProtocol("url");

// http://、https:// はあってもなくても OK

->url("url")

// http://、https:// は必須

->urlWithProtocol("url");

他の入力項目と連動する場合

　
前項では、「url」という入力項目だけでのチェックについての解説でした。
この項では他の入力項目と関連して入力チェックをする場合はどうするのか、について解説します。
　
「$value」は、「->add()」の第 1パラメータに設定している「url」の項目として入力された値が入ります。
また、「$context」にはフォームから送信された値全体が入っています。
　
そのため、例えば「delete_flag（削除フラグ）」が「1：削除」の場合は、「delete_date（削除日）」に日付を入力することを必須とする、という場合は下記のように記述します。
　
　

        // 追加したオリジナルのバリデーション
        $validator
            ->add("delete_flag", "custom",[
                "rule"=>
                    function($value, $context){
                        if($delete_flag === "1" ){
                            if ( $context["data"]["delete_date"] == "" ) {
                                return false;
                            }
                        }
                        return true;
                    },
                "message" => __('削除するときは削除する日付の指定が必要です。')
            ]);

// 追加したオリジナルのバリデーション

$validator

->add("delete_flag", "custom",[

"rule"=>

function($value, $context){

if($delete_flag === "1" ){

if ( $context["data"]["delete_date"] == "" ) {

return false;

}

return true;

"message" => __('削除するときは削除する日付の指定が必要です。')

]);

- CakePHP 3.x 4.x CakePHP3

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

Message コメントをキャンセル

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

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

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

: CakePHP3のタイムゾーンを協定世界時UTCから日本標準時間JSTにずれを変更する方法

CakePHP3の標準設定のタイムゾーンは「UTC（協定世界時）」に設定されている。これを日本標準時に変更する方法（app.php、bootstrap.phpの変更方法）の解説。

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

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

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

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

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

CakeDC謹製Usersプラグインの紹介。CakePHP4で使う場合のUsersのカスタマイズとして入力項目のバリデーションの変更を、プラグインのファイルは触らずオーバーライドにより実装する方法を解説する。

: VirtualBoxにCakePHP3を設置。必要なCentOS、Apache、PHP、MySQL、Composerをインストールし設定する

VirtualBoxにCentOS、Apache、MySQL、PHPをインストールするところから初めてCakePHP3の開発環境を構築する手順を詳細解説。この記事1つで全ての設定が完了する。

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

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

: CakePHP3のCakeDC/Usersでログインユーザの所有レコードのみ更新、削除する権限管理の設定方法

CakePHP3のユーザ管理、ログイン認証プラグイン「CakeDC/Users」の権限管理を行う方法やアクセスできるコントローラー、アクションを設定、所有権を持つレコードのみ更新できる設定方法を解説。

: CakePHPで favicon.icoやapple-touch-icon-144-precomposed.pngが could not be foundのエラーが出るときの対処方法

CakePHPで「CakeDC/Users」などルーティングを行うプラグインを利用するときに、favicon.icoやapple-touch-icon-144-precomposed.pngがNotFoundエラーになることがある。その対処方法の解説。

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

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