Escape the "share" as well

[friendica.git] / src / BaseModel.php

diff --git a/src/BaseModel.php b/src/BaseModel.php
index 055f9c4a19a46dd07c40ad4fa32a612c1a99e807..768e9e9e53d5190e4f9277e9e7531b2d9284e5c9 100644 (file)
--- a/src/BaseModel.php
+++ b/src/BaseModel.php
@@ -1,4 +1,23 @@
 <?php
+/**
+ * @copyright Copyright (C) 2010-2022, 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;
@@ -28,6 +47,13 @@ abstract class BaseModel
         */
        private $data = [];
 
+       /**
+        * Used to limit/avoid updates if no data was changed.
+        *
+        * @var array
+        */
+    private $originalData = [];
+
        /**
         * @param Database        $dba
         * @param LoggerInterface $logger
@@ -38,6 +64,17 @@ abstract class BaseModel
                $this->dba = $dba;
                $this->logger = $logger;
                $this->data = $data;
+               $this->originalData = $data;
+       }
+
+       public function getOriginalData(): array
+       {
+               return $this->originalData;
+       }
+
+       public function resetOriginalData()
+       {
+               $this->originalData = $this->data;
        }
 
        /**
@@ -47,14 +84,27 @@ 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;
+               $model->originalData = $data;
 
                return $model;
        }
 
+       /**
+        * Magic isset method. Returns true if the field exists, either in the data prperty 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): bool
+       {
+               return in_array($name, array_merge(array_keys($this->data), array_keys(get_object_vars($this))));
+       }
+
        /**
         * Magic getter. This allows to retrieve model fields with the following syntax:
         * - $model->field (outside of class)
@@ -66,9 +116,7 @@ abstract class BaseModel
         */
        public function __get($name)
        {
-               if (empty($this->data['id'])) {
-                       throw new HTTPException\InternalServerErrorException(static::class . ' record uninitialized');
-               }
+               $this->checkValid();
 
                if (!array_key_exists($name, $this->data)) {
                        throw new HTTPException\InternalServerErrorException('Field ' . $name . ' not found in ' . static::class);
@@ -78,16 +126,27 @@ 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->data;
        }
+
+       protected function checkValid()
+       {
+               if (!isset($this->data['id']) || is_null($this->data['id'])) {
+                       throw new HTTPException\InternalServerErrorException(static::class . ' record uninitialized');
+               }
+       }
 }