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

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

: CakePHP3で画像・ファイルのアップロード処理を自作・解説付き・その２

ファイルのアップロード機能の自作サンプルコードとその解説のその２。アップロード機能に関連するファイルの更新や削除の処理や画像、フォルダのパスの指定方法などを含めて解説。

: CakePHP3で Ajaxを使う方法の解説。3.6以降対応。Successとthenの両方を解説。

CakePHP3でajaxを利用する処理の実装方法を解説。プルダウンを変更するとデータベースの値を取得し検索結果の内容を変更するというような処理を想定。CakePHP3.6以降の CSRF対策対応済。

: CakePHP3にOGPをfetch、asignを利用してテンプレートごとに指定する方法を解説

CakePHP3でOGPを設定する方法を解説。fetch、assignを使用しレイアウトファイルに編集した変数にテンプレートファイルから値を指定する。これを利用してOGPを編集する。

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

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

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

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

: CakePHP 2.3　ID以外のカラムでアソシエーション（連携）をさせる場合

ID以外のカラムでアソシエーション（連携）させるための考え方とサンプルソースを用いての説明を行っています。

: CakePHP3でPHP Simple HTML DOM Parserを使ってスクレイピングする方法

CakePHP3でPHP Simple HTML DOM Parserを使ってスクレイピングをする方法を解説。インストール方法、読み込み方法。および、具体的なスクレイピングを実行するサンプルソースも。

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

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