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

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

: Google Analytics APIを CakePHP3で動かしてレポートデータを取得する方法の解説

CakePHP3で Google Analytics APIからレポートデータを取得する処理の解説。PHPのサンプルソースをCakePHP3で動くように改造。加えて、ディメンションやメトリックスを条件に設定する方法なども。

: CakePHPを学ぶ際にはオブジェクト指向を学ぼう

CakePHPはオブジェクト指向で書かれていますので、CakePHPを学ぶにはオブジェクト指向も学びましょう。

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

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

: CakePHP 2.3 コマンドラインからPHPのシェル実行の方法解説

CakePHP 2.3でコマンドラインから CakePHPで記述した処理を実行する方法を解説します。

: CakePHP3でパンくずの指定は HTMLヘルパーを使って指定する方法を解説

CakePHP3でパンくずの指定方法の解説。2つのヘルパーがあるが簡単なHTMLヘルパーを使った方法を、実際の状況に合わせて3つのパターン（エレメント化、ブロック化）にして解説。

: CakePHP3のメール送信の処理・テンプレート使用・添付ファイル送信も解説

CakePHP3からメールを送信する方法解説。基本的な記述方法を基にして、テンプレートを使う方法、ファイルを添付する方法へと拡張しながら解説。

: CakePHP 2.3 主キー（ID）以外のキーで更新方法 updateAll

主キー（ID）以外のカラムをキーとして更新する方法、updateAllの使い方をサンプルを用いて解説します。

: CakePHP3でデータを保存する save()で発生するエラーを確認する方法を解説

CakePHP3でデータ保存処理のログを取得する方法。save()では true、falseの戻り値しか取得できないが、saveOrFail()と try…catch文を使いエラーログ、エンティティを取得し、不具合の解析を行う。

: CakePHP3の検索プラグイン「friendsofcake/search」の設置方法・CakePHP3.6対応

CakePHP3で検索を担うプラグイン「friendsofcake/search」の紹介。基本的な設置方法の紹介のほか、処理の記述方法のバリエーション、エラーの解説など。CakeDC/searchより導入は簡単！

: CakePHP2の検索Plugin CakeDC/Searchで重複を省くgroup by（distinct）の実装方法

CakePHP2の検索プラグイン「CakeDC/Search」で、重複レコードを省くgroup by、distinctを使う方法についての解説。設定する場所はpaginatorの条件とするので、find()関数と同じ。

PREV: XSERVERにCakePHP3をインストール。コマンドラインのPHPのバージョンを変更する方法で解決
NEXT: URL短縮サービス「TTTオンライン（https://ttt.onl）」公開

日	月	火	水	木	金	土
1	2	3	4	5	6	7
8	9	10	11	12	13	14
15	16	17	18	19	20	21
22	23	24	25	26	27	28
29	30	31

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

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

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

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

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

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

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

CakePHP3の関連記事

GoogleAdwords

GoogleAdwords

Message コメントをキャンセル

関連記事

Google Analytics APIを CakePHP3で動かしてレポートデータを取得する方法の解説

CakePHPを学ぶ際にはオブジェクト指向を学ぼう

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

CakePHP 2.3 コマンドラインからPHPのシェル実行の方法解説

CakePHP3でパンくずの指定は HTMLヘルパーを使って指定する方法を解説

CakePHP3のメール送信の処理・テンプレート使用・添付ファイル送信も解説

CakePHP 2.3 主キー（ID）以外のキーで更新方法 updateAll

CakePHP3でデータを保存する save()で発生するエラーを確認する方法を解説

CakePHP3の検索プラグイン「friendsofcake/search」の設置方法・CakePHP3.6対応

CakePHP2の検索Plugin CakeDC/Searchで重複を省くgroup by（distinct）の実装方法

WordPress投稿にPHPを記述するショートコードの使い方add_shortcode

コピーコンテンツ対策.htaccessで直リンク禁止しリダイレクトで対応

評価点投票プラグイン10個を比較！WordPressで口コミサイトを構築

BackWPupでバックアップ・リストア（復元）の具体的手順

コンパクトキーボード・KEK-EA9AU・FKB1420の魅力

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

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

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

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

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

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

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

CakePHP3の関連記事

GoogleAdwords

GoogleAdwords

Message コメントをキャンセル

関連記事

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

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