nextcloud / server

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

lib/public/Files/StorageBadConfigException.php

Doc Comments -1 removed lines

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

Indentation +12 added lines, -12 removed lines

@@ -27,17 +27,17 @@
  */
 class StorageBadConfigException extends StorageNotAvailableException {
 
-	/**
-	 * ExtStorageBadConfigException 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 incomplete configuration. %s', $message), self::STATUS_INCOMPLETE_CONF, $previous);
-	}
+    /**
+     * ExtStorageBadConfigException 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 incomplete configuration. %s', $message), self::STATUS_INCOMPLETE_CONF, $previous);
+    }
 
 }

lib/public/Files/StorageConnectionException.php

Doc Comments -1 removed lines

@@ -30,7 +30,6 @@
 	 * StorageConnectionException 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 StorageConnectionException extends StorageNotAvailableException {
 
-	/**
-	 * StorageConnectionException 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 connection error. %s', $message), self::STATUS_NETWORK_ERROR, $previous);
-	}
+    /**
+     * StorageConnectionException 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 connection error. %s', $message), self::STATUS_NETWORK_ERROR, $previous);
+    }
 }

lib/public/Files/StorageTimeoutException.php

Doc Comments -1 removed lines

@@ -30,7 +30,6 @@
 	 * StorageTimeoutException 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 StorageTimeoutException extends StorageNotAvailableException {
 
-	/**
-	 * StorageTimeoutException 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 connection timeout. %s', $message), self::STATUS_TIMEOUT, $previous);
-	}
+    /**
+     * StorageTimeoutException 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 connection timeout. %s', $message), self::STATUS_TIMEOUT, $previous);
+    }
 }

lib/public/Migration/IOutput.php

Doc Comments +5 added lines, -1 removed lines

@@ -32,18 +32,21 @@ 
 	/**
 	 * @param string $message
 	 * @since 9.1.0
+	 * @return void
 	 */
 	public function info($message);
 
 	/**
 	 * @param string $message
 	 * @since 9.1.0
+	 * @return void
 	 */
 	public function warning($message);
 
 	/**
 	 * @param int $max
 	 * @since 9.1.0
+	 * @return void
 	 */
 	public function startProgress($max = 0);
 
@@ -51,12 +54,13 @@ 
 	 * @param int $step
 	 * @param string $description
 	 * @since 9.1.0
+	 * @return void
 	 */
 	public function advance($step = 1, $description = '');
 
 	/**
-	 * @param int $max
 	 * @since 9.1.0
+	 * @return void
 	 */
 	public function finishProgress();
 

Indentation +26 added lines, -26 removed lines

@@ -30,35 +30,35 @@
  */
 interface IOutput {
 
-	/**
-	 * @param string $message
-	 * @since 9.1.0
-	 */
-	public function info($message);
+    /**
+     * @param string $message
+     * @since 9.1.0
+     */
+    public function info($message);
 
-	/**
-	 * @param string $message
-	 * @since 9.1.0
-	 */
-	public function warning($message);
+    /**
+     * @param string $message
+     * @since 9.1.0
+     */
+    public function warning($message);
 
-	/**
-	 * @param int $max
-	 * @since 9.1.0
-	 */
-	public function startProgress($max = 0);
+    /**
+     * @param int $max
+     * @since 9.1.0
+     */
+    public function startProgress($max = 0);
 
-	/**
-	 * @param int $step
-	 * @param string $description
-	 * @since 9.1.0
-	 */
-	public function advance($step = 1, $description = '');
+    /**
+     * @param int $step
+     * @param string $description
+     * @since 9.1.0
+     */
+    public function advance($step = 1, $description = '');
 
-	/**
-	 * @param int $max
-	 * @since 9.1.0
-	 */
-	public function finishProgress();
+    /**
+     * @param int $max
+     * @since 9.1.0
+     */
+    public function finishProgress();
 
 }

lib/public/SystemTag/ISystemTagManager.php

Doc Comments +7 added lines, -4 removed lines

@@ -102,17 +102,19 @@ 
 	 * with the same attributes
 	 *
 	 * @since 9.0.0
+	 * @return void
 	 */
 	public function updateTag($tagId, $newName, $userVisible, $userAssignable);
 
 	/**
 	 * Delete the given tags from the database and all their relationships.
 	 *
-	 * @param string|array $tagIds array of tag ids
+	 * @param string $tagIds array of tag ids
 	 *
 	 * @throws \OCP\SystemTag\TagNotFoundException if at least one tag did not exist
 	 *
 	 * @since 9.0.0
+	 * @return void
 	 */
 	public function deleteTags($tagIds);
 
@@ -123,7 +125,7 @@ 
 	 * @param ISystemTag $tag tag to check permission for
 	 * @param IUser $user user to check permission for
 	 *
-	 * @return true if the user is allowed to assign/unassign the tag, false otherwise
+	 * @return boolean if the user is allowed to assign/unassign the tag, false otherwise
 	 *
 	 * @since 9.1.0
 	 */
@@ -133,9 +135,9 @@ 
 	 * Checks whether the given user is allowed to see the tag with the given id.
 	 *
 	 * @param ISystemTag $tag tag to check permission for
-	 * @param IUser $user user to check permission for
+	 * @param IUser $userId user to check permission for
 	 *
-	 * @return true if the user can see the tag, false otherwise
+	 * @return boolean if the user can see the tag, false otherwise
 	 *
 	 * @since 9.1.0
 	 */
@@ -148,6 +150,7 @@ 
 	 * @param string[] $groupIds group ids of groups that can assign/unassign the tag
 	 *
 	 * @since 9.1.0
+	 * @return void
 	 */
 	public function setTagGroups(ISystemTag $tag, $groupIds);
 

Indentation +120 added lines, -120 removed lines

@@ -33,133 +33,133 @@
  */
 interface ISystemTagManager {
 
-	/**
-	 * Returns the tag objects matching the given tag ids.
-	 *
-	 * @param array|string $tagIds id or array of unique ids of the tag to retrieve
-	 *
-	 * @return \OCP\SystemTag\ISystemTag[] array of system tags with tag id as key
-	 *
-	 * @throws \InvalidArgumentException if at least one given tag ids is invalid (string instead of integer, etc.)
-	 * @throws \OCP\SystemTag\TagNotFoundException if at least one given tag ids did no exist
-	 * 			The message contains a json_encoded array of the ids that could not be found
-	 *
-	 * @since 9.0.0
-	 */
-	public function getTagsByIds($tagIds);
+    /**
+     * Returns the tag objects matching the given tag ids.
+     *
+     * @param array|string $tagIds id or array of unique ids of the tag to retrieve
+     *
+     * @return \OCP\SystemTag\ISystemTag[] array of system tags with tag id as key
+     *
+     * @throws \InvalidArgumentException if at least one given tag ids is invalid (string instead of integer, etc.)
+     * @throws \OCP\SystemTag\TagNotFoundException if at least one given tag ids did no exist
+     * 			The message contains a json_encoded array of the ids that could not be found
+     *
+     * @since 9.0.0
+     */
+    public function getTagsByIds($tagIds);
 
-	/**
-	 * Returns the tag object matching the given attributes.
-	 *
-	 * @param string $tagName tag name
-	 * @param bool $userVisible whether the tag is visible by users
-	 * @param bool $userAssignable whether the tag is assignable by users
-	 *
-	 * @return \OCP\SystemTag\ISystemTag system tag
-	 *
-	 * @throws \OCP\SystemTag\TagNotFoundException if tag does not exist
-	 *
-	 * @since 9.0.0
-	 */
-	public function getTag($tagName, $userVisible, $userAssignable);
+    /**
+     * Returns the tag object matching the given attributes.
+     *
+     * @param string $tagName tag name
+     * @param bool $userVisible whether the tag is visible by users
+     * @param bool $userAssignable whether the tag is assignable by users
+     *
+     * @return \OCP\SystemTag\ISystemTag system tag
+     *
+     * @throws \OCP\SystemTag\TagNotFoundException if tag does not exist
+     *
+     * @since 9.0.0
+     */
+    public function getTag($tagName, $userVisible, $userAssignable);
 
-	/**
-	 * Creates the tag object using the given attributes.
-	 *
-	 * @param string $tagName tag name
-	 * @param bool $userVisible whether the tag is visible by users
-	 * @param bool $userAssignable whether the tag is assignable by users
-	 *
-	 * @return \OCP\SystemTag\ISystemTag system tag
-	 *
-	 * @throws \OCP\SystemTag\TagAlreadyExistsException if tag already exists
-	 *
-	 * @since 9.0.0
-	 */
-	public function createTag($tagName, $userVisible, $userAssignable);
+    /**
+     * Creates the tag object using the given attributes.
+     *
+     * @param string $tagName tag name
+     * @param bool $userVisible whether the tag is visible by users
+     * @param bool $userAssignable whether the tag is assignable by users
+     *
+     * @return \OCP\SystemTag\ISystemTag system tag
+     *
+     * @throws \OCP\SystemTag\TagAlreadyExistsException if tag already exists
+     *
+     * @since 9.0.0
+     */
+    public function createTag($tagName, $userVisible, $userAssignable);
 
-	/**
-	 * Returns all known tags, optionally filtered by visibility.
-	 *
-	 * @param bool|null $visibilityFilter filter by visibility if non-null
-	 * @param string $nameSearchPattern optional search pattern for the tag name
-	 *
-	 * @return \OCP\SystemTag\ISystemTag[] array of system tags or empty array if none found
-	 *
-	 * @since 9.0.0
-	 */
-	public function getAllTags($visibilityFilter = null, $nameSearchPattern = null);
+    /**
+     * Returns all known tags, optionally filtered by visibility.
+     *
+     * @param bool|null $visibilityFilter filter by visibility if non-null
+     * @param string $nameSearchPattern optional search pattern for the tag name
+     *
+     * @return \OCP\SystemTag\ISystemTag[] array of system tags or empty array if none found
+     *
+     * @since 9.0.0
+     */
+    public function getAllTags($visibilityFilter = null, $nameSearchPattern = null);
 
-	/**
-	 * Updates the given tag
-	 *
-	 * @param string $tagId tag id
-	 * @param string $newName the new tag name
-	 * @param bool $userVisible whether the tag is visible by users
-	 * @param bool $userAssignable whether the tag is assignable by users
-	 *
-	 * @throws \OCP\SystemTag\TagNotFoundException if tag with the given id does not exist
-	 * @throws \OCP\SystemTag\TagAlreadyExistsException if there is already another tag
-	 * with the same attributes
-	 *
-	 * @since 9.0.0
-	 */
-	public function updateTag($tagId, $newName, $userVisible, $userAssignable);
+    /**
+     * Updates the given tag
+     *
+     * @param string $tagId tag id
+     * @param string $newName the new tag name
+     * @param bool $userVisible whether the tag is visible by users
+     * @param bool $userAssignable whether the tag is assignable by users
+     *
+     * @throws \OCP\SystemTag\TagNotFoundException if tag with the given id does not exist
+     * @throws \OCP\SystemTag\TagAlreadyExistsException if there is already another tag
+     * with the same attributes
+     *
+     * @since 9.0.0
+     */
+    public function updateTag($tagId, $newName, $userVisible, $userAssignable);
 
-	/**
-	 * Delete the given tags from the database and all their relationships.
-	 *
-	 * @param string|array $tagIds array of tag ids
-	 *
-	 * @throws \OCP\SystemTag\TagNotFoundException if at least one tag did not exist
-	 *
-	 * @since 9.0.0
-	 */
-	public function deleteTags($tagIds);
+    /**
+     * Delete the given tags from the database and all their relationships.
+     *
+     * @param string|array $tagIds array of tag ids
+     *
+     * @throws \OCP\SystemTag\TagNotFoundException if at least one tag did not exist
+     *
+     * @since 9.0.0
+     */
+    public function deleteTags($tagIds);
 
-	/**
-	 * Checks whether the given user is allowed to assign/unassign the tag with the
-	 * given id.
-	 *
-	 * @param ISystemTag $tag tag to check permission for
-	 * @param IUser $user user to check permission for
-	 *
-	 * @return true if the user is allowed to assign/unassign the tag, false otherwise
-	 *
-	 * @since 9.1.0
-	 */
-	public function canUserAssignTag(ISystemTag $tag, IUser $user);
+    /**
+     * Checks whether the given user is allowed to assign/unassign the tag with the
+     * given id.
+     *
+     * @param ISystemTag $tag tag to check permission for
+     * @param IUser $user user to check permission for
+     *
+     * @return true if the user is allowed to assign/unassign the tag, false otherwise
+     *
+     * @since 9.1.0
+     */
+    public function canUserAssignTag(ISystemTag $tag, IUser $user);
 
-	/**
-	 * Checks whether the given user is allowed to see the tag with the given id.
-	 *
-	 * @param ISystemTag $tag tag to check permission for
-	 * @param IUser $user user to check permission for
-	 *
-	 * @return true if the user can see the tag, false otherwise
-	 *
-	 * @since 9.1.0
-	 */
-	public function canUserSeeTag(ISystemTag $tag, IUser $userId);
+    /**
+     * Checks whether the given user is allowed to see the tag with the given id.
+     *
+     * @param ISystemTag $tag tag to check permission for
+     * @param IUser $user user to check permission for
+     *
+     * @return true if the user can see the tag, false otherwise
+     *
+     * @since 9.1.0
+     */
+    public function canUserSeeTag(ISystemTag $tag, IUser $userId);
 
-	/**
-	 * Set groups that can assign a given tag.
-	 *
-	 * @param ISystemTag $tag tag for group assignment
-	 * @param string[] $groupIds group ids of groups that can assign/unassign the tag
-	 *
-	 * @since 9.1.0
-	 */
-	public function setTagGroups(ISystemTag $tag, $groupIds);
+    /**
+     * Set groups that can assign a given tag.
+     *
+     * @param ISystemTag $tag tag for group assignment
+     * @param string[] $groupIds group ids of groups that can assign/unassign the tag
+     *
+     * @since 9.1.0
+     */
+    public function setTagGroups(ISystemTag $tag, $groupIds);
 
-	/**
-	 * Get groups that can assign a given tag.
-	 *
-	 * @param ISystemTag $tag tag for group assignment
-	 *
-	 * @return string[] group ids of groups that can assign/unassign the tag
-	 *
-	 * @since 9.1.0
-	 */
-	public function getTagGroups(ISystemTag $tag);
+    /**
+     * Get groups that can assign a given tag.
+     *
+     * @param ISystemTag $tag tag for group assignment
+     *
+     * @return string[] group ids of groups that can assign/unassign the tag
+     *
+     * @since 9.1.0
+     */
+    public function getTagGroups(ISystemTag $tag);
 }