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" => __('削除するときは削除する日付の指定が必要です。')
            ]);