nextcloud / server

lib/public/AppFramework/OCS/OCSForbiddenException.php

Indentation +10 added lines, -11 removed lines

@@ -1,6 +1,5 @@ 
 <?php
 /**
-
  *
  * @author Roeland Jago Douma <roeland@famdouma.nl>
  *
@@ -32,14 +31,14 @@ 
  * @since 9.1.0
  */
 class OCSForbiddenException extends OCSException {
-	/**
-	 * OCSForbiddenException constructor.
-	 *
-	 * @param string $message
-	 * @param Exception|null $previous
-	 * @since 9.1.0
-	 */
-	public function __construct($message = '', Exception $previous = null) {
-		parent::__construct($message, Http::STATUS_FORBIDDEN, $previous);
-	}
+    /**
+     * OCSForbiddenException constructor.
+     *
+     * @param string $message
+     * @param Exception|null $previous
+     * @since 9.1.0
+     */
+    public function __construct($message = '', Exception $previous = null) {
+        parent::__construct($message, Http::STATUS_FORBIDDEN, $previous);
+    }
 }

lib/public/AppFramework/OCS/OCSBadRequestException.php

Indentation +10 added lines, -11 removed lines

@@ -1,6 +1,5 @@ 
 <?php
 /**
-
  *
  * @author Roeland Jago Douma <roeland@famdouma.nl>
  *
@@ -32,15 +31,15 @@ 
  * @since 9.1.0
  */
 class OCSBadRequestException extends OCSException {
-	/**
-	 * OCSBadRequestException constructor.
-	 *
-	 * @param string $message
-	 * @param Exception|null $previous
-	 * @since 9.1.0
-	 */
-	public function __construct($message = '', Exception $previous = null) {
-		parent::__construct($message, Http::STATUS_BAD_REQUEST, $previous);
-	}
+    /**
+     * OCSBadRequestException constructor.
+     *
+     * @param string $message
+     * @param Exception|null $previous
+     * @since 9.1.0
+     */
+    public function __construct($message = '', Exception $previous = null) {
+        parent::__construct($message, Http::STATUS_BAD_REQUEST, $previous);
+    }
 
 }

lib/public/AppFramework/OCS/OCSNotFoundException.php

Indentation +10 added lines, -11 removed lines

@@ -1,6 +1,5 @@ 
 <?php
 /**
-
  *
  * @author Roeland Jago Douma <roeland@famdouma.nl>
  *
@@ -32,14 +31,14 @@ 
  * @since 9.1.0
  */
 class OCSNotFoundException extends OCSException {
-	/**
-	 * OCSNotFoundException constructor.
-	 *
-	 * @param string $message
-	 * @param Exception|null $previous
-	 * @since 9.1.0
-	 */
-	public function __construct($message = '', Exception $previous = null) {
-		parent::__construct($message, Http::STATUS_NOT_FOUND, $previous);
-	}
+    /**
+     * OCSNotFoundException constructor.
+     *
+     * @param string $message
+     * @param Exception|null $previous
+     * @since 9.1.0
+     */
+    public function __construct($message = '', Exception $previous = null) {
+        parent::__construct($message, Http::STATUS_NOT_FOUND, $previous);
+    }
 }

lib/public/AppFramework/OCS/OCSException.php

Indentation -1 removed lines

@@ -1,6 +1,5 @@
 <?php
 /**
-
  *
  * @author Roeland Jago Douma <roeland@famdouma.nl>
  *

lib/public/AppFramework/Controller.php

Indentation +213 added lines, -213 removed lines

@@ -45,219 +45,219 @@
  */
 abstract class Controller {
 
-	/**
-	 * app name
-	 * @var string
-	 * @since 7.0.0
-	 */
-	protected $appName;
-
-	/**
-	 * current request
-	 * @var \OCP\IRequest
-	 * @since 6.0.0
-	 */
-	protected $request;
-
-	/**
-	 * @var array
-	 * @since 7.0.0
-	 */
-	private $responders;
-
-	/**
-	 * constructor of the controller
-	 * @param string $appName the name of the app
-	 * @param IRequest $request an instance of the request
-	 * @since 6.0.0 - parameter $appName was added in 7.0.0 - parameter $app was removed in 7.0.0
-	 */
-	public function __construct($appName,
-	                            IRequest $request) {
-		$this->appName = $appName;
-		$this->request = $request;
-
-		// default responders
-		$this->responders = array(
-			'json' => function ($data) {
-				if ($data instanceof DataResponse) {
-					$response = new JSONResponse(
-						$data->getData(),
-						$data->getStatus()
-					);
-					$dataHeaders = $data->getHeaders();
-					$headers = $response->getHeaders();
-					// do not overwrite Content-Type if it already exists
-					if (isset($dataHeaders['Content-Type'])) {
-						unset($headers['Content-Type']);
-					}
-					$response->setHeaders(array_merge($dataHeaders, $headers));
-					return $response;
-				}
-				return new JSONResponse($data);
-			}
-		);
-	}
-
-
-	/**
-	 * Parses an HTTP accept header and returns the supported responder type
-	 * @param string $acceptHeader
-	 * @return string the responder type
-	 * @since 7.0.0
-	 * @since 9.1.0 Added default parameter
-	 */
-	public function getResponderByHTTPHeader($acceptHeader, $default='json') {
-		$headers = explode(',', $acceptHeader);
-
-		// return the first matching responder
-		foreach ($headers as $header) {
-			$header = strtolower(trim($header));
-
-			$responder = str_replace('application/', '', $header);
-
-			if (array_key_exists($responder, $this->responders)) {
-				return $responder;
-			}
-		}
-
-		// no matching header return default
-		return $default;
-	}
-
-
-	/**
-	 * Registers a formatter for a type
-	 * @param string $format
-	 * @param \Closure $responder
-	 * @since 7.0.0
-	 */
-	protected function registerResponder($format, \Closure $responder) {
-		$this->responders[$format] = $responder;
-	}
-
-
-	/**
-	 * Serializes and formats a response
-	 * @param mixed $response the value that was returned from a controller and
-	 * is not a Response instance
-	 * @param string $format the format for which a formatter has been registered
-	 * @throws \DomainException if format does not match a registered formatter
-	 * @return Response
-	 * @since 7.0.0
-	 */
-	public function buildResponse($response, $format='json') {
-		if(array_key_exists($format, $this->responders)) {
-
-			$responder = $this->responders[$format];
-
-			return $responder($response);
-
-		}
-		throw new \DomainException('No responder registered for format '.
-			$format . '!');
-	}
-
-
-	/**
-	 * Lets you access post and get parameters by the index
-	 * @deprecated 7.0.0 write your parameters as method arguments instead
-	 * @param string $key the key which you want to access in the URL Parameter
-	 *                     placeholder, $_POST or $_GET array.
-	 *                     The priority how they're returned is the following:
-	 *                     1. URL parameters
-	 *                     2. POST parameters
-	 *                     3. GET parameters
-	 * @param string $default If the key is not found, this value will be returned
-	 * @return mixed the content of the array
-	 * @since 6.0.0
-	 */
-	public function params($key, $default=null){
-		return $this->request->getParam($key, $default);
-	}
-
-
-	/**
-	 * Returns all params that were received, be it from the request
-	 * (as GET or POST) or through the URL by the route
-	 * @deprecated 7.0.0 use $this->request instead
-	 * @return array the array with all parameters
-	 * @since 6.0.0
-	 */
-	public function getParams() {
-		return $this->request->getParams();
-	}
-
-
-	/**
-	 * Returns the method of the request
-	 * @deprecated 7.0.0 use $this->request instead
-	 * @return string the method of the request (POST, GET, etc)
-	 * @since 6.0.0
-	 */
-	public function method() {
-		return $this->request->getMethod();
-	}
-
-
-	/**
-	 * Shortcut for accessing an uploaded file through the $_FILES array
-	 * @deprecated 7.0.0 use $this->request instead
-	 * @param string $key the key that will be taken from the $_FILES array
-	 * @return array the file in the $_FILES element
-	 * @since 6.0.0
-	 */
-	public function getUploadedFile($key) {
-		return $this->request->getUploadedFile($key);
-	}
-
-
-	/**
-	 * Shortcut for getting env variables
-	 * @deprecated 7.0.0 use $this->request instead
-	 * @param string $key the key that will be taken from the $_ENV array
-	 * @return array the value in the $_ENV element
-	 * @since 6.0.0
-	 */
-	public function env($key) {
-		return $this->request->getEnv($key);
-	}
-
-
-	/**
-	 * Shortcut for getting cookie variables
-	 * @deprecated 7.0.0 use $this->request instead
-	 * @param string $key the key that will be taken from the $_COOKIE array
-	 * @return array the value in the $_COOKIE element
-	 * @since 6.0.0
-	 */
-	public function cookie($key) {
-		return $this->request->getCookie($key);
-	}
-
-
-	/**
-	 * Shortcut for rendering a template
-	 * @deprecated 7.0.0 return a template response instead
-	 * @param string $templateName the name of the template
-	 * @param array $params the template parameters in key => value structure
-	 * @param string $renderAs user renders a full page, blank only your template
-	 *                          admin an entry in the admin settings
-	 * @param string[] $headers set additional headers in name/value pairs
-	 * @return \OCP\AppFramework\Http\TemplateResponse containing the page
-	 * @since 6.0.0
-	 */
-	public function render($templateName, array $params=array(),
-							$renderAs='user', array $headers=array()){
-		$response = new TemplateResponse($this->appName, $templateName);
-		$response->setParams($params);
-		$response->renderAs($renderAs);
-
-		foreach($headers as $name => $value){
-			$response->addHeader($name, $value);
-		}
-
-		return $response;
-	}
+    /**
+     * app name
+     * @var string
+     * @since 7.0.0
+     */
+    protected $appName;
+
+    /**
+     * current request
+     * @var \OCP\IRequest
+     * @since 6.0.0
+     */
+    protected $request;
+
+    /**
+     * @var array
+     * @since 7.0.0
+     */
+    private $responders;
+
+    /**
+     * constructor of the controller
+     * @param string $appName the name of the app
+     * @param IRequest $request an instance of the request
+     * @since 6.0.0 - parameter $appName was added in 7.0.0 - parameter $app was removed in 7.0.0
+     */
+    public function __construct($appName,
+                                IRequest $request) {
+        $this->appName = $appName;
+        $this->request = $request;
+
+        // default responders
+        $this->responders = array(
+            'json' => function ($data) {
+                if ($data instanceof DataResponse) {
+                    $response = new JSONResponse(
+                        $data->getData(),
+                        $data->getStatus()
+                    );
+                    $dataHeaders = $data->getHeaders();
+                    $headers = $response->getHeaders();
+                    // do not overwrite Content-Type if it already exists
+                    if (isset($dataHeaders['Content-Type'])) {
+                        unset($headers['Content-Type']);
+                    }
+                    $response->setHeaders(array_merge($dataHeaders, $headers));
+                    return $response;
+                }
+                return new JSONResponse($data);
+            }
+        );
+    }
+
+
+    /**
+     * Parses an HTTP accept header and returns the supported responder type
+     * @param string $acceptHeader
+     * @return string the responder type
+     * @since 7.0.0
+     * @since 9.1.0 Added default parameter
+     */
+    public function getResponderByHTTPHeader($acceptHeader, $default='json') {
+        $headers = explode(',', $acceptHeader);
+
+        // return the first matching responder
+        foreach ($headers as $header) {
+            $header = strtolower(trim($header));
+
+            $responder = str_replace('application/', '', $header);
+
+            if (array_key_exists($responder, $this->responders)) {
+                return $responder;
+            }
+        }
+
+        // no matching header return default
+        return $default;
+    }
+
+
+    /**
+     * Registers a formatter for a type
+     * @param string $format
+     * @param \Closure $responder
+     * @since 7.0.0
+     */
+    protected function registerResponder($format, \Closure $responder) {
+        $this->responders[$format] = $responder;
+    }
+
+
+    /**
+     * Serializes and formats a response
+     * @param mixed $response the value that was returned from a controller and
+     * is not a Response instance
+     * @param string $format the format for which a formatter has been registered
+     * @throws \DomainException if format does not match a registered formatter
+     * @return Response
+     * @since 7.0.0
+     */
+    public function buildResponse($response, $format='json') {
+        if(array_key_exists($format, $this->responders)) {
+
+            $responder = $this->responders[$format];
+
+            return $responder($response);
+
+        }
+        throw new \DomainException('No responder registered for format '.
+            $format . '!');
+    }
+
+
+    /**
+     * Lets you access post and get parameters by the index
+     * @deprecated 7.0.0 write your parameters as method arguments instead
+     * @param string $key the key which you want to access in the URL Parameter
+     *                     placeholder, $_POST or $_GET array.
+     *                     The priority how they're returned is the following:
+     *                     1. URL parameters
+     *                     2. POST parameters
+     *                     3. GET parameters
+     * @param string $default If the key is not found, this value will be returned
+     * @return mixed the content of the array
+     * @since 6.0.0
+     */
+    public function params($key, $default=null){
+        return $this->request->getParam($key, $default);
+    }
+
+
+    /**
+     * Returns all params that were received, be it from the request
+     * (as GET or POST) or through the URL by the route
+     * @deprecated 7.0.0 use $this->request instead
+     * @return array the array with all parameters
+     * @since 6.0.0
+     */
+    public function getParams() {
+        return $this->request->getParams();
+    }
+
+
+    /**
+     * Returns the method of the request
+     * @deprecated 7.0.0 use $this->request instead
+     * @return string the method of the request (POST, GET, etc)
+     * @since 6.0.0
+     */
+    public function method() {
+        return $this->request->getMethod();
+    }
+
+
+    /**
+     * Shortcut for accessing an uploaded file through the $_FILES array
+     * @deprecated 7.0.0 use $this->request instead
+     * @param string $key the key that will be taken from the $_FILES array
+     * @return array the file in the $_FILES element
+     * @since 6.0.0
+     */
+    public function getUploadedFile($key) {
+        return $this->request->getUploadedFile($key);
+    }
+
+
+    /**
+     * Shortcut for getting env variables
+     * @deprecated 7.0.0 use $this->request instead
+     * @param string $key the key that will be taken from the $_ENV array
+     * @return array the value in the $_ENV element
+     * @since 6.0.0
+     */
+    public function env($key) {
+        return $this->request->getEnv($key);
+    }
+
+
+    /**
+     * Shortcut for getting cookie variables
+     * @deprecated 7.0.0 use $this->request instead
+     * @param string $key the key that will be taken from the $_COOKIE array
+     * @return array the value in the $_COOKIE element
+     * @since 6.0.0
+     */
+    public function cookie($key) {
+        return $this->request->getCookie($key);
+    }
+
+
+    /**
+     * Shortcut for rendering a template
+     * @deprecated 7.0.0 return a template response instead
+     * @param string $templateName the name of the template
+     * @param array $params the template parameters in key => value structure
+     * @param string $renderAs user renders a full page, blank only your template
+     *                          admin an entry in the admin settings
+     * @param string[] $headers set additional headers in name/value pairs
+     * @return \OCP\AppFramework\Http\TemplateResponse containing the page
+     * @since 6.0.0
+     */
+    public function render($templateName, array $params=array(),
+                            $renderAs='user', array $headers=array()){
+        $response = new TemplateResponse($this->appName, $templateName);
+        $response->setParams($params);
+        $response->renderAs($renderAs);
+
+        foreach($headers as $name => $value){
+            $response->addHeader($name, $value);
+        }
+
+        return $response;
+    }
 
 
 }

lib/public/AppFramework/ApiController.php

Indentation +2 added lines, -2 removed lines

@@ -55,7 +55,7 @@ 
      * defaults to 'Authorization, Content-Type, Accept'
      * @param int $corsMaxAge number in seconds how long a preflighted OPTIONS
      * request should be cached, defaults to 1728000 seconds
-	 * @since 7.0.0
+     * @since 7.0.0
      */
     public function __construct($appName,
                                 IRequest $request,
@@ -76,7 +76,7 @@ 
      * @NoAdminRequired
      * @NoCSRFRequired
      * @PublicPage
-	 * @since 7.0.0
+     * @since 7.0.0
      */
     public function preflightedCors() {
         if(isset($this->request->server['HTTP_ORIGIN'])) {

lib/public/AppFramework/Db/MultipleObjectsReturnedException.php

Indentation +8 added lines, -8 removed lines

@@ -32,13 +32,13 @@
  */
 class MultipleObjectsReturnedException extends \Exception {
 
-	/**
-	 * Constructor
-	 * @param string $msg the error message
-	 * @since 7.0.0
-	 */
-	public function __construct($msg){
-		parent::__construct($msg);
-	}
+    /**
+     * Constructor
+     * @param string $msg the error message
+     * @since 7.0.0
+     */
+    public function __construct($msg){
+        parent::__construct($msg);
+    }
 
 }

lib/public/AppFramework/Db/Mapper.php

Indentation +321 added lines, -321 removed lines

@@ -37,327 +37,327 @@
  */
 abstract class Mapper {
 
-	protected $tableName;
-	protected $entityClass;
-	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 7.0.0
-	 */
-	public function __construct(IDBConnection $db, $tableName, $entityClass=null){
-		$this->db = $db;
-		$this->tableName = '*PREFIX*' . $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 7.0.0
-	 */
-	public function getTableName(){
-		return $this->tableName;
-	}
-
-
-	/**
-	 * Deletes an entity from the table
-	 * @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
-	 */
-	public function delete(Entity $entity){
-		$sql = 'DELETE FROM `' . $this->tableName . '` WHERE `id` = ?';
-		$stmt = $this->execute($sql, [$entity->getId()]);
-		$stmt->closeCursor();
-		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 7.0.0
-	 */
-	public function insert(Entity $entity){
-		// get updated fields to save, fields have to be set using a setter to
-		// be saved
-		$properties = $entity->getUpdatedFields();
-		$values = '';
-		$columns = '';
-		$params = [];
-
-		// build the fields
-		$i = 0;
-		foreach($properties as $property => $updated) {
-			$column = $entity->propertyToColumn($property);
-			$getter = 'get' . ucfirst($property);
-
-			$columns .= '`' . $column . '`';
-			$values .= '?';
-
-			// only append colon if there are more entries
-			if($i < count($properties)-1){
-				$columns .= ',';
-				$values .= ',';
-			}
-
-			$params[] = $entity->$getter();
-			$i++;
-
-		}
-
-		$sql = 'INSERT INTO `' . $this->tableName . '`(' .
-				$columns . ') VALUES(' . $values . ')';
-
-		$stmt = $this->execute($sql, $params);
-
-		$entity->setId((int) $this->db->lastInsertId($this->tableName));
-
-		$stmt->closeCursor();
-
-		return $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 7.0.0 - return value was added in 8.0.0
-	 */
-	public function update(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']);
-
-		$columns = '';
-		$params = [];
-
-		// build the fields
-		$i = 0;
-		foreach($properties as $property => $updated) {
-
-			$column = $entity->propertyToColumn($property);
-			$getter = 'get' . ucfirst($property);
-
-			$columns .= '`' . $column . '` = ?';
-
-			// only append colon if there are more entries
-			if($i < count($properties)-1){
-				$columns .= ',';
-			}
-
-			$params[] = $entity->$getter();
-			$i++;
-		}
-
-		$sql = 'UPDATE `' . $this->tableName . '` SET ' .
-				$columns . ' WHERE `id` = ?';
-		$params[] = $id;
-
-		$stmt = $this->execute($sql, $params);
-		$stmt->closeCursor();
-
-		return $entity;
-	}
-
-	/**
-	 * Checks if an array is associative
-	 * @param array $array
-	 * @return bool true if associative
-	 * @since 8.1.0
-	 */
-	private function isAssocArray(array $array) {
-		return array_values($array) !== $array;
-	}
-
-	/**
-	 * Returns the correct PDO constant based on the value type
-	 * @param $value
-	 * @return int PDO constant
-	 * @since 8.1.0
-	 */
-	private function getPDOType($value) {
-		switch (gettype($value)) {
-			case 'integer':
-				return \PDO::PARAM_INT;
-			case 'boolean':
-				return \PDO::PARAM_BOOL;
-			default:
-				return \PDO::PARAM_STR;
-		}
-	}
-
-
-	/**
-	 * Runs an sql query
-	 * @param string $sql the prepare string
-	 * @param array $params the params which should replace the ? in the sql query
-	 * @param int $limit the maximum number of rows
-	 * @param int $offset from which row we want to start
-	 * @return \PDOStatement the database query result
-	 * @since 7.0.0
-	 */
-	protected function execute($sql, array $params=[], $limit=null, $offset=null){
-		$query = $this->db->prepare($sql, $limit, $offset);
-
-		if ($this->isAssocArray($params)) {
-			foreach ($params as $key => $param) {
-				$pdoConstant = $this->getPDOType($param);
-				$query->bindValue($key, $param, $pdoConstant);
-			}
-		} else {
-			$index = 1;  // bindParam is 1 indexed
-			foreach ($params as $param) {
-				$pdoConstant = $this->getPDOType($param);
-				$query->bindValue($index, $param, $pdoConstant);
-				$index++;
-			}
-		}
-
-		$result = $query->execute();
-
-		return $query;
-	}
-
-
-	/**
-	 * Returns an db result and throws exceptions when there are more or less
-	 * results
-	 * @see findEntity
-	 * @param string $sql the sql query
-	 * @param array $params the parameters of the sql query
-	 * @param int $limit the maximum number of rows
-	 * @param int $offset from which row we want to start
-	 * @throws DoesNotExistException if the item does not exist
-	 * @throws MultipleObjectsReturnedException if more than one item exist
-	 * @return array the result as row
-	 * @since 7.0.0
-	 */
-	protected function findOneQuery($sql, array $params=[], $limit=null, $offset=null){
-		$stmt = $this->execute($sql, $params, $limit, $offset);
-		$row = $stmt->fetch();
-
-		if($row === false || $row === null){
-			$stmt->closeCursor();
-			$msg = $this->buildDebugMessage(
-				'Did expect one result but found none when executing', $sql, $params, $limit, $offset
-			);
-			throw new DoesNotExistException($msg);
-		}
-		$row2 = $stmt->fetch();
-		$stmt->closeCursor();
-		//MDB2 returns null, PDO and doctrine false when no row is available
-		if( ! ($row2 === false || $row2 === null )) {
-			$msg = $this->buildDebugMessage(
-				'Did not expect more than one result when executing', $sql, $params, $limit, $offset
-			);
-			throw new MultipleObjectsReturnedException($msg);
-		} else {
-			return $row;
-		}
-	}
-
-	/**
-	 * Builds an error message by prepending the $msg to an error message which
-	 * has the parameters
-	 * @see findEntity
-	 * @param string $sql the sql query
-	 * @param array $params the parameters of the sql query
-	 * @param int $limit the maximum number of rows
-	 * @param int $offset from which row we want to start
-	 * @return string formatted error message string
-	 * @since 9.1.0
-	 */
-	private function buildDebugMessage($msg, $sql, array $params=[], $limit=null, $offset=null) {
-		return $msg .
-					': query "' .	$sql . '"; ' .
-					'parameters ' . print_r($params, true) . '; ' .
-					'limit "' . $limit . '"; '.
-					'offset "' . $offset . '"';
-	}
-
-
-	/**
-	 * 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 7.0.0
-	 */
-	protected function mapRowToEntity($row) {
-		return call_user_func($this->entityClass .'::fromRow', $row);
-	}
-
-
-	/**
-	 * Runs a sql query and returns an array of entities
-	 * @param string $sql the prepare string
-	 * @param array $params the params which should replace the ? in the sql query
-	 * @param int $limit the maximum number of rows
-	 * @param int $offset from which row we want to start
-	 * @return array all fetched entities
-	 * @since 7.0.0
-	 */
-	protected function findEntities($sql, array $params=[], $limit=null, $offset=null) {
-		$stmt = $this->execute($sql, $params, $limit, $offset);
-
-		$entities = [];
-
-		while($row = $stmt->fetch()){
-			$entities[] = $this->mapRowToEntity($row);
-		}
-
-		$stmt->closeCursor();
-
-		return $entities;
-	}
-
-
-	/**
-	 * Returns an db result and throws exceptions when there are more or less
-	 * results
-	 * @param string $sql the sql query
-	 * @param array $params the parameters of the sql query
-	 * @param int $limit the maximum number of rows
-	 * @param int $offset from which row we want to start
-	 * @throws DoesNotExistException if the item does not exist
-	 * @throws MultipleObjectsReturnedException if more than one item exist
-	 * @return Entity the entity
-	 * @since 7.0.0
-	 */
-	protected function findEntity($sql, array $params=[], $limit=null, $offset=null){
-		return $this->mapRowToEntity($this->findOneQuery($sql, $params, $limit, $offset));
-	}
+    protected $tableName;
+    protected $entityClass;
+    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 7.0.0
+     */
+    public function __construct(IDBConnection $db, $tableName, $entityClass=null){
+        $this->db = $db;
+        $this->tableName = '*PREFIX*' . $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 7.0.0
+     */
+    public function getTableName(){
+        return $this->tableName;
+    }
+
+
+    /**
+     * Deletes an entity from the table
+     * @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
+     */
+    public function delete(Entity $entity){
+        $sql = 'DELETE FROM `' . $this->tableName . '` WHERE `id` = ?';
+        $stmt = $this->execute($sql, [$entity->getId()]);
+        $stmt->closeCursor();
+        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 7.0.0
+     */
+    public function insert(Entity $entity){
+        // get updated fields to save, fields have to be set using a setter to
+        // be saved
+        $properties = $entity->getUpdatedFields();
+        $values = '';
+        $columns = '';
+        $params = [];
+
+        // build the fields
+        $i = 0;
+        foreach($properties as $property => $updated) {
+            $column = $entity->propertyToColumn($property);
+            $getter = 'get' . ucfirst($property);
+
+            $columns .= '`' . $column . '`';
+            $values .= '?';
+
+            // only append colon if there are more entries
+            if($i < count($properties)-1){
+                $columns .= ',';
+                $values .= ',';
+            }
+
+            $params[] = $entity->$getter();
+            $i++;
+
+        }
+
+        $sql = 'INSERT INTO `' . $this->tableName . '`(' .
+                $columns . ') VALUES(' . $values . ')';
+
+        $stmt = $this->execute($sql, $params);
+
+        $entity->setId((int) $this->db->lastInsertId($this->tableName));
+
+        $stmt->closeCursor();
+
+        return $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 7.0.0 - return value was added in 8.0.0
+     */
+    public function update(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']);
+
+        $columns = '';
+        $params = [];
+
+        // build the fields
+        $i = 0;
+        foreach($properties as $property => $updated) {
+
+            $column = $entity->propertyToColumn($property);
+            $getter = 'get' . ucfirst($property);
+
+            $columns .= '`' . $column . '` = ?';
+
+            // only append colon if there are more entries
+            if($i < count($properties)-1){
+                $columns .= ',';
+            }
+
+            $params[] = $entity->$getter();
+            $i++;
+        }
+
+        $sql = 'UPDATE `' . $this->tableName . '` SET ' .
+                $columns . ' WHERE `id` = ?';
+        $params[] = $id;
+
+        $stmt = $this->execute($sql, $params);
+        $stmt->closeCursor();
+
+        return $entity;
+    }
+
+    /**
+     * Checks if an array is associative
+     * @param array $array
+     * @return bool true if associative
+     * @since 8.1.0
+     */
+    private function isAssocArray(array $array) {
+        return array_values($array) !== $array;
+    }
+
+    /**
+     * Returns the correct PDO constant based on the value type
+     * @param $value
+     * @return int PDO constant
+     * @since 8.1.0
+     */
+    private function getPDOType($value) {
+        switch (gettype($value)) {
+            case 'integer':
+                return \PDO::PARAM_INT;
+            case 'boolean':
+                return \PDO::PARAM_BOOL;
+            default:
+                return \PDO::PARAM_STR;
+        }
+    }
+
+
+    /**
+     * Runs an sql query
+     * @param string $sql the prepare string
+     * @param array $params the params which should replace the ? in the sql query
+     * @param int $limit the maximum number of rows
+     * @param int $offset from which row we want to start
+     * @return \PDOStatement the database query result
+     * @since 7.0.0
+     */
+    protected function execute($sql, array $params=[], $limit=null, $offset=null){
+        $query = $this->db->prepare($sql, $limit, $offset);
+
+        if ($this->isAssocArray($params)) {
+            foreach ($params as $key => $param) {
+                $pdoConstant = $this->getPDOType($param);
+                $query->bindValue($key, $param, $pdoConstant);
+            }
+        } else {
+            $index = 1;  // bindParam is 1 indexed
+            foreach ($params as $param) {
+                $pdoConstant = $this->getPDOType($param);
+                $query->bindValue($index, $param, $pdoConstant);
+                $index++;
+            }
+        }
+
+        $result = $query->execute();
+
+        return $query;
+    }
+
+
+    /**
+     * Returns an db result and throws exceptions when there are more or less
+     * results
+     * @see findEntity
+     * @param string $sql the sql query
+     * @param array $params the parameters of the sql query
+     * @param int $limit the maximum number of rows
+     * @param int $offset from which row we want to start
+     * @throws DoesNotExistException if the item does not exist
+     * @throws MultipleObjectsReturnedException if more than one item exist
+     * @return array the result as row
+     * @since 7.0.0
+     */
+    protected function findOneQuery($sql, array $params=[], $limit=null, $offset=null){
+        $stmt = $this->execute($sql, $params, $limit, $offset);
+        $row = $stmt->fetch();
+
+        if($row === false || $row === null){
+            $stmt->closeCursor();
+            $msg = $this->buildDebugMessage(
+                'Did expect one result but found none when executing', $sql, $params, $limit, $offset
+            );
+            throw new DoesNotExistException($msg);
+        }
+        $row2 = $stmt->fetch();
+        $stmt->closeCursor();
+        //MDB2 returns null, PDO and doctrine false when no row is available
+        if( ! ($row2 === false || $row2 === null )) {
+            $msg = $this->buildDebugMessage(
+                'Did not expect more than one result when executing', $sql, $params, $limit, $offset
+            );
+            throw new MultipleObjectsReturnedException($msg);
+        } else {
+            return $row;
+        }
+    }
+
+    /**
+     * Builds an error message by prepending the $msg to an error message which
+     * has the parameters
+     * @see findEntity
+     * @param string $sql the sql query
+     * @param array $params the parameters of the sql query
+     * @param int $limit the maximum number of rows
+     * @param int $offset from which row we want to start
+     * @return string formatted error message string
+     * @since 9.1.0
+     */
+    private function buildDebugMessage($msg, $sql, array $params=[], $limit=null, $offset=null) {
+        return $msg .
+                    ': query "' .	$sql . '"; ' .
+                    'parameters ' . print_r($params, true) . '; ' .
+                    'limit "' . $limit . '"; '.
+                    'offset "' . $offset . '"';
+    }
+
+
+    /**
+     * 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 7.0.0
+     */
+    protected function mapRowToEntity($row) {
+        return call_user_func($this->entityClass .'::fromRow', $row);
+    }
+
+
+    /**
+     * Runs a sql query and returns an array of entities
+     * @param string $sql the prepare string
+     * @param array $params the params which should replace the ? in the sql query
+     * @param int $limit the maximum number of rows
+     * @param int $offset from which row we want to start
+     * @return array all fetched entities
+     * @since 7.0.0
+     */
+    protected function findEntities($sql, array $params=[], $limit=null, $offset=null) {
+        $stmt = $this->execute($sql, $params, $limit, $offset);
+
+        $entities = [];
+
+        while($row = $stmt->fetch()){
+            $entities[] = $this->mapRowToEntity($row);
+        }
+
+        $stmt->closeCursor();
+
+        return $entities;
+    }
+
+
+    /**
+     * Returns an db result and throws exceptions when there are more or less
+     * results
+     * @param string $sql the sql query
+     * @param array $params the parameters of the sql query
+     * @param int $limit the maximum number of rows
+     * @param int $offset from which row we want to start
+     * @throws DoesNotExistException if the item does not exist
+     * @throws MultipleObjectsReturnedException if more than one item exist
+     * @return Entity the entity
+     * @since 7.0.0
+     */
+    protected function findEntity($sql, array $params=[], $limit=null, $offset=null){
+        return $this->mapRowToEntity($this->findOneQuery($sql, $params, $limit, $offset));
+    }
 
 
 }

lib/public/AppFramework/Db/DoesNotExistException.php

Indentation +8 added lines, -8 removed lines

@@ -32,13 +32,13 @@
  */
 class DoesNotExistException extends \Exception {
 
-	/**
-	 * Constructor
-	 * @param string $msg the error message
-	 * @since 7.0.0
-	 */
-	public function __construct($msg){
-		parent::__construct($msg);
-	}
+    /**
+     * Constructor
+     * @param string $msg the error message
+     * @since 7.0.0
+     */
+    public function __construct($msg){
+        parent::__construct($msg);
+    }
 
 }