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 CakePHP3

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

Message コメントをキャンセル

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

: CakePHPで Auto Incrementを外すと Duplicate entry ‘0’ for keyのエラーが出るかも

CakePHPでAuto Incrementの設定を変更したときに「Duplicate entry ‘0’ for key」のエラーが出た。原因はModel内で IDを編集する処理の追加を忘れていたからだった。

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

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

: CakePHP3にOGPをfetch、asignを利用してテンプレートごとに指定する方法を解説

CakePHP3でOGPを設定する方法を解説。fetch、assignを使用しレイアウトファイルに編集した変数にテンプレートファイルから値を指定する。これを利用してOGPを編集する。

: CakePHP3で他のテーブルのマスタテーブルからセレクトボックス（プルダウンリスト）を作る

他のテーブルのマスタのレコードからプルダウンリストを作成し、選択できるようにするサンプルプログラムと解説。ORMの設定によりデータベースの値を取得し、配列を作成し optionsに与える。

: CakePHP4のCakeDC/Usersのログイン時のリダイレクトとユーザ権限管理の設定解説

CakeDC謹製UsersプラグインのCakePHP4版の紹介。ログイン認証後にリダイレクトする先の設定方法についての解説と実運用するために必要なコツを解説。便利な仕組みも仕様の理解があって初めてうまく使いこなせる。

: CakePHP 2.3　Search Pluginで検索処理　その１設置方法

CakePHPの検索プラグイン Search Pluginの設置方法と基本的な検索処理の解説です。

: CakePHP3でレコードを保存（追加、更新、Insert、Update）する複数の方法を紹介

CakePHP3でレコードを追加、更新（Insert、Update）する記述方法を解説。1件ずつ処理、全件をまとめて処理、条件に該当する複数件のレコードを処理方法をサンプルコードを用いて解説。

: CakePHP3でWarning Error: SplFileInfo::openFile()エラーが発生した場合の対処方法

CakePHP3のキャッシュファイルのパーミッションエラー Error: SplFileInfo::openFile()が発生した場合の対応方法解説。app.phpにキャッシュファイルのパーミッション設定を行い、既存のファイルは削除。