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 2.x　3.x CakePHP3

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

Message コメントをキャンセル

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

: CakePHP3の更新画面でUpload Plugin 3.0を使う方法、viewで使う方法解説・その３

CakePHP3でファイル、画像をアップロードするプラグイン、upload plugin 3を導入する手順を解説した記事。3部作のその3で記事を更新する際のファイルの取り回しなどについてを解説。

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

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

: CakePHP3で静的ページの作成は webrootか pagesを使う。トップページを参考に解説

CakePHP3で静的なページを設置する場合の方法（webrootとpagesとを活用する方法）を解説。pagesの解説はデフォルトのトップページがどう表示されているかを参考に解説。ルーティングの機能も。

: CakePHP3のdatetime型カラムの日時の扱い。秒まで正しく表示する方法

CakePHP3の日時カラムで秒まで扱う場合はdate()、strtotime()関数ではうまくいかない。CakePHP3であらかじめ用意された「i18nFormat()」を使用する。

: CakePHP 2.3　テーブルの項目を演算した結果を条件として抽出する方法

アソシエーション（連携）している先のテーブルの項目で演算をする場合の考え方と注意点をサンプルソースを用いて説明しています。分かってしまえば簡単です。

: CakePHP3でパンくずの指定は HTMLヘルパーを使って指定する方法を解説

CakePHP3でパンくずの指定方法の解説。2つのヘルパーがあるが簡単なHTMLヘルパーを使った方法を、実際の状況に合わせて3つのパターン（エレメント化、ブロック化）にして解説。

: CakePHP3で値を入力直後にバリデーションする方法解説

CakePHP3でバリデーションの実行を保存する時から入力情報を受け取るときに変更する処理の解説。CakePHP3ではnewEntity()の処理でバリデートするため1行追加で対応可能。

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

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

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

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

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

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