X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FBaseModel.php;h=1189f7f33b1187ef75e34a2e6c4d4ba890022535;hb=7c266be2064907ab3a23bfd6b7ee31b64fc661de;hp=791d6887c1702d088308bed27a4870b9c1766e0b;hpb=443e106105b7d4ff9b97d21491a3d0eb89aa9dfe;p=friendica.git

diff --git a/src/BaseModel.php b/src/BaseModel.php
index 791d6887c1..1189f7f33b 100644
--- a/src/BaseModel.php
+++ b/src/BaseModel.php
@@ -1,4 +1,23 @@
 <?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;
 
@@ -12,7 +31,7 @@ use Psr\Log\LoggerInterface;
  *
  * @property int id
  */
-abstract class BaseModel
+abstract class BaseModel extends BaseDataTransferObject
 {
 	/** @var Database */
 	protected $dba;
@@ -48,23 +67,9 @@ abstract class BaseModel
 		$this->originalData = $data;
 	}
 
-	/**
-	 * Maps a data array (original/current) to a known field list of the chosen model
-	 *
-	 * This is useful to filter out additional attributes, which aren't part of the db-table (like readonly cached fields)
-	 *
-	 * @param array $data The data array to map to db-fields
-	 *
-	 * @return array the mapped data array
-	 */
-	protected function mapFields(array $data)
-	{
-		return $data;
-	}
-
-	public function getOriginalData()
+	public function getOriginalData(): array
 	{
-		return $this->mapFields($this->originalData);
+		return $this->originalData;
 	}
 
 	public function resetOriginalData()
@@ -79,7 +84,7 @@ abstract class BaseModel
 	 * @param array     $data
 	 * @return BaseModel
 	 */
-	public static function createFromPrototype(BaseModel $prototype, array $data)
+	public static function createFromPrototype(BaseModel $prototype, array $data): BaseModel
 	{
 		$model = clone $prototype;
 		$model->data = $data;
@@ -89,13 +94,13 @@ abstract class BaseModel
 	}
 
 	/**
-	 * Magic isset method. Returns true if the field exists, either in the data prperty array or in any of the local properties.
+	 * Magic isset method. Returns true if the field exists, either in the data property array or in any of the local properties.
 	 * Used by array_column() on an array of objects.
 	 *
 	 * @param $name
 	 * @return bool
 	 */
-	public function __isset($name)
+	public function __isset($name): bool
 	{
 		return in_array($name, array_merge(array_keys($this->data), array_keys(get_object_vars($this))));
 	}
@@ -105,11 +110,11 @@ abstract class BaseModel
 	 * - $model->field (outside of class)
 	 * - $this->field (inside of class)
 	 *
-	 * @param $name
+	 * @param string $name Name of data to fetch
 	 * @return mixed
 	 * @throws HTTPException\InternalServerErrorException
 	 */
-	public function __get($name)
+	public function __get(string $name)
 	{
 		$this->checkValid();
 
@@ -121,22 +126,26 @@ abstract class BaseModel
 	}
 
 	/**
+	 * * Magic setter. This allows to set model fields with the following syntax:
+	 * - $model->field = $value (outside of class)
+	 * - $this->field = $value (inside of class)
+	 *
 	 * @param string $name
-	 * @param mixed $value
+	 * @param mixed  $value
 	 */
-	public function __set($name, $value)
+	public function __set(string $name, $value)
 	{
 		$this->data[$name] = $value;
 	}
 
-	public function toArray()
+	public function toArray(): array
 	{
-		return $this->mapFields($this->data);
+		return $this->data;
 	}
 
 	protected function checkValid()
 	{
-		if (empty($this->data['id'])) {
+		if (!isset($this->data['id']) || is_null($this->data['id'])) {
 			throw new HTTPException\InternalServerErrorException(static::class . ' record uninitialized');
 		}
 	}