nextcloud / server

lib/public/Share_Backend.php

Indentation +57 added lines, -57 removed lines

@@ -33,65 +33,65 @@
  */
 interface Share_Backend {
 
-	/**
-	 * Check if this $itemSource exist for the user
-	 * @param string $itemSource
-	 * @param string $uidOwner Owner of the item
-	 * @return boolean|null Source
-	 *
-	 * Return false if the item does not exist for the user
-	 * @since 5.0.0
-	 */
-	public function isValidSource($itemSource, $uidOwner);
+    /**
+     * Check if this $itemSource exist for the user
+     * @param string $itemSource
+     * @param string $uidOwner Owner of the item
+     * @return boolean|null Source
+     *
+     * Return false if the item does not exist for the user
+     * @since 5.0.0
+     */
+    public function isValidSource($itemSource, $uidOwner);
 
-	/**
-	 * Get a unique name of the item for the specified user
-	 * @param string $itemSource
-	 * @param string|false $shareWith User the item is being shared with
-	 * @param array|null $exclude List of similar item names already existing as shared items @deprecated since version OC7
-	 * @return string Target name
-	 *
-	 * This function needs to verify that the user does not already have an item with this name.
-	 * If it does generate a new name e.g. name_#
-	 * @since 5.0.0
-	 */
-	public function generateTarget($itemSource, $shareWith, $exclude = null);
+    /**
+     * Get a unique name of the item for the specified user
+     * @param string $itemSource
+     * @param string|false $shareWith User the item is being shared with
+     * @param array|null $exclude List of similar item names already existing as shared items @deprecated since version OC7
+     * @return string Target name
+     *
+     * This function needs to verify that the user does not already have an item with this name.
+     * If it does generate a new name e.g. name_#
+     * @since 5.0.0
+     */
+    public function generateTarget($itemSource, $shareWith, $exclude = null);
 
-	/**
-	 * Converts the shared item sources back into the item in the specified format
-	 * @param array $items Shared items
-	 * @param int $format
-	 * @return array
-	 *
-	 * The items array is a 3-dimensional array with the item_source as the
-	 * first key and the share id as the second key to an array with the share
-	 * info.
-	 *
-	 * The key/value pairs included in the share info depend on the function originally called:
-	 * If called by getItem(s)Shared: id, item_type, item, item_source,
-	 * share_type, share_with, permissions, stime, file_source
-	 *
-	 * If called by getItem(s)SharedWith: id, item_type, item, item_source,
-	 * item_target, share_type, share_with, permissions, stime, file_source,
-	 * file_target
-	 *
-	 * This function allows the backend to control the output of shared items with custom formats.
-	 * It is only called through calls to the public getItem(s)Shared(With) functions.
-	 * @since 5.0.0
-	 */
-	public function formatItems($items, $format, $parameters = null);
+    /**
+     * Converts the shared item sources back into the item in the specified format
+     * @param array $items Shared items
+     * @param int $format
+     * @return array
+     *
+     * The items array is a 3-dimensional array with the item_source as the
+     * first key and the share id as the second key to an array with the share
+     * info.
+     *
+     * The key/value pairs included in the share info depend on the function originally called:
+     * If called by getItem(s)Shared: id, item_type, item, item_source,
+     * share_type, share_with, permissions, stime, file_source
+     *
+     * If called by getItem(s)SharedWith: id, item_type, item, item_source,
+     * item_target, share_type, share_with, permissions, stime, file_source,
+     * file_target
+     *
+     * This function allows the backend to control the output of shared items with custom formats.
+     * It is only called through calls to the public getItem(s)Shared(With) functions.
+     * @since 5.0.0
+     */
+    public function formatItems($items, $format, $parameters = null);
 
-	/**
-	 * Check if a given share type is allowd by the back-end
-	 *
-	 * @param int $shareType share type
-	 * @return boolean
-	 *
-	 * The back-end can enable/disable specific share types. Just return true if
-	 * the back-end doesn't provide any specific settings for it and want to allow
-	 * all share types defined by the share API
-	 * @since 8.0.0
-	 */
-	public function isShareTypeAllowed($shareType);
+    /**
+     * Check if a given share type is allowd by the back-end
+     *
+     * @param int $shareType share type
+     * @return boolean
+     *
+     * The back-end can enable/disable specific share types. Just return true if
+     * the back-end doesn't provide any specific settings for it and want to allow
+     * all share types defined by the share API
+     * @since 8.0.0
+     */
+    public function isShareTypeAllowed($shareType);
 
 }

lib/public/Constants.php

Indentation +15 added lines, -15 removed lines

@@ -58,20 +58,20 @@
  * @since 8.0.0
  */
 class Constants {
-	/**
-	 * CRUDS permissions.
-	 * @since 8.0.0
-	 */
-	const PERMISSION_CREATE = 4;
-	const PERMISSION_READ = 1;
-	const PERMISSION_UPDATE = 2;
-	const PERMISSION_DELETE = 8;
-	const PERMISSION_SHARE = 16;
-	const PERMISSION_ALL = 31;
+    /**
+     * CRUDS permissions.
+     * @since 8.0.0
+     */
+    const PERMISSION_CREATE = 4;
+    const PERMISSION_READ = 1;
+    const PERMISSION_UPDATE = 2;
+    const PERMISSION_DELETE = 8;
+    const PERMISSION_SHARE = 16;
+    const PERMISSION_ALL = 31;
 
-	/**
-	 * @since 8.0.0 - Updated in 9.0.0 to allow all POSIX chars since we no
-	 * longer support windows as server platform.
-	 */
-	const FILENAME_INVALID_CHARS = "\\/";
+    /**
+     * @since 8.0.0 - Updated in 9.0.0 to allow all POSIX chars since we no
+     * longer support windows as server platform.
+     */
+    const FILENAME_INVALID_CHARS = "\\/";
 }

lib/public/Files/IMimeTypeDetector.php

Indentation +38 added lines, -38 removed lines

@@ -34,46 +34,46 @@
  **/
 interface IMimeTypeDetector {
 
-	/**
-	 * detect mimetype only based on filename, content of file is not used
-	 * @param string $path
-	 * @return string
-	 * @since 8.2.0
-	 **/
-	public function detectPath($path);
+    /**
+     * detect mimetype only based on filename, content of file is not used
+     * @param string $path
+     * @return string
+     * @since 8.2.0
+     **/
+    public function detectPath($path);
 
-	/**
-	 * detect mimetype based on both filename and content
-	 *
-	 * @param string $path
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function detect($path);
+    /**
+     * detect mimetype based on both filename and content
+     *
+     * @param string $path
+     * @return string
+     * @since 8.2.0
+     */
+    public function detect($path);
 
-	/**
-	 * Get a secure mimetype that won't expose potential XSS.
-	 *
-	 * @param string $mimeType
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getSecureMimeType($mimeType);
+    /**
+     * Get a secure mimetype that won't expose potential XSS.
+     *
+     * @param string $mimeType
+     * @return string
+     * @since 8.2.0
+     */
+    public function getSecureMimeType($mimeType);
 
-	/**
-	 * detect mimetype based on the content of a string
-	 *
-	 * @param string $data
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function detectString($data);
+    /**
+     * detect mimetype based on the content of a string
+     *
+     * @param string $data
+     * @return string
+     * @since 8.2.0
+     */
+    public function detectString($data);
 
-	/**
-	 * Get path to the icon of a file type
-	 * @param string $mimeType the MIME type
-	 * @return string the url
-	 * @since 8.2.0
-	 */
-	public function mimeTypeIcon($mimeType);
+    /**
+     * Get path to the icon of a file type
+     * @param string $mimeType the MIME type
+     * @return string the url
+     * @since 8.2.0
+     */
+    public function mimeTypeIcon($mimeType);
 }

lib/public/Files/Config/ICachedMountInfo.php

Indentation +39 added lines, -39 removed lines

@@ -31,49 +31,49 @@
  * @since 9.0.0
  */
 interface ICachedMountInfo {
-	/**
-	 * @return IUser
-	 * @since 9.0.0
-	 */
-	public function getUser();
+    /**
+     * @return IUser
+     * @since 9.0.0
+     */
+    public function getUser();
 
-	/**
-	 * @return int the numeric storage id of the mount
-	 * @since 9.0.0
-	 */
-	public function getStorageId();
+    /**
+     * @return int the numeric storage id of the mount
+     * @since 9.0.0
+     */
+    public function getStorageId();
 
-	/**
-	 * @return int the fileid of the root of the mount
-	 * @since 9.0.0
-	 */
-	public function getRootId();
+    /**
+     * @return int the fileid of the root of the mount
+     * @since 9.0.0
+     */
+    public function getRootId();
 
-	/**
-	 * @return Node the root node of the mount
-	 * @since 9.0.0
-	 */
-	public function getMountPointNode();
+    /**
+     * @return Node the root node of the mount
+     * @since 9.0.0
+     */
+    public function getMountPointNode();
 
-	/**
-	 * @return string the mount point of the mount for the user
-	 * @since 9.0.0
-	 */
-	public function getMountPoint();
+    /**
+     * @return string the mount point of the mount for the user
+     * @since 9.0.0
+     */
+    public function getMountPoint();
 
-	/**
-	 * Get the id of the configured mount
-	 *
-	 * @return int|null mount id or null if not applicable
-	 * @since 9.1.0
-	 */
-	public function getMountId();
+    /**
+     * Get the id of the configured mount
+     *
+     * @return int|null mount id or null if not applicable
+     * @since 9.1.0
+     */
+    public function getMountId();
 
-	/**
-	 * Get the internal path (within the storage) of the root of the mount
-	 *
-	 * @return string
-	 * @since 11.0.0
-	 */
-	public function getRootInternalPath();
+    /**
+     * Get the internal path (within the storage) of the root of the mount
+     *
+     * @return string
+     * @since 11.0.0
+     */
+    public function getRootInternalPath();
 }

lib/public/Files/Config/IMountProvider.php

Indentation +9 added lines, -9 removed lines

@@ -31,13 +31,13 @@
  * @since 8.0.0
  */
 interface IMountProvider {
-	/**
-	 * Get all mountpoints applicable for the user
-	 *
-	 * @param \OCP\IUser $user
-	 * @param \OCP\Files\Storage\IStorageFactory $loader
-	 * @return \OCP\Files\Mount\IMountPoint[]
-	 * @since 8.0.0
-	 */
-	public function getMountsForUser(IUser $user, IStorageFactory $loader);
+    /**
+     * Get all mountpoints applicable for the user
+     *
+     * @param \OCP\IUser $user
+     * @param \OCP\Files\Storage\IStorageFactory $loader
+     * @return \OCP\Files\Mount\IMountPoint[]
+     * @since 8.0.0
+     */
+    public function getMountsForUser(IUser $user, IStorageFactory $loader);
 }

lib/public/Files/Config/IHomeMountProvider.php

Indentation +9 added lines, -9 removed lines

@@ -31,13 +31,13 @@
  * @since 9.1.0
  */
 interface IHomeMountProvider {
-	/**
-	 * Get all mountpoints applicable for the user
-	 *
-	 * @param \OCP\IUser $user
-	 * @param \OCP\Files\Storage\IStorageFactory $loader
-	 * @return \OCP\Files\Mount\IMountPoint|null
-	 * @since 9.1.0
-	 */
-	public function getHomeMountForUser(IUser $user, IStorageFactory $loader);
+    /**
+     * Get all mountpoints applicable for the user
+     *
+     * @param \OCP\IUser $user
+     * @param \OCP\Files\Storage\IStorageFactory $loader
+     * @return \OCP\Files\Mount\IMountPoint|null
+     * @since 9.1.0
+     */
+    public function getHomeMountForUser(IUser $user, IStorageFactory $loader);
 }

lib/public/Files/IMimeTypeLoader.php

Indentation +30 added lines, -30 removed lines

@@ -31,37 +31,37 @@
  **/
 interface IMimeTypeLoader {
 
-	/**
-	 * Get a mimetype from its ID
-	 *
-	 * @param int $id
-	 * @return string|null
-	 * @since 8.2.0
-	 */
-	public function getMimetypeById($id);
+    /**
+     * Get a mimetype from its ID
+     *
+     * @param int $id
+     * @return string|null
+     * @since 8.2.0
+     */
+    public function getMimetypeById($id);
 
-	/**
-	 * Get a mimetype ID, adding the mimetype to the DB if it does not exist
-	 *
-	 * @param string $mimetype
-	 * @return int
-	 * @since 8.2.0
-	 */
-	public function getId($mimetype);
+    /**
+     * Get a mimetype ID, adding the mimetype to the DB if it does not exist
+     *
+     * @param string $mimetype
+     * @return int
+     * @since 8.2.0
+     */
+    public function getId($mimetype);
 
-	/**
-	 * Test if a mimetype exists in the database
-	 *
-	 * @param string $mimetype
-	 * @return bool
-	 * @since 8.2.0
-	 */
-	public function exists($mimetype);
+    /**
+     * Test if a mimetype exists in the database
+     *
+     * @param string $mimetype
+     * @return bool
+     * @since 8.2.0
+     */
+    public function exists($mimetype);
 
-	/**
-	 * Clear all loaded mimetypes, allow for re-loading
-	 *
-	 * @since 8.2.0
-	 */
-	public function reset();
+    /**
+     * Clear all loaded mimetypes, allow for re-loading
+     *
+     * @since 8.2.0
+     */
+    public function reset();
 }

lib/public/Files/LockNotAcquiredException.php

Indentation +20 added lines, -20 removed lines

@@ -36,27 +36,27 @@
  * @since 7.0.0
  */
 class LockNotAcquiredException extends \Exception {
-	/** @var string $path The path that could not be locked */
-	public $path;
+    /** @var string $path The path that could not be locked */
+    public $path;
 
-	/** @var integer $lockType The type of the lock that was attempted */
-	public $lockType;
+    /** @var integer $lockType The type of the lock that was attempted */
+    public $lockType;
 
-	/**
-	 * @since 7.0.0
-	 */
-	public function __construct($path, $lockType, $code = 0, \Exception $previous = null) {
-		$message = \OC::$server->getL10N('core')->t('Could not obtain lock type %d on "%s".', array($lockType, $path));
-		parent::__construct($message, $code, $previous);
-	}
+    /**
+     * @since 7.0.0
+     */
+    public function __construct($path, $lockType, $code = 0, \Exception $previous = null) {
+        $message = \OC::$server->getL10N('core')->t('Could not obtain lock type %d on "%s".', array($lockType, $path));
+        parent::__construct($message, $code, $previous);
+    }
 
-	/**
-	 * custom string representation of object
-	 *
-	 * @return string
-	 * @since 7.0.0
-	 */
-	public function __toString() {
-		return __CLASS__ . ": [{$this->code}]: {$this->message}\n";
-	}
+    /**
+     * custom string representation of object
+     *
+     * @return string
+     * @since 7.0.0
+     */
+    public function __toString() {
+        return __CLASS__ . ": [{$this->code}]: {$this->message}\n";
+    }
 }

Spacing +1 added lines, -1 removed lines

@@ -57,6 +57,6 @@
 	 * @since 7.0.0
 	 */
 	public function __toString() {
-		return __CLASS__ . ": [{$this->code}]: {$this->message}\n";
+		return __CLASS__.": [{$this->code}]: {$this->message}\n";
 	}
 }

lib/public/Files/Storage/INotifyStorage.php

Indentation +30 added lines, -30 removed lines

@@ -31,36 +31,36 @@
  * @since 9.1.0
  */
 interface INotifyStorage {
-	const NOTIFY_ADDED = 1;
-	const NOTIFY_REMOVED = 2;
-	const NOTIFY_MODIFIED = 3;
-	const NOTIFY_RENAMED = 4;
+    const NOTIFY_ADDED = 1;
+    const NOTIFY_REMOVED = 2;
+    const NOTIFY_MODIFIED = 3;
+    const NOTIFY_RENAMED = 4;
 
-	/**
-	 * Start listening for update notifications
-	 *
-	 * The provided callback will be called for every incoming notification with the following parameters
-	 *  - int $type the type of update, one of the INotifyStorage::NOTIFY_* constants
-	 *  - string $path the path of the update
-	 *  - string $renameTarget the target of the rename operation, only provided for rename updates
-	 *
-	 * Note that this call is blocking and will not exit on it's own, to stop listening for notifications return `false` from the callback
-	 *
-	 * @param string $path
-	 * @param callable $callback
-	 *
-	 * @since 9.1.0
-	 * @deprecated 12.0.0 use INotifyStorage::notify()->listen() instead
-	 */
-	public function listen($path, callable $callback);
+    /**
+     * Start listening for update notifications
+     *
+     * The provided callback will be called for every incoming notification with the following parameters
+     *  - int $type the type of update, one of the INotifyStorage::NOTIFY_* constants
+     *  - string $path the path of the update
+     *  - string $renameTarget the target of the rename operation, only provided for rename updates
+     *
+     * Note that this call is blocking and will not exit on it's own, to stop listening for notifications return `false` from the callback
+     *
+     * @param string $path
+     * @param callable $callback
+     *
+     * @since 9.1.0
+     * @deprecated 12.0.0 use INotifyStorage::notify()->listen() instead
+     */
+    public function listen($path, callable $callback);
 
-	/**
-	 * Start the notification handler for this storage
-	 *
-	 * @param $path
-	 * @return INotifyHandler
-	 *
-	 * @since 12.0.0
-	 */
-	public function notify($path);
+    /**
+     * Start the notification handler for this storage
+     *
+     * @param $path
+     * @return INotifyHandler
+     *
+     * @since 12.0.0
+     */
+    public function notify($path);
 }