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

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

: CakePHP4 でコマンドプログラム（シェルプログラム）を作成する方法解説

CakePHP4でバッチ処理を行うためのコマンド・シェルの実装方法について解説。bakeでテンプレートファイルを作成し、「execute()」に処理を記述する方法を解説。

: 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エラーになることがある。その対処方法の解説。

: CakePHP4のController内でViewテンプレート、レイアウトの変更設定を記述する方法

CakePHP4でテンプレートやレイアウトファイルをデフォルトから変更する場合は「render()」を使用するが、記述場所はできるだけコントローラー内の最後の方に書く方がいい。

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

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

: CakePHP3でページごとに読み込むJavaScript、CSSを変える処理の解説

CakePHP3でJavaScriptやCSSを編集する基本形から、それらやテンプレート（エレメント）を特定のテンプレートを読み込んだときのみ編集、実行するための方法、ブロック化について解説。

: CakePHPで同一テーブル内の値を比較する条件でレコードを取得する方法

CakePHPの同一テーブルにある項目の値を比較し条件に合致するレコードを取得する方法を解説。［”項目名”=>”値”]ではなく[”項目名 = 項目名”］と書くところがポイント。

: CakePHP 2.3　Search Pluginで検索処理　その６ORDER、sortソートの機能

CakePHPの検索プラグイン Search Pluginの検索処理の中で order、ソートについての解説です。

: Windows環境の XAMPPを利用して CakePHPの開発する際の注意点

WindowsベースにXAMPPで環境を構築しCakePHP4を利用したWebシステムを構築する際は、大文字と小文字の違いを意識する必要がある。LinuxベースのWebサーバに移動させたときに不具合で動作しないこともある。

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

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

: Windows上のXAMPP環境のCakePHPのコマンド実行時に環境変数を指定する方法

CakePHP4のコマンド（シェル）に対して、環境変数を指定して実行する方法を解説。LinuxとWindows上のXAMPPとでは記述方法が異なるため、Windowsのsetコマンドについても詳細解説。