CakePHPのバリデーションを入力値・項目の条件によって変える方法を解説
CakePHPで入力値によってバリデーションを切り替える
CakePHP 2でバリデーションを条件によって切り替える方法
入力フォームから入力された項目によって、バリデーション(入力チェック)の内容を変えたい、という場面があると思いますが、その方法を CakePHPで実装する方法を解説します。
対象バージョン:CakePHP2系(CakePHP 2.2以上)
参考サイト
https://book.cakephp.org/2.0/ja/models/data-validation.html#id11
条件によってバリデーションの内容を変える具体的な例
想定している具体的なイメージは下記のような感じです。
「連絡手段を選択し、選択した連絡手段の連絡先の情報を入力してください。」
上記の入力フォームで、「連絡手段」の選んだ選択肢によって、「連絡先情報」の入力内容が変わるため、それに合わせて「連絡先情報」のバリデーションの内容を変更する必要があります。
「連絡手段:電話」 の場合は、電話番号チェック
「連絡手段:メール」の場合は、メールアドレスチェック
「連絡手段:郵送」 の場合は、郵便番号チェック
「連絡手段:その他」の場合は、必須チェックのみ
CakePHPで unsetを利用して入力値を条件としてバリデーションを切り替える具体的なソースコードと解説
バリデーションを切り替える処理の実装手順
実装の手順としては以下の通りです。
1.Modelに、必要なバリデーションを記述します。
2.Controllerに、条件よって使わないバリデーションを削除する処理を記述します。
1.Modelに、必要なバリデーションを記述
では、具体的なソースコードを確認していきます。
まず、Modelに記述するバリデーションの内容です。
コメントを書いていますが、必須チェックのほか、電話番号、メールアドレス、郵便番号の入力チェックを行うバリデーションを記述しています。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
public $validate = array( 'contact_number' => array( // 必須チェック 'notEmpty' => array( 'rule' => 'notEmpty', 'allowEmpty' => false, 'message' => 'アカウントIDが入力されていません' ), // 電話番号のチェック 'telCheck' => array( 'rule' => '/^\d{10,11}$/', 'allowEmpty' => false, 'message' => '電話番号はハイフンなしで入力してください' ), // メールアドレスのチェック 'mailCheck' => array( 'rule' => 'email', 'allowEmpty' => false, 'message' => 'メールアドレスを入力してください' ), // 郵便番号のチェック 'zipCheck' => array( 'rule' => '/^\d{3}-\d{4}$/', 'allowEmpty' => false, 'message' => '3桁 - 4桁の形式で入力してください' ), ), ); |
上記の「rule」では、
「/^\d{10,11}$/
」(10桁~11桁の数値)
「/^\d{3}-\d{4}$/
」(3桁の数値 + 「-」 + 4桁の数値)
のように、正規表現を使って入力条件を指定しています。
2.Controllerに、条件よって使わないバリデーションを削除する処理を記述
続いて、1で設定したバリデーションを、条件によって使わない処理を記述していきます。
入力された「連絡手段」を「$this->request->data['Contact']['method']
」で取得し、電話の場合、メールの場合、電話の場合と振り分け、必要ないバリデーションを「unset」コマンドで削除していきます。
その結果、必要なバリデーションだけが残り、その処理が実行される、という仕組みになっています。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 |
public function add() { if ($this->request->is('post') || $this->request->is('put')) { // 電話が選択された場合 if ( $this->request->data['Contact']['method'] == "1" ) { unset ( $this->Contact->validate["contact_number"]["telCheck"] ); unset ( $this->Contact->validate["contact_number"]["mailCheck"] ); unset ( $this->Contact->validate["contact_number"]["zipCheck"] ); // メールが選択された場合 } elseif ( $this->request->data['Contact']['method'] == "2" ) { unset ( $this->Contact->validate["contact_number"]["telCheck"] ); unset ( $this->Contact->validate["contact_number"]["mailCheck"] ); unset ( $this->Contact->validate["contact_number"]["zipCheck"] ); // 郵送が選択された場合 } elseif ( $this->request->data['Contact']['method'] == "3" ) { unset ( $this->Contact->validate["contact_number"]["telCheck"] ); unset ( $this->Contact->validate["contact_number"]["mailCheck"] ); unset ( $this->Contact->validate["contact_number"]["zipCheck"] ); // その他が選択された場合 } else { unset ( $this->Contact->validate["contact_number"]["telCheck"] ); unset ( $this->Contact->validate["contact_number"]["mailCheck"] ); unset ( $this->Contact->validate["contact_number"]["zipCheck"] ); } // エラーがない場合は正常処理 if ( $this->Contact->validates() ) { if ($this->Contact->save($this->request->data)) { $this->Session->setFlash(__('The contact has been saved')); $this->redirect(array('action' => 'index')); } else { $this->Session->setFlash(__('The contact could not be saved. Please, try again.')); } } } $this->set(compact('contacts')); } |
ちなみに、この「unset」は CakePHP 2.2で追加されたため、CakePHP 2系でも 2.2より前のものではこの方法は使えません。
CakePHPで条件によってバリデーションを振り分ける処理のまとめ
入力条件によってバリデーションを振り分ける処理として、今回は「unset」関数を使ってすでにあるバリデーションを削除していく、という処理で条件に合致するバリデーションを指定する方法を紹介しました。
これ以外にも方法はあるようですが、この方法は理解しやすく、実装しやすい方法だと感じます。
GoogleAdwords
GoogleAdwords
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです!
関連記事
-
-
CakePHP4で公開側と管理側のデザインテンプレートを分ける方法・setLayout()
CakePHP4でデフォルトのレイアウトファイル「default.php」は管理側に使用し、これとは別のデザインを公開側のページに設定したい、を実装する方法を解説。
-
-
CakePHP3のfriendsofcake/searchでツリーカテゴリーの子階層も含めて検索する方法
CakePHP3のツリービヘイビアを使ったツリーカテゴリーの子階層も含めての検索を検索プラグイン「friendsofcake/search」を使って実現する方法を解説しました。
-
-
CakePHP3でPHP Simple HTML DOM Parserを使ってスクレイピングする方法
CakePHP3でPHP Simple HTML DOM Parserを使ってスクレイピングをする方法を解説。インストール方法、読み込み方法。および、具体的なスクレイピングを実行するサンプルソースも。
-
-
CakePHP3でテーブルにカラム(項目)を追加したときに変更するポイントのまとめ
CakePHP3でシステム開発をする際、途中でカラムを追加した場合に何を変更すればいいかを確認。カラムを追加する前後で Bakeした結果を比較し、変更になった点をリストアップした。
-
-
CakePHP3でComposerでインストールできないプラグイン、外部ライブラリを vendorに入れて手動で読み込む方法
CakePHP3にComposerからインストールできないプラグインやライブラリなどを利用する方法、vendorにファイルを設置し、composer.jsonを更新し、それを呼び出す方法を詳細に解説。
-
-
CakePHP4系でJSONレスポンスの処理ではwithStringBodyを使う。3との違い解説
responseの値を指定する方法は3系では「body」だが、4系では「withStringBody」になりる。加えてJSON形式なら「withType」で指定するなど4系では結構異なる処理がある。
-
-
CakePHP3のメッセージ日本語化の設定(国際化と地域化の機能の使い方の解説)
CakePHP3の英語のメッセージを日本語化(多言語化)する手順を解説。オリジナルのメッセージを作成する方法やプログラムで文言を追加する場合の対応なども解説。
-
-
CakePHP2の検索Plugin CakeDC/Searchで重複を省くgroup by(distinct)の実装方法
CakePHP2の検索プラグイン「CakeDC/Search」で、重複レコードを省くgroup by、distinctを使う方法についての解説。設定する場所はpaginatorの条件とするので、find()関数と同じ。
-
-
CakePHP3のビューで受取ったテーブルのオブジェクトを連想配列に変換する方法
コントローラーからビューに送ったテーブルのオブジェクトを連想配列に変換し、ビューの中で自由に使えるようにするメソッド「toArray()」の解説。連想配列に変換できれば利用度アップ!
-
-
CakePHP3のCakeDC/Usersでログインユーザの所有レコードのみ更新、削除する権限管理の設定方法
CakePHP3のユーザ管理、ログイン認証プラグイン「CakeDC/Users」の権限管理を行う方法やアクセスできるコントローラー、アクションを設定、所有権を持つレコードのみ更新できる設定方法を解説。