CakePHP3で保存前にバリデーション結果を取得する2つの方法

2019/03/17 2019/06/08

CakePHP3で保存前にバリデーション結果を取得する「$topic->errors()」と「$topic->hasErrors()」の 2つの方法

　
CakePHP3で、データベースに値を保存する前にバリデーションの結果を取得し、その結果によって処理を振り分けたい、そんな場合の方法について解説します。
　
　

解説のためのサンプルのテーブル

　
例えば、下記のような「トピックス」のテーブルがあったとします。
　

CREATE TABLE `topics` (
  `id`          int(11)  NOT NULL AUTO_INCREMENT,
  `topics_date` date     NOT NULL,
  `title`       text     NOT NULL,
  `body`        text     NOT NULL,
  `created`     datetime NOT NULL,
  `modified`    datetime NOT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8

CREATE TABLE `topics` (

`id` int(11) NOT NULL AUTO_INCREMENT,

`topics_date` date NOT NULL,

`title` text NOT NULL,

`body` text NOT NULL,

`created` datetime NOT NULL,

`modified` datetime NOT NULL,

PRIMARY KEY (`id`)

) ENGINE=InnoDB DEFAULT CHARSET=utf8

　
　
このテーブルに対して、「bin/cake bake all topics」で bakeして出来上がった「TopicsController.php」の add()アクションが以下になります。
　

public function add()
{
    $topic = $this->Topics->newEntity();
    if ($this->request->is('post')) {
        $topic = $this->Topics->patchEntity($topic, $this->request->getData());
        if ($this->Topics->save($topic)) {
            $this->Flash->success(__('The topic has been saved.'));
            return $this->redirect(['action' => 'index']);
        }
        $this->Flash->error(__('The topic could not be saved. Please, try again.'));
    }
    $this->set(compact('topic'));
}

public function add()

{

$topic = $this->Topics->newEntity();

if ($this->request->is('post')) {

$topic = $this->Topics->patchEntity($topic, $this->request->getData());

if ($this->Topics->save($topic)) {

$this->Flash->success(__('The topic has been saved.'));

return $this->redirect(['action' => 'index']);

}

$this->Flash->error(__('The topic could not be saved. Please, try again.'));

}

$this->set(compact('topic'));

}

　
この処理の中の 5行目の
「$topic = $this->Topics->patchEntity($topic, $this->request->getData());」
の部分で入力された値に対してバリデーションを行っています。
　
その次の
「$this->Topics->save($topic)」
の部分ではデータベースへの保存処理を行っています。
　
　
つまり、保存する前にバリデーションの結果を判定したい場合は「$topic = $this->Topics->patchEntity($topic, $this->request->getData());」の結果を取得している「$topic」の中身を見て判定します。
　
　
中身を取得する方法は、下記の 2つがあります。
　

$topic->errors();
$topic->hasErrors();

`$topic->errors();` で取得する場合

　
「$topic->errors();」では、エラーがある場合はエラーメッセージを取得することができます。
　
例えば、
エラーがある場合は、下記の様にエラーがある項目名とエラーメッセージが取得できます。
Array ( [title] => Array ( [title] => 20文字以下にしてください。 )
　
エラーがない場合は、下記の様に空の配列になります。
Array ( )
　
　

`$topic->hasErrors();` で取得する場合

　
「$topic->hasErrors();」では、エラーの有無だけを取得することができます。
　
例えば
エラーがある場合は、「1（true）」
エラーがない場合は、「null」
を取得することができます。
　
　

バリデーションの判定を行う方法

　
以上のことから、バリデーションの結果の有無だけをチェックして処理を行うのであれば、いずれの場合も同じような記述方法でチェックをすることができます。
　

// $topic->errors() を使う場合
if ( $topic->errors() ) {
	// エラーのときの処理
} else {
	// 正常のときの処理
}

// $topic->hasErrors() を使う場合
if ( $topic->hasErrors() ) {
	// エラーのときの処理
} else {
	// 正常のときの処理
}

// $topic->errors() を使う場合

if ( $topic->errors() ) {

// エラーのときの処理

} else {

// 正常のときの処理

}

// $topic->hasErrors() を使う場合

if ( $topic->hasErrors() ) {

// エラーのときの処理

} else {

// 正常のときの処理

}

テーブルに値を保存する前にバリデーションを行うサンプルプログラム

　
最初に掲示した add()アクションに追記したものが下記になります。
わざわざ書くほどのものでもないですが．．．
　

public function add()
{
    $topic = $this->Topics->newEntity();
    if ($this->request->is('post')) {
        $topic = $this->Topics->patchEntity($topic, $this->request->getData());

        if ( $topic->hasErrors() ) {
            // エラーのときの処理
        } else {
            // 正常のときの処理
        }

        if ($this->Topics->save($topic)) {
            $this->Flash->success(__('The topic has been saved.'));
            return $this->redirect(['action' => 'index']);
        }
        $this->Flash->error(__('The topic could not be saved. Please, try again.'));
    }
    $this->set(compact('topic'));
}

public function add()

{

$topic = $this->Topics->newEntity();

if ($this->request->is('post')) {

$topic = $this->Topics->patchEntity($topic, $this->request->getData());

if ( $topic->hasErrors() ) {

// エラーのときの処理

} else {

// 正常のときの処理

}

if ($this->Topics->save($topic)) {

$this->Flash->success(__('The topic has been saved.'));

return $this->redirect(['action' => 'index']);

}

$this->Flash->error(__('The topic could not be saved. Please, try again.'));

}

$this->set(compact('topic'));

}

　
　
ほぼ同じ内容の記事ですが、自分で過去に書いた記事を見つけることができずにまた書いてしまっていました。
以前書いた記事は、下記にあります。
「newEntity()」でも「patchEntity()」でもバリデーションは行われている、という内容ですね。
CakePHP3で値を入力直後にバリデーションする方法解説
　
　
また、今回の記事では、バリデーションを実行した結果を取得する方法でしたが、データベースに保存する際のエラーを「try ＋ catch 構文」で取得する方法については下記に記事を書いていますので参考にしてください。
CakePHP3でデータを保存する save()で発生するエラーを確認する方法を解説
　
　

- CakePHP 3.x 4.x 5.x CakePHP3

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

Message コメントをキャンセル

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

: CakePHP4系、CakePHP5系のexists()でカラムを指定して値の有無をチェックする方法解説

CakePHP4、5で指定したカラムに特定の値に該当のレコードの有無をチェックするにはexists()を使う。単純にカラムを指定する方法から複数条件をand、orで探すこともできる。

: CakePHP3で静的ページの作成は webrootか pagesを使う。トップページを参考に解説

CakePHP3で静的なページを設置する場合の方法（webrootとpagesとを活用する方法）を解説。pagesの解説はデフォルトのトップページがどう表示されているかを参考に解説。ルーティングの機能も。

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

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

: CakePHP3で /Layout/defult.ctpにある titleタグ、h1タグを編集する方法

CakePHP3でtitleタグ、h1タグのテキストをデフォルトから変更する方法を解説。テンプレートファイルに「$this->assign()」でテキストを指定して「/Layout/defult.ctp」で受け取る。

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

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

: MySQL＋CakePHPのdate型、datetime型項目は「2999-12-31」までしか扱えない

CakePHPの日付、日時の型であるdate型、datetime型の最大値は2999-12-31となっている。MySQLは9999年までなので違いがあるので注意が必要だ。

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

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

: CakePHP4で定数の設定と呼び出し方法の解説（defineとConfigure）

CakePHP4で定数を設定、使用する方法を解説。定数定義はdefineとConfigureを使用する方法を解説。また、bootstrap.phpに直接記述する方法と別のファイルにする方法を解説。

: CakePHP3のInsert On Duplicate Key Update（upsert）構文を解説・バルク処理も

CakePHP3で Insert … On Duplicate Key Update構文（upsert）を実行する方法を解説。バルク処理の方法も用意されているため大量処理の場合も対応可能。