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でPHPExcelを使ってエクセルファイルを生成、出力する方法
CakePHP3でPHPExcelを利用してエクセルを編集、出力するサンプルソース+解説。PHPExcelのインストール方法の解説からファイル保存とダウンロードの方法なども解説。
-
-
CakePHP4のメッセージ日本語化の設定(国際化と地域化の機能の使い方の解説)
CakePHP4の英語のメッセージを日本語化(多言語化)する手順を解説。オリジナルのメッセージを作成する方法やプログラムで文言を追加する場合の対応なども解説。
-
-
CakePHP4のCakeDC/Usersの画面、メール本文テンプレートのカスタマイズ方法解説
CakeDC謹製Usersプラグインの紹介。ユーザ新規登録の流れを紹介しつつ、テンプレートファイル、設定情報ファイルの場所とそれらをカスタマイズする方法を説明します。
-
-
CakePHP 2.3 bakeの超初心者向けフォロー講座
CakePHP 2.3 bakeの超初心者向けフォロー講座
-
-
CakePHP2の検索Plugin CakeDC/Searchで重複を省くgroup by(distinct)の実装方法
CakePHP2の検索プラグイン「CakeDC/Search」で、重複レコードを省くgroup by、distinctを使う方法についての解説。設定する場所はpaginatorの条件とするので、find()関数と同じ。
-
-
CakePHP 2.3でOn Duplicate Key構文を実装
CakePHPで On Duplicate Key構文を Queryを利用して実装する方法をサンプルソース付きで解説します。
-
-
CakePHP3のOGPはHTMLヘルパーの$this->Html->meta()を使って設定
CakePHP3でOGPを設定する方法を解説。metaタグを編集するHTMLヘルパーを利用してOGPのタグを編集する。また、エレメントとして分割することでメンテナンス性も向上させる。
-
-
CakePHP4で「app_local.php」「.env」を利用して環境ごとの定数を振り分ける方法
CakePHP4で.env、app_local.phpに定数を定義してそれを呼び出す方法の解説。Gitでは管理せず本番環境と開発環境とで異なる定数を定義するためそれを利用する方法。
-
-
CakePHP 2.3 Search Pluginで検索処理 その4前方一致検索、後方一致検索、不等号による検索、between句による範囲検索
CakePHPの検索プラグイン Search Pluginの検索処理の中で前方一致検索、後方一致検索、不等号による検索、between句による範囲検索の解説です。
-
-
CakePHP3にWYSIWYGエディタのCKEditor4を設置、カスタマイズ方法を解説
WYSIWYGエディタであるCKEditor4をCDNを利用して簡単にCakePHP3に導入する方法とカスタマイズする方法を解説。CakePHP3にはページごとの振り分けを行うブロック化を利用する。