cakephp3 カスタムバリデーションを簡易的に実装する方法
2019/08/24
CakePHP3のカスタムバリデーションの実装方法の一例
バリデーションファイルを作成する方が汎用性が高いルールとして設置できる
CakePHP3では、あらかじめ用意されたバリデーションのルール以外のオリジナルのバリデーションを行いたい場合の方法がいくつか用意されています。
ブログなどでよく紹介されているのは、
/src/Model/Validation/CustomValidation.php
ファイルを作成し、その中にバリデーションルールを作成して、それを呼び出す、というような方法です。
この方法は、汎用性が高く、複数のテーブルクラスで利用することができる有用な方法です。
ですが、今回は、他の処理では使わないであろう、と思われるバリデーションルールを、テーブルクラス内に簡単に記述する、という方法の紹介です。
テーブルファイル内に処理する関数も記述する方法
具体的には、下記の後半部分がオリジナルで追加したバリデーションになります。
通常の入力処理は前半のバリデーションで行い、さらにバリデーションを行いたい処理を後半に追加しています。
「function(){}」の中にチェックしたい内容を記述する方法ですので、理解しやすく、他に流用しやすいのではないか、と思います。
/src/Model/Table/TestsTable.php
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 |
$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のバリデーションは下記のように使い分けができます。
1 2 3 4 5 |
// http://、https:// はあってもなくても OK ->url("url") // http://、https:// は必須 ->urlWithProtocol("url"); |
他の入力項目と連動する場合
前項では、「url」という入力項目だけでのチェックについての解説でした。
この項では他の入力項目と関連して入力チェックをする場合はどうするのか、について解説します。
「$value」は、「->add()」の第 1パラメータに設定している「url」の項目として入力された値が入ります。
また、「$context」にはフォームから送信された値全体が入っています。
そのため、例えば「delete_flag(削除フラグ)」が「1:削除」の場合は、「delete_date(削除日)」に日付を入力することを必須とする、という場合は下記のように記述します。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
// 追加したオリジナルのバリデーション $validator ->add("delete_flag", "custom",[ "rule"=> function($value, $context){ if($delete_flag === "1" ){ if ( $context["data"]["delete_date"] == "" ) { return false; } } return true; }, "message" => __('削除するときは削除する日付の指定が必要です。') ]); |
CakePHP3の関連記事
CakePHP4のCSS、JavaScript、画像のブラウザへのキャッシュをコントロールするCakePHP3でレコードを保存(追加、更新、Insert、Update)する複数の方法を紹介
CakePHP3でモデルなしフォームからCSVをアップロードしレコードを更新する方法解説
CakePHP3でPHP Simple HTML DOM Parserを使ってスクレイピングする方法
CakePHP3のInsert On Duplicate Key Update(upsert)構文を解説・バルク処理も
CakePHP3の1対多での連携を中間テーブルを使った多対多の連携に変更するときの手順
CakePHP3でデフォルトのソート条件を設定してユーザの選択肢たソート条件を有効にする方法
CakePHP3で Ajaxを使う方法の解説。3.6以降対応。Successとthenの両方を解説。
CakePHP3でパンくずの指定は HTMLヘルパーを使って指定する方法を解説
CakePHP3にOGPをfetch、asignを利用してテンプレートごとに指定する方法を解説
その他の「CakePHP3」に関する記事一覧
GoogleAdwords
GoogleAdwords
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです!
関連記事
-
-
CakePHP3でシェルを作成しコマンドラインから実行・CakePHP2との違い
CakePHP3のシェルスクリプトを作成し、コマンドラインから実行する方法を解説。複数単語をつなげる場合の対応方法がCakePHP2より制限が厳しくなったのでCakePHP3の命名規則の確認が必要だ。
-
-
CakePHP 2.x系 Viewでのコメントの記述方法など
CakePHPにおいて View、ctpファイルでコメントを記述する方法を解説。
-
-
CakePHP4でcontrollerで実行したバリデーションエラーをmodelのにマージする方法
CakePHP4でcontrollerで実行したバリデーションの結果をModelのバリデーション結果に追加するメソッド「setError()」「setErrors()」の使い方の解説。
-
-
CakePHP3のアソシエーション機能を使い関連レコードをまとめて削除
CakePHP3でレコードを削除する際に関連するレコードをまとめて削除する機能の解説。フレームワークのメリットを存分に発揮し、コマンドを1行追加するだけで実装可能。
-
-
CakePHP 2.3でOn Duplicate Key構文を実装
CakePHPで On Duplicate Key構文を Queryを利用して実装する方法をサンプルソース付きで解説します。
-
-
CakePHP4で複数の引数(パラメータ)を付与してコマンドを実行する方法
CakePHP4でコマンドを実行する際に引数(パラメータ)をコマンド内で受け取る処理について解説。複数個の引数にも対応する記述方法も解説。
-
-
CakePHP4の数値項目は「like %10%」の部分一致検索(find select)はできない
CakePHP4でテーブルの数値項目に対してlike句を使用した部分一致検索を実行するとエラーが発生する。クリエービルダーの不具合だと思われ対処方法が分からない。
-
-
CakePHP3でCookieを保存、呼び出し、削除の操作・CakePHP3.7対応
CakePHP3.7でCookieを保存、取り出し、削除する方法を解説。CakePHP3でのCookieの取り扱いはバージョンごとに変更されるため、環境に合わせた方法を探す必要がある。
-
-
CakePHP3にOGPをfetch、asignを利用してテンプレートごとに指定する方法を解説
CakePHP3でOGPを設定する方法を解説。fetch、assignを使用しレイアウトファイルに編集した変数にテンプレートファイルから値を指定する。これを利用してOGPを編集する。
-
-
CakePHP3のアソシエーションでJOINのタイプのLEFT、INNERを切り替えながら使う方法
CakePHP3でテーブルのアソシエーションしたデータの取得をコントローラー側でINNERかLEFTを指定する方法を解説。TableファイルにINNERで指定していてもController側で変更ができる。