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 コメントをキャンセル

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

: CakePHP 2.3　連携先のテーブルの項目で条件抽出する場合

アソシエーション（連携）している先のテーブルの項目で条件抽出する際の考え方と注意点をサンプルソースを用いて説明しています。

: getParam('action')で取得するアクション名は別関数に移動しても不変

CakePHP4系、5系では「getParam()」で処理中のアクション名を取得できる。そのアクションから別関数を呼び出してた関数でアクション名を調べたが同一の名称だった。

: CakePHP 2.x系　Viewでのコメントの記述方法など

CakePHPにおいて View、ctpファイルでコメントを記述する方法を解説。

: CakePHP4で公開側と管理側のデザインテンプレートを分ける方法・setLayout()

CakePHP4でデフォルトのレイアウトファイル「default.php」は管理側に使用し、これとは別のデザインを公開側のページに設定したい、を実装する方法を解説。

: CakePHPで同一テーブル内の値を比較する条件でレコードを取得する方法

CakePHPの同一テーブルにある項目の値を比較し条件に合致するレコードを取得する方法を解説。［”項目名”=>”値”]ではなく[”項目名 = 項目名”］と書くところがポイント。

: CakePHP3にWYSIWYGエディタのCKEditor4を設置、カスタマイズ方法を解説

WYSIWYGエディタであるCKEditor4をCDNを利用して簡単にCakePHP3に導入する方法とカスタマイズする方法を解説。CakePHP3にはページごとの振り分けを行うブロック化を利用する。

: CakePHP3でDocumentRootやwebroot、imgフォルダのURLやドメイン、パスを取得

URLやドメイン、フォルダへのパスの取得は、ビューではUrlHelperを使い、コントローラーではRouterクラスを使います。第2引数の指定でURLを取得することも可能。

: CakePHP3チュートリアルで日付と時刻のDateTimeでエラーが出たときの対処方法

CakePHP3のブックマークチュートリアルには記載ミスもあり、そのまま動かない個所もある。CakePHP3では namespaceを使うようになったので、classを呼び出すときに￥を追加する必要が！

: CakePHP4のCakeDC/Usersの Usersへの接続、バリデーションのカスタマイズ方法解説

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