friendica/src/BaseModel.php

151 lines
3.5 KiB
PHP
Raw Normal View History

2019-12-11 03:30:29 -05:00
<?php
namespace Friendica;
use Friendica\Database\Database;
use Friendica\Network\HTTPException;
use Psr\Log\LoggerInterface;
/**
* 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
{
/** @var Database */
protected $dba;
/** @var LoggerInterface */
protected $logger;
/**
* Model record abstraction.
* Child classes never have to interact directly with it.
* Please use the magic getter instead.
*
* @var array
*/
private $data = [];
/**
* 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 = [])
2019-12-11 03:30:29 -05:00
{
$this->dba = $dba;
$this->logger = $logger;
$this->data = $data;
$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()
{
return $this->mapFields($this->originalData);
2019-12-11 03:30:29 -05:00
}
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)
{
$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)
{
return in_array($name, array_merge(array_keys($this->data), array_keys(get_object_vars($this))));
}
2019-12-11 03:30:29 -05:00
/**
* Magic getter. This allows to retrieve model fields with the following syntax:
* - $model->field (outside of class)
* - $this->field (inside of class)
*
* @param $name
* @return mixed
* @throws HTTPException\InternalServerErrorException
*/
public function __get($name)
{
$this->checkValid();
2019-12-11 03:30:29 -05:00
if (!array_key_exists($name, $this->data)) {
throw new HTTPException\InternalServerErrorException('Field ' . $name . ' not found in ' . static::class);
}
return $this->data[$name];
}
/**
* @param string $name
* @param mixed $value
2019-12-11 03:30:29 -05:00
*/
public function __set($name, $value)
2019-12-11 03:30:29 -05:00
{
$this->data[$name] = $value;
2019-12-11 03:30:29 -05:00
}
2020-01-27 19:33:29 -05:00
/**
* Returns the values of the current model as an array
*
* @param bool $dbOnly True, if just the db-relevant fields should be returned
*
* @return array The values of the current model
*/
public function toArray(bool $dbOnly = false)
2019-12-11 03:30:29 -05:00
{
2020-01-27 19:33:29 -05:00
return $dbOnly ? $this->mapFields($this->data) : $this->data;
2019-12-11 03:30:29 -05:00
}
protected function checkValid()
{
if (empty($this->data['id'])) {
throw new HTTPException\InternalServerErrorException(static::class . ' record uninitialized');
}
}
2019-12-11 03:30:29 -05:00
}