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/ILogger.php

Indentation +100 added lines, -100 removed lines

@@ -33,113 +33,113 @@
  * https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md#3-psrlogloggerinterface
  */
 interface ILogger {
-	/**
-	 * System is unusable.
-	 *
-	 * @param string $message
-	 * @param array $context
-	 * @return null
-	 * @since 7.0.0
-	 */
-	public function emergency($message, array $context = array());
+    /**
+     * System is unusable.
+     *
+     * @param string $message
+     * @param array $context
+     * @return null
+     * @since 7.0.0
+     */
+    public function emergency($message, array $context = array());
 
-	/**
-	 * Action must be taken immediately.
-	 *
-	 * @param string $message
-	 * @param array $context
-	 * @return null
-	 * @since 7.0.0
-	 */
-	public function alert($message, array $context = array());
+    /**
+     * Action must be taken immediately.
+     *
+     * @param string $message
+     * @param array $context
+     * @return null
+     * @since 7.0.0
+     */
+    public function alert($message, array $context = array());
 
-	/**
-	 * Critical conditions.
-	 *
-	 * @param string $message
-	 * @param array $context
-	 * @return null
-	 * @since 7.0.0
-	 */
-	public function critical($message, array $context = array());
+    /**
+     * Critical conditions.
+     *
+     * @param string $message
+     * @param array $context
+     * @return null
+     * @since 7.0.0
+     */
+    public function critical($message, array $context = array());
 
-	/**
-	 * Runtime errors that do not require immediate action but should typically
-	 * be logged and monitored.
-	 *
-	 * @param string $message
-	 * @param array $context
-	 * @return null
-	 * @since 7.0.0
-	 */
-	public function error($message, array $context = array());
+    /**
+     * Runtime errors that do not require immediate action but should typically
+     * be logged and monitored.
+     *
+     * @param string $message
+     * @param array $context
+     * @return null
+     * @since 7.0.0
+     */
+    public function error($message, array $context = array());
 
-	/**
-	 * Exceptional occurrences that are not errors.
-	 *
-	 * @param string $message
-	 * @param array $context
-	 * @return null
-	 * @since 7.0.0
-	 */
-	public function warning($message, array $context = array());
+    /**
+     * Exceptional occurrences that are not errors.
+     *
+     * @param string $message
+     * @param array $context
+     * @return null
+     * @since 7.0.0
+     */
+    public function warning($message, array $context = array());
 
-	/**
-	 * Normal but significant events.
-	 *
-	 * @param string $message
-	 * @param array $context
-	 * @return null
-	 * @since 7.0.0
-	 */
-	public function notice($message, array $context = array());
+    /**
+     * Normal but significant events.
+     *
+     * @param string $message
+     * @param array $context
+     * @return null
+     * @since 7.0.0
+     */
+    public function notice($message, array $context = array());
 
-	/**
-	 * Interesting events.
-	 *
-	 * @param string $message
-	 * @param array $context
-	 * @return null
-	 * @since 7.0.0
-	 */
-	public function info($message, array $context = array());
+    /**
+     * Interesting events.
+     *
+     * @param string $message
+     * @param array $context
+     * @return null
+     * @since 7.0.0
+     */
+    public function info($message, array $context = array());
 
-	/**
-	 * Detailed debug information.
-	 *
-	 * @param string $message
-	 * @param array $context
-	 * @return null
-	 * @since 7.0.0
-	 */
-	public function debug($message, array $context = array());
+    /**
+     * Detailed debug information.
+     *
+     * @param string $message
+     * @param array $context
+     * @return null
+     * @since 7.0.0
+     */
+    public function debug($message, array $context = array());
 
-	/**
-	 * Logs with an arbitrary level.
-	 *
-	 * @param mixed $level
-	 * @param string $message
-	 * @param array $context
-	 * @return mixed
-	 * @since 7.0.0
-	 */
-	public function log($level, $message, array $context = array());
+    /**
+     * Logs with an arbitrary level.
+     *
+     * @param mixed $level
+     * @param string $message
+     * @param array $context
+     * @return mixed
+     * @since 7.0.0
+     */
+    public function log($level, $message, array $context = array());
 
-	/**
-	 * Logs an exception very detailed
-	 * An additional message can we written to the log by adding it to the
-	 * context.
-	 *
-	 * <code>
-	 * $logger->logException($ex, [
-	 *     'message' => 'Exception during cron job execution'
-	 * ]);
-	 * </code>
-	 *
-	 * @param \Exception | \Throwable $exception
-	 * @param array $context
-	 * @return void
-	 * @since 8.2.0
-	 */
-	public function logException($exception, array $context = array());
+    /**
+     * Logs an exception very detailed
+     * An additional message can we written to the log by adding it to the
+     * context.
+     *
+     * <code>
+     * $logger->logException($ex, [
+     *     'message' => 'Exception during cron job execution'
+     * ]);
+     * </code>
+     *
+     * @param \Exception | \Throwable $exception
+     * @param array $context
+     * @return void
+     * @since 8.2.0
+     */
+    public function logException($exception, array $context = array());
 }

lib/public/ICacheFactory.php

Indentation +17 added lines, -17 removed lines

@@ -30,22 +30,22 @@
  * @since 7.0.0
  */
 interface ICacheFactory{
-	/**
-	 * Get a memory cache instance
-	 *
-	 * All entries added trough the cache instance will be namespaced by $prefix to prevent collisions between apps
-	 *
-	 * @param string $prefix
-	 * @return \OCP\ICache
-	 * @since 7.0.0
-	 */
-	public function create($prefix = '');
+    /**
+     * Get a memory cache instance
+     *
+     * All entries added trough the cache instance will be namespaced by $prefix to prevent collisions between apps
+     *
+     * @param string $prefix
+     * @return \OCP\ICache
+     * @since 7.0.0
+     */
+    public function create($prefix = '');
 
-	/**
-	 * Check if any memory cache backend is available
-	 *
-	 * @return bool
-	 * @since 7.0.0
-	 */
-	public function isAvailable();
+    /**
+     * Check if any memory cache backend is available
+     *
+     * @return bool
+     * @since 7.0.0
+     */
+    public function isAvailable();
 }

lib/public/ISession.php

Indentation +57 added lines, -57 removed lines

@@ -42,68 +42,68 @@
  */
 interface ISession {
 
-	/**
-	 * Set a value in the session
-	 *
-	 * @param string $key
-	 * @param mixed $value
-	 * @since 6.0.0
-	 */
-	public function set($key, $value);
+    /**
+     * Set a value in the session
+     *
+     * @param string $key
+     * @param mixed $value
+     * @since 6.0.0
+     */
+    public function set($key, $value);
 
-	/**
-	 * Get a value from the session
-	 *
-	 * @param string $key
-	 * @return mixed should return null if $key does not exist
-	 * @since 6.0.0
-	 */
-	public function get($key);
+    /**
+     * Get a value from the session
+     *
+     * @param string $key
+     * @return mixed should return null if $key does not exist
+     * @since 6.0.0
+     */
+    public function get($key);
 
-	/**
-	 * Check if a named key exists in the session
-	 *
-	 * @param string $key
-	 * @return bool
-	 * @since 6.0.0
-	 */
-	public function exists($key);
+    /**
+     * Check if a named key exists in the session
+     *
+     * @param string $key
+     * @return bool
+     * @since 6.0.0
+     */
+    public function exists($key);
 
-	/**
-	 * Remove a $key/$value pair from the session
-	 *
-	 * @param string $key
-	 * @since 6.0.0
-	 */
-	public function remove($key);
+    /**
+     * Remove a $key/$value pair from the session
+     *
+     * @param string $key
+     * @since 6.0.0
+     */
+    public function remove($key);
 
-	/**
-	 * Reset and recreate the session
-	 * @since 6.0.0
-	 */
-	public function clear();
+    /**
+     * Reset and recreate the session
+     * @since 6.0.0
+     */
+    public function clear();
 
-	/**
-	 * Close the session and release the lock
-	 * @since 7.0.0
-	 */
-	public function close();
+    /**
+     * Close the session and release the lock
+     * @since 7.0.0
+     */
+    public function close();
 
-	/**
-	 * Wrapper around session_regenerate_id
-	 *
-	 * @param bool $deleteOldSession Whether to delete the old associated session file or not.
-	 * @return void
-	 * @since 9.0.0
-	 */
-	public function regenerateId($deleteOldSession = true);
+    /**
+     * Wrapper around session_regenerate_id
+     *
+     * @param bool $deleteOldSession Whether to delete the old associated session file or not.
+     * @return void
+     * @since 9.0.0
+     */
+    public function regenerateId($deleteOldSession = true);
 
-	/**
-	 * Wrapper around session_id
-	 *
-	 * @return string
-	 * @throws SessionNotAvailableException
-	 * @since 9.1.0
-	 */
-	public function getId();
+    /**
+     * Wrapper around session_id
+     *
+     * @return string
+     * @throws SessionNotAvailableException
+     * @since 9.1.0
+     */
+    public function getId();
 }

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/Mount/IMountManager.php

Indentation +65 added lines, -65 removed lines

@@ -31,77 +31,77 @@
  */
 interface IMountManager {
 
-	/**
-	 * Add a new mount
-	 *
-	 * @param \OCP\Files\Mount\IMountPoint $mount
-	 * @since 8.2.0
-	 */
-	public function addMount(IMountPoint $mount);
+    /**
+     * Add a new mount
+     *
+     * @param \OCP\Files\Mount\IMountPoint $mount
+     * @since 8.2.0
+     */
+    public function addMount(IMountPoint $mount);
 
-	/**
-	 * Remove a mount
-	 *
-	 * @param string $mountPoint
-	 * @since 8.2.0
-	 */
-	public function removeMount($mountPoint);
+    /**
+     * Remove a mount
+     *
+     * @param string $mountPoint
+     * @since 8.2.0
+     */
+    public function removeMount($mountPoint);
 
-	/**
-	 * Change the location of a mount
-	 *
-	 * @param string $mountPoint
-	 * @param string $target
-	 * @since 8.2.0
-	 */
-	public function moveMount($mountPoint, $target);
+    /**
+     * Change the location of a mount
+     *
+     * @param string $mountPoint
+     * @param string $target
+     * @since 8.2.0
+     */
+    public function moveMount($mountPoint, $target);
 
-	/**
-	 * Find the mount for $path
-	 *
-	 * @param string $path
-	 * @return \OCP\Files\Mount\IMountPoint
-	 * @since 8.2.0
-	 */
-	public function find($path);
+    /**
+     * Find the mount for $path
+     *
+     * @param string $path
+     * @return \OCP\Files\Mount\IMountPoint
+     * @since 8.2.0
+     */
+    public function find($path);
 
-	/**
-	 * Find all mounts in $path
-	 *
-	 * @param string $path
-	 * @return \OCP\Files\Mount\IMountPoint[]
-	 * @since 8.2.0
-	 */
-	public function findIn($path);
+    /**
+     * Find all mounts in $path
+     *
+     * @param string $path
+     * @return \OCP\Files\Mount\IMountPoint[]
+     * @since 8.2.0
+     */
+    public function findIn($path);
 
-	/**
-	 * Remove all registered mounts
-	 *
-	 * @since 8.2.0
-	 */
-	public function clear();
+    /**
+     * Remove all registered mounts
+     *
+     * @since 8.2.0
+     */
+    public function clear();
 
-	/**
-	 * Find mounts by storage id
-	 *
-	 * @param string $id
-	 * @return \OCP\Files\Mount\IMountPoint[]
-	 * @since 8.2.0
-	 */
-	public function findByStorageId($id);
+    /**
+     * Find mounts by storage id
+     *
+     * @param string $id
+     * @return \OCP\Files\Mount\IMountPoint[]
+     * @since 8.2.0
+     */
+    public function findByStorageId($id);
 
-	/**
-	 * @return \OCP\Files\Mount\IMountPoint[]
-	 * @since 8.2.0
-	 */
-	public function getAll();
+    /**
+     * @return \OCP\Files\Mount\IMountPoint[]
+     * @since 8.2.0
+     */
+    public function getAll();
 
-	/**
-	 * Find mounts by numeric storage id
-	 *
-	 * @param int $id
-	 * @return \OCP\Files\Mount\IMountPoint[]
-	 * @since 8.2.0
-	 */
-	public function findByNumericId($id);
+    /**
+     * Find mounts by numeric storage id
+     *
+     * @param int $id
+     * @return \OCP\Files\Mount\IMountPoint[]
+     * @since 8.2.0
+     */
+    public function findByNumericId($id);
 }

lib/public/Files/ForbiddenException.php

Indentation +19 added lines, -19 removed lines

@@ -32,25 +32,25 @@
  */
 class ForbiddenException extends \Exception {
 
-	/** @var bool */
-	private $retry;
+    /** @var bool */
+    private $retry;
 
-	/**
-	 * @param string $message
-	 * @param bool $retry
-	 * @param \Exception $previous previous exception for cascading
-	 * @since 9.0.0
-	 */
-	public function __construct($message, $retry, \Exception $previous = null) {
-		parent::__construct($message, 0, $previous);
-		$this->retry = $retry;
-	}
+    /**
+     * @param string $message
+     * @param bool $retry
+     * @param \Exception $previous previous exception for cascading
+     * @since 9.0.0
+     */
+    public function __construct($message, $retry, \Exception $previous = null) {
+        parent::__construct($message, 0, $previous);
+        $this->retry = $retry;
+    }
 
-	/**
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function getRetry() {
-		return (bool) $this->retry;
-	}
+    /**
+     * @return bool
+     * @since 9.0.0
+     */
+    public function getRetry() {
+        return (bool) $this->retry;
+    }
 }

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/StorageAuthException.php

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