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
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです!
関連記事
-
CakePHP 2.3 Search Pluginで検索処理 その1設置方法
CakePHPの検索プラグイン Search Pluginの設置方法と基本的な検索処理の解説です。
-
CakePHP3でQRコードを作成、表示するライブラリ「cakePHP-QR-Code-Helper」
CakePHPでQRコードを生成するライブラリ「cakePHP-QR-Code-Helper」の紹介。GDライブラリのインストールも必要ないHelperとして提供されているため、ファイルを設置すればすぐに使用可能。
-
CakePHP3で他のテーブルのマスタテーブルからセレクトボックス(プルダウンリスト)を作る
他のテーブルのマスタのレコードからプルダウンリストを作成し、選択できるようにするサンプルプログラムと解説。ORMの設定によりデータベースの値を取得し、配列を作成し optionsに与える。
-
CakePHP 2.3 連携先のテーブルの項目で条件抽出する場合
アソシエーション(連携)している先のテーブルの項目で条件抽出する際の考え方と注意点をサンプルソースを用いて説明しています。
-
CakePHP3のCakeDC/Usersのバリデーションのカスタマイズ方法解説
CakeDC謹製Usersプラグインの紹介。Usersのカスタマイズとして入力項目のバリデーションの変更を、プラグインのファイルは触らずオーバーライドにより実装する方法を解説する。
-
CakePHP3でパンくずの指定は HTMLヘルパーを使って指定する方法を解説
CakePHP3でパンくずの指定方法の解説。2つのヘルパーがあるが簡単なHTMLヘルパーを使った方法を、実際の状況に合わせて3つのパターン(エレメント化、ブロック化)にして解説。
-
CakePHP3で保存前にバリデーション結果を取得する2つの方法
CakePHP3でデータベースに値を保存する前にバリデーションを行い、その結果によって処理を振り分ける方法について解説。「$topic->errors()」と「$topic->hasErrors()」の2つの方法がある。
-
CakePHP3のビューで受取ったテーブルのオブジェクトを連想配列に変換する方法
コントローラーからビューに送ったテーブルのオブジェクトを連想配列に変換し、ビューの中で自由に使えるようにするメソッド「toArray()」の解説。連想配列に変換できれば利用度アップ!
-
CakePHP3の画像、ファイルアップロードプラグインUpload Plugin 3.0の設置解説・その1
CakePHP3でファイル、画像をアップロードするプラグイン、upload plugin 3を導入する手順を解説した記事。3部作のその1で基本的な導入方法の解説で読みながら簡単に導入が可能。
-
CakePHP3でデータを保存する save()で発生するエラーを確認する方法を解説
CakePHP3でデータ保存処理のログを取得する方法。save()では true、falseの戻り値しか取得できないが、saveOrFail()と try…catch文を使いエラーログ、エンティティを取得し、不具合の解析を行う。