nextcloud / server

lib/public/AppFramework/Http/IOutput.php

Indentation +38 added lines, -38 removed lines

@@ -32,48 +32,48 @@
  */
 interface IOutput {
 
-	/**
-	 * @param string $out
-	 * @since 8.1.0
-	 */
-	public function setOutput($out);
+    /**
+     * @param string $out
+     * @since 8.1.0
+     */
+    public function setOutput($out);
 
-	/**
-	 * @param string|resource $path or file handle
-	 *
-	 * @return bool false if an error occurred
-	 * @since 8.1.0
-	 */
-	public function setReadfile($path);
+    /**
+     * @param string|resource $path or file handle
+     *
+     * @return bool false if an error occurred
+     * @since 8.1.0
+     */
+    public function setReadfile($path);
 
-	/**
-	 * @param string $header
-	 * @since 8.1.0
-	 */
-	public function setHeader($header);
+    /**
+     * @param string $header
+     * @since 8.1.0
+     */
+    public function setHeader($header);
 
-	/**
-	 * @return int returns the current http response code
-	 * @since 8.1.0
-	 */
-	public function getHttpResponseCode();
+    /**
+     * @return int returns the current http response code
+     * @since 8.1.0
+     */
+    public function getHttpResponseCode();
 
-	/**
-	 * @param int $code sets the http status code
-	 * @since 8.1.0
-	 */
-	public function setHttpResponseCode($code);
+    /**
+     * @param int $code sets the http status code
+     * @since 8.1.0
+     */
+    public function setHttpResponseCode($code);
 
-	/**
-	 * @param string $name
-	 * @param string $value
-	 * @param int $expire
-	 * @param string $path
-	 * @param string $domain
-	 * @param bool $secure
-	 * @param bool $httpOnly
-	 * @since 8.1.0
-	 */
-	public function setCookie($name, $value, $expire, $path, $domain, $secure, $httpOnly);
+    /**
+     * @param string $name
+     * @param string $value
+     * @param int $expire
+     * @param string $path
+     * @param string $domain
+     * @param bool $secure
+     * @param bool $httpOnly
+     * @since 8.1.0
+     */
+    public function setCookie($name, $value, $expire, $path, $domain, $secure, $httpOnly);
 
 }

lib/public/AppFramework/Http/DownloadResponse.php

Indentation +16 added lines, -16 removed lines

@@ -32,22 +32,22 @@
  */
 class DownloadResponse extends \OCP\AppFramework\Http\Response {
 
-	private $filename;
-	private $contentType;
-
-	/**
-	 * Creates a response that prompts the user to download the file
-	 * @param string $filename the name that the downloaded file should have
-	 * @param string $contentType the mimetype that the downloaded file should have
-	 * @since 7.0.0
-	 */
-	public function __construct($filename, $contentType) {
-		$this->filename = $filename;
-		$this->contentType = $contentType;
-
-		$this->addHeader('Content-Disposition', 'attachment; filename="' . $filename . '"');
-		$this->addHeader('Content-Type', $contentType);
-	}
+    private $filename;
+    private $contentType;
+
+    /**
+     * Creates a response that prompts the user to download the file
+     * @param string $filename the name that the downloaded file should have
+     * @param string $contentType the mimetype that the downloaded file should have
+     * @since 7.0.0
+     */
+    public function __construct($filename, $contentType) {
+        $this->filename = $filename;
+        $this->contentType = $contentType;
+
+        $this->addHeader('Content-Disposition', 'attachment; filename="' . $filename . '"');
+        $this->addHeader('Content-Type', $contentType);
+    }
 
 
 }

Spacing +1 added lines, -1 removed lines

@@ -45,7 +45,7 @@
 		$this->filename = $filename;
 		$this->contentType = $contentType;
 
-		$this->addHeader('Content-Disposition', 'attachment; filename="' . $filename . '"');
+		$this->addHeader('Content-Disposition', 'attachment; filename="'.$filename.'"');
 		$this->addHeader('Content-Type', $contentType);
 	}
 

lib/public/AppFramework/App.php

Spacing +1 added lines, -1 removed lines

@@ -55,7 +55,7 @@
 	 * @return string the starting namespace for the app
 	 * @since 8.0.0
 	 */
-	public static function buildAppNamespace($appId, $topNamespace='OCA\\') {
+	public static function buildAppNamespace($appId, $topNamespace = 'OCA\\') {
 		return \OC\AppFramework\App::buildAppNamespace($appId, $topNamespace);
 	}
 

Indentation +85 added lines, -85 removed lines

@@ -45,95 +45,95 @@
 class App {
 
 
-	/**
-	 * Turns an app id into a namespace by convetion. The id is split at the
-	 * underscores, all parts are camelcased and reassembled. e.g.:
-	 * some_app_id -> OCA\SomeAppId
-	 * @param string $appId the app id
-	 * @param string $topNamespace the namespace which should be prepended to
-	 * the transformed app id, defaults to OCA\
-	 * @return string the starting namespace for the app
-	 * @since 8.0.0
-	 */
-	public static function buildAppNamespace($appId, $topNamespace='OCA\\') {
-		return \OC\AppFramework\App::buildAppNamespace($appId, $topNamespace);
-	}
+    /**
+     * Turns an app id into a namespace by convetion. The id is split at the
+     * underscores, all parts are camelcased and reassembled. e.g.:
+     * some_app_id -> OCA\SomeAppId
+     * @param string $appId the app id
+     * @param string $topNamespace the namespace which should be prepended to
+     * the transformed app id, defaults to OCA\
+     * @return string the starting namespace for the app
+     * @since 8.0.0
+     */
+    public static function buildAppNamespace($appId, $topNamespace='OCA\\') {
+        return \OC\AppFramework\App::buildAppNamespace($appId, $topNamespace);
+    }
 
 
-	/**
-	 * @param array $urlParams an array with variables extracted from the routes
-	 * @since 6.0.0
-	 */
-	public function __construct($appName, $urlParams = array()) {
-		$this->container = new \OC\AppFramework\DependencyInjection\DIContainer($appName, $urlParams);
-	}
+    /**
+     * @param array $urlParams an array with variables extracted from the routes
+     * @since 6.0.0
+     */
+    public function __construct($appName, $urlParams = array()) {
+        $this->container = new \OC\AppFramework\DependencyInjection\DIContainer($appName, $urlParams);
+    }
 
-	private $container;
+    private $container;
 
-	/**
-	 * @return IAppContainer
-	 * @since 6.0.0
-	 */
-	public function getContainer() {
-		return $this->container;
-	}
+    /**
+     * @return IAppContainer
+     * @since 6.0.0
+     */
+    public function getContainer() {
+        return $this->container;
+    }
 
-	/**
-	 * This function is to be called to create single routes and restful routes based on the given $routes array.
-	 *
-	 * Example code in routes.php of tasks app (it will register two restful resources):
-	 * $routes = array(
-	 *		'resources' => array(
-	 *		'lists' => array('url' => '/tasklists'),
-	 *		'tasks' => array('url' => '/tasklists/{listId}/tasks')
-	 *	)
-	 *	);
-	 *
-	 * $a = new TasksApp();
-	 * $a->registerRoutes($this, $routes);
-	 *
-	 * @param \OCP\Route\IRouter $router
-	 * @param array $routes
-	 * @since 6.0.0
-	 * @suppress PhanAccessMethodInternal
-	 */
-	public function registerRoutes($router, $routes) {
-		$routeConfig = new RouteConfig($this->container, $router, $routes);
-		$routeConfig->register();
-	}
+    /**
+     * This function is to be called to create single routes and restful routes based on the given $routes array.
+     *
+     * Example code in routes.php of tasks app (it will register two restful resources):
+     * $routes = array(
+     *		'resources' => array(
+     *		'lists' => array('url' => '/tasklists'),
+     *		'tasks' => array('url' => '/tasklists/{listId}/tasks')
+     *	)
+     *	);
+     *
+     * $a = new TasksApp();
+     * $a->registerRoutes($this, $routes);
+     *
+     * @param \OCP\Route\IRouter $router
+     * @param array $routes
+     * @since 6.0.0
+     * @suppress PhanAccessMethodInternal
+     */
+    public function registerRoutes($router, $routes) {
+        $routeConfig = new RouteConfig($this->container, $router, $routes);
+        $routeConfig->register();
+    }
 
-	/**
-	 * This function is called by the routing component to fire up the frameworks dispatch mechanism.
-	 *
-	 * Example code in routes.php of the task app:
-	 * $this->create('tasks_index', '/')->get()->action(
-	 *		function($params){
-	 *			$app = new TaskApp($params);
-	 *			$app->dispatch('PageController', 'index');
-	 *		}
-	 *	);
-	 *
-	 *
-	 * Example for for TaskApp implementation:
-	 * class TaskApp extends \OCP\AppFramework\App {
-	 *
-	 *		public function __construct($params){
-	 *			parent::__construct('tasks', $params);
-	 *
-	 *			$this->getContainer()->registerService('PageController', function(IAppContainer $c){
-	 *				$a = $c->query('API');
-	 *				$r = $c->query('Request');
-	 *				return new PageController($a, $r);
-	 *			});
-	 *		}
-	 *	}
-	 *
-	 * @param string $controllerName the name of the controller under which it is
-	 *                               stored in the DI container
-	 * @param string $methodName the method that you want to call
-	 * @since 6.0.0
-	 */
-	public function dispatch($controllerName, $methodName) {
-		\OC\AppFramework\App::main($controllerName, $methodName, $this->container);
-	}
+    /**
+     * This function is called by the routing component to fire up the frameworks dispatch mechanism.
+     *
+     * Example code in routes.php of the task app:
+     * $this->create('tasks_index', '/')->get()->action(
+     *		function($params){
+     *			$app = new TaskApp($params);
+     *			$app->dispatch('PageController', 'index');
+     *		}
+     *	);
+     *
+     *
+     * Example for for TaskApp implementation:
+     * class TaskApp extends \OCP\AppFramework\App {
+     *
+     *		public function __construct($params){
+     *			parent::__construct('tasks', $params);
+     *
+     *			$this->getContainer()->registerService('PageController', function(IAppContainer $c){
+     *				$a = $c->query('API');
+     *				$r = $c->query('Request');
+     *				return new PageController($a, $r);
+     *			});
+     *		}
+     *	}
+     *
+     * @param string $controllerName the name of the controller under which it is
+     *                               stored in the DI container
+     * @param string $methodName the method that you want to call
+     * @since 6.0.0
+     */
+    public function dispatch($controllerName, $methodName) {
+        \OC\AppFramework\App::main($controllerName, $methodName, $this->container);
+    }
 }

lib/public/AppFramework/Middleware.php

Indentation +57 added lines, -57 removed lines

@@ -44,69 +44,69 @@
 abstract class Middleware {
 
 
-	/**
-	 * This is being run in normal order before the controller is being
-	 * called which allows several modifications and checks
-	 *
-	 * @param Controller $controller the controller that is being called
-	 * @param string $methodName the name of the method that will be called on
-	 *                           the controller
-	 * @since 6.0.0
-	 */
-	public function beforeController($controller, $methodName){
+    /**
+     * This is being run in normal order before the controller is being
+     * called which allows several modifications and checks
+     *
+     * @param Controller $controller the controller that is being called
+     * @param string $methodName the name of the method that will be called on
+     *                           the controller
+     * @since 6.0.0
+     */
+    public function beforeController($controller, $methodName){
 
-	}
+    }
 
 
-	/**
-	 * This is being run when either the beforeController method or the
-	 * controller method itself is throwing an exception. The middleware is
-	 * asked in reverse order to handle the exception and to return a response.
-	 * If the response is null, it is assumed that the exception could not be
-	 * handled and the error will be thrown again
-	 *
-	 * @param Controller $controller the controller that is being called
-	 * @param string $methodName the name of the method that will be called on
-	 *                           the controller
-	 * @param \Exception $exception the thrown exception
-	 * @throws \Exception the passed in exception if it can't handle it
-	 * @return Response a Response object in case that the exception was handled
-	 * @since 6.0.0
-	 */
-	public function afterException($controller, $methodName, \Exception $exception){
-		throw $exception;
-	}
+    /**
+     * This is being run when either the beforeController method or the
+     * controller method itself is throwing an exception. The middleware is
+     * asked in reverse order to handle the exception and to return a response.
+     * If the response is null, it is assumed that the exception could not be
+     * handled and the error will be thrown again
+     *
+     * @param Controller $controller the controller that is being called
+     * @param string $methodName the name of the method that will be called on
+     *                           the controller
+     * @param \Exception $exception the thrown exception
+     * @throws \Exception the passed in exception if it can't handle it
+     * @return Response a Response object in case that the exception was handled
+     * @since 6.0.0
+     */
+    public function afterException($controller, $methodName, \Exception $exception){
+        throw $exception;
+    }
 
 
-	/**
-	 * This is being run after a successful controllermethod call and allows
-	 * the manipulation of a Response object. The middleware is run in reverse order
-	 *
-	 * @param Controller $controller the controller that is being called
-	 * @param string $methodName the name of the method that will be called on
-	 *                           the controller
-	 * @param Response $response the generated response from the controller
-	 * @return Response a Response object
-	 * @since 6.0.0
-	 */
-	public function afterController($controller, $methodName, Response $response){
-		return $response;
-	}
+    /**
+     * This is being run after a successful controllermethod call and allows
+     * the manipulation of a Response object. The middleware is run in reverse order
+     *
+     * @param Controller $controller the controller that is being called
+     * @param string $methodName the name of the method that will be called on
+     *                           the controller
+     * @param Response $response the generated response from the controller
+     * @return Response a Response object
+     * @since 6.0.0
+     */
+    public function afterController($controller, $methodName, Response $response){
+        return $response;
+    }
 
 
-	/**
-	 * This is being run after the response object has been rendered and
-	 * allows the manipulation of the output. The middleware is run in reverse order
-	 *
-	 * @param Controller $controller the controller that is being called
-	 * @param string $methodName the name of the method that will be called on
-	 *                           the controller
-	 * @param string $output the generated output from a response
-	 * @return string the output that should be printed
-	 * @since 6.0.0
-	 */
-	public function beforeOutput($controller, $methodName, $output){
-		return $output;
-	}
+    /**
+     * This is being run after the response object has been rendered and
+     * allows the manipulation of the output. The middleware is run in reverse order
+     *
+     * @param Controller $controller the controller that is being called
+     * @param string $methodName the name of the method that will be called on
+     *                           the controller
+     * @param string $output the generated output from a response
+     * @return string the output that should be printed
+     * @since 6.0.0
+     */
+    public function beforeOutput($controller, $methodName, $output){
+        return $output;
+    }
 
 }

Spacing +4 added lines, -4 removed lines

@@ -53,7 +53,7 @@ 
 	 *                           the controller
 	 * @since 6.0.0
 	 */
-	public function beforeController($controller, $methodName){
+	public function beforeController($controller, $methodName) {
 
 	}
 
@@ -73,7 +73,7 @@ 
 	 * @return Response a Response object in case that the exception was handled
 	 * @since 6.0.0
 	 */
-	public function afterException($controller, $methodName, \Exception $exception){
+	public function afterException($controller, $methodName, \Exception $exception) {
 		throw $exception;
 	}
 
@@ -89,7 +89,7 @@ 
 	 * @return Response a Response object
 	 * @since 6.0.0
 	 */
-	public function afterController($controller, $methodName, Response $response){
+	public function afterController($controller, $methodName, Response $response) {
 		return $response;
 	}
 
@@ -105,7 +105,7 @@ 
 	 * @return string the output that should be printed
 	 * @since 6.0.0
 	 */
-	public function beforeOutput($controller, $methodName, $output){
+	public function beforeOutput($controller, $methodName, $output) {
 		return $output;
 	}
 

lib/public/AppFramework/Http.php

Indentation +59 added lines, -59 removed lines

@@ -35,63 +35,63 @@
  */
 class Http {
 
-	const STATUS_CONTINUE = 100;
-	const STATUS_SWITCHING_PROTOCOLS = 101;
-	const STATUS_PROCESSING = 102;
-	const STATUS_OK = 200;
-	const STATUS_CREATED = 201;
-	const STATUS_ACCEPTED = 202;
-	const STATUS_NON_AUTHORATIVE_INFORMATION = 203;
-	const STATUS_NO_CONTENT = 204;
-	const STATUS_RESET_CONTENT = 205;
-	const STATUS_PARTIAL_CONTENT = 206;
-	const STATUS_MULTI_STATUS = 207;
-	const STATUS_ALREADY_REPORTED = 208;
-	const STATUS_IM_USED = 226;
-	const STATUS_MULTIPLE_CHOICES = 300;
-	const STATUS_MOVED_PERMANENTLY = 301;
-	const STATUS_FOUND = 302;
-	const STATUS_SEE_OTHER = 303;
-	const STATUS_NOT_MODIFIED = 304;
-	const STATUS_USE_PROXY = 305;
-	const STATUS_RESERVED = 306;
-	const STATUS_TEMPORARY_REDIRECT = 307;
-	const STATUS_BAD_REQUEST = 400;
-	const STATUS_UNAUTHORIZED = 401;
-	const STATUS_PAYMENT_REQUIRED = 402;
-	const STATUS_FORBIDDEN = 403;
-	const STATUS_NOT_FOUND = 404;
-	const STATUS_METHOD_NOT_ALLOWED = 405;
-	const STATUS_NOT_ACCEPTABLE = 406;
-	const STATUS_PROXY_AUTHENTICATION_REQUIRED = 407;
-	const STATUS_REQUEST_TIMEOUT = 408;
-	const STATUS_CONFLICT = 409;
-	const STATUS_GONE = 410;
-	const STATUS_LENGTH_REQUIRED = 411;
-	const STATUS_PRECONDITION_FAILED = 412;
-	const STATUS_REQUEST_ENTITY_TOO_LARGE = 413;
-	const STATUS_REQUEST_URI_TOO_LONG = 414;
-	const STATUS_UNSUPPORTED_MEDIA_TYPE = 415;
-	const STATUS_REQUEST_RANGE_NOT_SATISFIABLE = 416;
-	const STATUS_EXPECTATION_FAILED = 417;
-	const STATUS_IM_A_TEAPOT = 418;
-	const STATUS_UNPROCESSABLE_ENTITY = 422;
-	const STATUS_LOCKED = 423;
-	const STATUS_FAILED_DEPENDENCY = 424;
-	const STATUS_UPGRADE_REQUIRED = 426;
-	const STATUS_PRECONDITION_REQUIRED = 428;
-	const STATUS_TOO_MANY_REQUESTS = 429;
-	const STATUS_REQUEST_HEADER_FIELDS_TOO_LARGE = 431;
-	const STATUS_INTERNAL_SERVER_ERROR = 500;
-	const STATUS_NOT_IMPLEMENTED = 501;
-	const STATUS_BAD_GATEWAY = 502;
-	const STATUS_SERVICE_UNAVAILABLE = 503;
-	const STATUS_GATEWAY_TIMEOUT = 504;
-	const STATUS_HTTP_VERSION_NOT_SUPPORTED = 505;
-	const STATUS_VARIANT_ALSO_NEGOTIATES = 506;
-	const STATUS_INSUFFICIENT_STORAGE = 507;
-	const STATUS_LOOP_DETECTED = 508;
-	const STATUS_BANDWIDTH_LIMIT_EXCEEDED = 509;
-	const STATUS_NOT_EXTENDED = 510;
-	const STATUS_NETWORK_AUTHENTICATION_REQUIRED = 511;
+    const STATUS_CONTINUE = 100;
+    const STATUS_SWITCHING_PROTOCOLS = 101;
+    const STATUS_PROCESSING = 102;
+    const STATUS_OK = 200;
+    const STATUS_CREATED = 201;
+    const STATUS_ACCEPTED = 202;
+    const STATUS_NON_AUTHORATIVE_INFORMATION = 203;
+    const STATUS_NO_CONTENT = 204;
+    const STATUS_RESET_CONTENT = 205;
+    const STATUS_PARTIAL_CONTENT = 206;
+    const STATUS_MULTI_STATUS = 207;
+    const STATUS_ALREADY_REPORTED = 208;
+    const STATUS_IM_USED = 226;
+    const STATUS_MULTIPLE_CHOICES = 300;
+    const STATUS_MOVED_PERMANENTLY = 301;
+    const STATUS_FOUND = 302;
+    const STATUS_SEE_OTHER = 303;
+    const STATUS_NOT_MODIFIED = 304;
+    const STATUS_USE_PROXY = 305;
+    const STATUS_RESERVED = 306;
+    const STATUS_TEMPORARY_REDIRECT = 307;
+    const STATUS_BAD_REQUEST = 400;
+    const STATUS_UNAUTHORIZED = 401;
+    const STATUS_PAYMENT_REQUIRED = 402;
+    const STATUS_FORBIDDEN = 403;
+    const STATUS_NOT_FOUND = 404;
+    const STATUS_METHOD_NOT_ALLOWED = 405;
+    const STATUS_NOT_ACCEPTABLE = 406;
+    const STATUS_PROXY_AUTHENTICATION_REQUIRED = 407;
+    const STATUS_REQUEST_TIMEOUT = 408;
+    const STATUS_CONFLICT = 409;
+    const STATUS_GONE = 410;
+    const STATUS_LENGTH_REQUIRED = 411;
+    const STATUS_PRECONDITION_FAILED = 412;
+    const STATUS_REQUEST_ENTITY_TOO_LARGE = 413;
+    const STATUS_REQUEST_URI_TOO_LONG = 414;
+    const STATUS_UNSUPPORTED_MEDIA_TYPE = 415;
+    const STATUS_REQUEST_RANGE_NOT_SATISFIABLE = 416;
+    const STATUS_EXPECTATION_FAILED = 417;
+    const STATUS_IM_A_TEAPOT = 418;
+    const STATUS_UNPROCESSABLE_ENTITY = 422;
+    const STATUS_LOCKED = 423;
+    const STATUS_FAILED_DEPENDENCY = 424;
+    const STATUS_UPGRADE_REQUIRED = 426;
+    const STATUS_PRECONDITION_REQUIRED = 428;
+    const STATUS_TOO_MANY_REQUESTS = 429;
+    const STATUS_REQUEST_HEADER_FIELDS_TOO_LARGE = 431;
+    const STATUS_INTERNAL_SERVER_ERROR = 500;
+    const STATUS_NOT_IMPLEMENTED = 501;
+    const STATUS_BAD_GATEWAY = 502;
+    const STATUS_SERVICE_UNAVAILABLE = 503;
+    const STATUS_GATEWAY_TIMEOUT = 504;
+    const STATUS_HTTP_VERSION_NOT_SUPPORTED = 505;
+    const STATUS_VARIANT_ALSO_NEGOTIATES = 506;
+    const STATUS_INSUFFICIENT_STORAGE = 507;
+    const STATUS_LOOP_DETECTED = 508;
+    const STATUS_BANDWIDTH_LIMIT_EXCEEDED = 509;
+    const STATUS_NOT_EXTENDED = 510;
+    const STATUS_NETWORK_AUTHENTICATION_REQUIRED = 511;
 }

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'])) {

Spacing +5 added lines, -5 removed lines

@@ -59,9 +59,9 @@ 
      */
     public function __construct($appName,
                                 IRequest $request,
-                                $corsMethods='PUT, POST, GET, DELETE, PATCH',
-                                $corsAllowedHeaders='Authorization, Content-Type, Accept',
-                                $corsMaxAge=1728000){
+                                $corsMethods = 'PUT, POST, GET, DELETE, PATCH',
+                                $corsAllowedHeaders = 'Authorization, Content-Type, Accept',
+                                $corsMaxAge = 1728000) {
         parent::__construct($appName, $request);
         $this->corsMethods = $corsMethods;
         $this->corsAllowedHeaders = $corsAllowedHeaders;
@@ -79,7 +79,7 @@ 
 	 * @since 7.0.0
      */
     public function preflightedCors() {
-        if(isset($this->request->server['HTTP_ORIGIN'])) {
+        if (isset($this->request->server['HTTP_ORIGIN'])) {
             $origin = $this->request->server['HTTP_ORIGIN'];
         } else {
             $origin = '*';
@@ -88,7 +88,7 @@ 
         $response = new Response();
         $response->addHeader('Access-Control-Allow-Origin', $origin);
         $response->addHeader('Access-Control-Allow-Methods', $this->corsMethods);
-        $response->addHeader('Access-Control-Max-Age', (string)$this->corsMaxAge);
+        $response->addHeader('Access-Control-Max-Age', (string) $this->corsMaxAge);
         $response->addHeader('Access-Control-Allow-Headers', $this->corsAllowedHeaders);
         $response->addHeader('Access-Control-Allow-Credentials', 'false');
         return $response;

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);
+    }
 
 }

Spacing +1 added lines, -1 removed lines

@@ -37,7 +37,7 @@
 	 * @param string $msg the error message
 	 * @since 7.0.0
 	 */
-	public function __construct($msg){
+	public function __construct($msg) {
 		parent::__construct($msg);
 	}
 

lib/public/AppFramework/Db/Mapper.php

Spacing +37 added lines, -37 removed lines

@@ -48,13 +48,13 @@ 
 	 * mapped to queries without using sql
 	 * @since 7.0.0
 	 */
-	public function __construct(IDBConnection $db, $tableName, $entityClass=null){
+	public function __construct(IDBConnection $db, $tableName, $entityClass = null) {
 		$this->db = $db;
-		$this->tableName = '*PREFIX*' . $tableName;
+		$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) {
+		if ($entityClass === null) {
 			$this->entityClass = str_replace('Mapper', '', get_class($this));
 		} else {
 			$this->entityClass = $entityClass;
@@ -66,7 +66,7 @@ 
 	 * @return string the table name
 	 * @since 7.0.0
 	 */
-	public function getTableName(){
+	public function getTableName() {
 		return $this->tableName;
 	}
 
@@ -77,8 +77,8 @@ 
 	 * @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` = ?';
+	public function delete(Entity $entity) {
+		$sql = 'DELETE FROM `'.$this->tableName.'` WHERE `id` = ?';
 		$stmt = $this->execute($sql, [$entity->getId()]);
 		$stmt->closeCursor();
 		return $entity;
@@ -91,7 +91,7 @@ 
 	 * @return Entity the saved entity with the set id
 	 * @since 7.0.0
 	 */
-	public function insert(Entity $entity){
+	public function insert(Entity $entity) {
 		// get updated fields to save, fields have to be set using a setter to
 		// be saved
 		$properties = $entity->getUpdatedFields();
@@ -101,15 +101,15 @@ 
 
 		// build the fields
 		$i = 0;
-		foreach($properties as $property => $updated) {
+		foreach ($properties as $property => $updated) {
 			$column = $entity->propertyToColumn($property);
-			$getter = 'get' . ucfirst($property);
+			$getter = 'get'.ucfirst($property);
 
-			$columns .= '`' . $column . '`';
+			$columns .= '`'.$column.'`';
 			$values .= '?';
 
 			// only append colon if there are more entries
-			if($i < count($properties)-1){
+			if ($i < count($properties) - 1) {
 				$columns .= ',';
 				$values .= ',';
 			}
@@ -119,8 +119,8 @@ 
 
 		}
 
-		$sql = 'INSERT INTO `' . $this->tableName . '`(' .
-				$columns . ') VALUES(' . $values . ')';
+		$sql = 'INSERT INTO `'.$this->tableName.'`('.
+				$columns.') VALUES('.$values.')';
 
 		$stmt = $this->execute($sql, $params);
 
@@ -140,16 +140,16 @@ 
 	 * @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){
+	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) {
+		if (count($properties) === 0) {
 			return $entity;
 		}
 
 		// entity needs an id
 		$id = $entity->getId();
-		if($id === null){
+		if ($id === null) {
 			throw new \InvalidArgumentException(
 				'Entity which should be updated has no id');
 		}
@@ -164,15 +164,15 @@ 
 
 		// build the fields
 		$i = 0;
-		foreach($properties as $property => $updated) {
+		foreach ($properties as $property => $updated) {
 
 			$column = $entity->propertyToColumn($property);
-			$getter = 'get' . ucfirst($property);
+			$getter = 'get'.ucfirst($property);
 
-			$columns .= '`' . $column . '` = ?';
+			$columns .= '`'.$column.'` = ?';
 
 			// only append colon if there are more entries
-			if($i < count($properties)-1){
+			if ($i < count($properties) - 1) {
 				$columns .= ',';
 			}
 
@@ -180,8 +180,8 @@ 
 			$i++;
 		}
 
-		$sql = 'UPDATE `' . $this->tableName . '` SET ' .
-				$columns . ' WHERE `id` = ?';
+		$sql = 'UPDATE `'.$this->tableName.'` SET '.
+				$columns.' WHERE `id` = ?';
 		$params[] = $id;
 
 		$stmt = $this->execute($sql, $params);
@@ -227,7 +227,7 @@ 
 	 * @return \PDOStatement the database query result
 	 * @since 7.0.0
 	 */
-	protected function execute($sql, array $params=[], $limit=null, $offset=null){
+	protected function execute($sql, array $params = [], $limit = null, $offset = null) {
 		$query = $this->db->prepare($sql, $limit, $offset);
 
 		if ($this->isAssocArray($params)) {
@@ -236,7 +236,7 @@ 
 				$query->bindValue($key, $param, $pdoConstant);
 			}
 		} else {
-			$index = 1;  // bindParam is 1 indexed
+			$index = 1; // bindParam is 1 indexed
 			foreach ($params as $param) {
 				$pdoConstant = $this->getPDOType($param);
 				$query->bindValue($index, $param, $pdoConstant);
@@ -263,11 +263,11 @@ 
 	 * @return array the result as row
 	 * @since 7.0.0
 	 */
-	protected function findOneQuery($sql, array $params=[], $limit=null, $offset=null){
+	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){
+		if ($row === false || $row === null) {
 			$stmt->closeCursor();
 			$msg = $this->buildDebugMessage(
 				'Did expect one result but found none when executing', $sql, $params, $limit, $offset
@@ -277,7 +277,7 @@ 
 		$row2 = $stmt->fetch();
 		$stmt->closeCursor();
 		//MDB2 returns null, PDO and doctrine false when no row is available
-		if( ! ($row2 === false || $row2 === null )) {
+		if (!($row2 === false || $row2 === null)) {
 			$msg = $this->buildDebugMessage(
 				'Did not expect more than one result when executing', $sql, $params, $limit, $offset
 			);
@@ -298,12 +298,12 @@ 
 	 * @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 . '"';
+	private function buildDebugMessage($msg, $sql, array $params = [], $limit = null, $offset = null) {
+		return $msg.
+					': query "'.$sql.'"; '.
+					'parameters '.print_r($params, true).'; '.
+					'limit "'.$limit.'"; '.
+					'offset "'.$offset.'"';
 	}
 
 
@@ -315,7 +315,7 @@ 
 	 * @since 7.0.0
 	 */
 	protected function mapRowToEntity($row) {
-		return call_user_func($this->entityClass .'::fromRow', $row);
+		return call_user_func($this->entityClass.'::fromRow', $row);
 	}
 
 
@@ -328,12 +328,12 @@ 
 	 * @return array all fetched entities
 	 * @since 7.0.0
 	 */
-	protected function findEntities($sql, array $params=[], $limit=null, $offset=null) {
+	protected function findEntities($sql, array $params = [], $limit = null, $offset = null) {
 		$stmt = $this->execute($sql, $params, $limit, $offset);
 
 		$entities = [];
 
-		while($row = $stmt->fetch()){
+		while ($row = $stmt->fetch()) {
 			$entities[] = $this->mapRowToEntity($row);
 		}
 
@@ -355,7 +355,7 @@ 
 	 * @return Entity the entity
 	 * @since 7.0.0
 	 */
-	protected function findEntity($sql, array $params=[], $limit=null, $offset=null){
+	protected function findEntity($sql, array $params = [], $limit = null, $offset = null) {
 		return $this->mapRowToEntity($this->findOneQuery($sql, $params, $limit, $offset));
 	}
 

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++;
-			}
-		}
-
-		$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++;
+            }
+        }
+
+        $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);
+    }
 
 }

Spacing +1 added lines, -1 removed lines

@@ -37,7 +37,7 @@
 	 * @param string $msg the error message
 	 * @since 7.0.0
 	 */
-	public function __construct($msg){
+	public function __construct($msg) {
 		parent::__construct($msg);
 	}