"getStyledURL" is now public

[friendica.git] / src / BaseModel.php

diff --git a/src/BaseModel.php b/src/BaseModel.php
index 4e4259170872ea23977c24ef7a425f52b4675575..1189f7f33b1187ef75e34a2e6c4d4ba890022535 100644 (file)
--- 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,7 +67,7 @@ abstract class BaseModel
                $this->originalData = $data;
        }
 
-       public function getOriginalData()
+       public function getOriginalData(): array
        {
                return $this->originalData;
        }
@@ -65,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;
@@ -75,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))));
        }
@@ -91,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();
 
@@ -107,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->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');
                }
        }