Merge pull request #9444 from nextcloud/techdep/noid/appframework_map…

…per_to_qb

Add a QueryBuilder based Mapper

lib/composer/composer/autoload_classmap.php

@@ -23,6 +23,7 @@
     'OCP\\AppFramework\\Db\\Entity' => $baseDir . '/lib/public/AppFramework/Db/Entity.php',
     'OCP\\AppFramework\\Db\\Mapper' => $baseDir . '/lib/public/AppFramework/Db/Mapper.php',
     'OCP\\AppFramework\\Db\\MultipleObjectsReturnedException' => $baseDir . '/lib/public/AppFramework/Db/MultipleObjectsReturnedException.php',
+    'OCP\\AppFramework\\Db\\QBMapper' => $baseDir . '/lib/public/AppFramework/Db/QBMapper.php',
     'OCP\\AppFramework\\Http' => $baseDir . '/lib/public/AppFramework/Http.php',
     'OCP\\AppFramework\\Http\\ContentSecurityPolicy' => $baseDir . '/lib/public/AppFramework/Http/ContentSecurityPolicy.php',
     'OCP\\AppFramework\\Http\\DataDisplayResponse' => $baseDir . '/lib/public/AppFramework/Http/DataDisplayResponse.php',

lib/composer/composer/autoload_static.php

@@ -53,6 +53,7 @@ class ComposerStaticInit53792487c5a8370acc0b06b1a864ff4c
         'OCP\\AppFramework\\Db\\Entity' => __DIR__ . '/../../..' . '/lib/public/AppFramework/Db/Entity.php',
         'OCP\\AppFramework\\Db\\Mapper' => __DIR__ . '/../../..' . '/lib/public/AppFramework/Db/Mapper.php',
         'OCP\\AppFramework\\Db\\MultipleObjectsReturnedException' => __DIR__ . '/../../..' . '/lib/public/AppFramework/Db/MultipleObjectsReturnedException.php',
+        'OCP\\AppFramework\\Db\\QBMapper' => __DIR__ . '/../../..' . '/lib/public/AppFramework/Db/QBMapper.php',
         'OCP\\AppFramework\\Http' => __DIR__ . '/../../..' . '/lib/public/AppFramework/Http.php',
         'OCP\\AppFramework\\Http\\ContentSecurityPolicy' => __DIR__ . '/../../..' . '/lib/public/AppFramework/Http/ContentSecurityPolicy.php',
         'OCP\\AppFramework\\Http\\DataDisplayResponse' => __DIR__ . '/../../..' . '/lib/public/AppFramework/Http/DataDisplayResponse.php',

lib/private/Authentication/Token/DefaultTokenMapper.php

@@ -30,11 +30,12 @@
 
 use OCP\AppFramework\Db\DoesNotExistException;
 use OCP\AppFramework\Db\Mapper;
+use OCP\AppFramework\Db\QBMapper;
 use OCP\DB\QueryBuilder\IQueryBuilder;
 use OCP\IDBConnection;
 use OCP\IUser;
 
-class DefaultTokenMapper extends Mapper {
+class DefaultTokenMapper extends QBMapper {
 
 	public function __construct(IDBConnection $db) {
 		parent::__construct($db, 'authtoken');

lib/public/AppFramework/Db/Mapper.php

@@ -34,6 +34,7 @@
  * Simple parent class for inheriting your data access layer from. This class
  * may be subject to change in the future
  * @since 7.0.0
+ * @deprecated 14.0.0 Move over to QBMapper
  */
 abstract class Mapper {
 
@@ -47,6 +48,7 @@ abstract class Mapper {
 	 * @param string $entityClass the name of the entity that the sql should be
 	 * mapped to queries without using sql
 	 * @since 7.0.0
+	 * @deprecated 14.0.0 Move over to QBMapper
 	 */
 	public function __construct(IDBConnection $db, $tableName, $entityClass=null){
 		$this->db = $db;
@@ -65,6 +67,7 @@ public function __construct(IDBConnection $db, $tableName, $entityClass=null){
 	/**
 	 * @return string the table name
 	 * @since 7.0.0
+	 * @deprecated 14.0.0 Move over to QBMapper
 	 */
 	public function getTableName(){
 		return $this->tableName;
@@ -76,6 +79,7 @@ public function getTableName(){
 	 * @param Entity $entity the entity that should be deleted
 	 * @return Entity the deleted entity
 	 * @since 7.0.0 - return value added in 8.1.0
+	 * @deprecated 14.0.0 Move over to QBMapper
 	 */
 	public function delete(Entity $entity){
 		$sql = 'DELETE FROM `' . $this->tableName . '` WHERE `id` = ?';
@@ -90,6 +94,7 @@ public function delete(Entity $entity){
 	 * @param Entity $entity the entity that should be created
 	 * @return Entity the saved entity with the set id
 	 * @since 7.0.0
+	 * @deprecated 14.0.0 Move over to QBMapper
 	 */
 	public function insert(Entity $entity){
 		// get updated fields to save, fields have to be set using a setter to
@@ -139,6 +144,7 @@ public function insert(Entity $entity){
 	 * @param Entity $entity the entity that should be created
 	 * @return Entity the saved entity with the set id
 	 * @since 7.0.0 - return value was added in 8.0.0
+	 * @deprecated 14.0.0 Move over to QBMapper
 	 */
 	public function update(Entity $entity){
 		// if entity wasn't changed it makes no sense to run a db query
@@ -195,6 +201,7 @@ public function update(Entity $entity){
 	 * @param array $array
 	 * @return bool true if associative
 	 * @since 8.1.0
+	 * @deprecated 14.0.0 Move over to QBMapper
 	 */
 	private function isAssocArray(array $array) {
 		return array_values($array) !== $array;
@@ -205,6 +212,7 @@ private function isAssocArray(array $array) {
 	 * @param $value
 	 * @return int PDO constant
 	 * @since 8.1.0
+	 * @deprecated 14.0.0 Move over to QBMapper
 	 */
 	private function getPDOType($value) {
 		switch (gettype($value)) {
@@ -226,6 +234,7 @@ private function getPDOType($value) {
 	 * @param int $offset from which row we want to start
 	 * @return \PDOStatement the database query result
 	 * @since 7.0.0
+	 * @deprecated 14.0.0 Move over to QBMapper
 	 */
 	protected function execute($sql, array $params=[], $limit=null, $offset=null){
 		$query = $this->db->prepare($sql, $limit, $offset);
@@ -249,7 +258,6 @@ protected function execute($sql, array $params=[], $limit=null, $offset=null){
 		return $query;
 	}
 
-
 	/**
 	 * Returns an db result and throws exceptions when there are more or less
 	 * results
@@ -262,6 +270,7 @@ protected function execute($sql, array $params=[], $limit=null, $offset=null){
 	 * @throws MultipleObjectsReturnedException if more than one item exist
 	 * @return array the result as row
 	 * @since 7.0.0
+	 * @deprecated 14.0.0 Move over to QBMapper
 	 */
 	protected function findOneQuery($sql, array $params=[], $limit=null, $offset=null){
 		$stmt = $this->execute($sql, $params, $limit, $offset);
@@ -297,6 +306,7 @@ protected function findOneQuery($sql, array $params=[], $limit=null, $offset=nul
 	 * @param int $offset from which row we want to start
 	 * @return string formatted error message string
 	 * @since 9.1.0
+	 * @deprecated 14.0.0 Move over to QBMapper
 	 */
 	private function buildDebugMessage($msg, $sql, array $params=[], $limit=null, $offset=null) {
 		return $msg .
@@ -313,6 +323,7 @@ private function buildDebugMessage($msg, $sql, array $params=[], $limit=null, $o
 	 * @param array $row the row which should be converted to an entity
 	 * @return Entity the entity
 	 * @since 7.0.0
+	 * @deprecated 14.0.0 Move over to QBMapper
 	 */
 	protected function mapRowToEntity($row) {
 		return call_user_func($this->entityClass .'::fromRow', $row);
@@ -327,6 +338,7 @@ protected function mapRowToEntity($row) {
 	 * @param int $offset from which row we want to start
 	 * @return array all fetched entities
 	 * @since 7.0.0
+	 * @deprecated 14.0.0 Move over to QBMapper
 	 */
 	protected function findEntities($sql, array $params=[], $limit=null, $offset=null) {
 		$stmt = $this->execute($sql, $params, $limit, $offset);
@@ -354,6 +366,7 @@ protected function findEntities($sql, array $params=[], $limit=null, $offset=nul
 	 * @throws MultipleObjectsReturnedException if more than one item exist
 	 * @return Entity the entity
 	 * @since 7.0.0
+	 * @deprecated 14.0.0 Move over to QBMapper
 	 */
 	protected function findEntity($sql, array $params=[], $limit=null, $offset=null){
 		return $this->mapRowToEntity($this->findOneQuery($sql, $params, $limit, $offset));