バリデーションエラーメッセージの取得

CakePHP 2.xになってバリデーションエラー時に返却されるメッセージのデータ形式が変更になったようです。1.3系では、ひとつのフィールドに対して返却されるメッセージは一つのルールのみですが、2.xではエラーとなったルールのメッセージが配列になって返されます。

複数ルールを設定して、全てのルールを実行する方法(2.x系・1.3系共通)

バリデーションはモデルの$validateに設定した各ルールを上から行っていきます。デフォルトでは、ひとつのルールがエラーとなるとそのフィールドに対するバリデーションを停止しますが、'last'=>falseを設定するとエラー有無にかかわらず後続のバリデーションルールも実行するようになります。3つある場合は、1つ目・2つ目に設定するようなかたちになります。

// 例
var $validate = array(
    'errormsgtest' => array(
        'email' => array(
            'rule' => array( 'email'),
            'message' => 'Not email!',
            'last' => false
        ),
        'notempty' => array(
            'rule' => array( 'notEmpty'),
            'message' => 'Empty!',
        ),
    ),
);

validationErrorsとvalidateErrors

バリデーション処理後、エラーがあった場合、

$this->[Model名]->validationErrors

を使用してエラーメッセージを取得することができます。

似たようなもので

$this->validateErrors

がありますがコレ自体でバリデーション処理を行います。二重にvalidatesしないよう"validationErrors"の方を使うようにして下さい。

エラーメッセージの内容(1.3系では)

最後にエラーとなったバリデーションのメッセージを返します。上の例でいうと、入力値('errormsgtest')がブランクの場合、

• デフォルトの状態('last'がtrue)では、ルール名'email'でバリデーションを終了させるため、Not email!'
• 'last'をfalseに設定した場合は、ルール'email'がエラーとなっても最後('notempty')までバリデーションを実行するため、'Empty!'

が返却されます。

// ログに出力
$this->log( $this->[Model名]->validationErrors, LOG_DEBUG);
// viewに渡す
$this->set( 'valerror', $this->[Model名]->validationErrors);
// セッションに渡す
$this->Session->setFlash( $this->[Model名]->validationErrors);

// ログ出力例
// 'last' => trueの場合
Array
(
    [errormsgtest] => Not email!
)
// 'last' => falseの場合
Array
(
    [errormsgtest] => Empty!
)

エラーメッセージの内容(2.x系では)

やっと本題。配列で返します。
'errormsgtest'がブランクだった場合は、

• デフォルトの状態('last'がtrue)では、ルール名'email'でバリデーションを終了させるため、'Not email!'のみ
• 'last'をfalseに設定した場合は、ルール'email'がエラーとなっても最後('notempty')までバリデーションを実行するため、'Not email!'と'Empty!'

が返却されます。

// ログに出力
$this->log( $this->[Model名]->validationErrors, LOG_DEBUG);
// viewに渡す
$this->set( 'valerror', $this->[Model名]->validationErrors);
// セッションに渡す
$this->Session->setFlash( $this->[Model名]->validationErrors);

// ログ出力例
// 'last' => trueの場合
Array
(
    [errormsgtest] => Array
        (
            [0] => Not email!
        )
)
// 'last' => falseの場合
Array
(
    [errormsgtest] => Array
        (
            [0] => Not email!
            [1] => Empty!
        )
)

今回は、バリデーションエラーメッセージのデータの取り扱いについてでした。
基本的には、'last'=>falseを多用するより、エラーメッセージの伝え方でユーザに入力をうまいことやってもらうのが一番いいですよね～。
上の例でいうと、どちらもEnter email!としておけばいいですし。

Related

ビルトインされたバリデーションルール (メール・URL・電話・郵便・IP) データ バリデーション コントローラ内でバリデーション処理を呼び出す ログインに追加の条件を付与する「scope」 日付・時間のバリデーション 独自のバリデーションルールを作成 コントローラ内でバリデーション処理を呼び出す SQLクエリーをログに出力する