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
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです!
関連記事
-
CakePHP3で /Layout/defult.ctpにある titleタグ、h1タグを編集する方法
CakePHP3でtitleタグ、h1タグのテキストをデフォルトから変更する方法を解説。テンプレートファイルに「$this->assign()」でテキストを指定して「/Layout/defult.ctp」で受け取る。
-
CakePHP4のCakeDC/Usersのログイン時のリダイレクトとユーザ権限管理の設定解説
CakeDC謹製UsersプラグインのCakePHP4版の紹介。ログイン認証後にリダイレクトする先の設定方法についての解説と実運用するために必要なコツを解説。便利な仕組みも仕様の理解があって初めてうまく使いこなせる。
-
CakePHP 2.3 ID以外のカラムでアソシエーション(連携)をさせる場合の詳細ページの注意点
ID以外のカラムでアソシエーション(連携)させて詳細ページを表示させる際の考え方と注意点をサンプルソースを用いて解説しています。
-
CakePHP3のアソシエーションでJOINのタイプのLEFT、INNERを切り替えながら使う方法
CakePHP3でテーブルのアソシエーションしたデータの取得をコントローラー側でINNERかLEFTを指定する方法を解説。TableファイルにINNERで指定していてもController側で変更ができる。
-
CakePHP3でレコードを保存(追加、更新、Insert、Update)する複数の方法を紹介
CakePHP3でレコードを追加、更新(Insert、Update)する記述方法を解説。1件ずつ処理、全件をまとめて処理、条件に該当する複数件のレコードを処理方法をサンプルコードを用いて解説。
-
国際化と地域化の翻訳機能「__()」を使って定数に変数を埋め込む方法
CakePHP4で定数に変数を埋め込み、翻訳機能「__()」で変数に値を入れる方法を紹介。定型の文章の一部だけを置換したい場合に利用すると便利。
-
CakePHP 2.3 主キー(ID)以外のキーで更新方法 updateAll
主キー(ID)以外のカラムをキーとして更新する方法、updateAllの使い方をサンプルを用いて解説します。
-
CakePHP3で値を入力直後にバリデーションする方法解説
CakePHP3でバリデーションの実行を保存する時から入力情報を受け取るときに変更する処理の解説。CakePHP3ではnewEntity()の処理でバリデートするため1行追加で対応可能。
-
CakePHP3でDocumentRootやtmp、webroot、logsなどのフォルダへのパスの定数
CakePHP3で特定フォルダのパスの定数を解説。root、DocumentRoot、app、config、webroot、tests、tmp、cache、vendor、コア、コアの srcが設定済み。realpath()関数を使うと柔軟なパス指定が可能。
-
CakePHP3のfriendsofcake/searchでブックマークチュートリアルのタグ検索を実装
CakePHP3のCookbookにあるブックマークチュートリアル。ここで紹介されているタグで検索する処理を検索プラグイン「friendsofcake/search」で実現する方法を解説しました。