Continued:

[friendica.git] / src / BaseEntity.php

diff --git a/src/BaseEntity.php b/src/BaseEntity.php
index 14f95c197ecef43caa27d34e32e0c97e55ee376a..dca1af4f627b2e29a5494af84bd2666496ce63de 100644 (file)
--- a/src/BaseEntity.php
+++ b/src/BaseEntity.php
@@ -1,33 +1,70 @@
 <?php
+/**
+ * @copyright Copyright (C) 2010-2023, the Friendica project
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ */
 
 namespace Friendica;
 
+use Friendica\Network\HTTPException;
+
 /**
- * The API entity classes are meant as data transfer objects. As such, their member should be protected.
- * Then the JsonSerializable interface ensures the protected members will be included in a JSON encode situation.
+ * The Entity classes directly inheriting from this abstract class are meant to represent a single business entity.
+ * Their properties may or may not correspond with the database fields of the table we use to represent it.
+ * Each model method must correspond to a business action being performed on this entity.
+ * Only these methods will be allowed to alter the model data.
+ *
+ * To persist such a model, the associated Repository must be instantiated and the "save" method must be called
+ * and passed the entity as a parameter.
  *
- * Constructors are supposed to take as arguments the Friendica dependencies/model/collection/data it needs to
- * populate the class members.
+ * Ideally, the constructor should only be called in the associated Factory which will instantiate entities depending
+ * on the provided data.
+ *
+ * Since these objects aren't meant to be using any dependency, including logging, unit tests can and must be
+ * written for each and all of their methods
  */
-abstract class BaseEntity implements \JsonSerializable
+abstract class BaseEntity extends BaseDataTransferObject
 {
        /**
-        * Returns the current entity as an json array
-        *
-        * @return array
+        * @param string $name
+        * @return mixed
+        * @throws HTTPException\InternalServerErrorException
         */
-       public function jsonSerialize()
+       public function __get(string $name)
        {
-               return $this->toArray();
+               if (!property_exists($this, $name)) {
+                       throw new HTTPException\InternalServerErrorException('Unknown property ' . $name . ' in Entity ' . static::class);
+               }
+
+               return $this->$name;
        }
 
        /**
-        * Returns the current entity as an array
-        *
-        * @return array
+        * @param mixed $name
+        * @return bool
+        * @throws HTTPException\InternalServerErrorException
         */
-       public function toArray()
+       public function __isset($name): bool
        {
-               return get_object_vars($this);
+               if (!property_exists($this, $name)) {
+                       throw new HTTPException\InternalServerErrorException('Unknown property ' . $name . ' of type ' . gettype($name) . ' in Entity ' . static::class);
+               }
+
+               return !empty($this->$name);
        }
 }