nextcloud / server

lib/public/AppFramework/Http/TemplateResponse.php

Indentation +127 added lines, -127 removed lines

@@ -39,132 +39,132 @@
  */
 class TemplateResponse extends Response {
 
-	const EVENT_LOAD_ADDITIONAL_SCRIPTS = self::class . '::loadAdditionalScripts';
-	const EVENT_LOAD_ADDITIONAL_SCRIPTS_LOGGEDIN = self::class . '::loadAdditionalScriptsLoggedIn';
-
-	/**
-	 * name of the template
-	 * @var string
-	 */
-	protected $templateName;
-
-	/**
-	 * parameters
-	 * @var array
-	 */
-	protected $params;
-
-	/**
-	 * rendering type (admin, user, blank)
-	 * @var string
-	 */
-	protected $renderAs;
-
-	/**
-	 * app name
-	 * @var string
-	 */
-	protected $appName;
-
-	/**
-	 * constructor of TemplateResponse
-	 * @param string $appName the name of the app to load the template from
-	 * @param string $templateName the name of the template
-	 * @param array $params an array of parameters which should be passed to the
-	 * template
-	 * @param string $renderAs how the page should be rendered, defaults to user
-	 * @since 6.0.0 - parameters $params and $renderAs were added in 7.0.0
-	 */
-	public function __construct($appName, $templateName, array $params=[],
-								$renderAs='user') {
-		parent::__construct();
-
-		$this->templateName = $templateName;
-		$this->appName = $appName;
-		$this->params = $params;
-		$this->renderAs = $renderAs;
-
-		$this->setContentSecurityPolicy(new ContentSecurityPolicy());
-		$this->setFeaturePolicy(new FeaturePolicy());
-	}
-
-
-	/**
-	 * Sets template parameters
-	 * @param array $params an array with key => value structure which sets template
-	 *                      variables
-	 * @return TemplateResponse Reference to this object
-	 * @since 6.0.0 - return value was added in 7.0.0
-	 */
-	public function setParams(array $params) {
-		$this->params = $params;
-
-		return $this;
-	}
-
-
-	/**
-	 * Used for accessing the set parameters
-	 * @return array the params
-	 * @since 6.0.0
-	 */
-	public function getParams() {
-		return $this->params;
-	}
-
-
-	/**
-	 * Used for accessing the name of the set template
-	 * @return string the name of the used template
-	 * @since 6.0.0
-	 */
-	public function getTemplateName() {
-		return $this->templateName;
-	}
-
-
-	/**
-	 * Sets the template page
-	 * @param string $renderAs admin, user or blank. Admin also prints the admin
-	 *                         settings header and footer, user renders the normal
-	 *                         normal page including footer and header and blank
-	 *                         just renders the plain template
-	 * @return TemplateResponse Reference to this object
-	 * @since 6.0.0 - return value was added in 7.0.0
-	 */
-	public function renderAs($renderAs) {
-		$this->renderAs = $renderAs;
-
-		return $this;
-	}
-
-
-	/**
-	 * Returns the set renderAs
-	 * @return string the renderAs value
-	 * @since 6.0.0
-	 */
-	public function getRenderAs() {
-		return $this->renderAs;
-	}
-
-
-	/**
-	 * Returns the rendered html
-	 * @return string the rendered html
-	 * @since 6.0.0
-	 */
-	public function render() {
-		// \OCP\Template needs an empty string instead of 'blank' for an unwrapped response
-		$renderAs = $this->renderAs === 'blank' ? '' : $this->renderAs;
-
-		$template = new \OCP\Template($this->appName, $this->templateName, $renderAs);
-
-		foreach($this->params as $key => $value){
-			$template->assign($key, $value);
-		}
-
-		return $template->fetchPage($this->params);
-	}
+    const EVENT_LOAD_ADDITIONAL_SCRIPTS = self::class . '::loadAdditionalScripts';
+    const EVENT_LOAD_ADDITIONAL_SCRIPTS_LOGGEDIN = self::class . '::loadAdditionalScriptsLoggedIn';
+
+    /**
+     * name of the template
+     * @var string
+     */
+    protected $templateName;
+
+    /**
+     * parameters
+     * @var array
+     */
+    protected $params;
+
+    /**
+     * rendering type (admin, user, blank)
+     * @var string
+     */
+    protected $renderAs;
+
+    /**
+     * app name
+     * @var string
+     */
+    protected $appName;
+
+    /**
+     * constructor of TemplateResponse
+     * @param string $appName the name of the app to load the template from
+     * @param string $templateName the name of the template
+     * @param array $params an array of parameters which should be passed to the
+     * template
+     * @param string $renderAs how the page should be rendered, defaults to user
+     * @since 6.0.0 - parameters $params and $renderAs were added in 7.0.0
+     */
+    public function __construct($appName, $templateName, array $params=[],
+                                $renderAs='user') {
+        parent::__construct();
+
+        $this->templateName = $templateName;
+        $this->appName = $appName;
+        $this->params = $params;
+        $this->renderAs = $renderAs;
+
+        $this->setContentSecurityPolicy(new ContentSecurityPolicy());
+        $this->setFeaturePolicy(new FeaturePolicy());
+    }
+
+
+    /**
+     * Sets template parameters
+     * @param array $params an array with key => value structure which sets template
+     *                      variables
+     * @return TemplateResponse Reference to this object
+     * @since 6.0.0 - return value was added in 7.0.0
+     */
+    public function setParams(array $params) {
+        $this->params = $params;
+
+        return $this;
+    }
+
+
+    /**
+     * Used for accessing the set parameters
+     * @return array the params
+     * @since 6.0.0
+     */
+    public function getParams() {
+        return $this->params;
+    }
+
+
+    /**
+     * Used for accessing the name of the set template
+     * @return string the name of the used template
+     * @since 6.0.0
+     */
+    public function getTemplateName() {
+        return $this->templateName;
+    }
+
+
+    /**
+     * Sets the template page
+     * @param string $renderAs admin, user or blank. Admin also prints the admin
+     *                         settings header and footer, user renders the normal
+     *                         normal page including footer and header and blank
+     *                         just renders the plain template
+     * @return TemplateResponse Reference to this object
+     * @since 6.0.0 - return value was added in 7.0.0
+     */
+    public function renderAs($renderAs) {
+        $this->renderAs = $renderAs;
+
+        return $this;
+    }
+
+
+    /**
+     * Returns the set renderAs
+     * @return string the renderAs value
+     * @since 6.0.0
+     */
+    public function getRenderAs() {
+        return $this->renderAs;
+    }
+
+
+    /**
+     * Returns the rendered html
+     * @return string the rendered html
+     * @since 6.0.0
+     */
+    public function render() {
+        // \OCP\Template needs an empty string instead of 'blank' for an unwrapped response
+        $renderAs = $this->renderAs === 'blank' ? '' : $this->renderAs;
+
+        $template = new \OCP\Template($this->appName, $this->templateName, $renderAs);
+
+        foreach($this->params as $key => $value){
+            $template->assign($key, $value);
+        }
+
+        return $template->fetchPage($this->params);
+    }
 
 }

Spacing +5 added lines, -5 removed lines

@@ -39,8 +39,8 @@ 
  */
 class TemplateResponse extends Response {
 
-	const EVENT_LOAD_ADDITIONAL_SCRIPTS = self::class . '::loadAdditionalScripts';
-	const EVENT_LOAD_ADDITIONAL_SCRIPTS_LOGGEDIN = self::class . '::loadAdditionalScriptsLoggedIn';
+	const EVENT_LOAD_ADDITIONAL_SCRIPTS = self::class.'::loadAdditionalScripts';
+	const EVENT_LOAD_ADDITIONAL_SCRIPTS_LOGGEDIN = self::class.'::loadAdditionalScriptsLoggedIn';
 
 	/**
 	 * name of the template
@@ -75,8 +75,8 @@ 
 	 * @param string $renderAs how the page should be rendered, defaults to user
 	 * @since 6.0.0 - parameters $params and $renderAs were added in 7.0.0
 	 */
-	public function __construct($appName, $templateName, array $params=[],
-								$renderAs='user') {
+	public function __construct($appName, $templateName, array $params = [],
+								$renderAs = 'user') {
 		parent::__construct();
 
 		$this->templateName = $templateName;
@@ -160,7 +160,7 @@ 
 
 		$template = new \OCP\Template($this->appName, $this->templateName, $renderAs);
 
-		foreach($this->params as $key => $value){
+		foreach ($this->params as $key => $value) {
 			$template->assign($key, $value);
 		}
 

lib/public/AppFramework/Http/Template/PublicTemplateResponse.php

Indentation +120 added lines, -120 removed lines

@@ -36,125 +36,125 @@
  */
 class PublicTemplateResponse extends TemplateResponse {
 
-	private $headerTitle = '';
-	private $headerDetails = '';
-	private $headerActions = [];
-	private $footerVisible = true;
-
-	/**
-	 * PublicTemplateResponse constructor.
-	 *
-	 * @param string $appName
-	 * @param string $templateName
-	 * @param array $params
-	 * @since 14.0.0
-	 */
-	public function __construct(string $appName, string $templateName, array $params = []) {
-		parent::__construct($appName, $templateName, $params, 'public');
-		\OC_Util::addScript('core', 'public/publicpage');
-	}
-
-	/**
-	 * @param string $title
-	 * @since 14.0.0
-	 */
-	public function setHeaderTitle(string $title) {
-		$this->headerTitle = $title;
-	}
-
-	/**
-	 * @return string
-	 * @since 14.0.0
-	 */
-	public function getHeaderTitle(): string {
-		return $this->headerTitle;
-	}
-
-	/**
-	 * @param string $details
-	 * @since 14.0.0
-	 */
-	public function setHeaderDetails(string $details) {
-		$this->headerDetails = $details;
-	}
-
-	/**
-	 * @return string
-	 * @since 14.0.0
-	 */
-	public function getHeaderDetails(): string {
-		return $this->headerDetails;
-	}
-
-	/**
-	 * @param array $actions
-	 * @since 14.0.0
-	 * @throws InvalidArgumentException
-	 */
-	public function setHeaderActions(array $actions) {
-		foreach ($actions as $action) {
-			if ($actions instanceof IMenuAction) {
-				throw new InvalidArgumentException('Actions must be of type IMenuAction');
-			}
-			$this->headerActions[] = $action;
-		}
-		usort($this->headerActions, function (IMenuAction $a, IMenuAction $b) {
-			return $a->getPriority() > $b->getPriority();
-		});
-	}
-
-	/**
-	 * @return IMenuAction
-	 * @since 14.0.0
-	 * @throws \Exception
-	 */
-	public function getPrimaryAction(): IMenuAction {
-		if ($this->getActionCount() > 0) {
-			return $this->headerActions[0];
-		}
-		throw new \Exception('No header actions have been set');
-	}
-
-	/**
-	 * @return int
-	 * @since 14.0.0
-	 */
-	public function getActionCount(): int {
-		return count($this->headerActions);
-	}
-
-	/**
-	 * @return IMenuAction[]
-	 * @since 14.0.0
-	 */
-	public function getOtherActions(): array {
-		return array_slice($this->headerActions, 1);
-	}
-
-	/**
-	 * @since 14.0.0
-	 */
-	public function setFooterVisible(bool $visible = false) {
-		$this->footerVisible = $visible;
-	}
-
-	/**
-	 * @since 14.0.0
-	 */
-	public function getFooterVisible(): bool {
-		return $this->footerVisible;
-	}
-
-	/**
-	 * @return string
-	 * @since 14.0.0
-	 */
-	public function render(): string {
-		$params = array_merge($this->getParams(), [
-			'template' => $this,
-		]);
-		$this->setParams($params);
-		return  parent::render();
-	}
+    private $headerTitle = '';
+    private $headerDetails = '';
+    private $headerActions = [];
+    private $footerVisible = true;
+
+    /**
+     * PublicTemplateResponse constructor.
+     *
+     * @param string $appName
+     * @param string $templateName
+     * @param array $params
+     * @since 14.0.0
+     */
+    public function __construct(string $appName, string $templateName, array $params = []) {
+        parent::__construct($appName, $templateName, $params, 'public');
+        \OC_Util::addScript('core', 'public/publicpage');
+    }
+
+    /**
+     * @param string $title
+     * @since 14.0.0
+     */
+    public function setHeaderTitle(string $title) {
+        $this->headerTitle = $title;
+    }
+
+    /**
+     * @return string
+     * @since 14.0.0
+     */
+    public function getHeaderTitle(): string {
+        return $this->headerTitle;
+    }
+
+    /**
+     * @param string $details
+     * @since 14.0.0
+     */
+    public function setHeaderDetails(string $details) {
+        $this->headerDetails = $details;
+    }
+
+    /**
+     * @return string
+     * @since 14.0.0
+     */
+    public function getHeaderDetails(): string {
+        return $this->headerDetails;
+    }
+
+    /**
+     * @param array $actions
+     * @since 14.0.0
+     * @throws InvalidArgumentException
+     */
+    public function setHeaderActions(array $actions) {
+        foreach ($actions as $action) {
+            if ($actions instanceof IMenuAction) {
+                throw new InvalidArgumentException('Actions must be of type IMenuAction');
+            }
+            $this->headerActions[] = $action;
+        }
+        usort($this->headerActions, function (IMenuAction $a, IMenuAction $b) {
+            return $a->getPriority() > $b->getPriority();
+        });
+    }
+
+    /**
+     * @return IMenuAction
+     * @since 14.0.0
+     * @throws \Exception
+     */
+    public function getPrimaryAction(): IMenuAction {
+        if ($this->getActionCount() > 0) {
+            return $this->headerActions[0];
+        }
+        throw new \Exception('No header actions have been set');
+    }
+
+    /**
+     * @return int
+     * @since 14.0.0
+     */
+    public function getActionCount(): int {
+        return count($this->headerActions);
+    }
+
+    /**
+     * @return IMenuAction[]
+     * @since 14.0.0
+     */
+    public function getOtherActions(): array {
+        return array_slice($this->headerActions, 1);
+    }
+
+    /**
+     * @since 14.0.0
+     */
+    public function setFooterVisible(bool $visible = false) {
+        $this->footerVisible = $visible;
+    }
+
+    /**
+     * @since 14.0.0
+     */
+    public function getFooterVisible(): bool {
+        return $this->footerVisible;
+    }
+
+    /**
+     * @return string
+     * @since 14.0.0
+     */
+    public function render(): string {
+        $params = array_merge($this->getParams(), [
+            'template' => $this,
+        ]);
+        $this->setParams($params);
+        return  parent::render();
+    }
 
 }

Spacing +1 added lines, -1 removed lines

@@ -98,7 +98,7 @@
 			}
 			$this->headerActions[] = $action;
 		}
-		usort($this->headerActions, function (IMenuAction $a, IMenuAction $b) {
+		usort($this->headerActions, function(IMenuAction $a, IMenuAction $b) {
 			return $a->getPriority() > $b->getPriority();
 		});
 	}

lib/public/AppFramework/OCSController.php

Indentation +64 added lines, -64 removed lines

@@ -42,73 +42,73 @@
  */
 abstract class OCSController extends ApiController {
 
-	/** @var int */
-	private $ocsVersion;
+    /** @var int */
+    private $ocsVersion;
 
-	/**
-	 * constructor of the controller
-	 * @param string $appName the name of the app
-	 * @param IRequest $request an instance of the request
-	 * @param string $corsMethods comma separated string of HTTP verbs which
-	 * should be allowed for websites or webapps when calling your API, defaults to
-	 * 'PUT, POST, GET, DELETE, PATCH'
-	 * @param string $corsAllowedHeaders comma separated string of HTTP headers
-	 * which should be allowed for websites or webapps when calling your API,
-	 * 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 8.1.0
-	 */
-	public function __construct($appName,
-								IRequest $request,
-								$corsMethods='PUT, POST, GET, DELETE, PATCH',
-								$corsAllowedHeaders='Authorization, Content-Type, Accept',
-								$corsMaxAge=1728000) {
-		parent::__construct($appName, $request, $corsMethods,
-							$corsAllowedHeaders, $corsMaxAge);
-		$this->registerResponder('json', function ($data) {
-			return $this->buildOCSResponse('json', $data);
-		});
-		$this->registerResponder('xml', function ($data) {
-			return $this->buildOCSResponse('xml', $data);
-		});
-	}
+    /**
+     * constructor of the controller
+     * @param string $appName the name of the app
+     * @param IRequest $request an instance of the request
+     * @param string $corsMethods comma separated string of HTTP verbs which
+     * should be allowed for websites or webapps when calling your API, defaults to
+     * 'PUT, POST, GET, DELETE, PATCH'
+     * @param string $corsAllowedHeaders comma separated string of HTTP headers
+     * which should be allowed for websites or webapps when calling your API,
+     * 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 8.1.0
+     */
+    public function __construct($appName,
+                                IRequest $request,
+                                $corsMethods='PUT, POST, GET, DELETE, PATCH',
+                                $corsAllowedHeaders='Authorization, Content-Type, Accept',
+                                $corsMaxAge=1728000) {
+        parent::__construct($appName, $request, $corsMethods,
+                            $corsAllowedHeaders, $corsMaxAge);
+        $this->registerResponder('json', function ($data) {
+            return $this->buildOCSResponse('json', $data);
+        });
+        $this->registerResponder('xml', function ($data) {
+            return $this->buildOCSResponse('xml', $data);
+        });
+    }
 
-	/**
-	 * @param int $version
-	 * @since 11.0.0
-	 * @internal
-	 */
-	public function setOCSVersion($version) {
-		$this->ocsVersion = $version;
-	}
+    /**
+     * @param int $version
+     * @since 11.0.0
+     * @internal
+     */
+    public function setOCSVersion($version) {
+        $this->ocsVersion = $version;
+    }
 
-	/**
-	 * Since the OCS endpoints default to XML we need to find out the format
-	 * again
-	 * @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 9.1.0
-	 */
-	public function buildResponse($response, $format = 'xml') {
-		return parent::buildResponse($response, $format);
-	}
+    /**
+     * Since the OCS endpoints default to XML we need to find out the format
+     * again
+     * @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 9.1.0
+     */
+    public function buildResponse($response, $format = 'xml') {
+        return parent::buildResponse($response, $format);
+    }
 
-	/**
-	 * Unwrap data and build ocs response
-	 * @param string $format json or xml
-	 * @param DataResponse $data the data which should be transformed
-	 * @since 8.1.0
-	 * @return \OC\AppFramework\OCS\BaseResponse
-	 */
-	private function buildOCSResponse($format, DataResponse $data) {
-		if ($this->ocsVersion === 1) {
-			return new \OC\AppFramework\OCS\V1Response($data, $format);
-		}
-		return new \OC\AppFramework\OCS\V2Response($data, $format);
-	}
+    /**
+     * Unwrap data and build ocs response
+     * @param string $format json or xml
+     * @param DataResponse $data the data which should be transformed
+     * @since 8.1.0
+     * @return \OC\AppFramework\OCS\BaseResponse
+     */
+    private function buildOCSResponse($format, DataResponse $data) {
+        if ($this->ocsVersion === 1) {
+            return new \OC\AppFramework\OCS\V1Response($data, $format);
+        }
+        return new \OC\AppFramework\OCS\V2Response($data, $format);
+    }
 
 }

Spacing +5 added lines, -5 removed lines

@@ -61,15 +61,15 @@
 	 */
 	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, $corsMethods,
 							$corsAllowedHeaders, $corsMaxAge);
-		$this->registerResponder('json', function ($data) {
+		$this->registerResponder('json', function($data) {
 			return $this->buildOCSResponse('json', $data);
 		});
-		$this->registerResponder('xml', function ($data) {
+		$this->registerResponder('xml', function($data) {
 			return $this->buildOCSResponse('xml', $data);
 		});
 	}

lib/public/AppFramework/Db/DoesNotExistException.php

Indentation +8 added lines, -8 removed lines

@@ -34,13 +34,13 @@
  */
 class DoesNotExistException extends \Exception implements IMapperException {
 
-	/**
-	 * 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/Entity.php

Indentation +231 added lines, -231 removed lines

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

Spacing +18 added lines, -18 removed lines

@@ -51,8 +51,8 @@ 
 	public static function fromParams(array $params) {
 		$instance = new static();
 
-		foreach($params as $key => $value) {
-			$method = 'set' . ucfirst($key);
+		foreach ($params as $key => $value) {
+			$method = 'set'.ucfirst($key);
 			$instance->$method($value);
 		}
 
@@ -68,9 +68,9 @@ 
 	public static function fromRow(array $row) {
 		$instance = new static();
 
-		foreach($row as $key => $value){
+		foreach ($row as $key => $value) {
 			$prop = ucfirst($instance->columnToProperty($key));
-			$setter = 'set' . $prop;
+			$setter = 'set'.$prop;
 			$instance->$setter($value);
 		}
 
@@ -103,20 +103,20 @@ 
 	 */
 	protected function setter($name, $args) {
 		// setters should only work for existing attributes
-		if(property_exists($this, $name)){
-			if($this->$name === $args[0]) {
+		if (property_exists($this, $name)) {
+			if ($this->$name === $args[0]) {
 				return;
 			}
 			$this->markFieldUpdated($name);
 
 			// if type definition exists, cast to correct type
-			if($args[0] !== null && array_key_exists($name, $this->_fieldTypes)) {
+			if ($args[0] !== null && array_key_exists($name, $this->_fieldTypes)) {
 				settype($args[0], $this->_fieldTypes[$name]);
 			}
 			$this->$name = $args[0];
 
 		} else {
-			throw new \BadFunctionCallException($name .
+			throw new \BadFunctionCallException($name.
 				' is not a valid attribute');
 		}
 	}
@@ -127,10 +127,10 @@ 
 	 */
 	protected function getter($name) {
 		// getters should only work for existing attributes
-		if(property_exists($this, $name)){
+		if (property_exists($this, $name)) {
 			return $this->$name;
 		} else {
-			throw new \BadFunctionCallException($name .
+			throw new \BadFunctionCallException($name.
 				' is not a valid attribute');
 		}
 	}
@@ -151,7 +151,7 @@ 
 		} elseif ($this->isGetterForBoolProperty($methodName)) {
 			return $this->getter(lcfirst(substr($methodName, 2)));
 		} else {
-			throw new \BadFunctionCallException($methodName .
+			throw new \BadFunctionCallException($methodName.
 				' does not exist');
 		}
 
@@ -190,8 +190,8 @@ 
 		$parts = explode('_', $columnName);
 		$property = null;
 
-		foreach($parts as $part){
-			if($property === null){
+		foreach ($parts as $part) {
+			if ($property === null) {
 				$property = $part;
 			} else {
 				$property .= ucfirst($part);
@@ -212,11 +212,11 @@ 
 		$parts = preg_split('/(?=[A-Z])/', $property);
 		$column = null;
 
-		foreach($parts as $part){
-			if($column === null){
+		foreach ($parts as $part) {
+			if ($column === null) {
 				$column = $part;
 			} else {
-				$column .= '_' . lcfirst($part);
+				$column .= '_'.lcfirst($part);
 			}
 		}
 
@@ -254,7 +254,7 @@ 
 	 */
 	public function slugify($attributeName) {
 		// toSlug should only work for existing attributes
-		if(property_exists($this, $attributeName)){
+		if (property_exists($this, $attributeName)) {
 			$value = $this->$attributeName;
 			// replace everything except alphanumeric with a single '-'
 			$value = preg_replace('/[^A-Za-z0-9]+/', '-', $value);
@@ -262,7 +262,7 @@ 
 			// trim '-'
 			return trim($value, '-');
 		} else {
-			throw new \BadFunctionCallException($attributeName .
+			throw new \BadFunctionCallException($attributeName.
 				' is not a valid attribute');
 		}
 	}

lib/public/AppFramework/Db/Mapper.php

Indentation +333 added lines, -333 removed lines

@@ -37,339 +37,339 @@
  */
 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
-	 * @deprecated 14.0.0 Move over to QBMapper
-	 */
-	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
-	 * @deprecated 14.0.0 Move over to QBMapper
-	 */
-	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
-	 * @deprecated 14.0.0 Move over to QBMapper
-	 */
-	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
-	 * @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
-		// 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
-	 * @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
-		$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
-	 * @deprecated 14.0.0 Move over to QBMapper
-	 */
-	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
-	 * @deprecated 14.0.0 Move over to QBMapper
-	 */
-	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
-	 * @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);
-
-		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
-	 * @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);
-		$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
-	 * @deprecated 14.0.0 Move over to QBMapper
-	 */
-	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
-	 * @deprecated 14.0.0 Move over to QBMapper
-	 */
-	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
-	 * @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);
-
-		$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
-	 * @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));
-	}
+    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
+     * @deprecated 14.0.0 Move over to QBMapper
+     */
+    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
+     * @deprecated 14.0.0 Move over to QBMapper
+     */
+    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
+     * @deprecated 14.0.0 Move over to QBMapper
+     */
+    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
+     * @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
+        // 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
+     * @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
+        $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
+     * @deprecated 14.0.0 Move over to QBMapper
+     */
+    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
+     * @deprecated 14.0.0 Move over to QBMapper
+     */
+    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
+     * @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);
+
+        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
+     * @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);
+        $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
+     * @deprecated 14.0.0 Move over to QBMapper
+     */
+    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
+     * @deprecated 14.0.0 Move over to QBMapper
+     */
+    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
+     * @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);
+
+        $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
+     * @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));
+    }
 
 
 }

Spacing +33 added lines, -33 removed lines

@@ -49,13 +49,13 @@ 
 	 * @since 7.0.0
 	 * @deprecated 14.0.0 Move over to QBMapper
 	 */
-	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;
@@ -81,7 +81,7 @@ 
 	 * @deprecated 14.0.0 Move over to QBMapper
 	 */
 	public function delete(Entity $entity) {
-		$sql = 'DELETE FROM `' . $this->tableName . '` WHERE `id` = ?';
+		$sql = 'DELETE FROM `'.$this->tableName.'` WHERE `id` = ?';
 		$stmt = $this->execute($sql, [$entity->getId()]);
 		$stmt->closeCursor();
 		return $entity;
@@ -105,15 +105,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 .= ',';
 			}
@@ -123,8 +123,8 @@ 
 
 		}
 
-		$sql = 'INSERT INTO `' . $this->tableName . '`(' .
-				$columns . ') VALUES(' . $values . ')';
+		$sql = 'INSERT INTO `'.$this->tableName.'`('.
+				$columns.') VALUES('.$values.')';
 
 		$stmt = $this->execute($sql, $params);
 
@@ -148,13 +148,13 @@ 
 	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');
 		}
@@ -169,15 +169,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 .= ',';
 			}
 
@@ -185,8 +185,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);
@@ -235,7 +235,7 @@ 
 	 * @since 7.0.0
 	 * @deprecated 14.0.0 Move over to QBMapper
 	 */
-	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)) {
@@ -244,7 +244,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);
@@ -271,11 +271,11 @@ 
 	 * @since 7.0.0
 	 * @deprecated 14.0.0 Move over to QBMapper
 	 */
-	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
@@ -285,7 +285,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
 			);
@@ -307,12 +307,12 @@ 
 	 * @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 .
-					': 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.'"';
 	}
 
 
@@ -325,7 +325,7 @@ 
 	 * @deprecated 14.0.0 Move over to QBMapper
 	 */
 	protected function mapRowToEntity($row) {
-		return call_user_func($this->entityClass .'::fromRow', $row);
+		return call_user_func($this->entityClass.'::fromRow', $row);
 	}
 
 
@@ -339,12 +339,12 @@ 
 	 * @since 7.0.0
 	 * @deprecated 14.0.0 Move over to QBMapper
 	 */
-	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);
 		}
 
@@ -367,7 +367,7 @@ 
 	 * @since 7.0.0
 	 * @deprecated 14.0.0 Move over to QBMapper
 	 */
-	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));
 	}
 

lib/public/AppFramework/Db/MultipleObjectsReturnedException.php

Indentation +8 added lines, -8 removed lines

@@ -34,13 +34,13 @@
  */
 class MultipleObjectsReturnedException extends \Exception implements IMapperException {
 
-	/**
-	 * 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/QBMapper.php

Indentation +289 added lines, -289 removed lines

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

Spacing +18 added lines, -18 removed lines

@@ -58,13 +58,13 @@ 
 	 * mapped to queries without using sql
 	 * @since 14.0.0
 	 */
-	public function __construct(IDBConnection $db, string $tableName, string $entityClass=null) {
+	public function __construct(IDBConnection $db, string $tableName, string $entityClass = null) {
 		$this->db = $db;
 		$this->tableName = $tableName;
 
 		// if not given set the entity name to the class without the mapper part
 		// cache it here for later use since reflection is slow
-		if($entityClass === null) {
+		if ($entityClass === null) {
 			$this->entityClass = str_replace('Mapper', '', \get_class($this));
 		} else {
 			$this->entityClass = $entityClass;
@@ -117,9 +117,9 @@ 
 		$qb->insert($this->tableName);
 
 		// build the fields
-		foreach($properties as $property => $updated) {
+		foreach ($properties as $property => $updated) {
 			$column = $entity->propertyToColumn($property);
-			$getter = 'get' . ucfirst($property);
+			$getter = 'get'.ucfirst($property);
 			$value = $entity->$getter();
 
 			$type = $this->getParameterTypeForProperty($entity, $property);
@@ -128,9 +128,9 @@ 
 
 		$qb->execute();
 
-		if($entity->id === null) {
+		if ($entity->id === null) {
 			// When autoincrement is used id is always an int
-			$entity->setId((int)$qb->getLastInsertId());
+			$entity->setId((int) $qb->getLastInsertId());
 		}
 
 		return $entity;
@@ -166,13 +166,13 @@ 
 	public function update(Entity $entity): Entity {
 		// if entity wasn't changed it makes no sense to run a db query
 		$properties = $entity->getUpdatedFields();
-		if(\count($properties) === 0) {
+		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');
 		}
@@ -186,9 +186,9 @@ 
 		$qb->update($this->tableName);
 
 		// build the fields
-		foreach($properties as $property => $updated) {
+		foreach ($properties as $property => $updated) {
 			$column = $entity->propertyToColumn($property);
-			$getter = 'get' . ucfirst($property);
+			$getter = 'get'.ucfirst($property);
 			$value = $entity->$getter();
 
 			$type = $this->getParameterTypeForProperty($entity, $property);
@@ -217,11 +217,11 @@ 
 	protected function getParameterTypeForProperty(Entity $entity, string $property): int {
 		$types = $entity->getFieldTypes();
 
-		if(!isset($types[ $property ])) {
+		if (!isset($types[$property])) {
 			return IQueryBuilder::PARAM_STR;
 		}
 
-		switch($types[ $property ]) {
+		switch ($types[$property]) {
 			case 'int':
 			case 'integer':
 				return IQueryBuilder::PARAM_INT;
@@ -251,7 +251,7 @@ 
 		$cursor = $query->execute();
 
 		$row = $cursor->fetch();
-		if($row === false) {
+		if ($row === false) {
 			$cursor->closeCursor();
 			$msg = $this->buildDebugMessage(
 				'Did expect one result but found none when executing', $query
@@ -261,7 +261,7 @@ 
 
 		$row2 = $cursor->fetch();
 		$cursor->closeCursor();
-		if($row2 !== false ) {
+		if ($row2 !== false) {
 			$msg = $this->buildDebugMessage(
 				'Did not expect more than one result when executing', $query
 			);
@@ -278,8 +278,8 @@ 
 	 * @since 14.0.0
 	 */
 	private function buildDebugMessage(string $msg, IQueryBuilder $sql): string {
-		return $msg .
-			': query "' . $sql->getSQL() . '"; ';
+		return $msg.
+			': query "'.$sql->getSQL().'"; ';
 	}
 
 
@@ -292,7 +292,7 @@ 
 	 * @since 14.0.0
 	 */
 	protected function mapRowToEntity(array $row): Entity {
-		return \call_user_func($this->entityClass .'::fromRow', $row);
+		return \call_user_func($this->entityClass.'::fromRow', $row);
 	}
 
 
@@ -308,7 +308,7 @@ 
 
 		$entities = [];
 
-		while($row = $cursor->fetch()){
+		while ($row = $cursor->fetch()) {
 			$entities[] = $this->mapRowToEntity($row);
 		}
 

lib/public/AppFramework/Middleware.php

Indentation +57 added lines, -57 removed lines

@@ -43,69 +43,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;
+    }
 
 }