CakePHPのバリデーションを入力値・項目の条件によって変える方法を解説

2018/04/28

CakePHPで入力値によってバリデーションを切り替える

CakePHP 2でバリデーションを条件によって切り替える方法

　
入力フォームから入力された項目によって、バリデーション（入力チェック）の内容を変えたい、という場面があると思いますが、その方法を CakePHPで実装する方法を解説します。
　
対象バージョン：CakePHP2系（CakePHP 2.2以上）
　
参考サイト
https://book.cakephp.org/2.0/ja/models/data-validation.html#id11
　
　

条件によってバリデーションの内容を変える具体的な例

　
想定している具体的なイメージは下記のような感じです。
　
「連絡手段を選択し、選択した連絡手段の連絡先の情報を入力してください。」
　

　
上記の入力フォームで、「連絡手段」の選んだ選択肢によって、「連絡先情報」の入力内容が変わるため、それに合わせて「連絡先情報」のバリデーションの内容を変更する必要があります。
　
　「連絡手段：電話」　の場合は、電話番号チェック
　「連絡手段：メール」の場合は、メールアドレスチェック
　「連絡手段：郵送」　の場合は、郵便番号チェック
　「連絡手段：その他」の場合は、必須チェックのみ
　
　

CakePHPで unsetを利用して入力値を条件としてバリデーションを切り替える具体的なソースコードと解説

バリデーションを切り替える処理の実装手順

　
実装の手順としては以下の通りです。
　
１．Modelに、必要なバリデーションを記述します。
２．Controllerに、条件よって使わないバリデーションを削除する処理を記述します。
　
　

１．Modelに、必要なバリデーションを記述

　
では、具体的なソースコードを確認していきます。
　
まず、Modelに記述するバリデーションの内容です。
コメントを書いていますが、必須チェックのほか、電話番号、メールアドレス、郵便番号の入力チェックを行うバリデーションを記述しています。
　

  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桁の形式で入力してください'
      ),
    ),
  );

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桁の数値）
のように、正規表現を使って入力条件を指定しています。
　
　

２．Controllerに、条件よって使わないバリデーションを削除する処理を記述

　
続いて、１で設定したバリデーションを、条件によって使わない処理を記述していきます。
　
入力された「連絡手段」を「$this->request->data['Contact']['method']」で取得し、電話の場合、メールの場合、電話の場合と振り分け、必要ないバリデーションを「unset」コマンドで削除していきます。
　
その結果、必要なバリデーションだけが残り、その処理が実行される、という仕組みになっています。
　

  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'));
  }

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」関数を使ってすでにあるバリデーションを削除していく、という処理で条件に合致するバリデーションを指定する方法を紹介しました。
　
これ以外にも方法はあるようですが、この方法は理解しやすく、実装しやすい方法だと感じます。

- CakePHP 3.x 4.x 5.x

最後までお読みいただきましてありがとうございます。
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです！

Message コメントをキャンセル

※入力いただいたコメントは管理者の承認後に掲載されます。

: CakePHP4のCSS、JavaScript、画像のブラウザへのキャッシュをコントロールする

CakePHP4、CakePHP3でブラウザにキャッシュさせる設定の解説。CSS、JavaScript、画像をブラウザにキャッシュさせるのか、定期的にリロードする設定にするのかの設定が可能。

: CakePHP3にデイトピッカー jQuery UI DatePickerを実装する手順の解説

CakePHP3にjQuery UIのDatePickerを実装する手順を説明。併せて、デイトピッカーを設置に関連するCakePHP3の解説と、テーマを変更したり、表記を変更するカスタマイズする方法なども紹介。

: CakePHP3のルーティング（routes.php）の変更が反映されない時はキャッシュのクリアを

CakePHP3でルーティングの設定変更をしたけど反映されない！そんなときは慌てず騒がずキャッシュをクリアしよう！ルーティングの設定もキャッシュされることがあるらしい。

: CakePHP3で生の SQLの実行はConnectionManagerを使う

CakePHP3で生の SQL文を実行する方法を解説。クリエビルダーを使う場合は TableRegistryを利用するが、SQLを実行する場合は ConnectionManagerを使う。プリペアードステートメントの使用方法も解説。

: CakePHP4の規約外のカラムをキーにアソシエーション（テーブル連結）する方法

CakePHPで規定外のカラム名のキーを指定してアソシエーション（テーブル連結）をする方法を解説。アソシエーション名によってはミスが発生しやすい点もあるので注意も必要。

: CakePHP3のCakeDC/Usersのバリデーションのカスタマイズ方法解説

CakeDC謹製Usersプラグインの紹介。Usersのカスタマイズとして入力項目のバリデーションの変更を、プラグインのファイルは触らずオーバーライドにより実装する方法を解説する。

: CakePHP3にデザインテンプレートBootstrapを導入する方法・friendsofcake/bootstrap-ui使用

CakePHP3にプラグイン「friendsofcake/bootstrap-ui」、デザインテンプレート「Bootstrap」を設置する手順を解説。Bootstrapの簡単な使い方やデフォルトのデザインとの混在方法なども解説。

: CakePHP4 でコマンドプログラム（シェルプログラム）を作成する方法解説

CakePHP4でバッチ処理を行うためのコマンド・シェルの実装方法について解説。bakeでテンプレートファイルを作成し、「execute()」に処理を記述する方法を解説。

: CakePHP3のOGPはHTMLヘルパーの$this->Html->meta()を使って設定

CakePHP3でOGPを設定する方法を解説。metaタグを編集するHTMLヘルパーを利用してOGPのタグを編集する。また、エレメントとして分割することでメンテナンス性も向上させる。

: CakePHP3のCakeDC/UsersのUserHelperでログアウトやreCAPTCHAをカスタマイズ

CakeDC謹製Usersプラグインの紹介。UserHelperを利用し、ログアウトのリンクや権限があるときのみ表示されるリンク、プロフィールページへのリンク、reCAPTCHAの設置方法などを解説。