エス技研

WordPress、CakePHP、PHP、baserCMSなどの Web系システムを中心に情報を提供します!


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

      2019/06/08

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

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

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

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

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

 
この処理の中の 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」
を取得することができます。
 
 

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

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

 
 

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

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

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

CakePHP3の関連記事

CakePHP3でレコードを保存(追加、更新、Insert、Update)する複数の方法を紹介
CakePHP3でモデルなしフォームからCSVをアップロードしレコードを更新する方法解説
CakePHP3でPHP Simple HTML DOM Parserを使ってスクレイピングする方法
CakePHP3のInsert On Duplicate Key Update(upsert)構文を解説・バルク処理も
CakePHP3の1対多での連携を中間テーブルを使った多対多の連携に変更するときの手順
CakePHP3でデフォルトのソート条件を設定してユーザの選択肢たソート条件を有効にする方法
CakePHP3で Ajaxを使う方法の解説。3.6以降対応。Successとthenの両方を解説。
CakePHP3でパンくずの指定は HTMLヘルパーを使って指定する方法を解説
CakePHP3にOGPをfetch、asignを利用してテンプレートごとに指定する方法を解説
CakePHP3のOGPはHTMLヘルパーの$this->Html->meta()を使って設定
 
その他の「CakePHP3」に関する記事一覧
 
 

 - CakePHP 2.x 3.x

GoogleAdwords

GoogleAdwords

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

Message

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

下記の空欄を埋めてください。 * Time limit is exhausted. Please reload CAPTCHA.

日本語が含まれない投稿は無視されますのでご注意ください。(スパム対策)

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

  関連記事

URL短縮サービス「TTTオンライン(https://ttt.onl)」公開
URL短縮サービス「TTTオンライン(https://ttt.onl)」公開

URL短縮サービス「TTTオンライン(https://ttt.onl)」を公開。メールやSNSでは使いにくい長いURLを短いURLに変換するサービス。QRコードも。Google URL Shortenerが2019年3月にサービス終了。

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

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

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

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

CakePHP3でシェルを作成しコマンドラインから実行・CakePHP2との違い
CakePHP3でシェルを作成しコマンドラインから実行・CakePHP2との違い

CakePHP3のシェルスクリプトを作成し、コマンドラインから実行する方法を解説。複数単語をつなげる場合の対応方法がCakePHP2より制限が厳しくなったのでCakePHP3の命名規則の確認が必要だ。

CakePHP3のバージョンを指定してインストールする詳細な手順を解説
CakePHP3のバージョンを指定してインストールする詳細な手順を解説

CakePHP3のバージョンを指定してインストールする方法を詳細解説。CakePHP3のインストールはComposerを使うため設定もほぼ自動で完了。データベースの接続情報を記載すればアプリ開発のベースが整う。

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

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

CakePHP3にデザインテンプレートBootstrapを導入する方法・friendsofcake/bootstrap-ui使用
CakePHP3にデザインテンプレートBootstrapを導入する方法・friendsofcake/bootstrap-ui使用

CakePHP3にプラグイン「friendsofcake/bootstrap-ui」、デザインテンプレート「Bootstrap」を設置する手順を解説。Bootstrapの簡単な使い方やデフォルトのデザインとの混在方法なども解説。

CakePHP3のOGPはHTMLヘルパーの$this->Html->meta()を使って設定
CakePHP3のOGPはHTMLヘルパーの$this->Html->meta()を使って設定

CakePHP3でOGPを設定する方法を解説。metaタグを編集するHTMLヘルパーを利用してOGPのタグを編集する。また、エレメントとして分割することでメンテナンス性も向上させる。

CakePHP3の更新画面でUpload Plugin 3.0を使う方法、viewで使う方法解説・その3
CakePHP3の更新画面でUpload Plugin 3.0を使う方法、viewで使う方法解説・その3

CakePHP3でファイル、画像をアップロードするプラグイン、upload plugin 3を導入する手順を解説した記事。3部作のその3で記事を更新する際のファイルの取り回しなどについてを解説。

CakePHPで favicon.icoやapple-touch-icon-144-precomposed.pngが could not be foundのエラーが出るときの対処方法
CakePHPで favicon.icoやapple-touch-icon-144-precomposed.pngが could not be foundのエラーが出るときの対処方法

CakePHPで「CakeDC/Users」などルーティングを行うプラグインを利用するときに、favicon.icoやapple-touch-icon-144-precomposed.pngがNotFoundエラーになることがある。その対処方法の解説。