nextcloud / server

lib/public/AppFramework/Db/Entity.php

Indentation +234 added lines, -234 removed lines

@@ -34,238 +34,238 @@
  * @since 7.0.0
  */
 abstract class Entity {
-	public $id;
-
-	private $_updatedFields = [];
-	private $_fieldTypes = ['id' => 'integer'];
-
-
-	/**
-	 * Simple alternative constructor for building entities from a request
-	 * @param array $params the array which was obtained via $this->params('key')
-	 * in the controller
-	 * @return Entity
-	 * @since 7.0.0
-	 */
-	public static function fromParams(array $params) {
-		$instance = new static();
-
-		foreach ($params as $key => $value) {
-			$method = 'set' . ucfirst($key);
-			$instance->$method($value);
-		}
-
-		return $instance;
-	}
-
-
-	/**
-	 * Maps the keys of the row array to the attributes
-	 * @param array $row the row to map onto the entity
-	 * @since 7.0.0
-	 */
-	public static function fromRow(array $row) {
-		$instance = new static();
-
-		foreach ($row as $key => $value) {
-			$prop = ucfirst($instance->columnToProperty($key));
-			$setter = 'set' . $prop;
-			$instance->$setter($value);
-		}
-
-		$instance->resetUpdatedFields();
-
-		return $instance;
-	}
-
-
-	/**
-	 * @return array with attribute and type
-	 * @since 7.0.0
-	 */
-	public function getFieldTypes() {
-		return $this->_fieldTypes;
-	}
-
-
-	/**
-	 * Marks the entity as clean needed for setting the id after the insertion
-	 * @since 7.0.0
-	 */
-	public function resetUpdatedFields() {
-		$this->_updatedFields = [];
-	}
-
-	/**
-	 * Generic setter for properties
-	 * @since 7.0.0
-	 */
-	protected function setter($name, $args) {
-		// setters should only work for existing attributes
-		if (property_exists($this, $name)) {
-			if ($this->$name === $args[0]) {
-				return;
-			}
-			$this->markFieldUpdated($name);
-
-			// if type definition exists, cast to correct type
-			if ($args[0] !== null && array_key_exists($name, $this->_fieldTypes)) {
-				$type = $this->_fieldTypes[$name];
-				if ($type === 'blob') {
-					// (B)LOB is treated as string when we read from the DB
-					$type = 'string';
-				}
-				settype($args[0], $type);
-			}
-			$this->$name = $args[0];
-		} else {
-			throw new \BadFunctionCallException($name .
-				' is not a valid attribute');
-		}
-	}
-
-	/**
-	 * Generic getter for properties
-	 * @since 7.0.0
-	 */
-	protected function getter($name) {
-		// getters should only work for existing attributes
-		if (property_exists($this, $name)) {
-			return $this->$name;
-		} else {
-			throw new \BadFunctionCallException($name .
-				' is not a valid attribute');
-		}
-	}
-
-
-	/**
-	 * Each time a setter is called, push the part after set
-	 * into an array: for instance setId will save Id in the
-	 * updated fields array so it can be easily used to create the
-	 * getter method
-	 * @since 7.0.0
-	 */
-	public function __call($methodName, $args) {
-		if (strpos($methodName, 'set') === 0) {
-			$this->setter(lcfirst(substr($methodName, 3)), $args);
-		} elseif (strpos($methodName, 'get') === 0) {
-			return $this->getter(lcfirst(substr($methodName, 3)));
-		} elseif ($this->isGetterForBoolProperty($methodName)) {
-			return $this->getter(lcfirst(substr($methodName, 2)));
-		} else {
-			throw new \BadFunctionCallException($methodName .
-				' does not exist');
-		}
-	}
-
-	/**
-	 * @param string $methodName
-	 * @return bool
-	 * @since 18.0.0
-	 */
-	protected function isGetterForBoolProperty(string $methodName): bool {
-		if (strpos($methodName, 'is') === 0) {
-			$fieldName = lcfirst(substr($methodName, 2));
-			return isset($this->_fieldTypes[$fieldName]) && strpos($this->_fieldTypes[$fieldName], 'bool') === 0;
-		}
-		return false;
-	}
-
-	/**
-	 * Mark am attribute as updated
-	 * @param string $attribute the name of the attribute
-	 * @since 7.0.0
-	 */
-	protected function markFieldUpdated($attribute) {
-		$this->_updatedFields[$attribute] = true;
-	}
-
-
-	/**
-	 * Transform a database columnname to a property
-	 * @param string $columnName the name of the column
-	 * @return string the property name
-	 * @since 7.0.0
-	 */
-	public function columnToProperty($columnName) {
-		$parts = explode('_', $columnName);
-		$property = null;
-
-		foreach ($parts as $part) {
-			if ($property === null) {
-				$property = $part;
-			} else {
-				$property .= ucfirst($part);
-			}
-		}
-
-		return $property;
-	}
-
-
-	/**
-	 * Transform a property to a database column name
-	 * @param string $property the name of the property
-	 * @return string the column name
-	 * @since 7.0.0
-	 */
-	public function propertyToColumn($property) {
-		$parts = preg_split('/(?=[A-Z])/', $property);
-		$column = null;
-
-		foreach ($parts as $part) {
-			if ($column === null) {
-				$column = $part;
-			} else {
-				$column .= '_' . lcfirst($part);
-			}
-		}
-
-		return $column;
-	}
-
-
-	/**
-	 * @return array array of updated fields for update query
-	 * @since 7.0.0
-	 */
-	public function getUpdatedFields() {
-		return $this->_updatedFields;
-	}
-
-
-	/**
-	 * Adds type information for a field so that its automatically casted to
-	 * that value once its being returned from the database
-	 * @param string $fieldName the name of the attribute
-	 * @param string $type the type which will be used to call settype()
-	 * @since 7.0.0
-	 */
-	protected function addType($fieldName, $type) {
-		$this->_fieldTypes[$fieldName] = $type;
-	}
-
-
-	/**
-	 * Slugify the value of a given attribute
-	 * Warning: This doesn't result in a unique value
-	 * @param string $attributeName the name of the attribute, which value should be slugified
-	 * @return string slugified value
-	 * @since 7.0.0
-	 */
-	public function slugify($attributeName) {
-		// toSlug should only work for existing attributes
-		if (property_exists($this, $attributeName)) {
-			$value = $this->$attributeName;
-			// replace everything except alphanumeric with a single '-'
-			$value = preg_replace('/[^A-Za-z0-9]+/', '-', $value);
-			$value = strtolower($value);
-			// trim '-'
-			return trim($value, '-');
-		} else {
-			throw new \BadFunctionCallException($attributeName .
-				' is not a valid attribute');
-		}
-	}
+    public $id;
+
+    private $_updatedFields = [];
+    private $_fieldTypes = ['id' => 'integer'];
+
+
+    /**
+     * Simple alternative constructor for building entities from a request
+     * @param array $params the array which was obtained via $this->params('key')
+     * in the controller
+     * @return Entity
+     * @since 7.0.0
+     */
+    public static function fromParams(array $params) {
+        $instance = new static();
+
+        foreach ($params as $key => $value) {
+            $method = 'set' . ucfirst($key);
+            $instance->$method($value);
+        }
+
+        return $instance;
+    }
+
+
+    /**
+     * Maps the keys of the row array to the attributes
+     * @param array $row the row to map onto the entity
+     * @since 7.0.0
+     */
+    public static function fromRow(array $row) {
+        $instance = new static();
+
+        foreach ($row as $key => $value) {
+            $prop = ucfirst($instance->columnToProperty($key));
+            $setter = 'set' . $prop;
+            $instance->$setter($value);
+        }
+
+        $instance->resetUpdatedFields();
+
+        return $instance;
+    }
+
+
+    /**
+     * @return array with attribute and type
+     * @since 7.0.0
+     */
+    public function getFieldTypes() {
+        return $this->_fieldTypes;
+    }
+
+
+    /**
+     * Marks the entity as clean needed for setting the id after the insertion
+     * @since 7.0.0
+     */
+    public function resetUpdatedFields() {
+        $this->_updatedFields = [];
+    }
+
+    /**
+     * Generic setter for properties
+     * @since 7.0.0
+     */
+    protected function setter($name, $args) {
+        // setters should only work for existing attributes
+        if (property_exists($this, $name)) {
+            if ($this->$name === $args[0]) {
+                return;
+            }
+            $this->markFieldUpdated($name);
+
+            // if type definition exists, cast to correct type
+            if ($args[0] !== null && array_key_exists($name, $this->_fieldTypes)) {
+                $type = $this->_fieldTypes[$name];
+                if ($type === 'blob') {
+                    // (B)LOB is treated as string when we read from the DB
+                    $type = 'string';
+                }
+                settype($args[0], $type);
+            }
+            $this->$name = $args[0];
+        } else {
+            throw new \BadFunctionCallException($name .
+                ' is not a valid attribute');
+        }
+    }
+
+    /**
+     * Generic getter for properties
+     * @since 7.0.0
+     */
+    protected function getter($name) {
+        // getters should only work for existing attributes
+        if (property_exists($this, $name)) {
+            return $this->$name;
+        } else {
+            throw new \BadFunctionCallException($name .
+                ' is not a valid attribute');
+        }
+    }
+
+
+    /**
+     * Each time a setter is called, push the part after set
+     * into an array: for instance setId will save Id in the
+     * updated fields array so it can be easily used to create the
+     * getter method
+     * @since 7.0.0
+     */
+    public function __call($methodName, $args) {
+        if (strpos($methodName, 'set') === 0) {
+            $this->setter(lcfirst(substr($methodName, 3)), $args);
+        } elseif (strpos($methodName, 'get') === 0) {
+            return $this->getter(lcfirst(substr($methodName, 3)));
+        } elseif ($this->isGetterForBoolProperty($methodName)) {
+            return $this->getter(lcfirst(substr($methodName, 2)));
+        } else {
+            throw new \BadFunctionCallException($methodName .
+                ' does not exist');
+        }
+    }
+
+    /**
+     * @param string $methodName
+     * @return bool
+     * @since 18.0.0
+     */
+    protected function isGetterForBoolProperty(string $methodName): bool {
+        if (strpos($methodName, 'is') === 0) {
+            $fieldName = lcfirst(substr($methodName, 2));
+            return isset($this->_fieldTypes[$fieldName]) && strpos($this->_fieldTypes[$fieldName], 'bool') === 0;
+        }
+        return false;
+    }
+
+    /**
+     * Mark am attribute as updated
+     * @param string $attribute the name of the attribute
+     * @since 7.0.0
+     */
+    protected function markFieldUpdated($attribute) {
+        $this->_updatedFields[$attribute] = true;
+    }
+
+
+    /**
+     * Transform a database columnname to a property
+     * @param string $columnName the name of the column
+     * @return string the property name
+     * @since 7.0.0
+     */
+    public function columnToProperty($columnName) {
+        $parts = explode('_', $columnName);
+        $property = null;
+
+        foreach ($parts as $part) {
+            if ($property === null) {
+                $property = $part;
+            } else {
+                $property .= ucfirst($part);
+            }
+        }
+
+        return $property;
+    }
+
+
+    /**
+     * Transform a property to a database column name
+     * @param string $property the name of the property
+     * @return string the column name
+     * @since 7.0.0
+     */
+    public function propertyToColumn($property) {
+        $parts = preg_split('/(?=[A-Z])/', $property);
+        $column = null;
+
+        foreach ($parts as $part) {
+            if ($column === null) {
+                $column = $part;
+            } else {
+                $column .= '_' . lcfirst($part);
+            }
+        }
+
+        return $column;
+    }
+
+
+    /**
+     * @return array array of updated fields for update query
+     * @since 7.0.0
+     */
+    public function getUpdatedFields() {
+        return $this->_updatedFields;
+    }
+
+
+    /**
+     * Adds type information for a field so that its automatically casted to
+     * that value once its being returned from the database
+     * @param string $fieldName the name of the attribute
+     * @param string $type the type which will be used to call settype()
+     * @since 7.0.0
+     */
+    protected function addType($fieldName, $type) {
+        $this->_fieldTypes[$fieldName] = $type;
+    }
+
+
+    /**
+     * Slugify the value of a given attribute
+     * Warning: This doesn't result in a unique value
+     * @param string $attributeName the name of the attribute, which value should be slugified
+     * @return string slugified value
+     * @since 7.0.0
+     */
+    public function slugify($attributeName) {
+        // toSlug should only work for existing attributes
+        if (property_exists($this, $attributeName)) {
+            $value = $this->$attributeName;
+            // replace everything except alphanumeric with a single '-'
+            $value = preg_replace('/[^A-Za-z0-9]+/', '-', $value);
+            $value = strtolower($value);
+            // trim '-'
+            return trim($value, '-');
+        } else {
+            throw new \BadFunctionCallException($attributeName .
+                ' is not a valid attribute');
+        }
+    }
 }

lib/public/AppFramework/Db/QBMapper.php

Indentation +291 added lines, -291 removed lines

@@ -42,295 +42,295 @@
  */
 abstract class QBMapper {
 
-	/** @var string */
-	protected $tableName;
-
-	/** @var string */
-	protected $entityClass;
-
-	/** @var IDBConnection */
-	protected $db;
-
-	/**
-	 * @param IDBConnection $db Instance of the Db abstraction layer
-	 * @param string $tableName the name of the table. set this to allow entity
-	 * @param string $entityClass the name of the entity that the sql should be
-	 * mapped to queries without using sql
-	 * @since 14.0.0
-	 */
-	public function __construct(IDBConnection $db, string $tableName, string $entityClass=null) {
-		$this->db = $db;
-		$this->tableName = $tableName;
-
-		// if not given set the entity name to the class without the mapper part
-		// cache it here for later use since reflection is slow
-		if ($entityClass === null) {
-			$this->entityClass = str_replace('Mapper', '', \get_class($this));
-		} else {
-			$this->entityClass = $entityClass;
-		}
-	}
-
-
-	/**
-	 * @return string the table name
-	 * @since 14.0.0
-	 */
-	public function getTableName(): string {
-		return $this->tableName;
-	}
-
-
-	/**
-	 * Deletes an entity from the table
-	 * @param Entity $entity the entity that should be deleted
-	 * @return Entity the deleted entity
-	 * @since 14.0.0
-	 */
-	public function delete(Entity $entity): Entity {
-		$qb = $this->db->getQueryBuilder();
-
-		$idType = $this->getParameterTypeForProperty($entity, 'id');
-
-		$qb->delete($this->tableName)
-			->where(
-				$qb->expr()->eq('id', $qb->createNamedParameter($entity->getId(), $idType))
-			);
-		$qb->execute();
-		return $entity;
-	}
-
-
-	/**
-	 * Creates a new entry in the db from an entity
-	 * @param Entity $entity the entity that should be created
-	 * @return Entity the saved entity with the set id
-	 * @since 14.0.0
-	 * @suppress SqlInjectionChecker
-	 */
-	public function insert(Entity $entity): Entity {
-		// get updated fields to save, fields have to be set using a setter to
-		// be saved
-		$properties = $entity->getUpdatedFields();
-
-		$qb = $this->db->getQueryBuilder();
-		$qb->insert($this->tableName);
-
-		// build the fields
-		foreach ($properties as $property => $updated) {
-			$column = $entity->propertyToColumn($property);
-			$getter = 'get' . ucfirst($property);
-			$value = $entity->$getter();
-
-			$type = $this->getParameterTypeForProperty($entity, $property);
-			$qb->setValue($column, $qb->createNamedParameter($value, $type));
-		}
-
-		$qb->execute();
-
-		if ($entity->id === null) {
-			// When autoincrement is used id is always an int
-			$entity->setId((int)$qb->getLastInsertId());
-		}
-
-		return $entity;
-	}
-
-	/**
-	 * Tries to creates a new entry in the db from an entity and
-	 * updates an existing entry if duplicate keys are detected
-	 * by the database
-	 *
-	 * @param Entity $entity the entity that should be created/updated
-	 * @return Entity the saved entity with the (new) id
-	 * @throws \InvalidArgumentException if entity has no id
-	 * @since 15.0.0
-	 * @suppress SqlInjectionChecker
-	 */
-	public function insertOrUpdate(Entity $entity): Entity {
-		try {
-			return $this->insert($entity);
-		} catch (UniqueConstraintViolationException $ex) {
-			return $this->update($entity);
-		}
-	}
-
-	/**
-	 * Updates an entry in the db from an entity
-	 * @throws \InvalidArgumentException if entity has no id
-	 * @param Entity $entity the entity that should be created
-	 * @return Entity the saved entity with the set id
-	 * @since 14.0.0
-	 * @suppress SqlInjectionChecker
-	 */
-	public function update(Entity $entity): Entity {
-		// if entity wasn't changed it makes no sense to run a db query
-		$properties = $entity->getUpdatedFields();
-		if (\count($properties) === 0) {
-			return $entity;
-		}
-
-		// entity needs an id
-		$id = $entity->getId();
-		if ($id === null) {
-			throw new \InvalidArgumentException(
-				'Entity which should be updated has no id');
-		}
-
-		// get updated fields to save, fields have to be set using a setter to
-		// be saved
-		// do not update the id field
-		unset($properties['id']);
-
-		$qb = $this->db->getQueryBuilder();
-		$qb->update($this->tableName);
-
-		// build the fields
-		foreach ($properties as $property => $updated) {
-			$column = $entity->propertyToColumn($property);
-			$getter = 'get' . ucfirst($property);
-			$value = $entity->$getter();
-
-			$type = $this->getParameterTypeForProperty($entity, $property);
-			$qb->set($column, $qb->createNamedParameter($value, $type));
-		}
-
-		$idType = $this->getParameterTypeForProperty($entity, 'id');
-
-		$qb->where(
-			$qb->expr()->eq('id', $qb->createNamedParameter($id, $idType))
-		);
-		$qb->execute();
-
-		return $entity;
-	}
-
-	/**
-	 * Returns the type parameter for the QueryBuilder for a specific property
-	 * of the $entity
-	 *
-	 * @param Entity $entity   The entity to get the types from
-	 * @param string $property The property of $entity to get the type for
-	 * @return int
-	 * @since 16.0.0
-	 */
-	protected function getParameterTypeForProperty(Entity $entity, string $property): int {
-		$types = $entity->getFieldTypes();
-
-		if (!isset($types[ $property ])) {
-			return IQueryBuilder::PARAM_STR;
-		}
-
-		switch ($types[ $property ]) {
-			case 'int':
-			case 'integer':
-				return IQueryBuilder::PARAM_INT;
-			case 'string':
-				return IQueryBuilder::PARAM_STR;
-			case 'bool':
-			case 'boolean':
-				return IQueryBuilder::PARAM_BOOL;
-			case 'blob':
-				return IQueryBuilder::PARAM_LOB;
-		}
-
-		return IQueryBuilder::PARAM_STR;
-	}
-
-	/**
-	 * Returns an db result and throws exceptions when there are more or less
-	 * results
-	 *
-	 * @see findEntity
-	 *
-	 * @param IQueryBuilder $query
-	 * @throws DoesNotExistException if the item does not exist
-	 * @throws MultipleObjectsReturnedException if more than one item exist
-	 * @return array the result as row
-	 * @since 14.0.0
-	 */
-	protected function findOneQuery(IQueryBuilder $query): array {
-		$cursor = $query->execute();
-
-		$row = $cursor->fetch();
-		if ($row === false) {
-			$cursor->closeCursor();
-			$msg = $this->buildDebugMessage(
-				'Did expect one result but found none when executing', $query
-			);
-			throw new DoesNotExistException($msg);
-		}
-
-		$row2 = $cursor->fetch();
-		$cursor->closeCursor();
-		if ($row2 !== false) {
-			$msg = $this->buildDebugMessage(
-				'Did not expect more than one result when executing', $query
-			);
-			throw new MultipleObjectsReturnedException($msg);
-		}
-
-		return $row;
-	}
-
-	/**
-	 * @param string $msg
-	 * @param IQueryBuilder $sql
-	 * @return string
-	 * @since 14.0.0
-	 */
-	private function buildDebugMessage(string $msg, IQueryBuilder $sql): string {
-		return $msg .
-			': query "' . $sql->getSQL() . '"; ';
-	}
-
-
-	/**
-	 * Creates an entity from a row. Automatically determines the entity class
-	 * from the current mapper name (MyEntityMapper -> MyEntity)
-	 *
-	 * @param array $row the row which should be converted to an entity
-	 * @return Entity the entity
-	 * @since 14.0.0
-	 */
-	protected function mapRowToEntity(array $row): Entity {
-		return \call_user_func($this->entityClass .'::fromRow', $row);
-	}
-
-
-	/**
-	 * Runs a sql query and returns an array of entities
-	 *
-	 * @param IQueryBuilder $query
-	 * @return Entity[] all fetched entities
-	 * @since 14.0.0
-	 */
-	protected function findEntities(IQueryBuilder $query): array {
-		$cursor = $query->execute();
-
-		$entities = [];
-
-		while ($row = $cursor->fetch()) {
-			$entities[] = $this->mapRowToEntity($row);
-		}
-
-		$cursor->closeCursor();
-
-		return $entities;
-	}
-
-
-	/**
-	 * Returns an db result and throws exceptions when there are more or less
-	 * results
-	 *
-	 * @param IQueryBuilder $query
-	 * @throws DoesNotExistException if the item does not exist
-	 * @throws MultipleObjectsReturnedException if more than one item exist
-	 * @return Entity the entity
-	 * @since 14.0.0
-	 */
-	protected function findEntity(IQueryBuilder $query): Entity {
-		return $this->mapRowToEntity($this->findOneQuery($query));
-	}
+    /** @var string */
+    protected $tableName;
+
+    /** @var string */
+    protected $entityClass;
+
+    /** @var IDBConnection */
+    protected $db;
+
+    /**
+     * @param IDBConnection $db Instance of the Db abstraction layer
+     * @param string $tableName the name of the table. set this to allow entity
+     * @param string $entityClass the name of the entity that the sql should be
+     * mapped to queries without using sql
+     * @since 14.0.0
+     */
+    public function __construct(IDBConnection $db, string $tableName, string $entityClass=null) {
+        $this->db = $db;
+        $this->tableName = $tableName;
+
+        // if not given set the entity name to the class without the mapper part
+        // cache it here for later use since reflection is slow
+        if ($entityClass === null) {
+            $this->entityClass = str_replace('Mapper', '', \get_class($this));
+        } else {
+            $this->entityClass = $entityClass;
+        }
+    }
+
+
+    /**
+     * @return string the table name
+     * @since 14.0.0
+     */
+    public function getTableName(): string {
+        return $this->tableName;
+    }
+
+
+    /**
+     * Deletes an entity from the table
+     * @param Entity $entity the entity that should be deleted
+     * @return Entity the deleted entity
+     * @since 14.0.0
+     */
+    public function delete(Entity $entity): Entity {
+        $qb = $this->db->getQueryBuilder();
+
+        $idType = $this->getParameterTypeForProperty($entity, 'id');
+
+        $qb->delete($this->tableName)
+            ->where(
+                $qb->expr()->eq('id', $qb->createNamedParameter($entity->getId(), $idType))
+            );
+        $qb->execute();
+        return $entity;
+    }
+
+
+    /**
+     * Creates a new entry in the db from an entity
+     * @param Entity $entity the entity that should be created
+     * @return Entity the saved entity with the set id
+     * @since 14.0.0
+     * @suppress SqlInjectionChecker
+     */
+    public function insert(Entity $entity): Entity {
+        // get updated fields to save, fields have to be set using a setter to
+        // be saved
+        $properties = $entity->getUpdatedFields();
+
+        $qb = $this->db->getQueryBuilder();
+        $qb->insert($this->tableName);
+
+        // build the fields
+        foreach ($properties as $property => $updated) {
+            $column = $entity->propertyToColumn($property);
+            $getter = 'get' . ucfirst($property);
+            $value = $entity->$getter();
+
+            $type = $this->getParameterTypeForProperty($entity, $property);
+            $qb->setValue($column, $qb->createNamedParameter($value, $type));
+        }
+
+        $qb->execute();
+
+        if ($entity->id === null) {
+            // When autoincrement is used id is always an int
+            $entity->setId((int)$qb->getLastInsertId());
+        }
+
+        return $entity;
+    }
+
+    /**
+     * Tries to creates a new entry in the db from an entity and
+     * updates an existing entry if duplicate keys are detected
+     * by the database
+     *
+     * @param Entity $entity the entity that should be created/updated
+     * @return Entity the saved entity with the (new) id
+     * @throws \InvalidArgumentException if entity has no id
+     * @since 15.0.0
+     * @suppress SqlInjectionChecker
+     */
+    public function insertOrUpdate(Entity $entity): Entity {
+        try {
+            return $this->insert($entity);
+        } catch (UniqueConstraintViolationException $ex) {
+            return $this->update($entity);
+        }
+    }
+
+    /**
+     * Updates an entry in the db from an entity
+     * @throws \InvalidArgumentException if entity has no id
+     * @param Entity $entity the entity that should be created
+     * @return Entity the saved entity with the set id
+     * @since 14.0.0
+     * @suppress SqlInjectionChecker
+     */
+    public function update(Entity $entity): Entity {
+        // if entity wasn't changed it makes no sense to run a db query
+        $properties = $entity->getUpdatedFields();
+        if (\count($properties) === 0) {
+            return $entity;
+        }
+
+        // entity needs an id
+        $id = $entity->getId();
+        if ($id === null) {
+            throw new \InvalidArgumentException(
+                'Entity which should be updated has no id');
+        }
+
+        // get updated fields to save, fields have to be set using a setter to
+        // be saved
+        // do not update the id field
+        unset($properties['id']);
+
+        $qb = $this->db->getQueryBuilder();
+        $qb->update($this->tableName);
+
+        // build the fields
+        foreach ($properties as $property => $updated) {
+            $column = $entity->propertyToColumn($property);
+            $getter = 'get' . ucfirst($property);
+            $value = $entity->$getter();
+
+            $type = $this->getParameterTypeForProperty($entity, $property);
+            $qb->set($column, $qb->createNamedParameter($value, $type));
+        }
+
+        $idType = $this->getParameterTypeForProperty($entity, 'id');
+
+        $qb->where(
+            $qb->expr()->eq('id', $qb->createNamedParameter($id, $idType))
+        );
+        $qb->execute();
+
+        return $entity;
+    }
+
+    /**
+     * Returns the type parameter for the QueryBuilder for a specific property
+     * of the $entity
+     *
+     * @param Entity $entity   The entity to get the types from
+     * @param string $property The property of $entity to get the type for
+     * @return int
+     * @since 16.0.0
+     */
+    protected function getParameterTypeForProperty(Entity $entity, string $property): int {
+        $types = $entity->getFieldTypes();
+
+        if (!isset($types[ $property ])) {
+            return IQueryBuilder::PARAM_STR;
+        }
+
+        switch ($types[ $property ]) {
+            case 'int':
+            case 'integer':
+                return IQueryBuilder::PARAM_INT;
+            case 'string':
+                return IQueryBuilder::PARAM_STR;
+            case 'bool':
+            case 'boolean':
+                return IQueryBuilder::PARAM_BOOL;
+            case 'blob':
+                return IQueryBuilder::PARAM_LOB;
+        }
+
+        return IQueryBuilder::PARAM_STR;
+    }
+
+    /**
+     * Returns an db result and throws exceptions when there are more or less
+     * results
+     *
+     * @see findEntity
+     *
+     * @param IQueryBuilder $query
+     * @throws DoesNotExistException if the item does not exist
+     * @throws MultipleObjectsReturnedException if more than one item exist
+     * @return array the result as row
+     * @since 14.0.0
+     */
+    protected function findOneQuery(IQueryBuilder $query): array {
+        $cursor = $query->execute();
+
+        $row = $cursor->fetch();
+        if ($row === false) {
+            $cursor->closeCursor();
+            $msg = $this->buildDebugMessage(
+                'Did expect one result but found none when executing', $query
+            );
+            throw new DoesNotExistException($msg);
+        }
+
+        $row2 = $cursor->fetch();
+        $cursor->closeCursor();
+        if ($row2 !== false) {
+            $msg = $this->buildDebugMessage(
+                'Did not expect more than one result when executing', $query
+            );
+            throw new MultipleObjectsReturnedException($msg);
+        }
+
+        return $row;
+    }
+
+    /**
+     * @param string $msg
+     * @param IQueryBuilder $sql
+     * @return string
+     * @since 14.0.0
+     */
+    private function buildDebugMessage(string $msg, IQueryBuilder $sql): string {
+        return $msg .
+            ': query "' . $sql->getSQL() . '"; ';
+    }
+
+
+    /**
+     * Creates an entity from a row. Automatically determines the entity class
+     * from the current mapper name (MyEntityMapper -> MyEntity)
+     *
+     * @param array $row the row which should be converted to an entity
+     * @return Entity the entity
+     * @since 14.0.0
+     */
+    protected function mapRowToEntity(array $row): Entity {
+        return \call_user_func($this->entityClass .'::fromRow', $row);
+    }
+
+
+    /**
+     * Runs a sql query and returns an array of entities
+     *
+     * @param IQueryBuilder $query
+     * @return Entity[] all fetched entities
+     * @since 14.0.0
+     */
+    protected function findEntities(IQueryBuilder $query): array {
+        $cursor = $query->execute();
+
+        $entities = [];
+
+        while ($row = $cursor->fetch()) {
+            $entities[] = $this->mapRowToEntity($row);
+        }
+
+        $cursor->closeCursor();
+
+        return $entities;
+    }
+
+
+    /**
+     * Returns an db result and throws exceptions when there are more or less
+     * results
+     *
+     * @param IQueryBuilder $query
+     * @throws DoesNotExistException if the item does not exist
+     * @throws MultipleObjectsReturnedException if more than one item exist
+     * @return Entity the entity
+     * @since 14.0.0
+     */
+    protected function findEntity(IQueryBuilder $query): Entity {
+        return $this->mapRowToEntity($this->findOneQuery($query));
+    }
 }

apps/contactsinteraction/lib/Db/RecentContact.php

Indentation +20 added lines, -20 removed lines

@@ -43,30 +43,30 @@
  */
 class RecentContact extends Entity {
 
-	/** @var string */
-	protected $actorUid;
+    /** @var string */
+    protected $actorUid;
 
-	/** @var string|null */
-	protected $uid;
+    /** @var string|null */
+    protected $uid;
 
-	/** @var string|null */
-	protected $email;
+    /** @var string|null */
+    protected $email;
 
-	/** @var string|null */
-	protected $federatedCloudId;
+    /** @var string|null */
+    protected $federatedCloudId;
 
-	/** @var string */
-	protected $card;
+    /** @var string */
+    protected $card;
 
-	/** @var int */
-	protected $lastContact;
+    /** @var int */
+    protected $lastContact;
 
-	public function __construct() {
-		$this->addType('actorUid', 'string');
-		$this->addType('uid', 'string');
-		$this->addType('email', 'string');
-		$this->addType('federatedCloudId', 'string');
-		$this->addType('card', 'blob');
-		$this->addType('lastContact', 'int');
-	}
+    public function __construct() {
+        $this->addType('actorUid', 'string');
+        $this->addType('uid', 'string');
+        $this->addType('email', 'string');
+        $this->addType('federatedCloudId', 'string');
+        $this->addType('card', 'blob');
+        $this->addType('lastContact', 'int');
+    }
 }