CakePHP4、5のnewEmptyEntityで作成したオブジェクトは空なのか、確認してみた

2025/01/18 2025/01/31

CakePHP4、5のnewEmptyEntityで作成したオブジェクトは空なのか？

　
CakePHP4系、CakePHP5系で新たにレコードを登録する際、「newEmptyEntity()」を使って空のオブジェクトを作成するかと思います。
　
この作成されたオブジェクトは「空」なのだろうか？と思い確認をしてみることにしました。
　
　
ちなみに、CakePHP4系、CakePHP5系の両方で確認しましたが、当たり前のように同じ結果でした。（CakePHPの処理ではなく、PHPの処理ですからね。）
　
　

「`$this->Users->newEmptyEntity();`」で生成した「$user」は「空」なのか？

public function add()
{
  $user = $this->Users->newEmptyEntity();
  if ($this->request->is('post')) {
    $user = $this->Users->patchEntity($user, $this->request->getData());
    if ($this->Users->save($user)) {
      $this->Flash->success(__('The user has been saved.'));

      return $this->redirect(['action' => 'index']);
    }
    $this->Flash->error(__('The user could not be saved. Please, try again.'));
  }
  $this->set(compact('user'));
}

public function add()

{

$user = $this->Users->newEmptyEntity();

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

$user = $this->Users->patchEntity($user, $this->request->getData());

if ($this->Users->save($user)) {

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

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

}

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

}

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

}

　
上記は、Bakeして作成した Usersコントローラー内の addアクションです。
上記の 3行目の「$this->Users->newEmptyEntity();」で生成した「$user」は「空」なのか？
　
という確認を行いました。
　
　

「newEmptyEntity」で生成したオブジェクトを「empty」「is_null」などでチェックしてみた

　
具体的なチェックの処理と結果は以下の通りでした。
　

$userNewEntity = $this->Users->newEmptyEntity();
if($userNewEntity){
  echo "True<br>";          // ← True（Objectがあるので空ではない）
} else {
  echo "False<br>";
}
if(empty($userNewEntity)){
  echo "EmptyTrue<br>";
} else {
  echo "EmptyFalse<br>";    // ← EmptyFalse（Objectがあるので空ではない）
}
if(is_null($userNewEntity)){
  echo "NullTrue<br>";
} else {
  echo "NullFalse<br>";     // ← NullFalse（Objectがあるので Nullではない）
}
if($userNewEntity == []){
  echo "True<br>";
} else {
  echo "False<br>";         // ← False（Objectがあるので空配列ではない）
}

$userNewEntity = $this->Users->newEmptyEntity();

if($userNewEntity){

echo "True "; // ← True（Objectがあるので空ではない）

} else {

echo "False ";

}

if(empty($userNewEntity)){

echo "EmptyTrue ";

} else {

echo "EmptyFalse "; // ← EmptyFalse（Objectがあるので空ではない）

}

if(is_null($userNewEntity)){

echo "NullTrue ";

} else {

echo "NullFalse "; // ← NullFalse（Objectがあるので Nullではない）

}

if($userNewEntity == []){

echo "True ";

} else {

echo "False "; // ← False（Objectがあるので空配列ではない）

}

　
上記の中にコメントで結果を書いていますが、いずれも「空」「null」ではない、という結果になっています。
　
「$this->Users->newEmptyEntity();」で「空のエンティティ」を作る処理ではあるものの、作成されるものは「空のオブジェクト」であるので、「empty()」などでチェックするとそれは「空」ではないと判断されるということですね。
　
オブジェクトが生成されていますので、空ではないですよね。そりゃそうですよね、と。
　
　

「newEmptyEntity()」が空なのか、明確にしたかった理由

　
「newEmptyEntity()」が空なのか、これまであまり気にしたことがなかったのですが、それを明確にしたかった理由は、以下のように「newEmptyEntity()」で作成した値を引数として別の関数に渡す処理を構築しようとしていたためです。
　
より具体的には、addと editで行う処理を共通化しようと考えたのですが、その際、「newEmptyEntity()」で作成した値を「empty()」でチェックすることができるのだろうか？と疑問に思ったためでした。
　

public function add()
{
  // 前略

  $userNewEntity = $this->Users->newEmptyEntity();
  $userRes = $this->_addEdit($userNewEntity);

  // 後略
}

public function _addEdit($userEntity = [])
{
  // 引数のチェック
  if(!empty($userEntity)){
    return "Error";
  }

  // 続きの処理
  //   ：
  //   ：
}

public function add()

{

// 前略

$userNewEntity = $this->Users->newEmptyEntity();

$userRes = $this->_addEdit($userNewEntity);

// 後略

}

public function _addEdit($userEntity = [])

{

// 引数のチェック

if(!empty($userEntity)){

return "Error";

}

// 続きの処理

// ：

}

　
「newEmptyEntity()」で作成した値は、「空」ではないことが明確になりましたので、引数が渡ってきていないときは、「empty()」が「true」になりますので、判別してエラー処理ができることが明確になりました。
　
これで、より不具合が少ないプログラムを組むことができますね。
　
　

想定外の値も想定した処理を構築する必要がある

　
かつて、私にプログラムを教えてくれた先輩がこんなことを言っていました。
「想定外の値が来た場合でもハングアップ（異常終了）しない処理を心がけろ」と。
　
想定外の値が来たときでも異常終了してしまうのではなく、想定外の値が来たとしてログを出力し、適切なエラー処理を実施したうえで、安全に停止するように処理を構築しろ、という意味です。
　
そのため、私が作成するプログラムは、若干エラーチェックがくどすぎると思うこともありますが、最初に教えてくれた方の教えなので、習慣になってしまっているとも言えますね。
　
どれだけの想定外を想定できるかが、いいシステムを構築するためのノウハウだ、ということも言っていましたね。
　
まぁ、どれくらいの信頼性が必要なシステムなのか、にもよりますけどね。
　
　

- CakePHP 3.x 4.x 5.x CakePHP5

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

Message コメントをキャンセル

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

: CakePHP 2.3　Search Pluginで検索処理　その７queryを使って日付の範囲検索

CakePHPの検索プラグイン Search Pluginの検索処理の中で queryを使って日付の範囲検索の方法です。

: CakePHP3でQRコードを作成、表示するライブラリ「cakePHP-QR-Code-Helper」

CakePHPでQRコードを生成するライブラリ「cakePHP-QR-Code-Helper」の紹介。GDライブラリのインストールも必要ないHelperとして提供されているため、ファイルを設置すればすぐに使用可能。

: CakePHP4のCakeDC/Usersの Usersへの接続、バリデーションのカスタマイズ方法解説

CakeDC謹製Usersプラグインの紹介。CakePHP4で使う場合のUsersのカスタマイズとして入力項目のバリデーションの変更を、プラグインのファイルは触らずオーバーライドにより実装する方法を解説する。

: CakePHP3でComposerでインストールできないプラグイン、外部ライブラリを vendorに入れて手動で読み込む方法

CakePHP3にComposerからインストールできないプラグインやライブラリなどを利用する方法、vendorにファイルを設置し、composer.jsonを更新し、それを呼び出す方法を詳細に解説。

: CakePHP4で「app_local.php」「.env」を利用して環境ごとの定数を振り分ける方法

CakePHP4で.env、app_local.phpに定数を定義してそれを呼び出す方法の解説。Gitでは管理せず本番環境と開発環境とで異なる定数を定義するためそれを利用する方法。

: CakePHP3、CakePHP4のdatetime型カラムの日時の扱い。秒まで表示する方法

CakePHP3の日時カラムで秒まで扱う場合はdate()、strtotime()関数ではうまくいかない。CakePHP3であらかじめ用意された「i18nFormat()」を使用する。

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

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

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

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