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

CakePHP3でデータベースに値を保存する save()を実行するときのログを確認する方法

通常の save()実行ではエラーの情報が分からない

　
CakePHP3のシェルを利用してシステムを開発している際に、データを保存する save()を実行するところでエラーが発生していました。
　
ですが、save()処理の戻り値を取得しても、エラーである「False」が帰ってきているだけで、どのようなエラーが起こっているのかが分かりませんでした。
　
　
ブラウザで表示する処理を作っているのであれば、デバッグキットを利用して、エラーの原因を探ることもできますが、今回はシェルのプログラム開発をしていましたので、デバッグキットを利用する方法も採れませんでした。
　
と言うわけで、なんとかして「save()」を実行したときのエラーログを取得する方法を探したところ、それがありました。
　
　
通常は、下記の様に保存処理を記述します。
　

if($tableObject->save($saveData) === false) {
    return '500(Save Failed)';
} else {
    return '200(Save Success)';
}

　
上記の方法では、save()の戻り値は、「true：正常終了」「False：エラー終了」のどちらかです。
エラーの場合は、どのようなエラーが出ているのかを確認する方法がありません。
　
そのため、エラーを確認するためには、下記の様に変更します。
　

try {
    $tableObject->saveOrFail($saveData);
} catch (\Cake\ORM\Exception\PersistenceFailedException $e) {
    echo $e;
//  echo $e->getEntity();
    return '500(Save Failed)';
}
return '200(Save Success)';

　
「save()」を「saveOrFail()」に変更します。
　
それを「try ．．． catch 文」でエラーを取得します。
　
「echo $e;」
を記述することで、エラーログを表示することができます。
　
上記のソースコード上ではコメントアウトしていますが、
「echo $e->getEntity();」
を記述すると、保存しようとしたデータの実態（エンティティ）を表示することができます。
　
エラーログと保存しようとしたデータを確認しながら、エラーの原因を探ることができます。
　
　
参考サイト
CakePHP3 Cookbook　厳密な保存
https://book.cakephp.org/3.0/ja/orm/saving-data.html#id21
　
　
また、今回の記事では、データベースに値を保存する際のエラーを「try ＋ catch 構文」を使って取得する方法ですが、保存処理をする前に事前にバリデーションを行って、その結果を取得する場合の処理については下記に記事を書いていますので参考にしてください。
CakePHP3で保存前にバリデーション結果を取得する2つの方法
　
　

　

Cake\ORM\Exception\PersistenceFailedException: Entity save failure (user_id: “_existsIn”, account_id: “_existsIn”).というエラーが出ていた

　
前項の対応を行ったところ、下記のエラーログが出力されました。
　

Cake\ORM\Exception\PersistenceFailedException: Entity save failure (user_id: "_existsIn", account_id: "_existsIn"). in /var/www/html/vendor/cakephp/cakephp/src/ORM/Table.php:1945
Stack trace:
#0 /var/www/html/src/Shell/GetUserShell.php(811): Cake\ORM\Table->saveOrFail(Object(App\Model\Entity\UserAccount))
   （以下略）

　
このエラーですが、「user_id: “_existsIn”, account_id: “_existsIn”」というところが大事なポイントです。
　
保存しようとしているデータに連携するはずの「user_id」「account_id」の値が、「users」「accounts」テーブルの中にありませんよ、というエラーです。
　
まだ開発をしている途中ですので、該当のテーブルのデータの保存の処理だけを作っていましたので、「users」「accounts」テーブルにはデータを入れていませんでした。
そのため、該当テーブル内にある「user_id」「account_id」の値がないので保存できません、というエラーでした。
　
エラーの原因が分かりましたので、「users」「accounts」テーブルに該当 IDのレコードを作成したところ、正しく保存することができるようになりました。
　
　
ちなみに、生の SQL文を直接実行する方法については下記に記事を書いていますので、合わせて参考にしてください。
CakePHP3で生の SQLの実行はConnectionManagerを使う
　
　

CakePHP3の関連記事