* * @author Julius Härtl * * @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 . * */ namespace OCA\Deck\Db; class RelationalEntity extends \OCP\AppFramework\Db\Entity implements \JsonSerializable { private $primaryKey; private $_relations = array(); private $_resolvedProperties = []; /** * Mark a property as relation so it will not get updated using Mapper::update * @param string $property Name of the property */ public function addRelation($property) { if (!in_array($property, $this->_relations)) { $this->_relations[] = $property; } } public function addResolvable($property) { $this->_resolvedProperties[$property] = null; } /** * Mark am attribute as updated * overwritten from \OCP\AppFramework\Db\Entity to avoid writing relational attributes * @param string $attribute the name of the attribute * @since 7.0.0 */ protected function markFieldUpdated($attribute) { if (!in_array($attribute, $this->_relations)) { parent::markFieldUpdated($attribute); } } /** * @return array serialized data */ public function jsonSerialize() { $properties = get_object_vars($this); $reflection = new \ReflectionClass($this); $json = []; foreach($properties as $property=>$value) { if(substr($property, 0, 1) !== '_' && $reflection->hasProperty($property)) { $propertyReflection = $reflection->getProperty($property); if(!$propertyReflection->isPrivate()) { $json[$property] = $this->getter($property); } } } return $json; public function resolveRelation($property, $resolver) { if($property !== null && $this->$property !== null) { $result = $resolver($this->$property); } else { $result = null; } if($result instanceof RelationalObject || $result === null) { $this->_resolvedProperties[$property] = $result; } else { throw new \Exception('resolver must return an instance of RelationalObject'); } } public function __call($methodName, $args){ $attr = lcfirst( substr($methodName, 7) ); if(strpos($methodName, 'resolve') === 0 && array_key_exists($attr, $this->_resolvedProperties)) { if($this->_resolvedProperties[$attr] !== null) { return $this->_resolvedProperties[$attr]; } else { return $this->getter($attr, $args); } } $attr = lcfirst( substr($methodName, 3) ); if(strpos($methodName, 'set') === 0 && array_key_exists($attr, $this->_resolvedProperties)) { if(!is_scalar($args[0])) { $args[0] = $args[0]['primaryKey']; parent::setter($attr, $args); } parent::setter($attr, $args); } return parent::__call($methodName, $args); } }