nextcloud / server

lib/public/Encryption/Exceptions/GenericEncryptionException.php

Indentation +13 added lines, -13 removed lines

@@ -35,18 +35,18 @@
  */
 class GenericEncryptionException extends HintException {
 
-	/**
-	 * @param string $message
-	 * @param string $hint
-	 * @param int $code
-	 * @param \Exception $previous
-	 * @since 8.1.0
-	 */
-	public function __construct($message = '', $hint = '', $code = 0, \Exception $previous = null) {
-		if (empty($message)) {
-			$message = 'Unspecified encryption exception';
-		}
-		parent::__construct($message, $hint, $code, $previous);
-	}
+    /**
+     * @param string $message
+     * @param string $hint
+     * @param int $code
+     * @param \Exception $previous
+     * @since 8.1.0
+     */
+    public function __construct($message = '', $hint = '', $code = 0, \Exception $previous = null) {
+        if (empty($message)) {
+            $message = 'Unspecified encryption exception';
+        }
+        parent::__construct($message, $hint, $code, $previous);
+    }
 
 }

lib/public/Encryption/IManager.php

Indentation +55 added lines, -55 removed lines

@@ -34,67 +34,67 @@
  */
 interface IManager {
 
-	/**
-	 * Check if encryption is available (at least one encryption module needs to be enabled)
-	 *
-	 * @return bool true if enabled, false if not
-	 * @since 8.1.0
-	 */
-	public function isEnabled();
+    /**
+     * Check if encryption is available (at least one encryption module needs to be enabled)
+     *
+     * @return bool true if enabled, false if not
+     * @since 8.1.0
+     */
+    public function isEnabled();
 
-	/**
-	 * Registers an callback function which must return an encryption module instance
-	 *
-	 * @param string $id
-	 * @param string $displayName
-	 * @param callable $callback
-	 * @throws ModuleAlreadyExistsException
-	 * @since 8.1.0
-	 */
-	public function registerEncryptionModule($id, $displayName, callable $callback);
+    /**
+     * Registers an callback function which must return an encryption module instance
+     *
+     * @param string $id
+     * @param string $displayName
+     * @param callable $callback
+     * @throws ModuleAlreadyExistsException
+     * @since 8.1.0
+     */
+    public function registerEncryptionModule($id, $displayName, callable $callback);
 
-	/**
-	 * Unregisters an encryption module
-	 *
-	 * @param string $moduleId
-	 * @since 8.1.0
-	 */
-	public function unregisterEncryptionModule($moduleId);
+    /**
+     * Unregisters an encryption module
+     *
+     * @param string $moduleId
+     * @since 8.1.0
+     */
+    public function unregisterEncryptionModule($moduleId);
 
-	/**
-	 * get a list of all encryption modules
-	 *
-	 * @return array [id => ['id' => $id, 'displayName' => $displayName, 'callback' => callback]]
-	 * @since 8.1.0
-	 */
-	public function getEncryptionModules();
+    /**
+     * get a list of all encryption modules
+     *
+     * @return array [id => ['id' => $id, 'displayName' => $displayName, 'callback' => callback]]
+     * @since 8.1.0
+     */
+    public function getEncryptionModules();
 
 
-	/**
-	 * get a specific encryption module
-	 *
-	 * @param string $moduleId Empty to get the default module
-	 * @return IEncryptionModule
-	 * @throws ModuleDoesNotExistsException
-	 * @since 8.1.0
-	 */
-	public function getEncryptionModule($moduleId = '');
+    /**
+     * get a specific encryption module
+     *
+     * @param string $moduleId Empty to get the default module
+     * @return IEncryptionModule
+     * @throws ModuleDoesNotExistsException
+     * @since 8.1.0
+     */
+    public function getEncryptionModule($moduleId = '');
 
-	/**
-	 * get default encryption module Id
-	 *
-	 * @return string
-	 * @since 8.1.0
-	 */
-	public function getDefaultEncryptionModuleId();
+    /**
+     * get default encryption module Id
+     *
+     * @return string
+     * @since 8.1.0
+     */
+    public function getDefaultEncryptionModuleId();
 
-	/**
-	 * set default encryption module Id
-	 *
-	 * @param string $moduleId
-	 * @return string
-	 * @since 8.1.0
-	 */
-	public function setDefaultEncryptionModule($moduleId);
+    /**
+     * set default encryption module Id
+     *
+     * @param string $moduleId
+     * @return string
+     * @since 8.1.0
+     */
+    public function setDefaultEncryptionModule($moduleId);
 
 }

lib/public/Encryption/Keys/IStorage.php

Indentation +135 added lines, -135 removed lines

@@ -33,151 +33,151 @@
  */
 interface IStorage {
 
-	/**
-	 * get user specific key
-	 *
-	 * @param string $uid ID if the user for whom we want the key
-	 * @param string $keyId id of the key
-	 * @param string $encryptionModuleId
-	 *
-	 * @return mixed key
-	 * @since 8.1.0
-	 */
-	public function getUserKey($uid, $keyId, $encryptionModuleId);
+    /**
+     * get user specific key
+     *
+     * @param string $uid ID if the user for whom we want the key
+     * @param string $keyId id of the key
+     * @param string $encryptionModuleId
+     *
+     * @return mixed key
+     * @since 8.1.0
+     */
+    public function getUserKey($uid, $keyId, $encryptionModuleId);
 
-	/**
-	 * get file specific key
-	 *
-	 * @param string $path path to file
-	 * @param string $keyId id of the key
-	 * @param string $encryptionModuleId
-	 *
-	 * @return mixed key
-	 * @since 8.1.0
-	 */
-	public function getFileKey($path, $keyId, $encryptionModuleId);
+    /**
+     * get file specific key
+     *
+     * @param string $path path to file
+     * @param string $keyId id of the key
+     * @param string $encryptionModuleId
+     *
+     * @return mixed key
+     * @since 8.1.0
+     */
+    public function getFileKey($path, $keyId, $encryptionModuleId);
 
-	/**
-	 * get system-wide encryption keys not related to a specific user,
-	 * e.g something like a key for public link shares
-	 *
-	 * @param string $keyId id of the key
-	 * @param string $encryptionModuleId
-	 *
-	 * @return mixed key
-	 * @since 8.1.0
-	 */
-	public function getSystemUserKey($keyId, $encryptionModuleId);
+    /**
+     * get system-wide encryption keys not related to a specific user,
+     * e.g something like a key for public link shares
+     *
+     * @param string $keyId id of the key
+     * @param string $encryptionModuleId
+     *
+     * @return mixed key
+     * @since 8.1.0
+     */
+    public function getSystemUserKey($keyId, $encryptionModuleId);
 
-	/**
-	 * set user specific key
-	 *
-	 * @param string $uid ID if the user for whom we want the key
-	 * @param string $keyId id of the key
-	 * @param mixed $key
-	 * @param string $encryptionModuleId
-	 * @since 8.1.0
-	 */
-	public function setUserKey($uid, $keyId, $key, $encryptionModuleId);
+    /**
+     * set user specific key
+     *
+     * @param string $uid ID if the user for whom we want the key
+     * @param string $keyId id of the key
+     * @param mixed $key
+     * @param string $encryptionModuleId
+     * @since 8.1.0
+     */
+    public function setUserKey($uid, $keyId, $key, $encryptionModuleId);
 
-	/**
-	 * set file specific key
-	 *
-	 * @param string $path path to file
-	 * @param string $keyId id of the key
-	 * @param mixed $key
-	 * @param string $encryptionModuleId
-	 * @since 8.1.0
-	 */
-	public function setFileKey($path, $keyId, $key, $encryptionModuleId);
+    /**
+     * set file specific key
+     *
+     * @param string $path path to file
+     * @param string $keyId id of the key
+     * @param mixed $key
+     * @param string $encryptionModuleId
+     * @since 8.1.0
+     */
+    public function setFileKey($path, $keyId, $key, $encryptionModuleId);
 
-	/**
-	 * set system-wide encryption keys not related to a specific user,
-	 * e.g something like a key for public link shares
-	 *
-	 * @param string $keyId id of the key
-	 * @param mixed $key
-	 * @param string $encryptionModuleId
-	 *
-	 * @return mixed key
-	 * @since 8.1.0
-	 */
-	public function setSystemUserKey($keyId, $key, $encryptionModuleId);
+    /**
+     * set system-wide encryption keys not related to a specific user,
+     * e.g something like a key for public link shares
+     *
+     * @param string $keyId id of the key
+     * @param mixed $key
+     * @param string $encryptionModuleId
+     *
+     * @return mixed key
+     * @since 8.1.0
+     */
+    public function setSystemUserKey($keyId, $key, $encryptionModuleId);
 
-	/**
-	 * delete user specific key
-	 *
-	 * @param string $uid ID if the user for whom we want to delete the key
-	 * @param string $keyId id of the key
-	 * @param string $encryptionModuleId
-	 *
-	 * @return boolean False when the key could not be deleted
-	 * @since 8.1.0
-	 */
-	public function deleteUserKey($uid, $keyId, $encryptionModuleId);
+    /**
+     * delete user specific key
+     *
+     * @param string $uid ID if the user for whom we want to delete the key
+     * @param string $keyId id of the key
+     * @param string $encryptionModuleId
+     *
+     * @return boolean False when the key could not be deleted
+     * @since 8.1.0
+     */
+    public function deleteUserKey($uid, $keyId, $encryptionModuleId);
 
-	/**
-	 * delete file specific key
-	 *
-	 * @param string $path path to file
-	 * @param string $keyId id of the key
-	 * @param string $encryptionModuleId
-	 *
-	 * @return boolean False when the key could not be deleted
-	 * @since 8.1.0
-	 */
-	public function deleteFileKey($path, $keyId, $encryptionModuleId);
+    /**
+     * delete file specific key
+     *
+     * @param string $path path to file
+     * @param string $keyId id of the key
+     * @param string $encryptionModuleId
+     *
+     * @return boolean False when the key could not be deleted
+     * @since 8.1.0
+     */
+    public function deleteFileKey($path, $keyId, $encryptionModuleId);
 
-	/**
-	 * delete all file keys for a given file
-	 *
-	 * @param string $path to the file
-	 *
-	 * @return boolean False when the keys could not be deleted
-	 * @since 8.1.0
-	 */
-	public function deleteAllFileKeys($path);
+    /**
+     * delete all file keys for a given file
+     *
+     * @param string $path to the file
+     *
+     * @return boolean False when the keys could not be deleted
+     * @since 8.1.0
+     */
+    public function deleteAllFileKeys($path);
 
-	/**
-	 * delete system-wide encryption keys not related to a specific user,
-	 * e.g something like a key for public link shares
-	 *
-	 * @param string $keyId id of the key
-	 * @param string $encryptionModuleId
-	 *
-	 * @return boolean False when the key could not be deleted
-	 * @since 8.1.0
-	 */
-	public function deleteSystemUserKey($keyId, $encryptionModuleId);
+    /**
+     * delete system-wide encryption keys not related to a specific user,
+     * e.g something like a key for public link shares
+     *
+     * @param string $keyId id of the key
+     * @param string $encryptionModuleId
+     *
+     * @return boolean False when the key could not be deleted
+     * @since 8.1.0
+     */
+    public function deleteSystemUserKey($keyId, $encryptionModuleId);
 
-	/**
-	 * copy keys if a file was renamed
-	 *
-	 * @param string $source
-	 * @param string $target
-	 * @return boolean
-	 * @since 8.1.0
-	 */
-	public function renameKeys($source, $target);
+    /**
+     * copy keys if a file was renamed
+     *
+     * @param string $source
+     * @param string $target
+     * @return boolean
+     * @since 8.1.0
+     */
+    public function renameKeys($source, $target);
 
-	/**
-	 * move keys if a file was renamed
-	 *
-	 * @param string $source
-	 * @param string $target
-	 * @return boolean
-	 * @since 8.1.0
-	 */
-	public function copyKeys($source, $target);
+    /**
+     * move keys if a file was renamed
+     *
+     * @param string $source
+     * @param string $target
+     * @return boolean
+     * @since 8.1.0
+     */
+    public function copyKeys($source, $target);
 
-	/**
-	 * backup keys of a given encryption module
-	 *
-	 * @param string $encryptionModuleId
-	 * @param string $purpose
-	 * @param string $uid
-	 * @return bool
-	 * @since 12.0.0
-	 */
-	public function backupUserKeys($encryptionModuleId, $purpose, $uid);
+    /**
+     * backup keys of a given encryption module
+     *
+     * @param string $encryptionModuleId
+     * @param string $purpose
+     * @param string $uid
+     * @return bool
+     * @since 12.0.0
+     */
+    public function backupUserKeys($encryptionModuleId, $purpose, $uid);
 }

lib/public/IGroupManager.php

Indentation +81 added lines, -81 removed lines

@@ -45,96 +45,96 @@
  * @since 8.0.0
  */
 interface IGroupManager {
-	/**
-	 * Checks whether a given backend is used
-	 *
-	 * @param string $backendClass Full classname including complete namespace
-	 * @return bool
-	 * @since 8.1.0
-	 */
-	public function isBackendUsed($backendClass);
+    /**
+     * Checks whether a given backend is used
+     *
+     * @param string $backendClass Full classname including complete namespace
+     * @return bool
+     * @since 8.1.0
+     */
+    public function isBackendUsed($backendClass);
 
-	/**
-	 * @param \OCP\GroupInterface $backend
-	 * @since 8.0.0
-	 */
-	public function addBackend($backend);
+    /**
+     * @param \OCP\GroupInterface $backend
+     * @since 8.0.0
+     */
+    public function addBackend($backend);
 
-	/**
-	 * @since 8.0.0
-	 */
-	public function clearBackends();
+    /**
+     * @since 8.0.0
+     */
+    public function clearBackends();
 
-	/**
-	 * @param string $gid
-	 * @return \OCP\IGroup
-	 * @since 8.0.0
-	 */
-	public function get($gid);
+    /**
+     * @param string $gid
+     * @return \OCP\IGroup
+     * @since 8.0.0
+     */
+    public function get($gid);
 
-	/**
-	 * @param string $gid
-	 * @return bool
-	 * @since 8.0.0
-	 */
-	public function groupExists($gid);
+    /**
+     * @param string $gid
+     * @return bool
+     * @since 8.0.0
+     */
+    public function groupExists($gid);
 
-	/**
-	 * @param string $gid
-	 * @return \OCP\IGroup
-	 * @since 8.0.0
-	 */
-	public function createGroup($gid);
+    /**
+     * @param string $gid
+     * @return \OCP\IGroup
+     * @since 8.0.0
+     */
+    public function createGroup($gid);
 
-	/**
-	 * @param string $search
-	 * @param int $limit
-	 * @param int $offset
-	 * @return \OCP\IGroup[]
-	 * @since 8.0.0
-	 */
-	public function search($search, $limit = null, $offset = null);
+    /**
+     * @param string $search
+     * @param int $limit
+     * @param int $offset
+     * @return \OCP\IGroup[]
+     * @since 8.0.0
+     */
+    public function search($search, $limit = null, $offset = null);
 
-	/**
-	 * @param \OCP\IUser|null $user
-	 * @return \OCP\IGroup[]
-	 * @since 8.0.0
-	 */
-	public function getUserGroups($user);
+    /**
+     * @param \OCP\IUser|null $user
+     * @return \OCP\IGroup[]
+     * @since 8.0.0
+     */
+    public function getUserGroups($user);
 
-	/**
-	 * @param \OCP\IUser $user
-	 * @return array with group names
-	 * @since 8.0.0
-	 */
-	public function getUserGroupIds($user);
+    /**
+     * @param \OCP\IUser $user
+     * @return array with group names
+     * @since 8.0.0
+     */
+    public function getUserGroupIds($user);
 
-	/**
-	 * get a list of all display names in a group
-	 *
-	 * @param string $gid
-	 * @param string $search
-	 * @param int $limit
-	 * @param int $offset
-	 * @return array an array of display names (value) and user ids (key)
-	 * @since 8.0.0
-	 */
-	public function displayNamesInGroup($gid, $search = '', $limit = -1, $offset = 0);
+    /**
+     * get a list of all display names in a group
+     *
+     * @param string $gid
+     * @param string $search
+     * @param int $limit
+     * @param int $offset
+     * @return array an array of display names (value) and user ids (key)
+     * @since 8.0.0
+     */
+    public function displayNamesInGroup($gid, $search = '', $limit = -1, $offset = 0);
 
-	/**
-	 * Checks if a userId is in the admin group
-	 * @param string $userId
-	 * @return bool if admin
-	 * @since 8.0.0
-	 */
-	public function isAdmin($userId);
+    /**
+     * Checks if a userId is in the admin group
+     * @param string $userId
+     * @return bool if admin
+     * @since 8.0.0
+     */
+    public function isAdmin($userId);
 
-	/**
-	 * Checks if a userId is in a group
-	 * @param string $userId
-	 * @param string $group
-	 * @return bool if in group
-	 * @since 8.0.0
-	 */
-	public function isInGroup($userId, $group);
+    /**
+     * Checks if a userId is in a group
+     * @param string $userId
+     * @param string $group
+     * @return bool if in group
+     * @since 8.0.0
+     */
+    public function isInGroup($userId, $group);
 }

lib/public/IAvatar.php

Indentation +38 added lines, -38 removed lines

@@ -35,46 +35,46 @@
  */
 interface IAvatar {
 
-	/**
-	 * get the users avatar
-	 * @param int $size size in px of the avatar, avatars are square, defaults to 64, -1 can be used to not scale the image
-	 * @return boolean|\OCP\IImage containing the avatar or false if there's no image
-	 * @since 6.0.0 - size of -1 was added in 9.0.0
-	 */
-	public function get($size = 64);
+    /**
+     * get the users avatar
+     * @param int $size size in px of the avatar, avatars are square, defaults to 64, -1 can be used to not scale the image
+     * @return boolean|\OCP\IImage containing the avatar or false if there's no image
+     * @since 6.0.0 - size of -1 was added in 9.0.0
+     */
+    public function get($size = 64);
 
-	/**
-	 * Check if an avatar exists for the user
-	 *
-	 * @return bool
-	 * @since 8.1.0
-	 */
-	public function exists();
+    /**
+     * Check if an avatar exists for the user
+     *
+     * @return bool
+     * @since 8.1.0
+     */
+    public function exists();
 
-	/**
-	 * sets the users avatar
-	 * @param \OCP\IImage|resource|string $data An image object, imagedata or path to set a new avatar
-	 * @throws \Exception if the provided file is not a jpg or png image
-	 * @throws \Exception if the provided image is not valid
-	 * @throws \OC\NotSquareException if the image is not square
-	 * @return void
-	 * @since 6.0.0
-	 */
-	public function set($data);
+    /**
+     * sets the users avatar
+     * @param \OCP\IImage|resource|string $data An image object, imagedata or path to set a new avatar
+     * @throws \Exception if the provided file is not a jpg or png image
+     * @throws \Exception if the provided image is not valid
+     * @throws \OC\NotSquareException if the image is not square
+     * @return void
+     * @since 6.0.0
+     */
+    public function set($data);
 
-	/**
-	 * remove the users avatar
-	 * @return void
-	 * @since 6.0.0
-	 */
-	public function remove();
+    /**
+     * remove the users avatar
+     * @return void
+     * @since 6.0.0
+     */
+    public function remove();
 
-	/**
-	 * Get the file of the avatar
-	 * @param int $size -1 can be used to not scale the image
-	 * @return File
-	 * @throws NotFoundException
-	 * @since 9.0.0
-	 */
-	public function getFile($size);
+    /**
+     * Get the file of the avatar
+     * @param int $size -1 can be used to not scale the image
+     * @return File
+     * @throws NotFoundException
+     * @since 9.0.0
+     */
+    public function getFile($size);
 }

lib/public/Contacts/IManager.php

Indentation +125 added lines, -125 removed lines

@@ -34,138 +34,138 @@
 // This means that they should be used by apps instead of the internal ownCloud classes
 namespace OCP\Contacts {
 
-	/**
-	 * This class provides access to the contacts app. Use this class exclusively if you want to access contacts.
-	 *
-	 * Contacts in general will be expressed as an array of key-value-pairs.
-	 * The keys will match the property names defined in https://tools.ietf.org/html/rfc2426#section-1
-	 *
-	 * Proposed workflow for working with contacts:
-	 *  - search for the contacts
-	 *  - manipulate the results array
-	 *  - createOrUpdate will save the given contacts overwriting the existing data
-	 *
-	 * For updating it is mandatory to keep the id.
-	 * Without an id a new contact will be created.
-	 *
-	 * @since 6.0.0
-	 */
-	interface IManager {
+    /**
+     * This class provides access to the contacts app. Use this class exclusively if you want to access contacts.
+     *
+     * Contacts in general will be expressed as an array of key-value-pairs.
+     * The keys will match the property names defined in https://tools.ietf.org/html/rfc2426#section-1
+     *
+     * Proposed workflow for working with contacts:
+     *  - search for the contacts
+     *  - manipulate the results array
+     *  - createOrUpdate will save the given contacts overwriting the existing data
+     *
+     * For updating it is mandatory to keep the id.
+     * Without an id a new contact will be created.
+     *
+     * @since 6.0.0
+     */
+    interface IManager {
 
-		/**
-		 * This function is used to search and find contacts within the users address books.
-		 * In case $pattern is empty all contacts will be returned.
-		 *
-		 * Example:
-		 *  Following function shows how to search for contacts for the name and the email address.
-		 *
-		 *		public static function getMatchingRecipient($term) {
-		 *			$cm = \OC::$server->getContactsManager();
-		 *			// The API is not active -> nothing to do
-		 *			if (!$cm->isEnabled()) {
-		 *				return array();
-		 *			}
-		 *
-		 *			$result = $cm->search($term, array('FN', 'EMAIL'));
-		 *			$receivers = array();
-		 *			foreach ($result as $r) {
-		 *				$id = $r['id'];
-		 *				$fn = $r['FN'];
-		 *				$email = $r['EMAIL'];
-		 *				if (!is_array($email)) {
-		 *					$email = array($email);
-		 *				}
-		 *
-		 *				// loop through all email addresses of this contact
-		 *				foreach ($email as $e) {
-		 *				$displayName = $fn . " <$e>";
-		 *				$receivers[] = array(
-		 *					'id'    => $id,
-		 *					'label' => $displayName,
-		 *					'value' => $displayName);
-		 *				}
-		 *			}
-		 *
-		 *			return $receivers;
-		 *		}
-		 *
-		 *
-		 * @param string $pattern which should match within the $searchProperties
-		 * @param array $searchProperties defines the properties within the query pattern should match
-		 * @param array $options - for future use. One should always have options!
-		 * @return array an array of contacts which are arrays of key-value-pairs
-		 * @since 6.0.0
-		 */
-		function search($pattern, $searchProperties = array(), $options = array());
+        /**
+         * This function is used to search and find contacts within the users address books.
+         * In case $pattern is empty all contacts will be returned.
+         *
+         * Example:
+         *  Following function shows how to search for contacts for the name and the email address.
+         *
+         *		public static function getMatchingRecipient($term) {
+         *			$cm = \OC::$server->getContactsManager();
+         *			// The API is not active -> nothing to do
+         *			if (!$cm->isEnabled()) {
+         *				return array();
+         *			}
+         *
+         *			$result = $cm->search($term, array('FN', 'EMAIL'));
+         *			$receivers = array();
+         *			foreach ($result as $r) {
+         *				$id = $r['id'];
+         *				$fn = $r['FN'];
+         *				$email = $r['EMAIL'];
+         *				if (!is_array($email)) {
+         *					$email = array($email);
+         *				}
+         *
+         *				// loop through all email addresses of this contact
+         *				foreach ($email as $e) {
+         *				$displayName = $fn . " <$e>";
+         *				$receivers[] = array(
+         *					'id'    => $id,
+         *					'label' => $displayName,
+         *					'value' => $displayName);
+         *				}
+         *			}
+         *
+         *			return $receivers;
+         *		}
+         *
+         *
+         * @param string $pattern which should match within the $searchProperties
+         * @param array $searchProperties defines the properties within the query pattern should match
+         * @param array $options - for future use. One should always have options!
+         * @return array an array of contacts which are arrays of key-value-pairs
+         * @since 6.0.0
+         */
+        function search($pattern, $searchProperties = array(), $options = array());
 
-		/**
-		 * This function can be used to delete the contact identified by the given id
-		 *
-		 * @param object $id the unique identifier to a contact
-		 * @param string $address_book_key identifier of the address book in which the contact shall be deleted
-		 * @return bool successful or not
-		 * @since 6.0.0
-		 */
-		function delete($id, $address_book_key);
+        /**
+         * This function can be used to delete the contact identified by the given id
+         *
+         * @param object $id the unique identifier to a contact
+         * @param string $address_book_key identifier of the address book in which the contact shall be deleted
+         * @return bool successful or not
+         * @since 6.0.0
+         */
+        function delete($id, $address_book_key);
 
-		/**
-		 * This function is used to create a new contact if 'id' is not given or not present.
-		 * Otherwise the contact will be updated by replacing the entire data set.
-		 *
-		 * @param array $properties this array if key-value-pairs defines a contact
-		 * @param string $address_book_key identifier of the address book in which the contact shall be created or updated
-		 * @return array an array representing the contact just created or updated
-		 * @since 6.0.0
-		 */
-		function createOrUpdate($properties, $address_book_key);
+        /**
+         * This function is used to create a new contact if 'id' is not given or not present.
+         * Otherwise the contact will be updated by replacing the entire data set.
+         *
+         * @param array $properties this array if key-value-pairs defines a contact
+         * @param string $address_book_key identifier of the address book in which the contact shall be created or updated
+         * @return array an array representing the contact just created or updated
+         * @since 6.0.0
+         */
+        function createOrUpdate($properties, $address_book_key);
 
-		/**
-		 * Check if contacts are available (e.g. contacts app enabled)
-		 *
-		 * @return bool true if enabled, false if not
-		 * @since 6.0.0
-		 */
-		function isEnabled();
+        /**
+         * Check if contacts are available (e.g. contacts app enabled)
+         *
+         * @return bool true if enabled, false if not
+         * @since 6.0.0
+         */
+        function isEnabled();
 
-		/**
-		 * Registers an address book
-		 *
-		 * @param \OCP\IAddressBook $address_book
-		 * @return void
-		 * @since 6.0.0
-		 */
-		function registerAddressBook(\OCP\IAddressBook $address_book);
+        /**
+         * Registers an address book
+         *
+         * @param \OCP\IAddressBook $address_book
+         * @return void
+         * @since 6.0.0
+         */
+        function registerAddressBook(\OCP\IAddressBook $address_book);
 
-		/**
-		 * Unregisters an address book
-		 *
-		 * @param \OCP\IAddressBook $address_book
-		 * @return void
-		 * @since 6.0.0
-		 */
-		function unregisterAddressBook(\OCP\IAddressBook $address_book);
+        /**
+         * Unregisters an address book
+         *
+         * @param \OCP\IAddressBook $address_book
+         * @return void
+         * @since 6.0.0
+         */
+        function unregisterAddressBook(\OCP\IAddressBook $address_book);
 
-		/**
-		 * In order to improve lazy loading a closure can be registered which will be called in case
-		 * address books are actually requested
-		 *
-		 * @param \Closure $callable
-		 * @return void
-		 * @since 6.0.0
-		 */
-		function register(\Closure $callable);
+        /**
+         * In order to improve lazy loading a closure can be registered which will be called in case
+         * address books are actually requested
+         *
+         * @param \Closure $callable
+         * @return void
+         * @since 6.0.0
+         */
+        function register(\Closure $callable);
 
-		/**
-		 * @return array
-		 * @since 6.0.0
-		 */
-		function getAddressBooks();
+        /**
+         * @return array
+         * @since 6.0.0
+         */
+        function getAddressBooks();
 
-		/**
-		 * removes all registered address book instances
-		 * @return void
-		 * @since 6.0.0
-		 */
-		function clear();
-	}
+        /**
+         * removes all registered address book instances
+         * @return void
+         * @since 6.0.0
+         */
+        function clear();
+    }
 }

lib/public/ISearch.php

Indentation +37 added lines, -37 removed lines

@@ -33,46 +33,46 @@
  */
 interface ISearch {
 
-	/**
-	 * Search all providers for $query
-	 * @param string $query
-	 * @param string[] $inApps optionally limit results to the given apps
-	 * @return array An array of OCP\Search\Result's
-	 * @deprecated 8.0.0 use searchPaged() with page and size
-	 * @since 7.0.0 - parameter $inApps was added in 8.0.0
-	 */
-	public function search($query, array $inApps = array());
+    /**
+     * Search all providers for $query
+     * @param string $query
+     * @param string[] $inApps optionally limit results to the given apps
+     * @return array An array of OCP\Search\Result's
+     * @deprecated 8.0.0 use searchPaged() with page and size
+     * @since 7.0.0 - parameter $inApps was added in 8.0.0
+     */
+    public function search($query, array $inApps = array());
 
-	/**
-	 * Search all providers for $query
-	 * @param string $query
-	 * @param string[] $inApps optionally limit results to the given apps
-	 * @param int $page pages start at page 1
-	 * @param int $size
-	 * @return array An array of OCP\Search\Result's
-	 * @since 8.0.0
-	 */
-	public function searchPaged($query, array $inApps = array(), $page = 1, $size = 30);
+    /**
+     * Search all providers for $query
+     * @param string $query
+     * @param string[] $inApps optionally limit results to the given apps
+     * @param int $page pages start at page 1
+     * @param int $size
+     * @return array An array of OCP\Search\Result's
+     * @since 8.0.0
+     */
+    public function searchPaged($query, array $inApps = array(), $page = 1, $size = 30);
 
-	/**
-	 * Register a new search provider to search with
-	 * @param string $class class name of a OCP\Search\Provider
-	 * @param array $options optional
-	 * @since 7.0.0
-	 */
-	public function registerProvider($class, array $options = array());
+    /**
+     * Register a new search provider to search with
+     * @param string $class class name of a OCP\Search\Provider
+     * @param array $options optional
+     * @since 7.0.0
+     */
+    public function registerProvider($class, array $options = array());
 
-	/**
-	 * Remove one existing search provider
-	 * @param string $provider class name of a OCP\Search\Provider
-	 * @since 7.0.0
-	 */
-	public function removeProvider($provider);
+    /**
+     * Remove one existing search provider
+     * @param string $provider class name of a OCP\Search\Provider
+     * @since 7.0.0
+     */
+    public function removeProvider($provider);
 
-	/**
-	 * Remove all registered search providers
-	 * @since 7.0.0
-	 */
-	public function clearProviders();
+    /**
+     * Remove all registered search providers
+     * @since 7.0.0
+     */
+    public function clearProviders();
 
 }

lib/public/IRequest.php

Indentation +186 added lines, -186 removed lines

@@ -63,217 +63,217 @@
  * @since 6.0.0
  */
 interface IRequest {
-	/**
-	 * @since 9.1.0
-	 */
-	const USER_AGENT_CLIENT_ANDROID = '/^Mozilla\/5\.0 \(Android\) ownCloud\-android.*$/';
+    /**
+     * @since 9.1.0
+     */
+    const USER_AGENT_CLIENT_ANDROID = '/^Mozilla\/5\.0 \(Android\) ownCloud\-android.*$/';
 
-	/**
-	 * @since 9.1.0
-	 */
-	const USER_AGENT_CLIENT_DESKTOP = '/^Mozilla\/5\.0 \([A-Za-z ]+\) (mirall|csyncoC)\/.*$/';
+    /**
+     * @since 9.1.0
+     */
+    const USER_AGENT_CLIENT_DESKTOP = '/^Mozilla\/5\.0 \([A-Za-z ]+\) (mirall|csyncoC)\/.*$/';
 
-	/**
-	 * @since 9.1.0
-	 */
-	const USER_AGENT_CLIENT_IOS = '/^Mozilla\/5\.0 \(iOS\) (ownCloud|Nextcloud)\-iOS.*$/';
+    /**
+     * @since 9.1.0
+     */
+    const USER_AGENT_CLIENT_IOS = '/^Mozilla\/5\.0 \(iOS\) (ownCloud|Nextcloud)\-iOS.*$/';
 
-	/**
-	 * @param string $name
-	 *
-	 * @return string
-	 * @since 6.0.0
-	 */
-	public function getHeader($name);
+    /**
+     * @param string $name
+     *
+     * @return string
+     * @since 6.0.0
+     */
+    public function getHeader($name);
 
-	/**
-	 * Lets you access post and get parameters by the index
-	 * In case of json requests the encoded json body is accessed
-	 *
-	 * @param string $key the key which you want to access in the URL Parameter
-	 *                     placeholder, $_POST or $_GET array.
-	 *                     The priority how they're returned is the following:
-	 *                     1. URL parameters
-	 *                     2. POST parameters
-	 *                     3. GET parameters
-	 * @param mixed $default If the key is not found, this value will be returned
-	 * @return mixed the content of the array
-	 * @since 6.0.0
-	 */
-	public function getParam($key, $default = null);
+    /**
+     * Lets you access post and get parameters by the index
+     * In case of json requests the encoded json body is accessed
+     *
+     * @param string $key the key which you want to access in the URL Parameter
+     *                     placeholder, $_POST or $_GET array.
+     *                     The priority how they're returned is the following:
+     *                     1. URL parameters
+     *                     2. POST parameters
+     *                     3. GET parameters
+     * @param mixed $default If the key is not found, this value will be returned
+     * @return mixed the content of the array
+     * @since 6.0.0
+     */
+    public function getParam($key, $default = null);
 
 
-	/**
-	 * Returns all params that were received, be it from the request
-	 *
-	 * (as GET or POST) or through the URL by the route
-	 *
-	 * @return array the array with all parameters
-	 * @since 6.0.0
-	 */
-	public function getParams();
+    /**
+     * Returns all params that were received, be it from the request
+     *
+     * (as GET or POST) or through the URL by the route
+     *
+     * @return array the array with all parameters
+     * @since 6.0.0
+     */
+    public function getParams();
 
-	/**
-	 * Returns the method of the request
-	 *
-	 * @return string the method of the request (POST, GET, etc)
-	 * @since 6.0.0
-	 */
-	public function getMethod();
+    /**
+     * Returns the method of the request
+     *
+     * @return string the method of the request (POST, GET, etc)
+     * @since 6.0.0
+     */
+    public function getMethod();
 
-	/**
-	 * Shortcut for accessing an uploaded file through the $_FILES array
-	 *
-	 * @param string $key the key that will be taken from the $_FILES array
-	 * @return array the file in the $_FILES element
-	 * @since 6.0.0
-	 */
-	public function getUploadedFile($key);
+    /**
+     * Shortcut for accessing an uploaded file through the $_FILES array
+     *
+     * @param string $key the key that will be taken from the $_FILES array
+     * @return array the file in the $_FILES element
+     * @since 6.0.0
+     */
+    public function getUploadedFile($key);
 
 
-	/**
-	 * Shortcut for getting env variables
-	 *
-	 * @param string $key the key that will be taken from the $_ENV array
-	 * @return array the value in the $_ENV element
-	 * @since 6.0.0
-	 */
-	public function getEnv($key);
+    /**
+     * Shortcut for getting env variables
+     *
+     * @param string $key the key that will be taken from the $_ENV array
+     * @return array the value in the $_ENV element
+     * @since 6.0.0
+     */
+    public function getEnv($key);
 
 
-	/**
-	 * Shortcut for getting cookie variables
-	 *
-	 * @param string $key the key that will be taken from the $_COOKIE array
-	 * @return string|null the value in the $_COOKIE element
-	 * @since 6.0.0
-	 */
-	public function getCookie($key);
+    /**
+     * Shortcut for getting cookie variables
+     *
+     * @param string $key the key that will be taken from the $_COOKIE array
+     * @return string|null the value in the $_COOKIE element
+     * @since 6.0.0
+     */
+    public function getCookie($key);
 
 
-	/**
-	 * Checks if the CSRF check was correct
-	 *
-	 * @return bool true if CSRF check passed
-	 * @since 6.0.0
-	 */
-	public function passesCSRFCheck();
+    /**
+     * Checks if the CSRF check was correct
+     *
+     * @return bool true if CSRF check passed
+     * @since 6.0.0
+     */
+    public function passesCSRFCheck();
 
-	/**
-	 * Checks if the strict cookie has been sent with the request if the request
-	 * is including any cookies.
-	 *
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function passesStrictCookieCheck();
+    /**
+     * Checks if the strict cookie has been sent with the request if the request
+     * is including any cookies.
+     *
+     * @return bool
+     * @since 9.0.0
+     */
+    public function passesStrictCookieCheck();
 
-	/**
-	 * Checks if the lax cookie has been sent with the request if the request
-	 * is including any cookies.
-	 *
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function passesLaxCookieCheck();
+    /**
+     * Checks if the lax cookie has been sent with the request if the request
+     * is including any cookies.
+     *
+     * @return bool
+     * @since 9.0.0
+     */
+    public function passesLaxCookieCheck();
 
-	/**
-	 * Returns an ID for the request, value is not guaranteed to be unique and is mostly meant for logging
-	 * If `mod_unique_id` is installed this value will be taken.
-	 *
-	 * @return string
-	 * @since 8.1.0
-	 */
-	public function getId();
+    /**
+     * Returns an ID for the request, value is not guaranteed to be unique and is mostly meant for logging
+     * If `mod_unique_id` is installed this value will be taken.
+     *
+     * @return string
+     * @since 8.1.0
+     */
+    public function getId();
 
-	/**
-	 * Returns the remote address, if the connection came from a trusted proxy
-	 * and `forwarded_for_headers` has been configured then the IP address
-	 * specified in this header will be returned instead.
-	 * Do always use this instead of $_SERVER['REMOTE_ADDR']
-	 *
-	 * @return string IP address
-	 * @since 8.1.0
-	 */
-	public function getRemoteAddress();
+    /**
+     * Returns the remote address, if the connection came from a trusted proxy
+     * and `forwarded_for_headers` has been configured then the IP address
+     * specified in this header will be returned instead.
+     * Do always use this instead of $_SERVER['REMOTE_ADDR']
+     *
+     * @return string IP address
+     * @since 8.1.0
+     */
+    public function getRemoteAddress();
 
-	/**
-	 * Returns the server protocol. It respects reverse proxy servers and load
-	 * balancers.
-	 *
-	 * @return string Server protocol (http or https)
-	 * @since 8.1.0
-	 */
-	public function getServerProtocol();
+    /**
+     * Returns the server protocol. It respects reverse proxy servers and load
+     * balancers.
+     *
+     * @return string Server protocol (http or https)
+     * @since 8.1.0
+     */
+    public function getServerProtocol();
 
-	/**
-	 * Returns the used HTTP protocol.
-	 *
-	 * @return string HTTP protocol. HTTP/2, HTTP/1.1 or HTTP/1.0.
-	 * @since 8.2.0
-	 */
-	public function getHttpProtocol();
+    /**
+     * Returns the used HTTP protocol.
+     *
+     * @return string HTTP protocol. HTTP/2, HTTP/1.1 or HTTP/1.0.
+     * @since 8.2.0
+     */
+    public function getHttpProtocol();
 
-	/**
-	 * Returns the request uri, even if the website uses one or more
-	 * reverse proxies
-	 *
-	 * @return string
-	 * @since 8.1.0
-	 */
-	public function getRequestUri();
+    /**
+     * Returns the request uri, even if the website uses one or more
+     * reverse proxies
+     *
+     * @return string
+     * @since 8.1.0
+     */
+    public function getRequestUri();
 
-	/**
-	 * Get raw PathInfo from request (not urldecoded)
-	 *
-	 * @throws \Exception
-	 * @return string Path info
-	 * @since 8.1.0
-	 */
-	public function getRawPathInfo();
+    /**
+     * Get raw PathInfo from request (not urldecoded)
+     *
+     * @throws \Exception
+     * @return string Path info
+     * @since 8.1.0
+     */
+    public function getRawPathInfo();
 
-	/**
-	 * Get PathInfo from request
-	 *
-	 * @throws \Exception
-	 * @return string|false Path info or false when not found
-	 * @since 8.1.0
-	 */
-	public function getPathInfo();
+    /**
+     * Get PathInfo from request
+     *
+     * @throws \Exception
+     * @return string|false Path info or false when not found
+     * @since 8.1.0
+     */
+    public function getPathInfo();
 
-	/**
-	 * Returns the script name, even if the website uses one or more
-	 * reverse proxies
-	 *
-	 * @return string the script name
-	 * @since 8.1.0
-	 */
-	public function getScriptName();
+    /**
+     * Returns the script name, even if the website uses one or more
+     * reverse proxies
+     *
+     * @return string the script name
+     * @since 8.1.0
+     */
+    public function getScriptName();
 
-	/**
-	 * Checks whether the user agent matches a given regex
-	 *
-	 * @param array $agent array of agent names
-	 * @return bool true if at least one of the given agent matches, false otherwise
-	 * @since 8.1.0
-	 */
-	public function isUserAgent(array $agent);
+    /**
+     * Checks whether the user agent matches a given regex
+     *
+     * @param array $agent array of agent names
+     * @return bool true if at least one of the given agent matches, false otherwise
+     * @since 8.1.0
+     */
+    public function isUserAgent(array $agent);
 
-	/**
-	 * Returns the unverified server host from the headers without checking
-	 * whether it is a trusted domain
-	 *
-	 * @return string Server host
-	 * @since 8.1.0
-	 */
-	public function getInsecureServerHost();
+    /**
+     * Returns the unverified server host from the headers without checking
+     * whether it is a trusted domain
+     *
+     * @return string Server host
+     * @since 8.1.0
+     */
+    public function getInsecureServerHost();
 
-	/**
-	 * Returns the server host from the headers, or the first configured
-	 * trusted domain if the host isn't in the trusted list
-	 *
-	 * @return string Server host
-	 * @since 8.1.0
-	 */
-	public function getServerHost();
+    /**
+     * Returns the server host from the headers, or the first configured
+     * trusted domain if the host isn't in the trusted list
+     *
+     * @return string Server host
+     * @since 8.1.0
+     */
+    public function getServerHost();
 }

lib/public/IURLGenerator.php

Indentation +47 added lines, -47 removed lines

@@ -38,57 +38,57 @@
  * @since 6.0.0
  */
 interface IURLGenerator {
-	/**
-	 * Returns the URL for a route
-	 * @param string $routeName the name of the route
-	 * @param array $arguments an array with arguments which will be filled into the url
-	 * @return string the url
-	 * @since 6.0.0
-	 */
-	public function linkToRoute($routeName, $arguments = array());
+    /**
+     * Returns the URL for a route
+     * @param string $routeName the name of the route
+     * @param array $arguments an array with arguments which will be filled into the url
+     * @return string the url
+     * @since 6.0.0
+     */
+    public function linkToRoute($routeName, $arguments = array());
 
-	/**
-	 * Returns the absolute URL for a route
-	 * @param string $routeName the name of the route
-	 * @param array $arguments an array with arguments which will be filled into the url
-	 * @return string the absolute url
-	 * @since 8.0.0
-	 */
-	public function linkToRouteAbsolute($routeName, $arguments = array());
+    /**
+     * Returns the absolute URL for a route
+     * @param string $routeName the name of the route
+     * @param array $arguments an array with arguments which will be filled into the url
+     * @return string the absolute url
+     * @since 8.0.0
+     */
+    public function linkToRouteAbsolute($routeName, $arguments = array());
 
-	/**
-	 * Returns an URL for an image or file
-	 * @param string $appName the name of the app
-	 * @param string $file the name of the file
-	 * @param array $args array with param=>value, will be appended to the returned url
-	 *    The value of $args will be urlencoded
-	 * @return string the url
-	 * @since 6.0.0
-	 */
-	public function linkTo($appName, $file, $args = array());
+    /**
+     * Returns an URL for an image or file
+     * @param string $appName the name of the app
+     * @param string $file the name of the file
+     * @param array $args array with param=>value, will be appended to the returned url
+     *    The value of $args will be urlencoded
+     * @return string the url
+     * @since 6.0.0
+     */
+    public function linkTo($appName, $file, $args = array());
 
-	/**
-	 * Returns the link to an image, like linkTo but only with prepending img/
-	 * @param string $appName the name of the app
-	 * @param string $file the name of the file
-	 * @return string the url
-	 * @since 6.0.0
-	 */
-	public function imagePath($appName, $file);
+    /**
+     * Returns the link to an image, like linkTo but only with prepending img/
+     * @param string $appName the name of the app
+     * @param string $file the name of the file
+     * @return string the url
+     * @since 6.0.0
+     */
+    public function imagePath($appName, $file);
 
 
-	/**
-	 * Makes an URL absolute
-	 * @param string $url the url in the ownCloud host
-	 * @return string the absolute version of the url
-	 * @since 6.0.0
-	 */
-	public function getAbsoluteURL($url);
+    /**
+     * Makes an URL absolute
+     * @param string $url the url in the ownCloud host
+     * @return string the absolute version of the url
+     * @since 6.0.0
+     */
+    public function getAbsoluteURL($url);
 
-	/**
-	 * @param string $key
-	 * @return string url to the online documentation
-	 * @since 8.0.0
-	 */
-	public function linkToDocs($key);
+    /**
+     * @param string $key
+     * @return string url to the online documentation
+     * @since 8.0.0
+     */
+    public function linkToDocs($key);
 }