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にデザインテンプレートBootstrapを導入する方法・friendsofcake/bootstrap-ui使用

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

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

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

: CakePHP3でPHPExcelを使ってエクセルファイルを生成、出力する方法

CakePHP3でPHPExcelを利用してエクセルを編集、出力するサンプルソース＋解説。PHPExcelのインストール方法の解説からファイル保存とダウンロードの方法なども解説。

: CakePHP3のCakeDC/Usersでログインユーザの所有レコードのみ更新、削除する権限管理の設定方法

CakePHP3のユーザ管理、ログイン認証プラグイン「CakeDC/Users」の権限管理を行う方法やアクセスできるコントローラー、アクションを設定、所有権を持つレコードのみ更新できる設定方法を解説。

: CakePHP5系で認証機能のAuthenticationプラグインをインストール・エラー発生注意

CakePHPのユーザ認証に使用するオフィシャルなプラグインAuthenticationだが、CakePHP5系では Authentication Ver.3系を使う必要があるが、公式ChiffonBookが間違えている。

: CakePHP3にデイトピッカー jQuery UI DatePickerを実装する手順の解説

CakePHP3にjQuery UIのDatePickerを実装する手順を説明。併せて、デイトピッカーを設置に関連するCakePHP3の解説と、テーマを変更したり、表記を変更するカスタマイズする方法なども紹介。

: CakePHP3でレコードを保存（追加、更新、Insert、Update）する複数の方法を紹介

CakePHP3でレコードを追加、更新（Insert、Update）する記述方法を解説。1件ずつ処理、全件をまとめて処理、条件に該当する複数件のレコードを処理方法をサンプルコードを用いて解説。

: CakePHP3のUpload Plugin 3.0をバリデーションなど実運用向けのカスタマイズ方法解説・その２

CakePHP3でファイル、画像をアップロードするプラグイン、upload plugin 3を導入する手順を解説した記事。3部作のその2でバリデーションなどの実用的なカスタマイズ方法を解説。

: CakePHP3のfriendsofcake/searchでブックマークチュートリアルのタグ検索を実装

CakePHP3のCookbookにあるブックマークチュートリアル。ここで紹介されているタグで検索する処理を検索プラグイン「friendsofcake/search」で実現する方法を解説しました。

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

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

PREV: CakePHP4、5でSELECT telephone as tel FROM usersの様にasでカラムに別名を付ける方法
NEXT: CakePHP4系、CakePHP5系のexists()でカラムを指定して値の有無をチェックする方法解説

日	月	火	水	木	金	土
			1	2	3	4
5	6	7	8	9	10	11
12	13	14	15	16	17	18
19	20	21	22	23	24	25
26	27	28	29	30	31

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

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

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

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

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

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

CakePHP5の関連記事

GoogleAdwords

GoogleAdwords

Message コメントをキャンセル

関連記事

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

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

CakePHP3でPHPExcelを使ってエクセルファイルを生成、出力する方法

CakePHP3のCakeDC/Usersでログインユーザの所有レコードのみ更新、削除する権限管理の設定方法

CakePHP5系で認証機能のAuthenticationプラグインをインストール・エラー発生注意

CakePHP3にデイトピッカー jQuery UI DatePickerを実装する手順の解説

CakePHP3でレコードを保存（追加、更新、Insert、Update）する複数の方法を紹介

CakePHP3のUpload Plugin 3.0をバリデーションなど実運用向けのカスタマイズ方法解説・その２

CakePHP3のfriendsofcake/searchでブックマークチュートリアルのタグ検索を実装

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

WordPress投稿にPHPを記述するショートコードの使い方add_shortcode

コピーコンテンツ対策.htaccessで直リンク禁止しリダイレクトで対応

評価点投票プラグイン10個を比較！WordPressで口コミサイトを構築

BackWPupでバックアップ・リストア（復元）の具体的手順

コンパクトキーボード・KEK-EA9AU・FKB1420の魅力

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

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

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

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

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

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

CakePHP5の関連記事

GoogleAdwords

GoogleAdwords

Message コメントをキャンセル

関連記事

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