X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FBaseModel.php;h=1189f7f33b1187ef75e34a2e6c4d4ba890022535;hb=fdaff4303952427f222ee21f6b501d5087e25932;hp=32011c7db2f916189ab14245e3e16a1179b276df;hpb=ff69fa162959cb77384c1b4107c4e5a3c3be75c5;p=friendica.git

diff --git a/src/BaseModel.php b/src/BaseModel.php
index 32011c7db2..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;
 
@@ -7,17 +26,13 @@ use Friendica\Network\HTTPException;
 use Psr\Log\LoggerInterface;
 
 /**
- * Class BaseModel
- *
  * The Model classes inheriting from this abstract class are meant to represent a single database record.
  * The associated table name has to be provided in the child class, and the table is expected to have a unique `id` field.
  *
  * @property int id
  */
-abstract class BaseModel
+abstract class BaseModel extends BaseDataTransferObject
 {
-	protected static $table_name;
-
 	/** @var Database */
 	protected $dba;
 	/** @var LoggerInterface */
@@ -32,10 +47,62 @@ abstract class BaseModel
 	 */
 	private $data = [];
 
-	public function __construct(Database $dba, LoggerInterface $logger)
+	/**
+	 * Used to limit/avoid updates if no data was changed.
+	 *
+	 * @var array
+	 */
+    private $originalData = [];
+
+	/**
+	 * @param Database        $dba
+	 * @param LoggerInterface $logger
+	 * @param array           $data   Table row attributes
+	 */
+	public function __construct(Database $dba, LoggerInterface $logger, array $data = [])
 	{
 		$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;
+	}
+
+	/**
+	 * Performance-improved model creation in a loop
+	 *
+	 * @param BaseModel $prototype
+	 * @param array     $data
+	 * @return BaseModel
+	 */
+	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 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): bool
+	{
+		return in_array($name, array_merge(array_keys($this->data), array_keys(get_object_vars($this))));
 	}
 
 	/**
@@ -43,15 +110,13 @@ 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)
 	{
-		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);
@@ -61,35 +126,27 @@ abstract class BaseModel
 	}
 
 	/**
-	 * Fetches a single model record. The condition array is expected to contain a unique index (primary or otherwise).
-	 *
-	 * Chainable.
+	 * * 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 array $condition
-	 * @return BaseModel
-	 * @throws HTTPException\NotFoundException
+	 * @param string $name
+	 * @param mixed  $value
 	 */
-	public function fetch(array $condition)
+	public function __set(string $name, $value)
 	{
-		$intro = $this->dba->selectFirst(static::$table_name, [], $condition);
-
-		if (!$intro) {
-			throw new HTTPException\NotFoundException(static::class . ' record not found.');
-		}
-
-		$this->data = $intro;
+		$this->data[$name] = $value;
+	}
 
-		return $this;
+	public function toArray(): array
+	{
+		return $this->data;
 	}
 
-	/**
-	 * Deletes the model record from the database.
-	 * Prevents further methods from being called by wiping the internal model data.
-	 */
-	public function delete()
+	protected function checkValid()
 	{
-		if ($this->dba->delete(static::$table_name, ['id' => $this->id])) {
-			$this->data = [];
+		if (!isset($this->data['id']) || is_null($this->data['id'])) {
+			throw new HTTPException\InternalServerErrorException(static::class . ' record uninitialized');
 		}
 	}
 }