nextcloud / server

lib/private/Memcache/Memcached.php

Doc Comments +1 added lines, -1 removed lines

@@ -155,7 +155,7 @@
 	 * Set a value in the cache if it's not already stored
 	 *
 	 * @param string $key
-	 * @param mixed $value
+	 * @param integer $value
 	 * @param int $ttl Time To Live in seconds. Defaults to 60*60*24
 	 * @return bool
 	 * @throws \Exception

Indentation +189 added lines, -189 removed lines

@@ -33,193 +33,193 @@
 use OCP\IMemcache;
 
 class Memcached extends Cache implements IMemcache {
-	use CASTrait;
-
-	/**
-	 * @var \Memcached $cache
-	 */
-	private static $cache = null;
-
-	use CADTrait;
-
-	public function __construct($prefix = '') {
-		parent::__construct($prefix);
-		if (is_null(self::$cache)) {
-			self::$cache = new \Memcached();
-
-			$defaultOptions = [
-				\Memcached::OPT_CONNECT_TIMEOUT => 50,
-				\Memcached::OPT_RETRY_TIMEOUT =>   50,
-				\Memcached::OPT_SEND_TIMEOUT =>    50,
-				\Memcached::OPT_RECV_TIMEOUT =>    50,
-				\Memcached::OPT_POLL_TIMEOUT =>    50,
-
-				// Enable compression
-				\Memcached::OPT_COMPRESSION =>          true,
-
-				// Turn on consistent hashing
-				\Memcached::OPT_LIBKETAMA_COMPATIBLE => true,
-
-				// Enable Binary Protocol
-				//\Memcached::OPT_BINARY_PROTOCOL =>      true,
-			];
-			// by default enable igbinary serializer if available
-			if (\Memcached::HAVE_IGBINARY) {
-				$defaultOptions[\Memcached::OPT_SERIALIZER] =
-					\Memcached::SERIALIZER_IGBINARY;
-			}
-			$options = \OC::$server->getConfig()->getSystemValue('memcached_options', []);
-			if (is_array($options)) {
-				$options = $options + $defaultOptions;
-				self::$cache->setOptions($options);
-			} else {
-				throw new HintException("Expected 'memcached_options' config to be an array, got $options");
-			}
-
-			$servers = \OC::$server->getSystemConfig()->getValue('memcached_servers');
-			if (!$servers) {
-				$server = \OC::$server->getSystemConfig()->getValue('memcached_server');
-				if ($server) {
-					$servers = [$server];
-				} else {
-					$servers = [['localhost', 11211]];
-				}
-			}
-			self::$cache->addServers($servers);
-		}
-	}
-
-	/**
-	 * entries in XCache gets namespaced to prevent collisions between owncloud instances and users
-	 */
-	protected function getNameSpace() {
-		return $this->prefix;
-	}
-
-	public function get($key) {
-		$result = self::$cache->get($this->getNamespace() . $key);
-		if ($result === false and self::$cache->getResultCode() == \Memcached::RES_NOTFOUND) {
-			return null;
-		} else {
-			return $result;
-		}
-	}
-
-	public function set($key, $value, $ttl = 0) {
-		if ($ttl > 0) {
-			$result =  self::$cache->set($this->getNamespace() . $key, $value, $ttl);
-		} else {
-			$result = self::$cache->set($this->getNamespace() . $key, $value);
-		}
-		if ($result !== true) {
-			$this->verifyReturnCode();
-		}
-		return $result;
-	}
-
-	public function hasKey($key) {
-		self::$cache->get($this->getNamespace() . $key);
-		return self::$cache->getResultCode() === \Memcached::RES_SUCCESS;
-	}
-
-	public function remove($key) {
-		$result= self::$cache->delete($this->getNamespace() . $key);
-		if (self::$cache->getResultCode() !== \Memcached::RES_NOTFOUND) {
-			$this->verifyReturnCode();
-		}
-		return $result;
-	}
-
-	public function clear($prefix = '') {
-		$prefix = $this->getNamespace() . $prefix;
-		$allKeys = self::$cache->getAllKeys();
-		if ($allKeys === false) {
-			// newer Memcached doesn't like getAllKeys(), flush everything
-			self::$cache->flush();
-			return true;
-		}
-		$keys = array();
-		$prefixLength = strlen($prefix);
-		foreach ($allKeys as $key) {
-			if (substr($key, 0, $prefixLength) === $prefix) {
-				$keys[] = $key;
-			}
-		}
-		if (method_exists(self::$cache, 'deleteMulti')) {
-			self::$cache->deleteMulti($keys);
-		} else {
-			foreach ($keys as $key) {
-				self::$cache->delete($key);
-			}
-		}
-		return true;
-	}
-
-	/**
-	 * Set a value in the cache if it's not already stored
-	 *
-	 * @param string $key
-	 * @param mixed $value
-	 * @param int $ttl Time To Live in seconds. Defaults to 60*60*24
-	 * @return bool
-	 * @throws \Exception
-	 */
-	public function add($key, $value, $ttl = 0) {
-		$result = self::$cache->add($this->getPrefix() . $key, $value, $ttl);
-		if (self::$cache->getResultCode() !== \Memcached::RES_NOTSTORED) {
-			$this->verifyReturnCode();
-		}
-		return $result;
-	}
-
-	/**
-	 * Increase a stored number
-	 *
-	 * @param string $key
-	 * @param int $step
-	 * @return int | bool
-	 */
-	public function inc($key, $step = 1) {
-		$this->add($key, 0);
-		$result = self::$cache->increment($this->getPrefix() . $key, $step);
-
-		if (self::$cache->getResultCode() !== \Memcached::RES_SUCCESS) {
-			return false;
-		}
-
-		return $result;
-	}
-
-	/**
-	 * Decrease a stored number
-	 *
-	 * @param string $key
-	 * @param int $step
-	 * @return int | bool
-	 */
-	public function dec($key, $step = 1) {
-		$result = self::$cache->decrement($this->getPrefix() . $key, $step);
-
-		if (self::$cache->getResultCode() !== \Memcached::RES_SUCCESS) {
-			return false;
-		}
-
-		return $result;
-	}
-
-	static public function isAvailable() {
-		return extension_loaded('memcached');
-	}
-
-	/**
-	 * @throws \Exception
-	 */
-	private function verifyReturnCode() {
-		$code = self::$cache->getResultCode();
-		if ($code === \Memcached::RES_SUCCESS) {
-			return;
-		}
-		$message = self::$cache->getResultMessage();
-		throw new \Exception("Error $code interacting with memcached : $message");
-	}
+    use CASTrait;
+
+    /**
+     * @var \Memcached $cache
+     */
+    private static $cache = null;
+
+    use CADTrait;
+
+    public function __construct($prefix = '') {
+        parent::__construct($prefix);
+        if (is_null(self::$cache)) {
+            self::$cache = new \Memcached();
+
+            $defaultOptions = [
+                \Memcached::OPT_CONNECT_TIMEOUT => 50,
+                \Memcached::OPT_RETRY_TIMEOUT =>   50,
+                \Memcached::OPT_SEND_TIMEOUT =>    50,
+                \Memcached::OPT_RECV_TIMEOUT =>    50,
+                \Memcached::OPT_POLL_TIMEOUT =>    50,
+
+                // Enable compression
+                \Memcached::OPT_COMPRESSION =>          true,
+
+                // Turn on consistent hashing
+                \Memcached::OPT_LIBKETAMA_COMPATIBLE => true,
+
+                // Enable Binary Protocol
+                //\Memcached::OPT_BINARY_PROTOCOL =>      true,
+            ];
+            // by default enable igbinary serializer if available
+            if (\Memcached::HAVE_IGBINARY) {
+                $defaultOptions[\Memcached::OPT_SERIALIZER] =
+                    \Memcached::SERIALIZER_IGBINARY;
+            }
+            $options = \OC::$server->getConfig()->getSystemValue('memcached_options', []);
+            if (is_array($options)) {
+                $options = $options + $defaultOptions;
+                self::$cache->setOptions($options);
+            } else {
+                throw new HintException("Expected 'memcached_options' config to be an array, got $options");
+            }
+
+            $servers = \OC::$server->getSystemConfig()->getValue('memcached_servers');
+            if (!$servers) {
+                $server = \OC::$server->getSystemConfig()->getValue('memcached_server');
+                if ($server) {
+                    $servers = [$server];
+                } else {
+                    $servers = [['localhost', 11211]];
+                }
+            }
+            self::$cache->addServers($servers);
+        }
+    }
+
+    /**
+     * entries in XCache gets namespaced to prevent collisions between owncloud instances and users
+     */
+    protected function getNameSpace() {
+        return $this->prefix;
+    }
+
+    public function get($key) {
+        $result = self::$cache->get($this->getNamespace() . $key);
+        if ($result === false and self::$cache->getResultCode() == \Memcached::RES_NOTFOUND) {
+            return null;
+        } else {
+            return $result;
+        }
+    }
+
+    public function set($key, $value, $ttl = 0) {
+        if ($ttl > 0) {
+            $result =  self::$cache->set($this->getNamespace() . $key, $value, $ttl);
+        } else {
+            $result = self::$cache->set($this->getNamespace() . $key, $value);
+        }
+        if ($result !== true) {
+            $this->verifyReturnCode();
+        }
+        return $result;
+    }
+
+    public function hasKey($key) {
+        self::$cache->get($this->getNamespace() . $key);
+        return self::$cache->getResultCode() === \Memcached::RES_SUCCESS;
+    }
+
+    public function remove($key) {
+        $result= self::$cache->delete($this->getNamespace() . $key);
+        if (self::$cache->getResultCode() !== \Memcached::RES_NOTFOUND) {
+            $this->verifyReturnCode();
+        }
+        return $result;
+    }
+
+    public function clear($prefix = '') {
+        $prefix = $this->getNamespace() . $prefix;
+        $allKeys = self::$cache->getAllKeys();
+        if ($allKeys === false) {
+            // newer Memcached doesn't like getAllKeys(), flush everything
+            self::$cache->flush();
+            return true;
+        }
+        $keys = array();
+        $prefixLength = strlen($prefix);
+        foreach ($allKeys as $key) {
+            if (substr($key, 0, $prefixLength) === $prefix) {
+                $keys[] = $key;
+            }
+        }
+        if (method_exists(self::$cache, 'deleteMulti')) {
+            self::$cache->deleteMulti($keys);
+        } else {
+            foreach ($keys as $key) {
+                self::$cache->delete($key);
+            }
+        }
+        return true;
+    }
+
+    /**
+     * Set a value in the cache if it's not already stored
+     *
+     * @param string $key
+     * @param mixed $value
+     * @param int $ttl Time To Live in seconds. Defaults to 60*60*24
+     * @return bool
+     * @throws \Exception
+     */
+    public function add($key, $value, $ttl = 0) {
+        $result = self::$cache->add($this->getPrefix() . $key, $value, $ttl);
+        if (self::$cache->getResultCode() !== \Memcached::RES_NOTSTORED) {
+            $this->verifyReturnCode();
+        }
+        return $result;
+    }
+
+    /**
+     * Increase a stored number
+     *
+     * @param string $key
+     * @param int $step
+     * @return int | bool
+     */
+    public function inc($key, $step = 1) {
+        $this->add($key, 0);
+        $result = self::$cache->increment($this->getPrefix() . $key, $step);
+
+        if (self::$cache->getResultCode() !== \Memcached::RES_SUCCESS) {
+            return false;
+        }
+
+        return $result;
+    }
+
+    /**
+     * Decrease a stored number
+     *
+     * @param string $key
+     * @param int $step
+     * @return int | bool
+     */
+    public function dec($key, $step = 1) {
+        $result = self::$cache->decrement($this->getPrefix() . $key, $step);
+
+        if (self::$cache->getResultCode() !== \Memcached::RES_SUCCESS) {
+            return false;
+        }
+
+        return $result;
+    }
+
+    static public function isAvailable() {
+        return extension_loaded('memcached');
+    }
+
+    /**
+     * @throws \Exception
+     */
+    private function verifyReturnCode() {
+        $code = self::$cache->getResultCode();
+        if ($code === \Memcached::RES_SUCCESS) {
+            return;
+        }
+        $message = self::$cache->getResultMessage();
+        throw new \Exception("Error $code interacting with memcached : $message");
+    }
 }

Spacing +9 added lines, -9 removed lines

@@ -97,7 +97,7 @@ 
 	}
 
 	public function get($key) {
-		$result = self::$cache->get($this->getNamespace() . $key);
+		$result = self::$cache->get($this->getNamespace().$key);
 		if ($result === false and self::$cache->getResultCode() == \Memcached::RES_NOTFOUND) {
 			return null;
 		} else {
@@ -107,9 +107,9 @@ 
 
 	public function set($key, $value, $ttl = 0) {
 		if ($ttl > 0) {
-			$result =  self::$cache->set($this->getNamespace() . $key, $value, $ttl);
+			$result = self::$cache->set($this->getNamespace().$key, $value, $ttl);
 		} else {
-			$result = self::$cache->set($this->getNamespace() . $key, $value);
+			$result = self::$cache->set($this->getNamespace().$key, $value);
 		}
 		if ($result !== true) {
 			$this->verifyReturnCode();
@@ -118,12 +118,12 @@ 
 	}
 
 	public function hasKey($key) {
-		self::$cache->get($this->getNamespace() . $key);
+		self::$cache->get($this->getNamespace().$key);
 		return self::$cache->getResultCode() === \Memcached::RES_SUCCESS;
 	}
 
 	public function remove($key) {
-		$result= self::$cache->delete($this->getNamespace() . $key);
+		$result = self::$cache->delete($this->getNamespace().$key);
 		if (self::$cache->getResultCode() !== \Memcached::RES_NOTFOUND) {
 			$this->verifyReturnCode();
 		}
@@ -131,7 +131,7 @@ 
 	}
 
 	public function clear($prefix = '') {
-		$prefix = $this->getNamespace() . $prefix;
+		$prefix = $this->getNamespace().$prefix;
 		$allKeys = self::$cache->getAllKeys();
 		if ($allKeys === false) {
 			// newer Memcached doesn't like getAllKeys(), flush everything
@@ -165,7 +165,7 @@ 
 	 * @throws \Exception
 	 */
 	public function add($key, $value, $ttl = 0) {
-		$result = self::$cache->add($this->getPrefix() . $key, $value, $ttl);
+		$result = self::$cache->add($this->getPrefix().$key, $value, $ttl);
 		if (self::$cache->getResultCode() !== \Memcached::RES_NOTSTORED) {
 			$this->verifyReturnCode();
 		}
@@ -181,7 +181,7 @@ 
 	 */
 	public function inc($key, $step = 1) {
 		$this->add($key, 0);
-		$result = self::$cache->increment($this->getPrefix() . $key, $step);
+		$result = self::$cache->increment($this->getPrefix().$key, $step);
 
 		if (self::$cache->getResultCode() !== \Memcached::RES_SUCCESS) {
 			return false;
@@ -198,7 +198,7 @@ 
 	 * @return int | bool
 	 */
 	public function dec($key, $step = 1) {
-		$result = self::$cache->decrement($this->getPrefix() . $key, $step);
+		$result = self::$cache->decrement($this->getPrefix().$key, $step);
 
 		if (self::$cache->getResultCode() !== \Memcached::RES_SUCCESS) {
 			return false;

lib/private/Repair.php

Doc Comments +1 added lines, -2 removed lines

@@ -139,7 +139,7 @@ 
 	 * Returns expensive repair steps to be run on the
 	 * command line with a special option.
 	 *
-	 * @return IRepairStep[]
+	 * @return OldGroupMembershipShares[]
 	 */
 	public static function getExpensiveRepairSteps() {
 		return [
@@ -216,7 +216,6 @@ 
 	}
 
 	/**
-	 * @param int $max
 	 */
 	public function finishProgress() {
 		// for now just emit as we did in the past

Spacing +1 added lines, -1 removed lines

@@ -58,7 +58,7 @@
 use Symfony\Component\EventDispatcher\EventDispatcher;
 use Symfony\Component\EventDispatcher\GenericEvent;
 
-class Repair implements IOutput{
+class Repair implements IOutput {
 	/* @var IRepairStep[] */
 	private $repairSteps;
 	/** @var EventDispatcher */

Indentation +174 added lines, -174 removed lines

@@ -52,178 +52,178 @@
 use Symfony\Component\EventDispatcher\GenericEvent;
 
 class Repair implements IOutput{
-	/* @var IRepairStep[] */
-	private $repairSteps;
-	/** @var EventDispatcher */
-	private $dispatcher;
-	/** @var string */
-	private $currentStep;
-
-	/**
-	 * Creates a new repair step runner
-	 *
-	 * @param IRepairStep[] $repairSteps array of RepairStep instances
-	 * @param EventDispatcher $dispatcher
-	 */
-	public function __construct($repairSteps = [], EventDispatcher $dispatcher = null) {
-		$this->repairSteps = $repairSteps;
-		$this->dispatcher = $dispatcher;
-	}
-
-	/**
-	 * Run a series of repair steps for common problems
-	 */
-	public function run() {
-		if (count($this->repairSteps) === 0) {
-			$this->emit('\OC\Repair', 'info', array('No repair steps available'));
-			return;
-		}
-		// run each repair step
-		foreach ($this->repairSteps as $step) {
-			$this->currentStep = $step->getName();
-			$this->emit('\OC\Repair', 'step', [$this->currentStep]);
-			$step->run($this);
-		}
-	}
-
-	/**
-	 * Add repair step
-	 *
-	 * @param IRepairStep|string $repairStep repair step
-	 * @throws \Exception
-	 */
-	public function addStep($repairStep) {
-		if (is_string($repairStep)) {
-			try {
-				$s = \OC::$server->query($repairStep);
-			} catch (QueryException $e) {
-				if (class_exists($repairStep)) {
-					$s = new $repairStep();
-				} else {
-					throw new \Exception("Repair step '$repairStep' is unknown");
-				}
-			}
-
-			if ($s instanceof IRepairStep) {
-				$this->repairSteps[] = $s;
-			} else {
-				throw new \Exception("Repair step '$repairStep' is not of type \\OCP\\Migration\\IRepairStep");
-			}
-		} else {
-			$this->repairSteps[] = $repairStep;
-		}
-	}
-
-	/**
-	 * Returns the default repair steps to be run on the
-	 * command line or after an upgrade.
-	 *
-	 * @return IRepairStep[]
-	 */
-	public static function getRepairSteps() {
-		return [
-			new Collation(\OC::$server->getConfig(), \OC::$server->getLogger(), \OC::$server->getDatabaseConnection(), false),
-			new RepairMimeTypes(\OC::$server->getConfig()),
-			new CleanTags(\OC::$server->getDatabaseConnection(), \OC::$server->getUserManager()),
-			new RepairInvalidShares(\OC::$server->getConfig(), \OC::$server->getDatabaseConnection()),
-			new RemoveRootShares(\OC::$server->getDatabaseConnection(), \OC::$server->getUserManager(), \OC::$server->getLazyRootFolder()),
-			new MoveUpdaterStepFile(\OC::$server->getConfig()),
-			new MoveAvatars(
-				\OC::$server->getJobList(),
-				\OC::$server->getConfig()
-			),
-			new CleanPreviews(
-				\OC::$server->getJobList(),
-				\OC::$server->getUserManager(),
-				\OC::$server->getConfig()
-			),
-			new FixMountStorages(\OC::$server->getDatabaseConnection()),
-			new UpdateLanguageCodes(\OC::$server->getDatabaseConnection(), \OC::$server->getConfig()),
-			new InstallCoreBundle(
-				\OC::$server->query(BundleFetcher::class),
-				\OC::$server->getConfig(),
-				\OC::$server->query(Installer::class)
-			)
-		];
-	}
-
-	/**
-	 * Returns expensive repair steps to be run on the
-	 * command line with a special option.
-	 *
-	 * @return IRepairStep[]
-	 */
-	public static function getExpensiveRepairSteps() {
-		return [
-			new OldGroupMembershipShares(\OC::$server->getDatabaseConnection(), \OC::$server->getGroupManager()),
-		];
-	}
-
-	/**
-	 * Returns the repair steps to be run before an
-	 * upgrade.
-	 *
-	 * @return IRepairStep[]
-	 */
-	public static function getBeforeUpgradeRepairSteps() {
-		$connection = \OC::$server->getDatabaseConnection();
-		$config = \OC::$server->getConfig();
-		$steps = [
-			new Collation(\OC::$server->getConfig(), \OC::$server->getLogger(), $connection, true),
-			new SqliteAutoincrement($connection),
-			new SaveAccountsTableData($connection, $config),
-		];
-
-		return $steps;
-	}
-
-	/**
-	 * @param string $scope
-	 * @param string $method
-	 * @param array $arguments
-	 */
-	public function emit($scope, $method, array $arguments = []) {
-		if (!is_null($this->dispatcher)) {
-			$this->dispatcher->dispatch("$scope::$method",
-				new GenericEvent("$scope::$method", $arguments));
-		}
-	}
-
-	public function info($string) {
-		// for now just emit as we did in the past
-		$this->emit('\OC\Repair', 'info', array($string));
-	}
-
-	/**
-	 * @param string $message
-	 */
-	public function warning($message) {
-		// for now just emit as we did in the past
-		$this->emit('\OC\Repair', 'warning', [$message]);
-	}
-
-	/**
-	 * @param int $max
-	 */
-	public function startProgress($max = 0) {
-		// for now just emit as we did in the past
-		$this->emit('\OC\Repair', 'startProgress', [$max, $this->currentStep]);
-	}
-
-	/**
-	 * @param int $step
-	 * @param string $description
-	 */
-	public function advance($step = 1, $description = '') {
-		// for now just emit as we did in the past
-		$this->emit('\OC\Repair', 'advance', [$step, $description]);
-	}
-
-	/**
-	 * @param int $max
-	 */
-	public function finishProgress() {
-		// for now just emit as we did in the past
-		$this->emit('\OC\Repair', 'finishProgress', []);
-	}
+    /* @var IRepairStep[] */
+    private $repairSteps;
+    /** @var EventDispatcher */
+    private $dispatcher;
+    /** @var string */
+    private $currentStep;
+
+    /**
+     * Creates a new repair step runner
+     *
+     * @param IRepairStep[] $repairSteps array of RepairStep instances
+     * @param EventDispatcher $dispatcher
+     */
+    public function __construct($repairSteps = [], EventDispatcher $dispatcher = null) {
+        $this->repairSteps = $repairSteps;
+        $this->dispatcher = $dispatcher;
+    }
+
+    /**
+     * Run a series of repair steps for common problems
+     */
+    public function run() {
+        if (count($this->repairSteps) === 0) {
+            $this->emit('\OC\Repair', 'info', array('No repair steps available'));
+            return;
+        }
+        // run each repair step
+        foreach ($this->repairSteps as $step) {
+            $this->currentStep = $step->getName();
+            $this->emit('\OC\Repair', 'step', [$this->currentStep]);
+            $step->run($this);
+        }
+    }
+
+    /**
+     * Add repair step
+     *
+     * @param IRepairStep|string $repairStep repair step
+     * @throws \Exception
+     */
+    public function addStep($repairStep) {
+        if (is_string($repairStep)) {
+            try {
+                $s = \OC::$server->query($repairStep);
+            } catch (QueryException $e) {
+                if (class_exists($repairStep)) {
+                    $s = new $repairStep();
+                } else {
+                    throw new \Exception("Repair step '$repairStep' is unknown");
+                }
+            }
+
+            if ($s instanceof IRepairStep) {
+                $this->repairSteps[] = $s;
+            } else {
+                throw new \Exception("Repair step '$repairStep' is not of type \\OCP\\Migration\\IRepairStep");
+            }
+        } else {
+            $this->repairSteps[] = $repairStep;
+        }
+    }
+
+    /**
+     * Returns the default repair steps to be run on the
+     * command line or after an upgrade.
+     *
+     * @return IRepairStep[]
+     */
+    public static function getRepairSteps() {
+        return [
+            new Collation(\OC::$server->getConfig(), \OC::$server->getLogger(), \OC::$server->getDatabaseConnection(), false),
+            new RepairMimeTypes(\OC::$server->getConfig()),
+            new CleanTags(\OC::$server->getDatabaseConnection(), \OC::$server->getUserManager()),
+            new RepairInvalidShares(\OC::$server->getConfig(), \OC::$server->getDatabaseConnection()),
+            new RemoveRootShares(\OC::$server->getDatabaseConnection(), \OC::$server->getUserManager(), \OC::$server->getLazyRootFolder()),
+            new MoveUpdaterStepFile(\OC::$server->getConfig()),
+            new MoveAvatars(
+                \OC::$server->getJobList(),
+                \OC::$server->getConfig()
+            ),
+            new CleanPreviews(
+                \OC::$server->getJobList(),
+                \OC::$server->getUserManager(),
+                \OC::$server->getConfig()
+            ),
+            new FixMountStorages(\OC::$server->getDatabaseConnection()),
+            new UpdateLanguageCodes(\OC::$server->getDatabaseConnection(), \OC::$server->getConfig()),
+            new InstallCoreBundle(
+                \OC::$server->query(BundleFetcher::class),
+                \OC::$server->getConfig(),
+                \OC::$server->query(Installer::class)
+            )
+        ];
+    }
+
+    /**
+     * Returns expensive repair steps to be run on the
+     * command line with a special option.
+     *
+     * @return IRepairStep[]
+     */
+    public static function getExpensiveRepairSteps() {
+        return [
+            new OldGroupMembershipShares(\OC::$server->getDatabaseConnection(), \OC::$server->getGroupManager()),
+        ];
+    }
+
+    /**
+     * Returns the repair steps to be run before an
+     * upgrade.
+     *
+     * @return IRepairStep[]
+     */
+    public static function getBeforeUpgradeRepairSteps() {
+        $connection = \OC::$server->getDatabaseConnection();
+        $config = \OC::$server->getConfig();
+        $steps = [
+            new Collation(\OC::$server->getConfig(), \OC::$server->getLogger(), $connection, true),
+            new SqliteAutoincrement($connection),
+            new SaveAccountsTableData($connection, $config),
+        ];
+
+        return $steps;
+    }
+
+    /**
+     * @param string $scope
+     * @param string $method
+     * @param array $arguments
+     */
+    public function emit($scope, $method, array $arguments = []) {
+        if (!is_null($this->dispatcher)) {
+            $this->dispatcher->dispatch("$scope::$method",
+                new GenericEvent("$scope::$method", $arguments));
+        }
+    }
+
+    public function info($string) {
+        // for now just emit as we did in the past
+        $this->emit('\OC\Repair', 'info', array($string));
+    }
+
+    /**
+     * @param string $message
+     */
+    public function warning($message) {
+        // for now just emit as we did in the past
+        $this->emit('\OC\Repair', 'warning', [$message]);
+    }
+
+    /**
+     * @param int $max
+     */
+    public function startProgress($max = 0) {
+        // for now just emit as we did in the past
+        $this->emit('\OC\Repair', 'startProgress', [$max, $this->currentStep]);
+    }
+
+    /**
+     * @param int $step
+     * @param string $description
+     */
+    public function advance($step = 1, $description = '') {
+        // for now just emit as we did in the past
+        $this->emit('\OC\Repair', 'advance', [$step, $description]);
+    }
+
+    /**
+     * @param int $max
+     */
+    public function finishProgress() {
+        // for now just emit as we did in the past
+        $this->emit('\OC\Repair', 'finishProgress', []);
+    }
 }

lib/private/Session/CryptoSessionData.php

Doc Comments +1 added lines, -1 removed lines

@@ -176,7 +176,7 @@
 
 	/**
 	 * @param mixed $offset
-	 * @return mixed
+	 * @return string|null
 	 */
 	public function offsetGet($offset) {
 		return $this->get($offset);

Indentation +172 added lines, -172 removed lines

@@ -34,176 +34,176 @@
  * @package OC\Session
  */
 class CryptoSessionData implements \ArrayAccess, ISession {
-	/** @var ISession */
-	protected $session;
-	/** @var \OCP\Security\ICrypto */
-	protected $crypto;
-	/** @var string */
-	protected $passphrase;
-	/** @var array */
-	protected $sessionValues;
-	/** @var bool */
-	protected $isModified = false;
-	CONST encryptedSessionName = 'encrypted_session_data';
-
-	/**
-	 * @param ISession $session
-	 * @param ICrypto $crypto
-	 * @param string $passphrase
-	 */
-	public function __construct(ISession $session,
-								ICrypto $crypto,
-								$passphrase) {
-		$this->crypto = $crypto;
-		$this->session = $session;
-		$this->passphrase = $passphrase;
-		$this->initializeSession();
-	}
-
-	/**
-	 * Close session if class gets destructed
-	 */
-	public function __destruct() {
-		try {
-			$this->close();
-		} catch (SessionNotAvailableException $e){
-			// This exception can occur if session is already closed
-			// So it is safe to ignore it and let the garbage collector to proceed
-		}
-	}
-
-	protected function initializeSession() {
-		$encryptedSessionData = $this->session->get(self::encryptedSessionName);
-		try {
-			$this->sessionValues = json_decode(
-				$this->crypto->decrypt($encryptedSessionData, $this->passphrase),
-				true
-			);
-		} catch (\Exception $e) {
-			$this->sessionValues = [];
-		}
-	}
-
-	/**
-	 * Set a value in the session
-	 *
-	 * @param string $key
-	 * @param mixed $value
-	 */
-	public function set($key, $value) {
-		$this->sessionValues[$key] = $value;
-		$this->isModified = true;
-	}
-
-	/**
-	 * Get a value from the session
-	 *
-	 * @param string $key
-	 * @return string|null Either the value or null
-	 */
-	public function get($key) {
-		if(isset($this->sessionValues[$key])) {
-			return $this->sessionValues[$key];
-		}
-
-		return null;
-	}
-
-	/**
-	 * Check if a named key exists in the session
-	 *
-	 * @param string $key
-	 * @return bool
-	 */
-	public function exists($key) {
-		return isset($this->sessionValues[$key]);
-	}
-
-	/**
-	 * Remove a $key/$value pair from the session
-	 *
-	 * @param string $key
-	 */
-	public function remove($key) {
-		$this->isModified = true;
-		unset($this->sessionValues[$key]);
-		$this->session->remove(self::encryptedSessionName);
-	}
-
-	/**
-	 * Reset and recreate the session
-	 */
-	public function clear() {
-		$requesttoken = $this->get('requesttoken');
-		$this->sessionValues = [];
-		if ($requesttoken !== null) {
-			$this->set('requesttoken', $requesttoken);
-		}
-		$this->isModified = true;
-		$this->session->clear();
-	}
-
-	/**
-	 * Wrapper around session_regenerate_id
-	 *
-	 * @param bool $deleteOldSession Whether to delete the old associated session file or not.
-	 * @return void
-	 */
-	public function regenerateId($deleteOldSession = true) {
-		$this->session->regenerateId($deleteOldSession);
-	}
-
-	/**
-	 * Wrapper around session_id
-	 *
-	 * @return string
-	 * @throws SessionNotAvailableException
-	 * @since 9.1.0
-	 */
-	public function getId() {
-		return $this->session->getId();
-	}
-
-	/**
-	 * Close the session and release the lock, also writes all changed data in batch
-	 */
-	public function close() {
-		if($this->isModified) {
-			$encryptedValue = $this->crypto->encrypt(json_encode($this->sessionValues), $this->passphrase);
-			$this->session->set(self::encryptedSessionName, $encryptedValue);
-			$this->isModified = false;
-		}
-		$this->session->close();
-	}
-
-	/**
-	 * @param mixed $offset
-	 * @return bool
-	 */
-	public function offsetExists($offset) {
-		return $this->exists($offset);
-	}
-
-	/**
-	 * @param mixed $offset
-	 * @return mixed
-	 */
-	public function offsetGet($offset) {
-		return $this->get($offset);
-	}
-
-	/**
-	 * @param mixed $offset
-	 * @param mixed $value
-	 */
-	public function offsetSet($offset, $value) {
-		$this->set($offset, $value);
-	}
-
-	/**
-	 * @param mixed $offset
-	 */
-	public function offsetUnset($offset) {
-		$this->remove($offset);
-	}
+    /** @var ISession */
+    protected $session;
+    /** @var \OCP\Security\ICrypto */
+    protected $crypto;
+    /** @var string */
+    protected $passphrase;
+    /** @var array */
+    protected $sessionValues;
+    /** @var bool */
+    protected $isModified = false;
+    CONST encryptedSessionName = 'encrypted_session_data';
+
+    /**
+     * @param ISession $session
+     * @param ICrypto $crypto
+     * @param string $passphrase
+     */
+    public function __construct(ISession $session,
+                                ICrypto $crypto,
+                                $passphrase) {
+        $this->crypto = $crypto;
+        $this->session = $session;
+        $this->passphrase = $passphrase;
+        $this->initializeSession();
+    }
+
+    /**
+     * Close session if class gets destructed
+     */
+    public function __destruct() {
+        try {
+            $this->close();
+        } catch (SessionNotAvailableException $e){
+            // This exception can occur if session is already closed
+            // So it is safe to ignore it and let the garbage collector to proceed
+        }
+    }
+
+    protected function initializeSession() {
+        $encryptedSessionData = $this->session->get(self::encryptedSessionName);
+        try {
+            $this->sessionValues = json_decode(
+                $this->crypto->decrypt($encryptedSessionData, $this->passphrase),
+                true
+            );
+        } catch (\Exception $e) {
+            $this->sessionValues = [];
+        }
+    }
+
+    /**
+     * Set a value in the session
+     *
+     * @param string $key
+     * @param mixed $value
+     */
+    public function set($key, $value) {
+        $this->sessionValues[$key] = $value;
+        $this->isModified = true;
+    }
+
+    /**
+     * Get a value from the session
+     *
+     * @param string $key
+     * @return string|null Either the value or null
+     */
+    public function get($key) {
+        if(isset($this->sessionValues[$key])) {
+            return $this->sessionValues[$key];
+        }
+
+        return null;
+    }
+
+    /**
+     * Check if a named key exists in the session
+     *
+     * @param string $key
+     * @return bool
+     */
+    public function exists($key) {
+        return isset($this->sessionValues[$key]);
+    }
+
+    /**
+     * Remove a $key/$value pair from the session
+     *
+     * @param string $key
+     */
+    public function remove($key) {
+        $this->isModified = true;
+        unset($this->sessionValues[$key]);
+        $this->session->remove(self::encryptedSessionName);
+    }
+
+    /**
+     * Reset and recreate the session
+     */
+    public function clear() {
+        $requesttoken = $this->get('requesttoken');
+        $this->sessionValues = [];
+        if ($requesttoken !== null) {
+            $this->set('requesttoken', $requesttoken);
+        }
+        $this->isModified = true;
+        $this->session->clear();
+    }
+
+    /**
+     * Wrapper around session_regenerate_id
+     *
+     * @param bool $deleteOldSession Whether to delete the old associated session file or not.
+     * @return void
+     */
+    public function regenerateId($deleteOldSession = true) {
+        $this->session->regenerateId($deleteOldSession);
+    }
+
+    /**
+     * Wrapper around session_id
+     *
+     * @return string
+     * @throws SessionNotAvailableException
+     * @since 9.1.0
+     */
+    public function getId() {
+        return $this->session->getId();
+    }
+
+    /**
+     * Close the session and release the lock, also writes all changed data in batch
+     */
+    public function close() {
+        if($this->isModified) {
+            $encryptedValue = $this->crypto->encrypt(json_encode($this->sessionValues), $this->passphrase);
+            $this->session->set(self::encryptedSessionName, $encryptedValue);
+            $this->isModified = false;
+        }
+        $this->session->close();
+    }
+
+    /**
+     * @param mixed $offset
+     * @return bool
+     */
+    public function offsetExists($offset) {
+        return $this->exists($offset);
+    }
+
+    /**
+     * @param mixed $offset
+     * @return mixed
+     */
+    public function offsetGet($offset) {
+        return $this->get($offset);
+    }
+
+    /**
+     * @param mixed $offset
+     * @param mixed $value
+     */
+    public function offsetSet($offset, $value) {
+        $this->set($offset, $value);
+    }
+
+    /**
+     * @param mixed $offset
+     */
+    public function offsetUnset($offset) {
+        $this->remove($offset);
+    }
 }

Spacing +3 added lines, -3 removed lines

@@ -66,7 +66,7 @@ 
 	public function __destruct() {
 		try {
 			$this->close();
-		} catch (SessionNotAvailableException $e){
+		} catch (SessionNotAvailableException $e) {
 			// This exception can occur if session is already closed
 			// So it is safe to ignore it and let the garbage collector to proceed
 		}
@@ -102,7 +102,7 @@ 
 	 * @return string|null Either the value or null
 	 */
 	public function get($key) {
-		if(isset($this->sessionValues[$key])) {
+		if (isset($this->sessionValues[$key])) {
 			return $this->sessionValues[$key];
 		}
 
@@ -168,7 +168,7 @@ 
 	 * Close the session and release the lock, also writes all changed data in batch
 	 */
 	public function close() {
-		if($this->isModified) {
+		if ($this->isModified) {
 			$encryptedValue = $this->crypto->encrypt(json_encode($this->sessionValues), $this->passphrase);
 			$this->session->set(self::encryptedSessionName, $encryptedValue);
 			$this->isModified = false;

lib/private/Tags.php

Doc Comments +10 added lines, -2 removed lines

@@ -742,11 +742,19 @@ 
 	}
 
 	// case-insensitive array_search
+
+	/**
+	 * @param string $needle
+	 */
 	protected function array_searchi($needle, $haystack, $mem='getName') {
 		if(!is_array($haystack)) {
 			return false;
 		}
 		return array_search(strtolower($needle), array_map(
+
+			/**
+			 * @param string $tag
+			 */
 			function($tag) use($mem) {
 				return strtolower(call_user_func(array($tag, $mem)));
 			}, $haystack)
@@ -771,7 +779,7 @@ 
 	* Get a tag by its name.
 	*
 	* @param string $name The tag name.
-	* @return integer|bool The tag object's offset within the $this->tags
+	* @return \OCP\AppFramework\Db\Entity The tag object's offset within the $this->tags
 	*                      array or false if it doesn't exist.
 	*/
 	private function getTagByName($name) {
@@ -782,7 +790,7 @@ 
 	* Get a tag by its ID.
 	*
 	* @param string $id The tag ID to look for.
-	* @return integer|bool The tag object's offset within the $this->tags
+	* @return \OCP\AppFramework\Db\Entity The tag object's offset within the $this->tags
 	*                      array or false if it doesn't exist.
 	*/
 	private function getTagById($id) {

Indentation +757 added lines, -757 removed lines

@@ -48,761 +48,761 @@
 
 class Tags implements \OCP\ITags {
 
-	/**
-	 * Tags
-	 *
-	 * @var array
-	 */
-	private $tags = array();
-
-	/**
-	 * Used for storing objectid/categoryname pairs while rescanning.
-	 *
-	 * @var array
-	 */
-	private static $relations = array();
-
-	/**
-	 * Type
-	 *
-	 * @var string
-	 */
-	private $type;
-
-	/**
-	 * User
-	 *
-	 * @var string
-	 */
-	private $user;
-
-	/**
-	 * Are we including tags for shared items?
-	 *
-	 * @var bool
-	 */
-	private $includeShared = false;
-
-	/**
-	 * The current user, plus any owners of the items shared with the current
-	 * user, if $this->includeShared === true.
-	 *
-	 * @var array
-	 */
-	private $owners = array();
-
-	/**
-	 * The Mapper we're using to communicate our Tag objects to the database.
-	 *
-	 * @var TagMapper
-	 */
-	private $mapper;
-
-	/**
-	 * The sharing backend for objects of $this->type. Required if
-	 * $this->includeShared === true to determine ownership of items.
-	 *
-	 * @var \OCP\Share_Backend
-	 */
-	private $backend;
-
-	const TAG_TABLE = '*PREFIX*vcategory';
-	const RELATION_TABLE = '*PREFIX*vcategory_to_object';
-
-	const TAG_FAVORITE = '_$!<Favorite>!$_';
-
-	/**
-	* Constructor.
-	*
-	* @param TagMapper $mapper Instance of the TagMapper abstraction layer.
-	* @param string $user The user whose data the object will operate on.
-	* @param string $type The type of items for which tags will be loaded.
-	* @param array $defaultTags Tags that should be created at construction.
-	* @param boolean $includeShared Whether to include tags for items shared with this user by others.
-	*/
-	public function __construct(TagMapper $mapper, $user, $type, $defaultTags = array(), $includeShared = false) {
-		$this->mapper = $mapper;
-		$this->user = $user;
-		$this->type = $type;
-		$this->includeShared = $includeShared;
-		$this->owners = array($this->user);
-		if ($this->includeShared) {
-			$this->owners = array_merge($this->owners, \OC\Share\Share::getSharedItemsOwners($this->user, $this->type, true));
-			$this->backend = \OC\Share\Share::getBackend($this->type);
-		}
-		$this->tags = $this->mapper->loadTags($this->owners, $this->type);
-
-		if(count($defaultTags) > 0 && count($this->tags) === 0) {
-			$this->addMultiple($defaultTags, true);
-		}
-	}
-
-	/**
-	* Check if any tags are saved for this type and user.
-	*
-	* @return boolean.
-	*/
-	public function isEmpty() {
-		return count($this->tags) === 0;
-	}
-
-	/**
-	* Returns an array mapping a given tag's properties to its values:
-	* ['id' => 0, 'name' = 'Tag', 'owner' = 'User', 'type' => 'tagtype']
-	*
-	* @param string $id The ID of the tag that is going to be mapped
-	* @return array|false
-	*/
-	public function getTag($id) {
-		$key = $this->getTagById($id);
-		if ($key !== false) {
-			return $this->tagMap($this->tags[$key]);
-		}
-		return false;
-	}
-
-	/**
-	* Get the tags for a specific user.
-	*
-	* This returns an array with maps containing each tag's properties:
-	* [
-	* 	['id' => 0, 'name' = 'First tag', 'owner' = 'User', 'type' => 'tagtype'],
-	* 	['id' => 1, 'name' = 'Shared tag', 'owner' = 'Other user', 'type' => 'tagtype'],
-	* ]
-	*
-	* @return array
-	*/
-	public function getTags() {
-		if(!count($this->tags)) {
-			return array();
-		}
-
-		usort($this->tags, function($a, $b) {
-			return strnatcasecmp($a->getName(), $b->getName());
-		});
-		$tagMap = array();
-
-		foreach($this->tags as $tag) {
-			if($tag->getName() !== self::TAG_FAVORITE) {
-				$tagMap[] = $this->tagMap($tag);
-			}
-		}
-		return $tagMap;
-
-	}
-
-	/**
-	* Return only the tags owned by the given user, omitting any tags shared
-	* by other users.
-	*
-	* @param string $user The user whose tags are to be checked.
-	* @return array An array of Tag objects.
-	*/
-	public function getTagsForUser($user) {
-		return array_filter($this->tags,
-			function($tag) use($user) {
-				return $tag->getOwner() === $user;
-			}
-		);
-	}
-
-	/**
-	 * Get the list of tags for the given ids.
-	 *
-	 * @param array $objIds array of object ids
-	 * @return array|boolean of tags id as key to array of tag names
-	 * or false if an error occurred
-	 */
-	public function getTagsForObjects(array $objIds) {
-		$entries = array();
-
-		try {
-			$conn = \OC::$server->getDatabaseConnection();
-			$chunks = array_chunk($objIds, 900, false);
-			foreach ($chunks as $chunk) {
-				$result = $conn->executeQuery(
-					'SELECT `category`, `categoryid`, `objid` ' .
-					'FROM `' . self::RELATION_TABLE . '` r, `' . self::TAG_TABLE . '` ' .
-					'WHERE `categoryid` = `id` AND `uid` = ? AND r.`type` = ? AND `objid` IN (?)',
-					array($this->user, $this->type, $chunk),
-					array(null, null, IQueryBuilder::PARAM_INT_ARRAY)
-				);
-				while ($row = $result->fetch()) {
-					$objId = (int)$row['objid'];
-					if (!isset($entries[$objId])) {
-						$entries[$objId] = array();
-					}
-					$entries[$objId][] = $row['category'];
-				}
-				if (\OCP\DB::isError($result)) {
-					\OCP\Util::writeLog('core', __METHOD__. 'DB error: ' . \OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
-					return false;
-				}
-			}
-		} catch(\Exception $e) {
-			\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
-				\OCP\Util::ERROR);
-			return false;
-		}
-
-		return $entries;
-	}
-
-	/**
-	* Get the a list if items tagged with $tag.
-	*
-	* Throws an exception if the tag could not be found.
-	*
-	* @param string $tag Tag id or name.
-	* @return array|false An array of object ids or false on error.
-	* @throws \Exception
-	*/
-	public function getIdsForTag($tag) {
-		$result = null;
-		$tagId = false;
-		if(is_numeric($tag)) {
-			$tagId = $tag;
-		} elseif(is_string($tag)) {
-			$tag = trim($tag);
-			if($tag === '') {
-				\OCP\Util::writeLog('core', __METHOD__.', Cannot use empty tag names', \OCP\Util::DEBUG);
-				return false;
-			}
-			$tagId = $this->getTagId($tag);
-		}
-
-		if($tagId === false) {
-			$l10n = \OC::$server->getL10N('core');
-			throw new \Exception(
-				$l10n->t('Could not find category "%s"', $tag)
-			);
-		}
-
-		$ids = array();
-		$sql = 'SELECT `objid` FROM `' . self::RELATION_TABLE
-			. '` WHERE `categoryid` = ?';
-
-		try {
-			$stmt = \OCP\DB::prepare($sql);
-			$result = $stmt->execute(array($tagId));
-			if (\OCP\DB::isError($result)) {
-				\OCP\Util::writeLog('core', __METHOD__. 'DB error: ' . \OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
-				return false;
-			}
-		} catch(\Exception $e) {
-			\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
-				\OCP\Util::ERROR);
-			return false;
-		}
-
-		if(!is_null($result)) {
-			while( $row = $result->fetchRow()) {
-				$id = (int)$row['objid'];
-
-				if ($this->includeShared) {
-					// We have to check if we are really allowed to access the
-					// items that are tagged with $tag. To that end, we ask the
-					// corresponding sharing backend if the item identified by $id
-					// is owned by any of $this->owners.
-					foreach ($this->owners as $owner) {
-						if ($this->backend->isValidSource($id, $owner)) {
-							$ids[] = $id;
-							break;
-						}
-					}
-				} else {
-					$ids[] = $id;
-				}
-			}
-		}
-
-		return $ids;
-	}
-
-	/**
-	* Checks whether a tag is saved for the given user,
-	* disregarding the ones shared with him or her.
-	*
-	* @param string $name The tag name to check for.
-	* @param string $user The user whose tags are to be checked.
-	* @return bool
-	*/
-	public function userHasTag($name, $user) {
-		$key = $this->array_searchi($name, $this->getTagsForUser($user));
-		return ($key !== false) ? $this->tags[$key]->getId() : false;
-	}
-
-	/**
-	* Checks whether a tag is saved for or shared with the current user.
-	*
-	* @param string $name The tag name to check for.
-	* @return bool
-	*/
-	public function hasTag($name) {
-		return $this->getTagId($name) !== false;
-	}
-
-	/**
-	* Add a new tag.
-	*
-	* @param string $name A string with a name of the tag
-	* @return false|int the id of the added tag or false on error.
-	*/
-	public function add($name) {
-		$name = trim($name);
-
-		if($name === '') {
-			\OCP\Util::writeLog('core', __METHOD__.', Cannot add an empty tag', \OCP\Util::DEBUG);
-			return false;
-		}
-		if($this->userHasTag($name, $this->user)) {
-			\OCP\Util::writeLog('core', __METHOD__.', name: ' . $name. ' exists already', \OCP\Util::DEBUG);
-			return false;
-		}
-		try {
-			$tag = new Tag($this->user, $this->type, $name);
-			$tag = $this->mapper->insert($tag);
-			$this->tags[] = $tag;
-		} catch(\Exception $e) {
-			\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
-				\OCP\Util::ERROR);
-			return false;
-		}
-		\OCP\Util::writeLog('core', __METHOD__.', id: ' . $tag->getId(), \OCP\Util::DEBUG);
-		return $tag->getId();
-	}
-
-	/**
-	* Rename tag.
-	*
-	* @param string|integer $from The name or ID of the existing tag
-	* @param string $to The new name of the tag.
-	* @return bool
-	*/
-	public function rename($from, $to) {
-		$from = trim($from);
-		$to = trim($to);
-
-		if($to === '' || $from === '') {
-			\OCP\Util::writeLog('core', __METHOD__.', Cannot use empty tag names', \OCP\Util::DEBUG);
-			return false;
-		}
-
-		if (is_numeric($from)) {
-			$key = $this->getTagById($from);
-		} else {
-			$key = $this->getTagByName($from);
-		}
-		if($key === false) {
-			\OCP\Util::writeLog('core', __METHOD__.', tag: ' . $from. ' does not exist', \OCP\Util::DEBUG);
-			return false;
-		}
-		$tag = $this->tags[$key];
-
-		if($this->userHasTag($to, $tag->getOwner())) {
-			\OCP\Util::writeLog('core', __METHOD__.', A tag named ' . $to. ' already exists for user ' . $tag->getOwner() . '.', \OCP\Util::DEBUG);
-			return false;
-		}
-
-		try {
-			$tag->setName($to);
-			$this->tags[$key] = $this->mapper->update($tag);
-		} catch(\Exception $e) {
-			\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
-				\OCP\Util::ERROR);
-			return false;
-		}
-		return true;
-	}
-
-	/**
-	* Add a list of new tags.
-	*
-	* @param string[] $names A string with a name or an array of strings containing
-	* the name(s) of the tag(s) to add.
-	* @param bool $sync When true, save the tags
-	* @param int|null $id int Optional object id to add to this|these tag(s)
-	* @return bool Returns false on error.
-	*/
-	public function addMultiple($names, $sync=false, $id = null) {
-		if(!is_array($names)) {
-			$names = array($names);
-		}
-		$names = array_map('trim', $names);
-		array_filter($names);
-
-		$newones = array();
-		foreach($names as $name) {
-			if(!$this->hasTag($name) && $name !== '') {
-				$newones[] = new Tag($this->user, $this->type, $name);
-			}
-			if(!is_null($id) ) {
-				// Insert $objectid, $categoryid  pairs if not exist.
-				self::$relations[] = array('objid' => $id, 'tag' => $name);
-			}
-		}
-		$this->tags = array_merge($this->tags, $newones);
-		if($sync === true) {
-			$this->save();
-		}
-
-		return true;
-	}
-
-	/**
-	 * Save the list of tags and their object relations
-	 */
-	protected function save() {
-		if(is_array($this->tags)) {
-			foreach($this->tags as $tag) {
-				try {
-					if (!$this->mapper->tagExists($tag)) {
-						$this->mapper->insert($tag);
-					}
-				} catch(\Exception $e) {
-					\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
-						\OCP\Util::ERROR);
-				}
-			}
-
-			// reload tags to get the proper ids.
-			$this->tags = $this->mapper->loadTags($this->owners, $this->type);
-			\OCP\Util::writeLog('core', __METHOD__.', tags: ' . print_r($this->tags, true),
-				\OCP\Util::DEBUG);
-			// Loop through temporarily cached objectid/tagname pairs
-			// and save relations.
-			$tags = $this->tags;
-			// For some reason this is needed or array_search(i) will return 0..?
-			ksort($tags);
-			foreach(self::$relations as $relation) {
-				$tagId = $this->getTagId($relation['tag']);
-				\OCP\Util::writeLog('core', __METHOD__ . 'catid, ' . $relation['tag'] . ' ' . $tagId, \OCP\Util::DEBUG);
-				if($tagId) {
-					try {
-						\OCP\DB::insertIfNotExist(self::RELATION_TABLE,
-							array(
-								'objid' => $relation['objid'],
-								'categoryid' => $tagId,
-								'type' => $this->type,
-								));
-					} catch(\Exception $e) {
-						\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
-							\OCP\Util::ERROR);
-					}
-				}
-			}
-			self::$relations = array(); // reset
-		} else {
-			\OCP\Util::writeLog('core', __METHOD__.', $this->tags is not an array! '
-				. print_r($this->tags, true), \OCP\Util::ERROR);
-		}
-	}
-
-	/**
-	* Delete tags and tag/object relations for a user.
-	*
-	* For hooking up on post_deleteUser
-	*
-	* @param array $arguments
-	*/
-	public static function post_deleteUser($arguments) {
-		// Find all objectid/tagId pairs.
-		$result = null;
-		try {
-			$stmt = \OCP\DB::prepare('SELECT `id` FROM `' . self::TAG_TABLE . '` '
-				. 'WHERE `uid` = ?');
-			$result = $stmt->execute(array($arguments['uid']));
-			if (\OCP\DB::isError($result)) {
-				\OCP\Util::writeLog('core', __METHOD__. 'DB error: ' . \OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
-			}
-		} catch(\Exception $e) {
-			\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
-				\OCP\Util::ERROR);
-		}
-
-		if(!is_null($result)) {
-			try {
-				$stmt = \OCP\DB::prepare('DELETE FROM `' . self::RELATION_TABLE . '` '
-					. 'WHERE `categoryid` = ?');
-				while( $row = $result->fetchRow()) {
-					try {
-						$stmt->execute(array($row['id']));
-					} catch(\Exception $e) {
-						\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
-							\OCP\Util::ERROR);
-					}
-				}
-			} catch(\Exception $e) {
-				\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
-					\OCP\Util::ERROR);
-			}
-		}
-		try {
-			$stmt = \OCP\DB::prepare('DELETE FROM `' . self::TAG_TABLE . '` '
-				. 'WHERE `uid` = ?');
-			$result = $stmt->execute(array($arguments['uid']));
-			if (\OCP\DB::isError($result)) {
-				\OCP\Util::writeLog('core', __METHOD__. ', DB error: ' . \OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
-			}
-		} catch(\Exception $e) {
-			\OCP\Util::writeLog('core', __METHOD__ . ', exception: '
-				. $e->getMessage(), \OCP\Util::ERROR);
-		}
-	}
-
-	/**
-	* Delete tag/object relations from the db
-	*
-	* @param array $ids The ids of the objects
-	* @return boolean Returns false on error.
-	*/
-	public function purgeObjects(array $ids) {
-		if(count($ids) === 0) {
-			// job done ;)
-			return true;
-		}
-		$updates = $ids;
-		try {
-			$query = 'DELETE FROM `' . self::RELATION_TABLE . '` ';
-			$query .= 'WHERE `objid` IN (' . str_repeat('?,', count($ids)-1) . '?) ';
-			$query .= 'AND `type`= ?';
-			$updates[] = $this->type;
-			$stmt = \OCP\DB::prepare($query);
-			$result = $stmt->execute($updates);
-			if (\OCP\DB::isError($result)) {
-				\OCP\Util::writeLog('core', __METHOD__. 'DB error: ' . \OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
-				return false;
-			}
-		} catch(\Exception $e) {
-			\OCP\Util::writeLog('core', __METHOD__.', exception: ' . $e->getMessage(),
-				\OCP\Util::ERROR);
-			return false;
-		}
-		return true;
-	}
-
-	/**
-	* Get favorites for an object type
-	*
-	* @return array|false An array of object ids.
-	*/
-	public function getFavorites() {
-		try {
-			return $this->getIdsForTag(self::TAG_FAVORITE);
-		} catch(\Exception $e) {
-			\OCP\Util::writeLog('core', __METHOD__.', exception: ' . $e->getMessage(),
-				\OCP\Util::DEBUG);
-			return array();
-		}
-	}
-
-	/**
-	* Add an object to favorites
-	*
-	* @param int $objid The id of the object
-	* @return boolean
-	*/
-	public function addToFavorites($objid) {
-		if(!$this->userHasTag(self::TAG_FAVORITE, $this->user)) {
-			$this->add(self::TAG_FAVORITE);
-		}
-		return $this->tagAs($objid, self::TAG_FAVORITE);
-	}
-
-	/**
-	* Remove an object from favorites
-	*
-	* @param int $objid The id of the object
-	* @return boolean
-	*/
-	public function removeFromFavorites($objid) {
-		return $this->unTag($objid, self::TAG_FAVORITE);
-	}
-
-	/**
-	* Creates a tag/object relation.
-	*
-	* @param int $objid The id of the object
-	* @param string $tag The id or name of the tag
-	* @return boolean Returns false on error.
-	*/
-	public function tagAs($objid, $tag) {
-		if(is_string($tag) && !is_numeric($tag)) {
-			$tag = trim($tag);
-			if($tag === '') {
-				\OCP\Util::writeLog('core', __METHOD__.', Cannot add an empty tag', \OCP\Util::DEBUG);
-				return false;
-			}
-			if(!$this->hasTag($tag)) {
-				$this->add($tag);
-			}
-			$tagId =  $this->getTagId($tag);
-		} else {
-			$tagId = $tag;
-		}
-		try {
-			\OCP\DB::insertIfNotExist(self::RELATION_TABLE,
-				array(
-					'objid' => $objid,
-					'categoryid' => $tagId,
-					'type' => $this->type,
-				));
-		} catch(\Exception $e) {
-			\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
-				\OCP\Util::ERROR);
-			return false;
-		}
-		return true;
-	}
-
-	/**
-	* Delete single tag/object relation from the db
-	*
-	* @param int $objid The id of the object
-	* @param string $tag The id or name of the tag
-	* @return boolean
-	*/
-	public function unTag($objid, $tag) {
-		if(is_string($tag) && !is_numeric($tag)) {
-			$tag = trim($tag);
-			if($tag === '') {
-				\OCP\Util::writeLog('core', __METHOD__.', Tag name is empty', \OCP\Util::DEBUG);
-				return false;
-			}
-			$tagId =  $this->getTagId($tag);
-		} else {
-			$tagId = $tag;
-		}
-
-		try {
-			$sql = 'DELETE FROM `' . self::RELATION_TABLE . '` '
-					. 'WHERE `objid` = ? AND `categoryid` = ? AND `type` = ?';
-			$stmt = \OCP\DB::prepare($sql);
-			$stmt->execute(array($objid, $tagId, $this->type));
-		} catch(\Exception $e) {
-			\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
-				\OCP\Util::ERROR);
-			return false;
-		}
-		return true;
-	}
-
-	/**
-	* Delete tags from the database.
-	*
-	* @param string[]|integer[] $names An array of tags (names or IDs) to delete
-	* @return bool Returns false on error
-	*/
-	public function delete($names) {
-		if(!is_array($names)) {
-			$names = array($names);
-		}
-
-		$names = array_map('trim', $names);
-		array_filter($names);
-
-		\OCP\Util::writeLog('core', __METHOD__ . ', before: '
-			. print_r($this->tags, true), \OCP\Util::DEBUG);
-		foreach($names as $name) {
-			$id = null;
-
-			if (is_numeric($name)) {
-				$key = $this->getTagById($name);
-			} else {
-				$key = $this->getTagByName($name);
-			}
-			if ($key !== false) {
-				$tag = $this->tags[$key];
-				$id = $tag->getId();
-				unset($this->tags[$key]);
-				$this->mapper->delete($tag);
-			} else {
-				\OCP\Util::writeLog('core', __METHOD__ . 'Cannot delete tag ' . $name
-					. ': not found.', \OCP\Util::ERROR);
-			}
-			if(!is_null($id) && $id !== false) {
-				try {
-					$sql = 'DELETE FROM `' . self::RELATION_TABLE . '` '
-							. 'WHERE `categoryid` = ?';
-					$stmt = \OCP\DB::prepare($sql);
-					$result = $stmt->execute(array($id));
-					if (\OCP\DB::isError($result)) {
-						\OCP\Util::writeLog('core',
-							__METHOD__. 'DB error: ' . \OCP\DB::getErrorMessage(),
-							\OCP\Util::ERROR);
-						return false;
-					}
-				} catch(\Exception $e) {
-					\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
-						\OCP\Util::ERROR);
-					return false;
-				}
-			}
-		}
-		return true;
-	}
-
-	// case-insensitive array_search
-	protected function array_searchi($needle, $haystack, $mem='getName') {
-		if(!is_array($haystack)) {
-			return false;
-		}
-		return array_search(strtolower($needle), array_map(
-			function($tag) use($mem) {
-				return strtolower(call_user_func(array($tag, $mem)));
-			}, $haystack)
-		);
-	}
-
-	/**
-	* Get a tag's ID.
-	*
-	* @param string $name The tag name to look for.
-	* @return string|bool The tag's id or false if no matching tag is found.
-	*/
-	private function getTagId($name) {
-		$key = $this->array_searchi($name, $this->tags);
-		if ($key !== false) {
-			return $this->tags[$key]->getId();
-		}
-		return false;
-	}
-
-	/**
-	* Get a tag by its name.
-	*
-	* @param string $name The tag name.
-	* @return integer|bool The tag object's offset within the $this->tags
-	*                      array or false if it doesn't exist.
-	*/
-	private function getTagByName($name) {
-		return $this->array_searchi($name, $this->tags, 'getName');
-	}
-
-	/**
-	* Get a tag by its ID.
-	*
-	* @param string $id The tag ID to look for.
-	* @return integer|bool The tag object's offset within the $this->tags
-	*                      array or false if it doesn't exist.
-	*/
-	private function getTagById($id) {
-		return $this->array_searchi($id, $this->tags, 'getId');
-	}
-
-	/**
-	* Returns an array mapping a given tag's properties to its values:
-	* ['id' => 0, 'name' = 'Tag', 'owner' = 'User', 'type' => 'tagtype']
-	*
-	* @param Tag $tag The tag that is going to be mapped
-	* @return array
-	*/
-	private function tagMap(Tag $tag) {
-		return array(
-			'id'    => $tag->getId(),
-			'name'  => $tag->getName(),
-			'owner' => $tag->getOwner(),
-			'type'  => $tag->getType()
-		);
-	}
+    /**
+     * Tags
+     *
+     * @var array
+     */
+    private $tags = array();
+
+    /**
+     * Used for storing objectid/categoryname pairs while rescanning.
+     *
+     * @var array
+     */
+    private static $relations = array();
+
+    /**
+     * Type
+     *
+     * @var string
+     */
+    private $type;
+
+    /**
+     * User
+     *
+     * @var string
+     */
+    private $user;
+
+    /**
+     * Are we including tags for shared items?
+     *
+     * @var bool
+     */
+    private $includeShared = false;
+
+    /**
+     * The current user, plus any owners of the items shared with the current
+     * user, if $this->includeShared === true.
+     *
+     * @var array
+     */
+    private $owners = array();
+
+    /**
+     * The Mapper we're using to communicate our Tag objects to the database.
+     *
+     * @var TagMapper
+     */
+    private $mapper;
+
+    /**
+     * The sharing backend for objects of $this->type. Required if
+     * $this->includeShared === true to determine ownership of items.
+     *
+     * @var \OCP\Share_Backend
+     */
+    private $backend;
+
+    const TAG_TABLE = '*PREFIX*vcategory';
+    const RELATION_TABLE = '*PREFIX*vcategory_to_object';
+
+    const TAG_FAVORITE = '_$!<Favorite>!$_';
+
+    /**
+     * Constructor.
+     *
+     * @param TagMapper $mapper Instance of the TagMapper abstraction layer.
+     * @param string $user The user whose data the object will operate on.
+     * @param string $type The type of items for which tags will be loaded.
+     * @param array $defaultTags Tags that should be created at construction.
+     * @param boolean $includeShared Whether to include tags for items shared with this user by others.
+     */
+    public function __construct(TagMapper $mapper, $user, $type, $defaultTags = array(), $includeShared = false) {
+        $this->mapper = $mapper;
+        $this->user = $user;
+        $this->type = $type;
+        $this->includeShared = $includeShared;
+        $this->owners = array($this->user);
+        if ($this->includeShared) {
+            $this->owners = array_merge($this->owners, \OC\Share\Share::getSharedItemsOwners($this->user, $this->type, true));
+            $this->backend = \OC\Share\Share::getBackend($this->type);
+        }
+        $this->tags = $this->mapper->loadTags($this->owners, $this->type);
+
+        if(count($defaultTags) > 0 && count($this->tags) === 0) {
+            $this->addMultiple($defaultTags, true);
+        }
+    }
+
+    /**
+     * Check if any tags are saved for this type and user.
+     *
+     * @return boolean.
+     */
+    public function isEmpty() {
+        return count($this->tags) === 0;
+    }
+
+    /**
+     * Returns an array mapping a given tag's properties to its values:
+     * ['id' => 0, 'name' = 'Tag', 'owner' = 'User', 'type' => 'tagtype']
+     *
+     * @param string $id The ID of the tag that is going to be mapped
+     * @return array|false
+     */
+    public function getTag($id) {
+        $key = $this->getTagById($id);
+        if ($key !== false) {
+            return $this->tagMap($this->tags[$key]);
+        }
+        return false;
+    }
+
+    /**
+     * Get the tags for a specific user.
+     *
+     * This returns an array with maps containing each tag's properties:
+     * [
+     * 	['id' => 0, 'name' = 'First tag', 'owner' = 'User', 'type' => 'tagtype'],
+     * 	['id' => 1, 'name' = 'Shared tag', 'owner' = 'Other user', 'type' => 'tagtype'],
+     * ]
+     *
+     * @return array
+     */
+    public function getTags() {
+        if(!count($this->tags)) {
+            return array();
+        }
+
+        usort($this->tags, function($a, $b) {
+            return strnatcasecmp($a->getName(), $b->getName());
+        });
+        $tagMap = array();
+
+        foreach($this->tags as $tag) {
+            if($tag->getName() !== self::TAG_FAVORITE) {
+                $tagMap[] = $this->tagMap($tag);
+            }
+        }
+        return $tagMap;
+
+    }
+
+    /**
+     * Return only the tags owned by the given user, omitting any tags shared
+     * by other users.
+     *
+     * @param string $user The user whose tags are to be checked.
+     * @return array An array of Tag objects.
+     */
+    public function getTagsForUser($user) {
+        return array_filter($this->tags,
+            function($tag) use($user) {
+                return $tag->getOwner() === $user;
+            }
+        );
+    }
+
+    /**
+     * Get the list of tags for the given ids.
+     *
+     * @param array $objIds array of object ids
+     * @return array|boolean of tags id as key to array of tag names
+     * or false if an error occurred
+     */
+    public function getTagsForObjects(array $objIds) {
+        $entries = array();
+
+        try {
+            $conn = \OC::$server->getDatabaseConnection();
+            $chunks = array_chunk($objIds, 900, false);
+            foreach ($chunks as $chunk) {
+                $result = $conn->executeQuery(
+                    'SELECT `category`, `categoryid`, `objid` ' .
+                    'FROM `' . self::RELATION_TABLE . '` r, `' . self::TAG_TABLE . '` ' .
+                    'WHERE `categoryid` = `id` AND `uid` = ? AND r.`type` = ? AND `objid` IN (?)',
+                    array($this->user, $this->type, $chunk),
+                    array(null, null, IQueryBuilder::PARAM_INT_ARRAY)
+                );
+                while ($row = $result->fetch()) {
+                    $objId = (int)$row['objid'];
+                    if (!isset($entries[$objId])) {
+                        $entries[$objId] = array();
+                    }
+                    $entries[$objId][] = $row['category'];
+                }
+                if (\OCP\DB::isError($result)) {
+                    \OCP\Util::writeLog('core', __METHOD__. 'DB error: ' . \OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
+                    return false;
+                }
+            }
+        } catch(\Exception $e) {
+            \OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
+                \OCP\Util::ERROR);
+            return false;
+        }
+
+        return $entries;
+    }
+
+    /**
+     * Get the a list if items tagged with $tag.
+     *
+     * Throws an exception if the tag could not be found.
+     *
+     * @param string $tag Tag id or name.
+     * @return array|false An array of object ids or false on error.
+     * @throws \Exception
+     */
+    public function getIdsForTag($tag) {
+        $result = null;
+        $tagId = false;
+        if(is_numeric($tag)) {
+            $tagId = $tag;
+        } elseif(is_string($tag)) {
+            $tag = trim($tag);
+            if($tag === '') {
+                \OCP\Util::writeLog('core', __METHOD__.', Cannot use empty tag names', \OCP\Util::DEBUG);
+                return false;
+            }
+            $tagId = $this->getTagId($tag);
+        }
+
+        if($tagId === false) {
+            $l10n = \OC::$server->getL10N('core');
+            throw new \Exception(
+                $l10n->t('Could not find category "%s"', $tag)
+            );
+        }
+
+        $ids = array();
+        $sql = 'SELECT `objid` FROM `' . self::RELATION_TABLE
+            . '` WHERE `categoryid` = ?';
+
+        try {
+            $stmt = \OCP\DB::prepare($sql);
+            $result = $stmt->execute(array($tagId));
+            if (\OCP\DB::isError($result)) {
+                \OCP\Util::writeLog('core', __METHOD__. 'DB error: ' . \OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
+                return false;
+            }
+        } catch(\Exception $e) {
+            \OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
+                \OCP\Util::ERROR);
+            return false;
+        }
+
+        if(!is_null($result)) {
+            while( $row = $result->fetchRow()) {
+                $id = (int)$row['objid'];
+
+                if ($this->includeShared) {
+                    // We have to check if we are really allowed to access the
+                    // items that are tagged with $tag. To that end, we ask the
+                    // corresponding sharing backend if the item identified by $id
+                    // is owned by any of $this->owners.
+                    foreach ($this->owners as $owner) {
+                        if ($this->backend->isValidSource($id, $owner)) {
+                            $ids[] = $id;
+                            break;
+                        }
+                    }
+                } else {
+                    $ids[] = $id;
+                }
+            }
+        }
+
+        return $ids;
+    }
+
+    /**
+     * Checks whether a tag is saved for the given user,
+     * disregarding the ones shared with him or her.
+     *
+     * @param string $name The tag name to check for.
+     * @param string $user The user whose tags are to be checked.
+     * @return bool
+     */
+    public function userHasTag($name, $user) {
+        $key = $this->array_searchi($name, $this->getTagsForUser($user));
+        return ($key !== false) ? $this->tags[$key]->getId() : false;
+    }
+
+    /**
+     * Checks whether a tag is saved for or shared with the current user.
+     *
+     * @param string $name The tag name to check for.
+     * @return bool
+     */
+    public function hasTag($name) {
+        return $this->getTagId($name) !== false;
+    }
+
+    /**
+     * Add a new tag.
+     *
+     * @param string $name A string with a name of the tag
+     * @return false|int the id of the added tag or false on error.
+     */
+    public function add($name) {
+        $name = trim($name);
+
+        if($name === '') {
+            \OCP\Util::writeLog('core', __METHOD__.', Cannot add an empty tag', \OCP\Util::DEBUG);
+            return false;
+        }
+        if($this->userHasTag($name, $this->user)) {
+            \OCP\Util::writeLog('core', __METHOD__.', name: ' . $name. ' exists already', \OCP\Util::DEBUG);
+            return false;
+        }
+        try {
+            $tag = new Tag($this->user, $this->type, $name);
+            $tag = $this->mapper->insert($tag);
+            $this->tags[] = $tag;
+        } catch(\Exception $e) {
+            \OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
+                \OCP\Util::ERROR);
+            return false;
+        }
+        \OCP\Util::writeLog('core', __METHOD__.', id: ' . $tag->getId(), \OCP\Util::DEBUG);
+        return $tag->getId();
+    }
+
+    /**
+     * Rename tag.
+     *
+     * @param string|integer $from The name or ID of the existing tag
+     * @param string $to The new name of the tag.
+     * @return bool
+     */
+    public function rename($from, $to) {
+        $from = trim($from);
+        $to = trim($to);
+
+        if($to === '' || $from === '') {
+            \OCP\Util::writeLog('core', __METHOD__.', Cannot use empty tag names', \OCP\Util::DEBUG);
+            return false;
+        }
+
+        if (is_numeric($from)) {
+            $key = $this->getTagById($from);
+        } else {
+            $key = $this->getTagByName($from);
+        }
+        if($key === false) {
+            \OCP\Util::writeLog('core', __METHOD__.', tag: ' . $from. ' does not exist', \OCP\Util::DEBUG);
+            return false;
+        }
+        $tag = $this->tags[$key];
+
+        if($this->userHasTag($to, $tag->getOwner())) {
+            \OCP\Util::writeLog('core', __METHOD__.', A tag named ' . $to. ' already exists for user ' . $tag->getOwner() . '.', \OCP\Util::DEBUG);
+            return false;
+        }
+
+        try {
+            $tag->setName($to);
+            $this->tags[$key] = $this->mapper->update($tag);
+        } catch(\Exception $e) {
+            \OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
+                \OCP\Util::ERROR);
+            return false;
+        }
+        return true;
+    }
+
+    /**
+     * Add a list of new tags.
+     *
+     * @param string[] $names A string with a name or an array of strings containing
+     * the name(s) of the tag(s) to add.
+     * @param bool $sync When true, save the tags
+     * @param int|null $id int Optional object id to add to this|these tag(s)
+     * @return bool Returns false on error.
+     */
+    public function addMultiple($names, $sync=false, $id = null) {
+        if(!is_array($names)) {
+            $names = array($names);
+        }
+        $names = array_map('trim', $names);
+        array_filter($names);
+
+        $newones = array();
+        foreach($names as $name) {
+            if(!$this->hasTag($name) && $name !== '') {
+                $newones[] = new Tag($this->user, $this->type, $name);
+            }
+            if(!is_null($id) ) {
+                // Insert $objectid, $categoryid  pairs if not exist.
+                self::$relations[] = array('objid' => $id, 'tag' => $name);
+            }
+        }
+        $this->tags = array_merge($this->tags, $newones);
+        if($sync === true) {
+            $this->save();
+        }
+
+        return true;
+    }
+
+    /**
+     * Save the list of tags and their object relations
+     */
+    protected function save() {
+        if(is_array($this->tags)) {
+            foreach($this->tags as $tag) {
+                try {
+                    if (!$this->mapper->tagExists($tag)) {
+                        $this->mapper->insert($tag);
+                    }
+                } catch(\Exception $e) {
+                    \OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
+                        \OCP\Util::ERROR);
+                }
+            }
+
+            // reload tags to get the proper ids.
+            $this->tags = $this->mapper->loadTags($this->owners, $this->type);
+            \OCP\Util::writeLog('core', __METHOD__.', tags: ' . print_r($this->tags, true),
+                \OCP\Util::DEBUG);
+            // Loop through temporarily cached objectid/tagname pairs
+            // and save relations.
+            $tags = $this->tags;
+            // For some reason this is needed or array_search(i) will return 0..?
+            ksort($tags);
+            foreach(self::$relations as $relation) {
+                $tagId = $this->getTagId($relation['tag']);
+                \OCP\Util::writeLog('core', __METHOD__ . 'catid, ' . $relation['tag'] . ' ' . $tagId, \OCP\Util::DEBUG);
+                if($tagId) {
+                    try {
+                        \OCP\DB::insertIfNotExist(self::RELATION_TABLE,
+                            array(
+                                'objid' => $relation['objid'],
+                                'categoryid' => $tagId,
+                                'type' => $this->type,
+                                ));
+                    } catch(\Exception $e) {
+                        \OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
+                            \OCP\Util::ERROR);
+                    }
+                }
+            }
+            self::$relations = array(); // reset
+        } else {
+            \OCP\Util::writeLog('core', __METHOD__.', $this->tags is not an array! '
+                . print_r($this->tags, true), \OCP\Util::ERROR);
+        }
+    }
+
+    /**
+     * Delete tags and tag/object relations for a user.
+     *
+     * For hooking up on post_deleteUser
+     *
+     * @param array $arguments
+     */
+    public static function post_deleteUser($arguments) {
+        // Find all objectid/tagId pairs.
+        $result = null;
+        try {
+            $stmt = \OCP\DB::prepare('SELECT `id` FROM `' . self::TAG_TABLE . '` '
+                . 'WHERE `uid` = ?');
+            $result = $stmt->execute(array($arguments['uid']));
+            if (\OCP\DB::isError($result)) {
+                \OCP\Util::writeLog('core', __METHOD__. 'DB error: ' . \OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
+            }
+        } catch(\Exception $e) {
+            \OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
+                \OCP\Util::ERROR);
+        }
+
+        if(!is_null($result)) {
+            try {
+                $stmt = \OCP\DB::prepare('DELETE FROM `' . self::RELATION_TABLE . '` '
+                    . 'WHERE `categoryid` = ?');
+                while( $row = $result->fetchRow()) {
+                    try {
+                        $stmt->execute(array($row['id']));
+                    } catch(\Exception $e) {
+                        \OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
+                            \OCP\Util::ERROR);
+                    }
+                }
+            } catch(\Exception $e) {
+                \OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
+                    \OCP\Util::ERROR);
+            }
+        }
+        try {
+            $stmt = \OCP\DB::prepare('DELETE FROM `' . self::TAG_TABLE . '` '
+                . 'WHERE `uid` = ?');
+            $result = $stmt->execute(array($arguments['uid']));
+            if (\OCP\DB::isError($result)) {
+                \OCP\Util::writeLog('core', __METHOD__. ', DB error: ' . \OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
+            }
+        } catch(\Exception $e) {
+            \OCP\Util::writeLog('core', __METHOD__ . ', exception: '
+                . $e->getMessage(), \OCP\Util::ERROR);
+        }
+    }
+
+    /**
+     * Delete tag/object relations from the db
+     *
+     * @param array $ids The ids of the objects
+     * @return boolean Returns false on error.
+     */
+    public function purgeObjects(array $ids) {
+        if(count($ids) === 0) {
+            // job done ;)
+            return true;
+        }
+        $updates = $ids;
+        try {
+            $query = 'DELETE FROM `' . self::RELATION_TABLE . '` ';
+            $query .= 'WHERE `objid` IN (' . str_repeat('?,', count($ids)-1) . '?) ';
+            $query .= 'AND `type`= ?';
+            $updates[] = $this->type;
+            $stmt = \OCP\DB::prepare($query);
+            $result = $stmt->execute($updates);
+            if (\OCP\DB::isError($result)) {
+                \OCP\Util::writeLog('core', __METHOD__. 'DB error: ' . \OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
+                return false;
+            }
+        } catch(\Exception $e) {
+            \OCP\Util::writeLog('core', __METHOD__.', exception: ' . $e->getMessage(),
+                \OCP\Util::ERROR);
+            return false;
+        }
+        return true;
+    }
+
+    /**
+     * Get favorites for an object type
+     *
+     * @return array|false An array of object ids.
+     */
+    public function getFavorites() {
+        try {
+            return $this->getIdsForTag(self::TAG_FAVORITE);
+        } catch(\Exception $e) {
+            \OCP\Util::writeLog('core', __METHOD__.', exception: ' . $e->getMessage(),
+                \OCP\Util::DEBUG);
+            return array();
+        }
+    }
+
+    /**
+     * Add an object to favorites
+     *
+     * @param int $objid The id of the object
+     * @return boolean
+     */
+    public function addToFavorites($objid) {
+        if(!$this->userHasTag(self::TAG_FAVORITE, $this->user)) {
+            $this->add(self::TAG_FAVORITE);
+        }
+        return $this->tagAs($objid, self::TAG_FAVORITE);
+    }
+
+    /**
+     * Remove an object from favorites
+     *
+     * @param int $objid The id of the object
+     * @return boolean
+     */
+    public function removeFromFavorites($objid) {
+        return $this->unTag($objid, self::TAG_FAVORITE);
+    }
+
+    /**
+     * Creates a tag/object relation.
+     *
+     * @param int $objid The id of the object
+     * @param string $tag The id or name of the tag
+     * @return boolean Returns false on error.
+     */
+    public function tagAs($objid, $tag) {
+        if(is_string($tag) && !is_numeric($tag)) {
+            $tag = trim($tag);
+            if($tag === '') {
+                \OCP\Util::writeLog('core', __METHOD__.', Cannot add an empty tag', \OCP\Util::DEBUG);
+                return false;
+            }
+            if(!$this->hasTag($tag)) {
+                $this->add($tag);
+            }
+            $tagId =  $this->getTagId($tag);
+        } else {
+            $tagId = $tag;
+        }
+        try {
+            \OCP\DB::insertIfNotExist(self::RELATION_TABLE,
+                array(
+                    'objid' => $objid,
+                    'categoryid' => $tagId,
+                    'type' => $this->type,
+                ));
+        } catch(\Exception $e) {
+            \OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
+                \OCP\Util::ERROR);
+            return false;
+        }
+        return true;
+    }
+
+    /**
+     * Delete single tag/object relation from the db
+     *
+     * @param int $objid The id of the object
+     * @param string $tag The id or name of the tag
+     * @return boolean
+     */
+    public function unTag($objid, $tag) {
+        if(is_string($tag) && !is_numeric($tag)) {
+            $tag = trim($tag);
+            if($tag === '') {
+                \OCP\Util::writeLog('core', __METHOD__.', Tag name is empty', \OCP\Util::DEBUG);
+                return false;
+            }
+            $tagId =  $this->getTagId($tag);
+        } else {
+            $tagId = $tag;
+        }
+
+        try {
+            $sql = 'DELETE FROM `' . self::RELATION_TABLE . '` '
+                    . 'WHERE `objid` = ? AND `categoryid` = ? AND `type` = ?';
+            $stmt = \OCP\DB::prepare($sql);
+            $stmt->execute(array($objid, $tagId, $this->type));
+        } catch(\Exception $e) {
+            \OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
+                \OCP\Util::ERROR);
+            return false;
+        }
+        return true;
+    }
+
+    /**
+     * Delete tags from the database.
+     *
+     * @param string[]|integer[] $names An array of tags (names or IDs) to delete
+     * @return bool Returns false on error
+     */
+    public function delete($names) {
+        if(!is_array($names)) {
+            $names = array($names);
+        }
+
+        $names = array_map('trim', $names);
+        array_filter($names);
+
+        \OCP\Util::writeLog('core', __METHOD__ . ', before: '
+            . print_r($this->tags, true), \OCP\Util::DEBUG);
+        foreach($names as $name) {
+            $id = null;
+
+            if (is_numeric($name)) {
+                $key = $this->getTagById($name);
+            } else {
+                $key = $this->getTagByName($name);
+            }
+            if ($key !== false) {
+                $tag = $this->tags[$key];
+                $id = $tag->getId();
+                unset($this->tags[$key]);
+                $this->mapper->delete($tag);
+            } else {
+                \OCP\Util::writeLog('core', __METHOD__ . 'Cannot delete tag ' . $name
+                    . ': not found.', \OCP\Util::ERROR);
+            }
+            if(!is_null($id) && $id !== false) {
+                try {
+                    $sql = 'DELETE FROM `' . self::RELATION_TABLE . '` '
+                            . 'WHERE `categoryid` = ?';
+                    $stmt = \OCP\DB::prepare($sql);
+                    $result = $stmt->execute(array($id));
+                    if (\OCP\DB::isError($result)) {
+                        \OCP\Util::writeLog('core',
+                            __METHOD__. 'DB error: ' . \OCP\DB::getErrorMessage(),
+                            \OCP\Util::ERROR);
+                        return false;
+                    }
+                } catch(\Exception $e) {
+                    \OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
+                        \OCP\Util::ERROR);
+                    return false;
+                }
+            }
+        }
+        return true;
+    }
+
+    // case-insensitive array_search
+    protected function array_searchi($needle, $haystack, $mem='getName') {
+        if(!is_array($haystack)) {
+            return false;
+        }
+        return array_search(strtolower($needle), array_map(
+            function($tag) use($mem) {
+                return strtolower(call_user_func(array($tag, $mem)));
+            }, $haystack)
+        );
+    }
+
+    /**
+     * Get a tag's ID.
+     *
+     * @param string $name The tag name to look for.
+     * @return string|bool The tag's id or false if no matching tag is found.
+     */
+    private function getTagId($name) {
+        $key = $this->array_searchi($name, $this->tags);
+        if ($key !== false) {
+            return $this->tags[$key]->getId();
+        }
+        return false;
+    }
+
+    /**
+     * Get a tag by its name.
+     *
+     * @param string $name The tag name.
+     * @return integer|bool The tag object's offset within the $this->tags
+     *                      array or false if it doesn't exist.
+     */
+    private function getTagByName($name) {
+        return $this->array_searchi($name, $this->tags, 'getName');
+    }
+
+    /**
+     * Get a tag by its ID.
+     *
+     * @param string $id The tag ID to look for.
+     * @return integer|bool The tag object's offset within the $this->tags
+     *                      array or false if it doesn't exist.
+     */
+    private function getTagById($id) {
+        return $this->array_searchi($id, $this->tags, 'getId');
+    }
+
+    /**
+     * Returns an array mapping a given tag's properties to its values:
+     * ['id' => 0, 'name' = 'Tag', 'owner' = 'User', 'type' => 'tagtype']
+     *
+     * @param Tag $tag The tag that is going to be mapped
+     * @return array
+     */
+    private function tagMap(Tag $tag) {
+        return array(
+            'id'    => $tag->getId(),
+            'name'  => $tag->getName(),
+            'owner' => $tag->getOwner(),
+            'type'  => $tag->getType()
+        );
+    }
 }

Spacing +85 added lines, -85 removed lines

@@ -132,7 +132,7 @@ 
 		}
 		$this->tags = $this->mapper->loadTags($this->owners, $this->type);
 
-		if(count($defaultTags) > 0 && count($this->tags) === 0) {
+		if (count($defaultTags) > 0 && count($this->tags) === 0) {
 			$this->addMultiple($defaultTags, true);
 		}
 	}
@@ -173,7 +173,7 @@ 
 	* @return array
 	*/
 	public function getTags() {
-		if(!count($this->tags)) {
+		if (!count($this->tags)) {
 			return array();
 		}
 
@@ -182,8 +182,8 @@ 
 		});
 		$tagMap = array();
 
-		foreach($this->tags as $tag) {
-			if($tag->getName() !== self::TAG_FAVORITE) {
+		foreach ($this->tags as $tag) {
+			if ($tag->getName() !== self::TAG_FAVORITE) {
 				$tagMap[] = $this->tagMap($tag);
 			}
 		}
@@ -221,25 +221,25 @@ 
 			$chunks = array_chunk($objIds, 900, false);
 			foreach ($chunks as $chunk) {
 				$result = $conn->executeQuery(
-					'SELECT `category`, `categoryid`, `objid` ' .
-					'FROM `' . self::RELATION_TABLE . '` r, `' . self::TAG_TABLE . '` ' .
+					'SELECT `category`, `categoryid`, `objid` '.
+					'FROM `'.self::RELATION_TABLE.'` r, `'.self::TAG_TABLE.'` '.
 					'WHERE `categoryid` = `id` AND `uid` = ? AND r.`type` = ? AND `objid` IN (?)',
 					array($this->user, $this->type, $chunk),
 					array(null, null, IQueryBuilder::PARAM_INT_ARRAY)
 				);
 				while ($row = $result->fetch()) {
-					$objId = (int)$row['objid'];
+					$objId = (int) $row['objid'];
 					if (!isset($entries[$objId])) {
 						$entries[$objId] = array();
 					}
 					$entries[$objId][] = $row['category'];
 				}
 				if (\OCP\DB::isError($result)) {
-					\OCP\Util::writeLog('core', __METHOD__. 'DB error: ' . \OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
+					\OCP\Util::writeLog('core', __METHOD__.'DB error: '.\OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
 					return false;
 				}
 			}
-		} catch(\Exception $e) {
+		} catch (\Exception $e) {
 			\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
 				\OCP\Util::ERROR);
 			return false;
@@ -260,18 +260,18 @@ 
 	public function getIdsForTag($tag) {
 		$result = null;
 		$tagId = false;
-		if(is_numeric($tag)) {
+		if (is_numeric($tag)) {
 			$tagId = $tag;
-		} elseif(is_string($tag)) {
+		} elseif (is_string($tag)) {
 			$tag = trim($tag);
-			if($tag === '') {
+			if ($tag === '') {
 				\OCP\Util::writeLog('core', __METHOD__.', Cannot use empty tag names', \OCP\Util::DEBUG);
 				return false;
 			}
 			$tagId = $this->getTagId($tag);
 		}
 
-		if($tagId === false) {
+		if ($tagId === false) {
 			$l10n = \OC::$server->getL10N('core');
 			throw new \Exception(
 				$l10n->t('Could not find category "%s"', $tag)
@@ -279,25 +279,25 @@ 
 		}
 
 		$ids = array();
-		$sql = 'SELECT `objid` FROM `' . self::RELATION_TABLE
+		$sql = 'SELECT `objid` FROM `'.self::RELATION_TABLE
 			. '` WHERE `categoryid` = ?';
 
 		try {
 			$stmt = \OCP\DB::prepare($sql);
 			$result = $stmt->execute(array($tagId));
 			if (\OCP\DB::isError($result)) {
-				\OCP\Util::writeLog('core', __METHOD__. 'DB error: ' . \OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
+				\OCP\Util::writeLog('core', __METHOD__.'DB error: '.\OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
 				return false;
 			}
-		} catch(\Exception $e) {
+		} catch (\Exception $e) {
 			\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
 				\OCP\Util::ERROR);
 			return false;
 		}
 
-		if(!is_null($result)) {
-			while( $row = $result->fetchRow()) {
-				$id = (int)$row['objid'];
+		if (!is_null($result)) {
+			while ($row = $result->fetchRow()) {
+				$id = (int) $row['objid'];
 
 				if ($this->includeShared) {
 					// We have to check if we are really allowed to access the
@@ -351,24 +351,24 @@ 
 	public function add($name) {
 		$name = trim($name);
 
-		if($name === '') {
+		if ($name === '') {
 			\OCP\Util::writeLog('core', __METHOD__.', Cannot add an empty tag', \OCP\Util::DEBUG);
 			return false;
 		}
-		if($this->userHasTag($name, $this->user)) {
-			\OCP\Util::writeLog('core', __METHOD__.', name: ' . $name. ' exists already', \OCP\Util::DEBUG);
+		if ($this->userHasTag($name, $this->user)) {
+			\OCP\Util::writeLog('core', __METHOD__.', name: '.$name.' exists already', \OCP\Util::DEBUG);
 			return false;
 		}
 		try {
 			$tag = new Tag($this->user, $this->type, $name);
 			$tag = $this->mapper->insert($tag);
 			$this->tags[] = $tag;
-		} catch(\Exception $e) {
+		} catch (\Exception $e) {
 			\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
 				\OCP\Util::ERROR);
 			return false;
 		}
-		\OCP\Util::writeLog('core', __METHOD__.', id: ' . $tag->getId(), \OCP\Util::DEBUG);
+		\OCP\Util::writeLog('core', __METHOD__.', id: '.$tag->getId(), \OCP\Util::DEBUG);
 		return $tag->getId();
 	}
 
@@ -383,7 +383,7 @@ 
 		$from = trim($from);
 		$to = trim($to);
 
-		if($to === '' || $from === '') {
+		if ($to === '' || $from === '') {
 			\OCP\Util::writeLog('core', __METHOD__.', Cannot use empty tag names', \OCP\Util::DEBUG);
 			return false;
 		}
@@ -393,21 +393,21 @@ 
 		} else {
 			$key = $this->getTagByName($from);
 		}
-		if($key === false) {
-			\OCP\Util::writeLog('core', __METHOD__.', tag: ' . $from. ' does not exist', \OCP\Util::DEBUG);
+		if ($key === false) {
+			\OCP\Util::writeLog('core', __METHOD__.', tag: '.$from.' does not exist', \OCP\Util::DEBUG);
 			return false;
 		}
 		$tag = $this->tags[$key];
 
-		if($this->userHasTag($to, $tag->getOwner())) {
-			\OCP\Util::writeLog('core', __METHOD__.', A tag named ' . $to. ' already exists for user ' . $tag->getOwner() . '.', \OCP\Util::DEBUG);
+		if ($this->userHasTag($to, $tag->getOwner())) {
+			\OCP\Util::writeLog('core', __METHOD__.', A tag named '.$to.' already exists for user '.$tag->getOwner().'.', \OCP\Util::DEBUG);
 			return false;
 		}
 
 		try {
 			$tag->setName($to);
 			$this->tags[$key] = $this->mapper->update($tag);
-		} catch(\Exception $e) {
+		} catch (\Exception $e) {
 			\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
 				\OCP\Util::ERROR);
 			return false;
@@ -424,25 +424,25 @@ 
 	* @param int|null $id int Optional object id to add to this|these tag(s)
 	* @return bool Returns false on error.
 	*/
-	public function addMultiple($names, $sync=false, $id = null) {
-		if(!is_array($names)) {
+	public function addMultiple($names, $sync = false, $id = null) {
+		if (!is_array($names)) {
 			$names = array($names);
 		}
 		$names = array_map('trim', $names);
 		array_filter($names);
 
 		$newones = array();
-		foreach($names as $name) {
-			if(!$this->hasTag($name) && $name !== '') {
+		foreach ($names as $name) {
+			if (!$this->hasTag($name) && $name !== '') {
 				$newones[] = new Tag($this->user, $this->type, $name);
 			}
-			if(!is_null($id) ) {
+			if (!is_null($id)) {
 				// Insert $objectid, $categoryid  pairs if not exist.
 				self::$relations[] = array('objid' => $id, 'tag' => $name);
 			}
 		}
 		$this->tags = array_merge($this->tags, $newones);
-		if($sync === true) {
+		if ($sync === true) {
 			$this->save();
 		}
 
@@ -453,13 +453,13 @@ 
 	 * Save the list of tags and their object relations
 	 */
 	protected function save() {
-		if(is_array($this->tags)) {
-			foreach($this->tags as $tag) {
+		if (is_array($this->tags)) {
+			foreach ($this->tags as $tag) {
 				try {
 					if (!$this->mapper->tagExists($tag)) {
 						$this->mapper->insert($tag);
 					}
-				} catch(\Exception $e) {
+				} catch (\Exception $e) {
 					\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
 						\OCP\Util::ERROR);
 				}
@@ -467,17 +467,17 @@ 
 
 			// reload tags to get the proper ids.
 			$this->tags = $this->mapper->loadTags($this->owners, $this->type);
-			\OCP\Util::writeLog('core', __METHOD__.', tags: ' . print_r($this->tags, true),
+			\OCP\Util::writeLog('core', __METHOD__.', tags: '.print_r($this->tags, true),
 				\OCP\Util::DEBUG);
 			// Loop through temporarily cached objectid/tagname pairs
 			// and save relations.
 			$tags = $this->tags;
 			// For some reason this is needed or array_search(i) will return 0..?
 			ksort($tags);
-			foreach(self::$relations as $relation) {
+			foreach (self::$relations as $relation) {
 				$tagId = $this->getTagId($relation['tag']);
-				\OCP\Util::writeLog('core', __METHOD__ . 'catid, ' . $relation['tag'] . ' ' . $tagId, \OCP\Util::DEBUG);
-				if($tagId) {
+				\OCP\Util::writeLog('core', __METHOD__.'catid, '.$relation['tag'].' '.$tagId, \OCP\Util::DEBUG);
+				if ($tagId) {
 					try {
 						\OCP\DB::insertIfNotExist(self::RELATION_TABLE,
 							array(
@@ -485,7 +485,7 @@ 
 								'categoryid' => $tagId,
 								'type' => $this->type,
 								));
-					} catch(\Exception $e) {
+					} catch (\Exception $e) {
 						\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
 							\OCP\Util::ERROR);
 					}
@@ -509,43 +509,43 @@ 
 		// Find all objectid/tagId pairs.
 		$result = null;
 		try {
-			$stmt = \OCP\DB::prepare('SELECT `id` FROM `' . self::TAG_TABLE . '` '
+			$stmt = \OCP\DB::prepare('SELECT `id` FROM `'.self::TAG_TABLE.'` '
 				. 'WHERE `uid` = ?');
 			$result = $stmt->execute(array($arguments['uid']));
 			if (\OCP\DB::isError($result)) {
-				\OCP\Util::writeLog('core', __METHOD__. 'DB error: ' . \OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
+				\OCP\Util::writeLog('core', __METHOD__.'DB error: '.\OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
 			}
-		} catch(\Exception $e) {
+		} catch (\Exception $e) {
 			\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
 				\OCP\Util::ERROR);
 		}
 
-		if(!is_null($result)) {
+		if (!is_null($result)) {
 			try {
-				$stmt = \OCP\DB::prepare('DELETE FROM `' . self::RELATION_TABLE . '` '
+				$stmt = \OCP\DB::prepare('DELETE FROM `'.self::RELATION_TABLE.'` '
 					. 'WHERE `categoryid` = ?');
-				while( $row = $result->fetchRow()) {
+				while ($row = $result->fetchRow()) {
 					try {
 						$stmt->execute(array($row['id']));
-					} catch(\Exception $e) {
+					} catch (\Exception $e) {
 						\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
 							\OCP\Util::ERROR);
 					}
 				}
-			} catch(\Exception $e) {
+			} catch (\Exception $e) {
 				\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
 					\OCP\Util::ERROR);
 			}
 		}
 		try {
-			$stmt = \OCP\DB::prepare('DELETE FROM `' . self::TAG_TABLE . '` '
+			$stmt = \OCP\DB::prepare('DELETE FROM `'.self::TAG_TABLE.'` '
 				. 'WHERE `uid` = ?');
 			$result = $stmt->execute(array($arguments['uid']));
 			if (\OCP\DB::isError($result)) {
-				\OCP\Util::writeLog('core', __METHOD__. ', DB error: ' . \OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
+				\OCP\Util::writeLog('core', __METHOD__.', DB error: '.\OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
 			}
-		} catch(\Exception $e) {
-			\OCP\Util::writeLog('core', __METHOD__ . ', exception: '
+		} catch (\Exception $e) {
+			\OCP\Util::writeLog('core', __METHOD__.', exception: '
 				. $e->getMessage(), \OCP\Util::ERROR);
 		}
 	}
@@ -557,24 +557,24 @@ 
 	* @return boolean Returns false on error.
 	*/
 	public function purgeObjects(array $ids) {
-		if(count($ids) === 0) {
+		if (count($ids) === 0) {
 			// job done ;)
 			return true;
 		}
 		$updates = $ids;
 		try {
-			$query = 'DELETE FROM `' . self::RELATION_TABLE . '` ';
-			$query .= 'WHERE `objid` IN (' . str_repeat('?,', count($ids)-1) . '?) ';
+			$query = 'DELETE FROM `'.self::RELATION_TABLE.'` ';
+			$query .= 'WHERE `objid` IN ('.str_repeat('?,', count($ids) - 1).'?) ';
 			$query .= 'AND `type`= ?';
 			$updates[] = $this->type;
 			$stmt = \OCP\DB::prepare($query);
 			$result = $stmt->execute($updates);
 			if (\OCP\DB::isError($result)) {
-				\OCP\Util::writeLog('core', __METHOD__. 'DB error: ' . \OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
+				\OCP\Util::writeLog('core', __METHOD__.'DB error: '.\OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
 				return false;
 			}
-		} catch(\Exception $e) {
-			\OCP\Util::writeLog('core', __METHOD__.', exception: ' . $e->getMessage(),
+		} catch (\Exception $e) {
+			\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
 				\OCP\Util::ERROR);
 			return false;
 		}
@@ -589,8 +589,8 @@ 
 	public function getFavorites() {
 		try {
 			return $this->getIdsForTag(self::TAG_FAVORITE);
-		} catch(\Exception $e) {
-			\OCP\Util::writeLog('core', __METHOD__.', exception: ' . $e->getMessage(),
+		} catch (\Exception $e) {
+			\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
 				\OCP\Util::DEBUG);
 			return array();
 		}
@@ -603,7 +603,7 @@ 
 	* @return boolean
 	*/
 	public function addToFavorites($objid) {
-		if(!$this->userHasTag(self::TAG_FAVORITE, $this->user)) {
+		if (!$this->userHasTag(self::TAG_FAVORITE, $this->user)) {
 			$this->add(self::TAG_FAVORITE);
 		}
 		return $this->tagAs($objid, self::TAG_FAVORITE);
@@ -627,16 +627,16 @@ 
 	* @return boolean Returns false on error.
 	*/
 	public function tagAs($objid, $tag) {
-		if(is_string($tag) && !is_numeric($tag)) {
+		if (is_string($tag) && !is_numeric($tag)) {
 			$tag = trim($tag);
-			if($tag === '') {
+			if ($tag === '') {
 				\OCP\Util::writeLog('core', __METHOD__.', Cannot add an empty tag', \OCP\Util::DEBUG);
 				return false;
 			}
-			if(!$this->hasTag($tag)) {
+			if (!$this->hasTag($tag)) {
 				$this->add($tag);
 			}
-			$tagId =  $this->getTagId($tag);
+			$tagId = $this->getTagId($tag);
 		} else {
 			$tagId = $tag;
 		}
@@ -647,7 +647,7 @@ 
 					'categoryid' => $tagId,
 					'type' => $this->type,
 				));
-		} catch(\Exception $e) {
+		} catch (\Exception $e) {
 			\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
 				\OCP\Util::ERROR);
 			return false;
@@ -663,23 +663,23 @@ 
 	* @return boolean
 	*/
 	public function unTag($objid, $tag) {
-		if(is_string($tag) && !is_numeric($tag)) {
+		if (is_string($tag) && !is_numeric($tag)) {
 			$tag = trim($tag);
-			if($tag === '') {
+			if ($tag === '') {
 				\OCP\Util::writeLog('core', __METHOD__.', Tag name is empty', \OCP\Util::DEBUG);
 				return false;
 			}
-			$tagId =  $this->getTagId($tag);
+			$tagId = $this->getTagId($tag);
 		} else {
 			$tagId = $tag;
 		}
 
 		try {
-			$sql = 'DELETE FROM `' . self::RELATION_TABLE . '` '
+			$sql = 'DELETE FROM `'.self::RELATION_TABLE.'` '
 					. 'WHERE `objid` = ? AND `categoryid` = ? AND `type` = ?';
 			$stmt = \OCP\DB::prepare($sql);
 			$stmt->execute(array($objid, $tagId, $this->type));
-		} catch(\Exception $e) {
+		} catch (\Exception $e) {
 			\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
 				\OCP\Util::ERROR);
 			return false;
@@ -694,16 +694,16 @@ 
 	* @return bool Returns false on error
 	*/
 	public function delete($names) {
-		if(!is_array($names)) {
+		if (!is_array($names)) {
 			$names = array($names);
 		}
 
 		$names = array_map('trim', $names);
 		array_filter($names);
 
-		\OCP\Util::writeLog('core', __METHOD__ . ', before: '
+		\OCP\Util::writeLog('core', __METHOD__.', before: '
 			. print_r($this->tags, true), \OCP\Util::DEBUG);
-		foreach($names as $name) {
+		foreach ($names as $name) {
 			$id = null;
 
 			if (is_numeric($name)) {
@@ -717,22 +717,22 @@ 
 				unset($this->tags[$key]);
 				$this->mapper->delete($tag);
 			} else {
-				\OCP\Util::writeLog('core', __METHOD__ . 'Cannot delete tag ' . $name
+				\OCP\Util::writeLog('core', __METHOD__.'Cannot delete tag '.$name
 					. ': not found.', \OCP\Util::ERROR);
 			}
-			if(!is_null($id) && $id !== false) {
+			if (!is_null($id) && $id !== false) {
 				try {
-					$sql = 'DELETE FROM `' . self::RELATION_TABLE . '` '
+					$sql = 'DELETE FROM `'.self::RELATION_TABLE.'` '
 							. 'WHERE `categoryid` = ?';
 					$stmt = \OCP\DB::prepare($sql);
 					$result = $stmt->execute(array($id));
 					if (\OCP\DB::isError($result)) {
 						\OCP\Util::writeLog('core',
-							__METHOD__. 'DB error: ' . \OCP\DB::getErrorMessage(),
+							__METHOD__.'DB error: '.\OCP\DB::getErrorMessage(),
 							\OCP\Util::ERROR);
 						return false;
 					}
-				} catch(\Exception $e) {
+				} catch (\Exception $e) {
 					\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
 						\OCP\Util::ERROR);
 					return false;
@@ -743,8 +743,8 @@ 
 	}
 
 	// case-insensitive array_search
-	protected function array_searchi($needle, $haystack, $mem='getName') {
-		if(!is_array($haystack)) {
+	protected function array_searchi($needle, $haystack, $mem = 'getName') {
+		if (!is_array($haystack)) {
 			return false;
 		}
 		return array_search(strtolower($needle), array_map(

lib/private/Template/Base.php

Doc Comments +1 added lines, -1 removed lines

@@ -103,7 +103,7 @@
 	/**
 	 * Appends a variable
 	 * @param string $key key
-	 * @param mixed $value value
+	 * @param string $value value
 	 * @return boolean|null
 	 *
 	 * This function assigns a variable in an array context. If the key already

Braces +2 added lines, -4 removed lines

@@ -114,8 +114,7 @@ 
 	public function append( $key, $value ) {
 		if( array_key_exists( $key, $this->vars )) {
 			$this->vars[$key][] = $value;
-		}
-		else{
+		} else{
 			$this->vars[$key] = array( $value );
 		}
 	}
@@ -130,8 +129,7 @@ 
 		$data = $this->fetchPage();
 		if( $data === false ) {
 			return false;
-		}
-		else{
+		} else{
 			print $data;
 			return true;
 		}

Indentation +153 added lines, -153 removed lines

@@ -31,158 +31,158 @@
 use OCP\Defaults;
 
 class Base {
-	private $template; // The template
-	private $vars; // Vars
-
-	/** @var \OCP\IL10N */
-	private $l10n;
-
-	/** @var Defaults */
-	private $theme;
-
-	/**
-	 * @param string $template
-	 * @param string $requestToken
-	 * @param \OCP\IL10N $l10n
-	 * @param Defaults $theme
-	 */
-	public function __construct($template, $requestToken, $l10n, $theme ) {
-		$this->vars = array();
-		$this->vars['requesttoken'] = $requestToken;
-		$this->l10n = $l10n;
-		$this->template = $template;
-		$this->theme = $theme;
-	}
-
-	/**
-	 * @param string $serverRoot
-	 * @param string|false $app_dir
-	 * @param string $theme
-	 * @param string $app
-	 * @return string[]
-	 */
-	protected function getAppTemplateDirs($theme, $app, $serverRoot, $app_dir) {
-		// Check if the app is in the app folder or in the root
-		if( file_exists($app_dir.'/templates/' )) {
-			return [
-				$serverRoot.'/themes/'.$theme.'/apps/'.$app.'/templates/',
-				$app_dir.'/templates/',
-			];
-		}
-		return [
-			$serverRoot.'/themes/'.$theme.'/'.$app.'/templates/',
-			$serverRoot.'/'.$app.'/templates/',
-		];
-	}
-
-	/**
-	 * @param string $serverRoot
-	 * @param string $theme
-	 * @return string[]
-	 */
-	protected function getCoreTemplateDirs($theme, $serverRoot) {
-		return [
-			$serverRoot.'/themes/'.$theme.'/core/templates/',
-			$serverRoot.'/core/templates/',
-		];
-	}
-
-	/**
-	 * Assign variables
-	 * @param string $key key
-	 * @param array|bool|integer|string $value value
-	 * @return bool
-	 *
-	 * This function assigns a variable. It can be accessed via $_[$key] in
-	 * the template.
-	 *
-	 * If the key existed before, it will be overwritten
-	 */
-	public function assign( $key, $value) {
-		$this->vars[$key] = $value;
-		return true;
-	}
-
-	/**
-	 * Appends a variable
-	 * @param string $key key
-	 * @param mixed $value value
-	 * @return boolean|null
-	 *
-	 * This function assigns a variable in an array context. If the key already
-	 * exists, the value will be appended. It can be accessed via
-	 * $_[$key][$position] in the template.
-	 */
-	public function append( $key, $value ) {
-		if( array_key_exists( $key, $this->vars )) {
-			$this->vars[$key][] = $value;
-		}
-		else{
-			$this->vars[$key] = array( $value );
-		}
-	}
-
-	/**
-	 * Prints the proceeded template
-	 * @return bool
-	 *
-	 * This function proceeds the template and prints its output.
-	 */
-	public function printPage() {
-		$data = $this->fetchPage();
-		if( $data === false ) {
-			return false;
-		}
-		else{
-			print $data;
-			return true;
-		}
-	}
-
-	/**
-	 * Process the template
-	 *
-	 * @param array|null $additionalParams
-	 * @return string This function processes the template.
-	 *
-	 * This function processes the template.
-	 */
-	public function fetchPage($additionalParams = null) {
-		return $this->load($this->template, $additionalParams);
-	}
-
-	/**
-	 * doing the actual work
-	 *
-	 * @param string $file
-	 * @param array|null $additionalParams
-	 * @return string content
-	 *
-	 * Includes the template file, fetches its output
-	 */
-	protected function load($file, $additionalParams = null) {
-		// Register the variables
-		$_ = $this->vars;
-		$l = $this->l10n;
-		$theme = $this->theme;
-
-		if( !is_null($additionalParams)) {
-			$_ = array_merge( $additionalParams, $this->vars );
-		}
-
-		// Include
-		ob_start();
-		try {
-			include $file;
-			$data = ob_get_contents();
-		} catch (\Exception $e) {
-			@ob_end_clean();
-			throw $e;
-		}
-		@ob_end_clean();
-
-		// Return data
-		return $data;
-	}
+    private $template; // The template
+    private $vars; // Vars
+
+    /** @var \OCP\IL10N */
+    private $l10n;
+
+    /** @var Defaults */
+    private $theme;
+
+    /**
+     * @param string $template
+     * @param string $requestToken
+     * @param \OCP\IL10N $l10n
+     * @param Defaults $theme
+     */
+    public function __construct($template, $requestToken, $l10n, $theme ) {
+        $this->vars = array();
+        $this->vars['requesttoken'] = $requestToken;
+        $this->l10n = $l10n;
+        $this->template = $template;
+        $this->theme = $theme;
+    }
+
+    /**
+     * @param string $serverRoot
+     * @param string|false $app_dir
+     * @param string $theme
+     * @param string $app
+     * @return string[]
+     */
+    protected function getAppTemplateDirs($theme, $app, $serverRoot, $app_dir) {
+        // Check if the app is in the app folder or in the root
+        if( file_exists($app_dir.'/templates/' )) {
+            return [
+                $serverRoot.'/themes/'.$theme.'/apps/'.$app.'/templates/',
+                $app_dir.'/templates/',
+            ];
+        }
+        return [
+            $serverRoot.'/themes/'.$theme.'/'.$app.'/templates/',
+            $serverRoot.'/'.$app.'/templates/',
+        ];
+    }
+
+    /**
+     * @param string $serverRoot
+     * @param string $theme
+     * @return string[]
+     */
+    protected function getCoreTemplateDirs($theme, $serverRoot) {
+        return [
+            $serverRoot.'/themes/'.$theme.'/core/templates/',
+            $serverRoot.'/core/templates/',
+        ];
+    }
+
+    /**
+     * Assign variables
+     * @param string $key key
+     * @param array|bool|integer|string $value value
+     * @return bool
+     *
+     * This function assigns a variable. It can be accessed via $_[$key] in
+     * the template.
+     *
+     * If the key existed before, it will be overwritten
+     */
+    public function assign( $key, $value) {
+        $this->vars[$key] = $value;
+        return true;
+    }
+
+    /**
+     * Appends a variable
+     * @param string $key key
+     * @param mixed $value value
+     * @return boolean|null
+     *
+     * This function assigns a variable in an array context. If the key already
+     * exists, the value will be appended. It can be accessed via
+     * $_[$key][$position] in the template.
+     */
+    public function append( $key, $value ) {
+        if( array_key_exists( $key, $this->vars )) {
+            $this->vars[$key][] = $value;
+        }
+        else{
+            $this->vars[$key] = array( $value );
+        }
+    }
+
+    /**
+     * Prints the proceeded template
+     * @return bool
+     *
+     * This function proceeds the template and prints its output.
+     */
+    public function printPage() {
+        $data = $this->fetchPage();
+        if( $data === false ) {
+            return false;
+        }
+        else{
+            print $data;
+            return true;
+        }
+    }
+
+    /**
+     * Process the template
+     *
+     * @param array|null $additionalParams
+     * @return string This function processes the template.
+     *
+     * This function processes the template.
+     */
+    public function fetchPage($additionalParams = null) {
+        return $this->load($this->template, $additionalParams);
+    }
+
+    /**
+     * doing the actual work
+     *
+     * @param string $file
+     * @param array|null $additionalParams
+     * @return string content
+     *
+     * Includes the template file, fetches its output
+     */
+    protected function load($file, $additionalParams = null) {
+        // Register the variables
+        $_ = $this->vars;
+        $l = $this->l10n;
+        $theme = $this->theme;
+
+        if( !is_null($additionalParams)) {
+            $_ = array_merge( $additionalParams, $this->vars );
+        }
+
+        // Include
+        ob_start();
+        try {
+            include $file;
+            $data = ob_get_contents();
+        } catch (\Exception $e) {
+            @ob_end_clean();
+            throw $e;
+        }
+        @ob_end_clean();
+
+        // Return data
+        return $data;
+    }
 
 }

Spacing +11 added lines, -11 removed lines

@@ -46,7 +46,7 @@ 
 	 * @param \OCP\IL10N $l10n
 	 * @param Defaults $theme
 	 */
-	public function __construct($template, $requestToken, $l10n, $theme ) {
+	public function __construct($template, $requestToken, $l10n, $theme) {
 		$this->vars = array();
 		$this->vars['requesttoken'] = $requestToken;
 		$this->l10n = $l10n;
@@ -63,7 +63,7 @@ 
 	 */
 	protected function getAppTemplateDirs($theme, $app, $serverRoot, $app_dir) {
 		// Check if the app is in the app folder or in the root
-		if( file_exists($app_dir.'/templates/' )) {
+		if (file_exists($app_dir.'/templates/')) {
 			return [
 				$serverRoot.'/themes/'.$theme.'/apps/'.$app.'/templates/',
 				$app_dir.'/templates/',
@@ -98,7 +98,7 @@ 
 	 *
 	 * If the key existed before, it will be overwritten
 	 */
-	public function assign( $key, $value) {
+	public function assign($key, $value) {
 		$this->vars[$key] = $value;
 		return true;
 	}
@@ -113,12 +113,12 @@ 
 	 * exists, the value will be appended. It can be accessed via
 	 * $_[$key][$position] in the template.
 	 */
-	public function append( $key, $value ) {
-		if( array_key_exists( $key, $this->vars )) {
+	public function append($key, $value) {
+		if (array_key_exists($key, $this->vars)) {
 			$this->vars[$key][] = $value;
 		}
-		else{
-			$this->vars[$key] = array( $value );
+		else {
+			$this->vars[$key] = array($value);
 		}
 	}
 
@@ -130,10 +130,10 @@ 
 	 */
 	public function printPage() {
 		$data = $this->fetchPage();
-		if( $data === false ) {
+		if ($data === false) {
 			return false;
 		}
-		else{
+		else {
 			print $data;
 			return true;
 		}
@@ -166,8 +166,8 @@ 
 		$l = $this->l10n;
 		$theme = $this->theme;
 
-		if( !is_null($additionalParams)) {
-			$_ = array_merge( $additionalParams, $this->vars );
+		if (!is_null($additionalParams)) {
+			$_ = array_merge($additionalParams, $this->vars);
 		}
 
 		// Include

lib/public/App/ManagerEvent.php

Doc Comments +1 added lines, -1 removed lines

@@ -46,7 +46,7 @@
 	 * DispatcherEvent constructor.
 	 *
 	 * @param string $event
-	 * @param $appID
+	 * @param string $appID
 	 * @param \OCP\IGroup[] $groups
 	 * @since 9.0.0
 	 */

Indentation +51 added lines, -51 removed lines

@@ -32,61 +32,61 @@
  */
 class ManagerEvent extends Event {
 
-	const EVENT_APP_ENABLE = 'OCP\App\IAppManager::enableApp';
-	const EVENT_APP_ENABLE_FOR_GROUPS = 'OCP\App\IAppManager::enableAppForGroups';
-	const EVENT_APP_DISABLE = 'OCP\App\IAppManager::disableApp';
+    const EVENT_APP_ENABLE = 'OCP\App\IAppManager::enableApp';
+    const EVENT_APP_ENABLE_FOR_GROUPS = 'OCP\App\IAppManager::enableAppForGroups';
+    const EVENT_APP_DISABLE = 'OCP\App\IAppManager::disableApp';
 
-	/**
-	 * @since 9.1.0
-	 */
-	const EVENT_APP_UPDATE = 'OCP\App\IAppManager::updateApp';
+    /**
+     * @since 9.1.0
+     */
+    const EVENT_APP_UPDATE = 'OCP\App\IAppManager::updateApp';
 
-	/** @var string */
-	protected $event;
-	/** @var string */
-	protected $appID;
-	/** @var \OCP\IGroup[] */
-	protected $groups;
+    /** @var string */
+    protected $event;
+    /** @var string */
+    protected $appID;
+    /** @var \OCP\IGroup[] */
+    protected $groups;
 
-	/**
-	 * DispatcherEvent constructor.
-	 *
-	 * @param string $event
-	 * @param $appID
-	 * @param \OCP\IGroup[] $groups
-	 * @since 9.0.0
-	 */
-	public function __construct($event, $appID, array $groups = null) {
-		$this->event = $event;
-		$this->appID = $appID;
-		$this->groups = $groups;
-	}
+    /**
+     * DispatcherEvent constructor.
+     *
+     * @param string $event
+     * @param $appID
+     * @param \OCP\IGroup[] $groups
+     * @since 9.0.0
+     */
+    public function __construct($event, $appID, array $groups = null) {
+        $this->event = $event;
+        $this->appID = $appID;
+        $this->groups = $groups;
+    }
 
-	/**
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getEvent() {
-		return $this->event;
-	}
+    /**
+     * @return string
+     * @since 9.0.0
+     */
+    public function getEvent() {
+        return $this->event;
+    }
 
-	/**
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getAppID() {
-		return $this->appID;
-	}
+    /**
+     * @return string
+     * @since 9.0.0
+     */
+    public function getAppID() {
+        return $this->appID;
+    }
 
-	/**
-	 * returns the group Ids
-	 * @return string[]
-	 * @since 9.0.0
-	 */
-	public function getGroups() {
-		return array_map(function ($group) {
-			/** @var \OCP\IGroup $group */
-			return $group->getGID();
-		}, $this->groups);
-	}
+    /**
+     * returns the group Ids
+     * @return string[]
+     * @since 9.0.0
+     */
+    public function getGroups() {
+        return array_map(function ($group) {
+            /** @var \OCP\IGroup $group */
+            return $group->getGID();
+        }, $this->groups);
+    }
 }

Spacing +1 added lines, -1 removed lines

@@ -84,7 +84,7 @@
 	 * @since 9.0.0
 	 */
 	public function getGroups() {
-		return array_map(function ($group) {
+		return array_map(function($group) {
 			/** @var \OCP\IGroup $group */
 			return $group->getGID();
 		}, $this->groups);

lib/public/AppFramework/Db/Mapper.php

Doc Comments +2 added lines, -1 removed lines

@@ -308,6 +308,7 @@ 
 	 * @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
+	 * @param string $msg
 	 * @return string formatted error message string
 	 * @since 9.1.0
 	 */
@@ -360,7 +361,7 @@ 
 	 * 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 string[] $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

Indentation +321 added lines, -321 removed lines

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

Spacing +37 added lines, -37 removed lines

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

lib/public/Files.php

Doc Comments +2 added lines, -1 removed lines

@@ -46,6 +46,7 @@ 
 class Files {
 	/**
 	 * Recusive deletion of folders
+	 * @param string $dir
 	 * @return bool
 	 * @since 5.0.0
 	 */
@@ -67,7 +68,7 @@ 
 	/**
 	 * Search for files by mimetype
 	 * @param string $mimetype
-	 * @return array
+	 * @return \OC\Files\FileInfo[]
 	 * @since 6.0.0
 	 */
 	static public function searchByMime( $mimetype ) {

Indentation +81 added lines, -81 removed lines

@@ -45,92 +45,92 @@
  * @since 5.0.0
  */
 class Files {
-	/**
-	 * Recusive deletion of folders
-	 * @return bool
-	 * @since 5.0.0
-	 */
-	static function rmdirr( $dir ) {
-		return \OC_Helper::rmdirr( $dir );
-	}
+    /**
+     * Recusive deletion of folders
+     * @return bool
+     * @since 5.0.0
+     */
+    static function rmdirr( $dir ) {
+        return \OC_Helper::rmdirr( $dir );
+    }
 
-	/**
-	 * Get the mimetype form a local file
-	 * @param string $path
-	 * @return string
-	 * does NOT work for ownClouds filesystem, use OC_FileSystem::getMimeType instead
-	 * @since 5.0.0
-	 */
-	static function getMimeType( $path ) {
-		return \OC::$server->getMimeTypeDetector()->detect($path);
-	}
+    /**
+     * Get the mimetype form a local file
+     * @param string $path
+     * @return string
+     * does NOT work for ownClouds filesystem, use OC_FileSystem::getMimeType instead
+     * @since 5.0.0
+     */
+    static function getMimeType( $path ) {
+        return \OC::$server->getMimeTypeDetector()->detect($path);
+    }
 
-	/**
-	 * Search for files by mimetype
-	 * @param string $mimetype
-	 * @return array
-	 * @since 6.0.0
-	 */
-	static public function searchByMime( $mimetype ) {
-		return(\OC\Files\Filesystem::searchByMime( $mimetype ));
-	}
+    /**
+     * Search for files by mimetype
+     * @param string $mimetype
+     * @return array
+     * @since 6.0.0
+     */
+    static public function searchByMime( $mimetype ) {
+        return(\OC\Files\Filesystem::searchByMime( $mimetype ));
+    }
 
-	/**
-	 * Copy the contents of one stream to another
-	 * @param resource $source
-	 * @param resource $target
-	 * @return int the number of bytes copied
-	 * @since 5.0.0
-	 */
-	public static function streamCopy( $source, $target ) {
-		list($count, ) = \OC_Helper::streamCopy( $source, $target );
-		return $count;
-	}
+    /**
+     * Copy the contents of one stream to another
+     * @param resource $source
+     * @param resource $target
+     * @return int the number of bytes copied
+     * @since 5.0.0
+     */
+    public static function streamCopy( $source, $target ) {
+        list($count, ) = \OC_Helper::streamCopy( $source, $target );
+        return $count;
+    }
 
-	/**
-	 * Create a temporary file with an unique filename
-	 * @param string $postfix
-	 * @return string
-	 *
-	 * temporary files are automatically cleaned up after the script is finished
-	 * @deprecated 8.1.0 use getTemporaryFile() of \OCP\ITempManager - \OC::$server->getTempManager()
-	 * @since 5.0.0
-	 */
-	public static function tmpFile( $postfix='' ) {
-		return \OC::$server->getTempManager()->getTemporaryFile($postfix);
-	}
+    /**
+     * Create a temporary file with an unique filename
+     * @param string $postfix
+     * @return string
+     *
+     * temporary files are automatically cleaned up after the script is finished
+     * @deprecated 8.1.0 use getTemporaryFile() of \OCP\ITempManager - \OC::$server->getTempManager()
+     * @since 5.0.0
+     */
+    public static function tmpFile( $postfix='' ) {
+        return \OC::$server->getTempManager()->getTemporaryFile($postfix);
+    }
 
-	/**
-	 * Create a temporary folder with an unique filename
-	 * @return string
-	 *
-	 * temporary files are automatically cleaned up after the script is finished
-	 * @deprecated 8.1.0 use getTemporaryFolder() of \OCP\ITempManager - \OC::$server->getTempManager()
-	 * @since 5.0.0
-	 */
-	public static function tmpFolder() {
-		return \OC::$server->getTempManager()->getTemporaryFolder();
-	}
+    /**
+     * Create a temporary folder with an unique filename
+     * @return string
+     *
+     * temporary files are automatically cleaned up after the script is finished
+     * @deprecated 8.1.0 use getTemporaryFolder() of \OCP\ITempManager - \OC::$server->getTempManager()
+     * @since 5.0.0
+     */
+    public static function tmpFolder() {
+        return \OC::$server->getTempManager()->getTemporaryFolder();
+    }
 
-	/**
-	 * Adds a suffix to the name in case the file exists
-	 * @param string $path
-	 * @param string $filename
-	 * @return string
-	 * @since 5.0.0
-	 */
-	public static function buildNotExistingFileName( $path, $filename ) {
-		return(\OC_Helper::buildNotExistingFileName( $path, $filename ));
-	}
+    /**
+     * Adds a suffix to the name in case the file exists
+     * @param string $path
+     * @param string $filename
+     * @return string
+     * @since 5.0.0
+     */
+    public static function buildNotExistingFileName( $path, $filename ) {
+        return(\OC_Helper::buildNotExistingFileName( $path, $filename ));
+    }
 
-	/**
-	 * Gets the Storage for an app - creates the needed folder if they are not
-	 * existent
-	 * @param string $app
-	 * @return \OC\Files\View
-	 * @since 5.0.0
-	 */
-	public static function getStorage( $app ) {
-		return \OC_App::getStorage( $app );
-	}
+    /**
+     * Gets the Storage for an app - creates the needed folder if they are not
+     * existent
+     * @param string $app
+     * @return \OC\Files\View
+     * @since 5.0.0
+     */
+    public static function getStorage( $app ) {
+        return \OC_App::getStorage( $app );
+    }
 }

Spacing +12 added lines, -12 removed lines

@@ -50,8 +50,8 @@ 
 	 * @return bool
 	 * @since 5.0.0
 	 */
-	static function rmdirr( $dir ) {
-		return \OC_Helper::rmdirr( $dir );
+	static function rmdirr($dir) {
+		return \OC_Helper::rmdirr($dir);
 	}
 
 	/**
@@ -61,7 +61,7 @@ 
 	 * does NOT work for ownClouds filesystem, use OC_FileSystem::getMimeType instead
 	 * @since 5.0.0
 	 */
-	static function getMimeType( $path ) {
+	static function getMimeType($path) {
 		return \OC::$server->getMimeTypeDetector()->detect($path);
 	}
 
@@ -71,8 +71,8 @@ 
 	 * @return array
 	 * @since 6.0.0
 	 */
-	static public function searchByMime( $mimetype ) {
-		return(\OC\Files\Filesystem::searchByMime( $mimetype ));
+	static public function searchByMime($mimetype) {
+		return(\OC\Files\Filesystem::searchByMime($mimetype));
 	}
 
 	/**
@@ -82,8 +82,8 @@ 
 	 * @return int the number of bytes copied
 	 * @since 5.0.0
 	 */
-	public static function streamCopy( $source, $target ) {
-		list($count, ) = \OC_Helper::streamCopy( $source, $target );
+	public static function streamCopy($source, $target) {
+		list($count,) = \OC_Helper::streamCopy($source, $target);
 		return $count;
 	}
 
@@ -96,7 +96,7 @@ 
 	 * @deprecated 8.1.0 use getTemporaryFile() of \OCP\ITempManager - \OC::$server->getTempManager()
 	 * @since 5.0.0
 	 */
-	public static function tmpFile( $postfix='' ) {
+	public static function tmpFile($postfix = '') {
 		return \OC::$server->getTempManager()->getTemporaryFile($postfix);
 	}
 
@@ -119,8 +119,8 @@ 
 	 * @return string
 	 * @since 5.0.0
 	 */
-	public static function buildNotExistingFileName( $path, $filename ) {
-		return(\OC_Helper::buildNotExistingFileName( $path, $filename ));
+	public static function buildNotExistingFileName($path, $filename) {
+		return(\OC_Helper::buildNotExistingFileName($path, $filename));
 	}
 
 	/**
@@ -130,7 +130,7 @@ 
 	 * @return \OC\Files\View
 	 * @since 5.0.0
 	 */
-	public static function getStorage( $app ) {
-		return \OC_App::getStorage( $app );
+	public static function getStorage($app) {
+		return \OC_App::getStorage($app);
 	}
 }

lib/public/Files/StorageAuthException.php

Doc Comments -1 removed lines

@@ -30,7 +30,6 @@
 	 * StorageAuthException constructor.
 	 *
 	 * @param string $message
-	 * @param int $code
 	 * @param \Exception $previous
 	 * @since 9.0.0
 	 */

Indentation +12 added lines, -12 removed lines

@@ -27,16 +27,16 @@
  */
 class StorageAuthException extends StorageNotAvailableException {
 
-	/**
-	 * StorageAuthException constructor.
-	 *
-	 * @param string $message
-	 * @param int $code
-	 * @param \Exception $previous
-	 * @since 9.0.0
-	 */
-	public function __construct($message = '', \Exception $previous = null) {
-		$l = \OC::$server->getL10N('core');
-		parent::__construct($l->t('Storage unauthorized. %s', $message), self::STATUS_UNAUTHORIZED, $previous);
-	}
+    /**
+     * StorageAuthException constructor.
+     *
+     * @param string $message
+     * @param int $code
+     * @param \Exception $previous
+     * @since 9.0.0
+     */
+    public function __construct($message = '', \Exception $previous = null) {
+        $l = \OC::$server->getL10N('core');
+        parent::__construct($l->t('Storage unauthorized. %s', $message), self::STATUS_UNAUTHORIZED, $previous);
+    }
 }