nextcloud / server

lib/public/Files/Storage/ILockingStorage.php

Indentation +24 added lines, -24 removed lines

@@ -33,30 +33,30 @@
  * @since 9.0.0
  */
 interface ILockingStorage {
-	/**
-	 * @param string $path The path of the file to acquire the lock for
-	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
-	 * @param \OCP\Lock\ILockingProvider $provider
-	 * @throws \OCP\Lock\LockedException
-	 * @since 9.0.0
-	 */
-	public function acquireLock($path, $type, ILockingProvider $provider);
+    /**
+     * @param string $path The path of the file to acquire the lock for
+     * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
+     * @param \OCP\Lock\ILockingProvider $provider
+     * @throws \OCP\Lock\LockedException
+     * @since 9.0.0
+     */
+    public function acquireLock($path, $type, ILockingProvider $provider);
 
-	/**
-	 * @param string $path The path of the file to acquire the lock for
-	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
-	 * @param \OCP\Lock\ILockingProvider $provider
-	 * @throws \OCP\Lock\LockedException
-	 * @since 9.0.0
-	 */
-	public function releaseLock($path, $type, ILockingProvider $provider);
+    /**
+     * @param string $path The path of the file to acquire the lock for
+     * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
+     * @param \OCP\Lock\ILockingProvider $provider
+     * @throws \OCP\Lock\LockedException
+     * @since 9.0.0
+     */
+    public function releaseLock($path, $type, ILockingProvider $provider);
 
-	/**
-	 * @param string $path The path of the file to change the lock for
-	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
-	 * @param \OCP\Lock\ILockingProvider $provider
-	 * @throws \OCP\Lock\LockedException
-	 * @since 9.0.0
-	 */
-	public function changeLock($path, $type, ILockingProvider $provider);
+    /**
+     * @param string $path The path of the file to change the lock for
+     * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
+     * @param \OCP\Lock\ILockingProvider $provider
+     * @throws \OCP\Lock\LockedException
+     * @since 9.0.0
+     */
+    public function changeLock($path, $type, ILockingProvider $provider);
 }

lib/public/Files/Storage/IStorage.php

Indentation +411 added lines, -411 removed lines

@@ -44,415 +44,415 @@
  * @since 9.0.0
  */
 interface IStorage {
-	/**
-	 * $parameters is a free form array with the configuration options needed to construct the storage
-	 *
-	 * @param array $parameters
-	 * @since 9.0.0
-	 */
-	public function __construct($parameters);
-
-	/**
-	 * Get the identifier for the storage,
-	 * the returned id should be the same for every storage object that is created with the same parameters
-	 * and two storage objects with the same id should refer to two storages that display the same files.
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getId();
-
-	/**
-	 * see http://php.net/manual/en/function.mkdir.php
-	 * implementations need to implement a recursive mkdir
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function mkdir($path);
-
-	/**
-	 * see http://php.net/manual/en/function.rmdir.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function rmdir($path);
-
-	/**
-	 * see http://php.net/manual/en/function.opendir.php
-	 *
-	 * @param string $path
-	 * @return resource|false
-	 * @since 9.0.0
-	 */
-	public function opendir($path);
-
-	/**
-	 * see http://php.net/manual/en/function.is-dir.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function is_dir($path);
-
-	/**
-	 * see http://php.net/manual/en/function.is-file.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function is_file($path);
-
-	/**
-	 * see http://php.net/manual/en/function.stat.php
-	 * only the following keys are required in the result: size and mtime
-	 *
-	 * @param string $path
-	 * @return array|false
-	 * @since 9.0.0
-	 */
-	public function stat($path);
-
-	/**
-	 * see http://php.net/manual/en/function.filetype.php
-	 *
-	 * @param string $path
-	 * @return string|false
-	 * @since 9.0.0
-	 */
-	public function filetype($path);
-
-	/**
-	 * see http://php.net/manual/en/function.filesize.php
-	 * The result for filesize when called on a folder is required to be 0
-	 *
-	 * @param string $path
-	 * @return int|false
-	 * @since 9.0.0
-	 */
-	public function filesize($path);
-
-	/**
-	 * check if a file can be created in $path
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function isCreatable($path);
-
-	/**
-	 * check if a file can be read
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function isReadable($path);
-
-	/**
-	 * check if a file can be written to
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function isUpdatable($path);
-
-	/**
-	 * check if a file can be deleted
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function isDeletable($path);
-
-	/**
-	 * check if a file can be shared
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function isSharable($path);
-
-	/**
-	 * get the full permissions of a path.
-	 * Should return a combination of the PERMISSION_ constants defined in lib/public/constants.php
-	 *
-	 * @param string $path
-	 * @return int
-	 * @since 9.0.0
-	 */
-	public function getPermissions($path);
-
-	/**
-	 * see http://php.net/manual/en/function.file_exists.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function file_exists($path);
-
-	/**
-	 * see http://php.net/manual/en/function.filemtime.php
-	 *
-	 * @param string $path
-	 * @return int|false
-	 * @since 9.0.0
-	 */
-	public function filemtime($path);
-
-	/**
-	 * see http://php.net/manual/en/function.file_get_contents.php
-	 *
-	 * @param string $path
-	 * @return string|false
-	 * @since 9.0.0
-	 */
-	public function file_get_contents($path);
-
-	/**
-	 * see http://php.net/manual/en/function.file_put_contents.php
-	 *
-	 * @param string $path
-	 * @param string $data
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function file_put_contents($path, $data);
-
-	/**
-	 * see http://php.net/manual/en/function.unlink.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function unlink($path);
-
-	/**
-	 * see http://php.net/manual/en/function.rename.php
-	 *
-	 * @param string $path1
-	 * @param string $path2
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function rename($path1, $path2);
-
-	/**
-	 * see http://php.net/manual/en/function.copy.php
-	 *
-	 * @param string $path1
-	 * @param string $path2
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function copy($path1, $path2);
-
-	/**
-	 * see http://php.net/manual/en/function.fopen.php
-	 *
-	 * @param string $path
-	 * @param string $mode
-	 * @return resource|false
-	 * @since 9.0.0
-	 */
-	public function fopen($path, $mode);
-
-	/**
-	 * get the mimetype for a file or folder
-	 * The mimetype for a folder is required to be "httpd/unix-directory"
-	 *
-	 * @param string $path
-	 * @return string|false
-	 * @since 9.0.0
-	 */
-	public function getMimeType($path);
-
-	/**
-	 * see http://php.net/manual/en/function.hash-file.php
-	 *
-	 * @param string $type
-	 * @param string $path
-	 * @param bool $raw
-	 * @return string|false
-	 * @since 9.0.0
-	 */
-	public function hash($type, $path, $raw = false);
-
-	/**
-	 * see http://php.net/manual/en/function.free_space.php
-	 *
-	 * @param string $path
-	 * @return int|false
-	 * @since 9.0.0
-	 */
-	public function free_space($path);
-
-	/**
-	 * see http://php.net/manual/en/function.touch.php
-	 * If the backend does not support the operation, false should be returned
-	 *
-	 * @param string $path
-	 * @param int $mtime
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function touch($path, $mtime = null);
-
-	/**
-	 * get the path to a local version of the file.
-	 * The local version of the file can be temporary and doesn't have to be persistent across requests
-	 *
-	 * @param string $path
-	 * @return string|false
-	 * @since 9.0.0
-	 */
-	public function getLocalFile($path);
-
-	/**
-	 * check if a file or folder has been updated since $time
-	 *
-	 * @param string $path
-	 * @param int $time
-	 * @return bool
-	 * @since 9.0.0
-	 *
-	 * hasUpdated for folders should return at least true if a file inside the folder is add, removed or renamed.
-	 * returning true for other changes in the folder is optional
-	 */
-	public function hasUpdated($path, $time);
-
-	/**
-	 * get the ETag for a file or folder
-	 *
-	 * @param string $path
-	 * @return string|false
-	 * @since 9.0.0
-	 */
-	public function getETag($path);
-
-	/**
-	 * Returns whether the storage is local, which means that files
-	 * are stored on the local filesystem instead of remotely.
-	 * Calling getLocalFile() for local storages should always
-	 * return the local files, whereas for non-local storages
-	 * it might return a temporary file.
-	 *
-	 * @return bool true if the files are stored locally, false otherwise
-	 * @since 9.0.0
-	 */
-	public function isLocal();
-
-	/**
-	 * Check if the storage is an instance of $class or is a wrapper for a storage that is an instance of $class
-	 *
-	 * @param string $class
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function instanceOfStorage($class);
-
-	/**
-	 * A custom storage implementation can return an url for direct download of a give file.
-	 *
-	 * For now the returned array can hold the parameter url - in future more attributes might follow.
-	 *
-	 * @param string $path
-	 * @return array|false
-	 * @since 9.0.0
-	 */
-	public function getDirectDownload($path);
-
-	/**
-	 * @param string $path the path of the target folder
-	 * @param string $fileName the name of the file itself
-	 * @return void
-	 * @throws InvalidPathException
-	 * @since 9.0.0
-	 */
-	public function verifyPath($path, $fileName);
-
-	/**
-	 * @param \OCP\Files\Storage|\OCP\Files\Storage\IStorage $sourceStorage
-	 * @param string $sourceInternalPath
-	 * @param string $targetInternalPath
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function copyFromStorage(\OCP\Files\Storage $sourceStorage, $sourceInternalPath, $targetInternalPath);
-
-	/**
-	 * @param \OCP\Files\Storage|\OCP\Files\Storage\IStorage $sourceStorage
-	 * @param string $sourceInternalPath
-	 * @param string $targetInternalPath
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function moveFromStorage(\OCP\Files\Storage $sourceStorage, $sourceInternalPath, $targetInternalPath);
-
-	/**
-	 * Test a storage for availability
-	 *
-	 * @since 9.0.0
-	 * @return bool
-	 */
-	public function test();
-
-	/**
-	 * @since 9.0.0
-	 * @return array [ available, last_checked ]
-	 */
-	public function getAvailability();
-
-	/**
-	 * @since 9.0.0
-	 * @param bool $isAvailable
-	 */
-	public function setAvailability($isAvailable);
-
-	/**
-	 * @param string $path path for which to retrieve the owner
-	 * @since 9.0.0
-	 */
-	public function getOwner($path);
-
-	/**
-	 * @return ICache
-	 * @since 9.0.0
-	 */
-	public function getCache();
-
-	/**
-	 * @return IPropagator
-	 * @since 9.0.0
-	 */
-	public function getPropagator();
-
-	/**
-	 * @return IScanner
-	 * @since 9.0.0
-	 */
-	public function getScanner();
-
-	/**
-	 * @return IUpdater
-	 * @since 9.0.0
-	 */
-	public function getUpdater();
-
-	/**
-	 * @return IWatcher
-	 * @since 9.0.0
-	 */
-	public function getWatcher();
+    /**
+     * $parameters is a free form array with the configuration options needed to construct the storage
+     *
+     * @param array $parameters
+     * @since 9.0.0
+     */
+    public function __construct($parameters);
+
+    /**
+     * Get the identifier for the storage,
+     * the returned id should be the same for every storage object that is created with the same parameters
+     * and two storage objects with the same id should refer to two storages that display the same files.
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getId();
+
+    /**
+     * see http://php.net/manual/en/function.mkdir.php
+     * implementations need to implement a recursive mkdir
+     *
+     * @param string $path
+     * @return bool
+     * @since 9.0.0
+     */
+    public function mkdir($path);
+
+    /**
+     * see http://php.net/manual/en/function.rmdir.php
+     *
+     * @param string $path
+     * @return bool
+     * @since 9.0.0
+     */
+    public function rmdir($path);
+
+    /**
+     * see http://php.net/manual/en/function.opendir.php
+     *
+     * @param string $path
+     * @return resource|false
+     * @since 9.0.0
+     */
+    public function opendir($path);
+
+    /**
+     * see http://php.net/manual/en/function.is-dir.php
+     *
+     * @param string $path
+     * @return bool
+     * @since 9.0.0
+     */
+    public function is_dir($path);
+
+    /**
+     * see http://php.net/manual/en/function.is-file.php
+     *
+     * @param string $path
+     * @return bool
+     * @since 9.0.0
+     */
+    public function is_file($path);
+
+    /**
+     * see http://php.net/manual/en/function.stat.php
+     * only the following keys are required in the result: size and mtime
+     *
+     * @param string $path
+     * @return array|false
+     * @since 9.0.0
+     */
+    public function stat($path);
+
+    /**
+     * see http://php.net/manual/en/function.filetype.php
+     *
+     * @param string $path
+     * @return string|false
+     * @since 9.0.0
+     */
+    public function filetype($path);
+
+    /**
+     * see http://php.net/manual/en/function.filesize.php
+     * The result for filesize when called on a folder is required to be 0
+     *
+     * @param string $path
+     * @return int|false
+     * @since 9.0.0
+     */
+    public function filesize($path);
+
+    /**
+     * check if a file can be created in $path
+     *
+     * @param string $path
+     * @return bool
+     * @since 9.0.0
+     */
+    public function isCreatable($path);
+
+    /**
+     * check if a file can be read
+     *
+     * @param string $path
+     * @return bool
+     * @since 9.0.0
+     */
+    public function isReadable($path);
+
+    /**
+     * check if a file can be written to
+     *
+     * @param string $path
+     * @return bool
+     * @since 9.0.0
+     */
+    public function isUpdatable($path);
+
+    /**
+     * check if a file can be deleted
+     *
+     * @param string $path
+     * @return bool
+     * @since 9.0.0
+     */
+    public function isDeletable($path);
+
+    /**
+     * check if a file can be shared
+     *
+     * @param string $path
+     * @return bool
+     * @since 9.0.0
+     */
+    public function isSharable($path);
+
+    /**
+     * get the full permissions of a path.
+     * Should return a combination of the PERMISSION_ constants defined in lib/public/constants.php
+     *
+     * @param string $path
+     * @return int
+     * @since 9.0.0
+     */
+    public function getPermissions($path);
+
+    /**
+     * see http://php.net/manual/en/function.file_exists.php
+     *
+     * @param string $path
+     * @return bool
+     * @since 9.0.0
+     */
+    public function file_exists($path);
+
+    /**
+     * see http://php.net/manual/en/function.filemtime.php
+     *
+     * @param string $path
+     * @return int|false
+     * @since 9.0.0
+     */
+    public function filemtime($path);
+
+    /**
+     * see http://php.net/manual/en/function.file_get_contents.php
+     *
+     * @param string $path
+     * @return string|false
+     * @since 9.0.0
+     */
+    public function file_get_contents($path);
+
+    /**
+     * see http://php.net/manual/en/function.file_put_contents.php
+     *
+     * @param string $path
+     * @param string $data
+     * @return bool
+     * @since 9.0.0
+     */
+    public function file_put_contents($path, $data);
+
+    /**
+     * see http://php.net/manual/en/function.unlink.php
+     *
+     * @param string $path
+     * @return bool
+     * @since 9.0.0
+     */
+    public function unlink($path);
+
+    /**
+     * see http://php.net/manual/en/function.rename.php
+     *
+     * @param string $path1
+     * @param string $path2
+     * @return bool
+     * @since 9.0.0
+     */
+    public function rename($path1, $path2);
+
+    /**
+     * see http://php.net/manual/en/function.copy.php
+     *
+     * @param string $path1
+     * @param string $path2
+     * @return bool
+     * @since 9.0.0
+     */
+    public function copy($path1, $path2);
+
+    /**
+     * see http://php.net/manual/en/function.fopen.php
+     *
+     * @param string $path
+     * @param string $mode
+     * @return resource|false
+     * @since 9.0.0
+     */
+    public function fopen($path, $mode);
+
+    /**
+     * get the mimetype for a file or folder
+     * The mimetype for a folder is required to be "httpd/unix-directory"
+     *
+     * @param string $path
+     * @return string|false
+     * @since 9.0.0
+     */
+    public function getMimeType($path);
+
+    /**
+     * see http://php.net/manual/en/function.hash-file.php
+     *
+     * @param string $type
+     * @param string $path
+     * @param bool $raw
+     * @return string|false
+     * @since 9.0.0
+     */
+    public function hash($type, $path, $raw = false);
+
+    /**
+     * see http://php.net/manual/en/function.free_space.php
+     *
+     * @param string $path
+     * @return int|false
+     * @since 9.0.0
+     */
+    public function free_space($path);
+
+    /**
+     * see http://php.net/manual/en/function.touch.php
+     * If the backend does not support the operation, false should be returned
+     *
+     * @param string $path
+     * @param int $mtime
+     * @return bool
+     * @since 9.0.0
+     */
+    public function touch($path, $mtime = null);
+
+    /**
+     * get the path to a local version of the file.
+     * The local version of the file can be temporary and doesn't have to be persistent across requests
+     *
+     * @param string $path
+     * @return string|false
+     * @since 9.0.0
+     */
+    public function getLocalFile($path);
+
+    /**
+     * check if a file or folder has been updated since $time
+     *
+     * @param string $path
+     * @param int $time
+     * @return bool
+     * @since 9.0.0
+     *
+     * hasUpdated for folders should return at least true if a file inside the folder is add, removed or renamed.
+     * returning true for other changes in the folder is optional
+     */
+    public function hasUpdated($path, $time);
+
+    /**
+     * get the ETag for a file or folder
+     *
+     * @param string $path
+     * @return string|false
+     * @since 9.0.0
+     */
+    public function getETag($path);
+
+    /**
+     * Returns whether the storage is local, which means that files
+     * are stored on the local filesystem instead of remotely.
+     * Calling getLocalFile() for local storages should always
+     * return the local files, whereas for non-local storages
+     * it might return a temporary file.
+     *
+     * @return bool true if the files are stored locally, false otherwise
+     * @since 9.0.0
+     */
+    public function isLocal();
+
+    /**
+     * Check if the storage is an instance of $class or is a wrapper for a storage that is an instance of $class
+     *
+     * @param string $class
+     * @return bool
+     * @since 9.0.0
+     */
+    public function instanceOfStorage($class);
+
+    /**
+     * A custom storage implementation can return an url for direct download of a give file.
+     *
+     * For now the returned array can hold the parameter url - in future more attributes might follow.
+     *
+     * @param string $path
+     * @return array|false
+     * @since 9.0.0
+     */
+    public function getDirectDownload($path);
+
+    /**
+     * @param string $path the path of the target folder
+     * @param string $fileName the name of the file itself
+     * @return void
+     * @throws InvalidPathException
+     * @since 9.0.0
+     */
+    public function verifyPath($path, $fileName);
+
+    /**
+     * @param \OCP\Files\Storage|\OCP\Files\Storage\IStorage $sourceStorage
+     * @param string $sourceInternalPath
+     * @param string $targetInternalPath
+     * @return bool
+     * @since 9.0.0
+     */
+    public function copyFromStorage(\OCP\Files\Storage $sourceStorage, $sourceInternalPath, $targetInternalPath);
+
+    /**
+     * @param \OCP\Files\Storage|\OCP\Files\Storage\IStorage $sourceStorage
+     * @param string $sourceInternalPath
+     * @param string $targetInternalPath
+     * @return bool
+     * @since 9.0.0
+     */
+    public function moveFromStorage(\OCP\Files\Storage $sourceStorage, $sourceInternalPath, $targetInternalPath);
+
+    /**
+     * Test a storage for availability
+     *
+     * @since 9.0.0
+     * @return bool
+     */
+    public function test();
+
+    /**
+     * @since 9.0.0
+     * @return array [ available, last_checked ]
+     */
+    public function getAvailability();
+
+    /**
+     * @since 9.0.0
+     * @param bool $isAvailable
+     */
+    public function setAvailability($isAvailable);
+
+    /**
+     * @param string $path path for which to retrieve the owner
+     * @since 9.0.0
+     */
+    public function getOwner($path);
+
+    /**
+     * @return ICache
+     * @since 9.0.0
+     */
+    public function getCache();
+
+    /**
+     * @return IPropagator
+     * @since 9.0.0
+     */
+    public function getPropagator();
+
+    /**
+     * @return IScanner
+     * @since 9.0.0
+     */
+    public function getScanner();
+
+    /**
+     * @return IUpdater
+     * @since 9.0.0
+     */
+    public function getUpdater();
+
+    /**
+     * @return IWatcher
+     * @since 9.0.0
+     */
+    public function getWatcher();
 }

lib/public/Files/Notify/IChange.php

Indentation +22 added lines, -22 removed lines

@@ -29,28 +29,28 @@
  * @since 12.0.0
  */
 interface IChange {
-	const ADDED = 1;
-	const REMOVED = 2;
-	const MODIFIED = 3;
-	const RENAMED = 4;
+    const ADDED = 1;
+    const REMOVED = 2;
+    const MODIFIED = 3;
+    const RENAMED = 4;
 
-	/**
-	 * Get the type of the change
-	 *
-	 * @return int IChange::ADDED, IChange::REMOVED, IChange::MODIFIED or IChange::RENAMED
-	 *
-	 * @since 12.0.0
-	 */
-	public function getType();
+    /**
+     * Get the type of the change
+     *
+     * @return int IChange::ADDED, IChange::REMOVED, IChange::MODIFIED or IChange::RENAMED
+     *
+     * @since 12.0.0
+     */
+    public function getType();
 
-	/**
-	 * Get the path of the file that was changed relative to the root of the storage
-	 *
-	 * Note, for rename changes this path is the old path for the file
-	 *
-	 * @return mixed
-	 *
-	 * @since 12.0.0
-	 */
-	public function getPath();
+    /**
+     * Get the path of the file that was changed relative to the root of the storage
+     *
+     * Note, for rename changes this path is the old path for the file
+     *
+     * @return mixed
+     *
+     * @since 12.0.0
+     */
+    public function getPath();
 }

lib/public/Files/Notify/INotifyHandler.php

Indentation +29 added lines, -29 removed lines

@@ -30,35 +30,35 @@
  * @since 12.0.0
  */
 interface INotifyHandler {
-	/**
-	 * Start listening for update notifications
-	 *
-	 * The provided callback will be called for every incoming notification with the following parameters
-	 *  - IChange|IRenameChange $change
-	 *
-	 * 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 callable $callback
-	 *
-	 * @since 12.0.0
-	 */
-	public function listen(callable $callback);
+    /**
+     * Start listening for update notifications
+     *
+     * The provided callback will be called for every incoming notification with the following parameters
+     *  - IChange|IRenameChange $change
+     *
+     * 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 callable $callback
+     *
+     * @since 12.0.0
+     */
+    public function listen(callable $callback);
 
-	/**
-	 * Get all changes detected since the start of the notify process or the last call to getChanges
-	 *
-	 * @return IChange[]
-	 *
-	 * @since 12.0.0
-	 */
-	public function getChanges();
+    /**
+     * Get all changes detected since the start of the notify process or the last call to getChanges
+     *
+     * @return IChange[]
+     *
+     * @since 12.0.0
+     */
+    public function getChanges();
 
-	/**
-	 * Stop listening for changes
-	 *
-	 * Note that any pending changes will be discarded
-	 *
-	 * @since 12.0.0
-	 */
-	public function stop();
+    /**
+     * Stop listening for changes
+     *
+     * Note that any pending changes will be discarded
+     *
+     * @since 12.0.0
+     */
+    public function stop();
 }

lib/public/Files/Notify/IRenameChange.php

Indentation +8 added lines, -8 removed lines

@@ -29,12 +29,12 @@
  * @since 12.0.0
  */
 interface IRenameChange extends IChange {
-	/**
-	 * Get the new path of the renamed file relative to the storage root
-	 *
-	 * @return string
-	 *
-	 * @since 12.0.0
-	 */
-	public function getTargetPath();
+    /**
+     * Get the new path of the renamed file relative to the storage root
+     *
+     * @return string
+     *
+     * @since 12.0.0
+     */
+    public function getTargetPath();
 }

lib/public/Files/Node.php

Indentation +215 added lines, -215 removed lines

@@ -40,241 +40,241 @@
  * @since 6.0.0 - extends FileInfo was added in 8.0.0
  */
 interface Node extends FileInfo {
-	/**
-	 * Move the file or folder to a new location
-	 *
-	 * @param string $targetPath the absolute target path
-	 * @throws \OCP\Files\NotPermittedException
-	 * @return \OCP\Files\Node
-	 * @since 6.0.0
-	 */
-	public function move($targetPath);
+    /**
+     * Move the file or folder to a new location
+     *
+     * @param string $targetPath the absolute target path
+     * @throws \OCP\Files\NotPermittedException
+     * @return \OCP\Files\Node
+     * @since 6.0.0
+     */
+    public function move($targetPath);
 
-	/**
-	 * Delete the file or folder
-	 * @return void
-	 * @since 6.0.0
-	 */
-	public function delete();
+    /**
+     * Delete the file or folder
+     * @return void
+     * @since 6.0.0
+     */
+    public function delete();
 
-	/**
-	 * Cope the file or folder to a new location
-	 *
-	 * @param string $targetPath the absolute target path
-	 * @return \OCP\Files\Node
-	 * @since 6.0.0
-	 */
-	public function copy($targetPath);
+    /**
+     * Cope the file or folder to a new location
+     *
+     * @param string $targetPath the absolute target path
+     * @return \OCP\Files\Node
+     * @since 6.0.0
+     */
+    public function copy($targetPath);
 
-	/**
-	 * Change the modified date of the file or folder
-	 * If $mtime is omitted the current time will be used
-	 *
-	 * @param int $mtime (optional) modified date as unix timestamp
-	 * @throws \OCP\Files\NotPermittedException
-	 * @return void
-	 * @since 6.0.0
-	 */
-	public function touch($mtime = null);
+    /**
+     * Change the modified date of the file or folder
+     * If $mtime is omitted the current time will be used
+     *
+     * @param int $mtime (optional) modified date as unix timestamp
+     * @throws \OCP\Files\NotPermittedException
+     * @return void
+     * @since 6.0.0
+     */
+    public function touch($mtime = null);
 
-	/**
-	 * Get the storage backend the file or folder is stored on
-	 *
-	 * @return \OCP\Files\Storage
-	 * @throws \OCP\Files\NotFoundException
-	 * @since 6.0.0
-	 */
-	public function getStorage();
+    /**
+     * Get the storage backend the file or folder is stored on
+     *
+     * @return \OCP\Files\Storage
+     * @throws \OCP\Files\NotFoundException
+     * @since 6.0.0
+     */
+    public function getStorage();
 
-	/**
-	 * Get the full path of the file or folder
-	 *
-	 * @return string
-	 * @since 6.0.0
-	 */
-	public function getPath();
+    /**
+     * Get the full path of the file or folder
+     *
+     * @return string
+     * @since 6.0.0
+     */
+    public function getPath();
 
-	/**
-	 * Get the path of the file or folder relative to the mountpoint of it's storage
-	 *
-	 * @return string
-	 * @since 6.0.0
-	 */
-	public function getInternalPath();
+    /**
+     * Get the path of the file or folder relative to the mountpoint of it's storage
+     *
+     * @return string
+     * @since 6.0.0
+     */
+    public function getInternalPath();
 
-	/**
-	 * Get the internal file id for the file or folder
-	 *
-	 * @return int
-	 * @throws InvalidPathException
-	 * @throws NotFoundException
-	 * @since 6.0.0
-	 */
-	public function getId();
+    /**
+     * Get the internal file id for the file or folder
+     *
+     * @return int
+     * @throws InvalidPathException
+     * @throws NotFoundException
+     * @since 6.0.0
+     */
+    public function getId();
 
-	/**
-	 * Get metadata of the file or folder
-	 * The returned array contains the following values:
-	 *  - mtime
-	 *  - size
-	 *
-	 * @return array
-	 * @since 6.0.0
-	 */
-	public function stat();
+    /**
+     * Get metadata of the file or folder
+     * The returned array contains the following values:
+     *  - mtime
+     *  - size
+     *
+     * @return array
+     * @since 6.0.0
+     */
+    public function stat();
 
-	/**
-	 * Get the modified date of the file or folder as unix timestamp
-	 *
-	 * @return int
-	 * @throws InvalidPathException
-	 * @throws NotFoundException
-	 * @since 6.0.0
-	 */
-	public function getMTime();
+    /**
+     * Get the modified date of the file or folder as unix timestamp
+     *
+     * @return int
+     * @throws InvalidPathException
+     * @throws NotFoundException
+     * @since 6.0.0
+     */
+    public function getMTime();
 
-	/**
-	 * Get the size of the file or folder in bytes
-	 *
-	 * @return int
-	 * @throws InvalidPathException
-	 * @throws NotFoundException
-	 * @since 6.0.0
-	 */
-	public function getSize();
+    /**
+     * Get the size of the file or folder in bytes
+     *
+     * @return int
+     * @throws InvalidPathException
+     * @throws NotFoundException
+     * @since 6.0.0
+     */
+    public function getSize();
 
-	/**
-	 * Get the Etag of the file or folder
-	 * The Etag is an string id used to detect changes to a file or folder,
-	 * every time the file or folder is changed the Etag will change to
-	 *
-	 * @return string
-	 * @throws InvalidPathException
-	 * @throws NotFoundException
-	 * @since 6.0.0
-	 */
-	public function getEtag();
+    /**
+     * Get the Etag of the file or folder
+     * The Etag is an string id used to detect changes to a file or folder,
+     * every time the file or folder is changed the Etag will change to
+     *
+     * @return string
+     * @throws InvalidPathException
+     * @throws NotFoundException
+     * @since 6.0.0
+     */
+    public function getEtag();
 
 
-	/**
-	 * Get the permissions of the file or folder as a combination of one or more of the following constants:
-	 *  - \OCP\Constants::PERMISSION_READ
-	 *  - \OCP\Constants::PERMISSION_UPDATE
-	 *  - \OCP\Constants::PERMISSION_CREATE
-	 *  - \OCP\Constants::PERMISSION_DELETE
-	 *  - \OCP\Constants::PERMISSION_SHARE
-	 *
-	 * @return int
-	 * @throws InvalidPathException
-	 * @throws NotFoundException
-	 * @since 6.0.0 - namespace of constants has changed in 8.0.0
-	 */
-	public function getPermissions();
+    /**
+     * Get the permissions of the file or folder as a combination of one or more of the following constants:
+     *  - \OCP\Constants::PERMISSION_READ
+     *  - \OCP\Constants::PERMISSION_UPDATE
+     *  - \OCP\Constants::PERMISSION_CREATE
+     *  - \OCP\Constants::PERMISSION_DELETE
+     *  - \OCP\Constants::PERMISSION_SHARE
+     *
+     * @return int
+     * @throws InvalidPathException
+     * @throws NotFoundException
+     * @since 6.0.0 - namespace of constants has changed in 8.0.0
+     */
+    public function getPermissions();
 
-	/**
-	 * Check if the file or folder is readable
-	 *
-	 * @return bool
-	 * @throws InvalidPathException
-	 * @throws NotFoundException
-	 * @since 6.0.0
-	 */
-	public function isReadable();
+    /**
+     * Check if the file or folder is readable
+     *
+     * @return bool
+     * @throws InvalidPathException
+     * @throws NotFoundException
+     * @since 6.0.0
+     */
+    public function isReadable();
 
-	/**
-	 * Check if the file or folder is writable
-	 *
-	 * @return bool
-	 * @throws InvalidPathException
-	 * @throws NotFoundException
-	 * @since 6.0.0
-	 */
-	public function isUpdateable();
+    /**
+     * Check if the file or folder is writable
+     *
+     * @return bool
+     * @throws InvalidPathException
+     * @throws NotFoundException
+     * @since 6.0.0
+     */
+    public function isUpdateable();
 
-	/**
-	 * Check if the file or folder is deletable
-	 *
-	 * @return bool
-	 * @throws InvalidPathException
-	 * @throws NotFoundException
-	 * @since 6.0.0
-	 */
-	public function isDeletable();
+    /**
+     * Check if the file or folder is deletable
+     *
+     * @return bool
+     * @throws InvalidPathException
+     * @throws NotFoundException
+     * @since 6.0.0
+     */
+    public function isDeletable();
 
-	/**
-	 * Check if the file or folder is shareable
-	 *
-	 * @return bool
-	 * @throws InvalidPathException
-	 * @throws NotFoundException
-	 * @since 6.0.0
-	 */
-	public function isShareable();
+    /**
+     * Check if the file or folder is shareable
+     *
+     * @return bool
+     * @throws InvalidPathException
+     * @throws NotFoundException
+     * @since 6.0.0
+     */
+    public function isShareable();
 
-	/**
-	 * Get the parent folder of the file or folder
-	 *
-	 * @return Folder
-	 * @since 6.0.0
-	 */
-	public function getParent();
+    /**
+     * Get the parent folder of the file or folder
+     *
+     * @return Folder
+     * @since 6.0.0
+     */
+    public function getParent();
 
-	/**
-	 * Get the filename of the file or folder
-	 *
-	 * @return string
-	 * @since 6.0.0
-	 */
-	public function getName();
+    /**
+     * Get the filename of the file or folder
+     *
+     * @return string
+     * @since 6.0.0
+     */
+    public function getName();
 
-	/**
-	 * Acquire a lock on this file or folder.
-	 *
-	 * A shared (read) lock will prevent any exclusive (write) locks from being created but any number of shared locks
-	 * can be active at the same time.
-	 * An exclusive lock will prevent any other lock from being created (both shared and exclusive).
-	 *
-	 * A locked exception will be thrown if any conflicting lock already exists
-	 *
-	 * Note that this uses mandatory locking, if you acquire an exclusive lock on a file it will block *all*
-	 * other operations for that file, even within the same php process.
-	 *
-	 * Acquiring any lock on a file will also create a shared lock on all parent folders of that file.
-	 *
-	 * Note that in most cases you won't need to manually manage the locks for any files you're working with,
-	 * any filesystem operation will automatically acquire the relevant locks for that operation.
-	 *
-	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
-	 * @throws \OCP\Lock\LockedException
-	 * @since 9.1.0
-	 */
-	public function lock($type);
+    /**
+     * Acquire a lock on this file or folder.
+     *
+     * A shared (read) lock will prevent any exclusive (write) locks from being created but any number of shared locks
+     * can be active at the same time.
+     * An exclusive lock will prevent any other lock from being created (both shared and exclusive).
+     *
+     * A locked exception will be thrown if any conflicting lock already exists
+     *
+     * Note that this uses mandatory locking, if you acquire an exclusive lock on a file it will block *all*
+     * other operations for that file, even within the same php process.
+     *
+     * Acquiring any lock on a file will also create a shared lock on all parent folders of that file.
+     *
+     * Note that in most cases you won't need to manually manage the locks for any files you're working with,
+     * any filesystem operation will automatically acquire the relevant locks for that operation.
+     *
+     * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
+     * @throws \OCP\Lock\LockedException
+     * @since 9.1.0
+     */
+    public function lock($type);
 
-	/**
-	 * Check the type of an existing lock.
-	 *
-	 * A shared lock can be changed to an exclusive lock is there is exactly one shared lock on the file,
-	 * an exclusive lock can always be changed to a shared lock since there can only be one exclusive lock int he first place.
-	 *
-	 * A locked exception will be thrown when these preconditions are not met.
-	 * Note that this is also the case if no existing lock exists for the file.
-	 *
-	 * @param int $targetType \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
-	 * @throws \OCP\Lock\LockedException
-	 * @since 9.1.0
-	 */
-	public function changeLock($targetType);
+    /**
+     * Check the type of an existing lock.
+     *
+     * A shared lock can be changed to an exclusive lock is there is exactly one shared lock on the file,
+     * an exclusive lock can always be changed to a shared lock since there can only be one exclusive lock int he first place.
+     *
+     * A locked exception will be thrown when these preconditions are not met.
+     * Note that this is also the case if no existing lock exists for the file.
+     *
+     * @param int $targetType \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
+     * @throws \OCP\Lock\LockedException
+     * @since 9.1.0
+     */
+    public function changeLock($targetType);
 
-	/**
-	 * Release an existing lock.
-	 *
-	 * This will also free up the shared locks on any parent folder that were automatically acquired when locking the file.
-	 *
-	 * Note that this method will not give any sort of error when trying to free a lock that doesn't exist.
-	 *
-	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
-	 * @throws \OCP\Lock\LockedException
-	 * @since 9.1.0
-	 */
-	public function unlock($type);
+    /**
+     * Release an existing lock.
+     *
+     * This will also free up the shared locks on any parent folder that were automatically acquired when locking the file.
+     *
+     * Note that this method will not give any sort of error when trying to free a lock that doesn't exist.
+     *
+     * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
+     * @throws \OCP\Lock\LockedException
+     * @since 9.1.0
+     */
+    public function unlock($type);
 }

lib/public/Files/StorageBadConfigException.php

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

Indentation +8 added lines, -8 removed lines

@@ -34,13 +34,13 @@
  */
 interface IRootFolder extends Folder, Emitter {
 
-	/**
-	 * Returns a view to user's files folder
-	 *
-	 * @param String $userId user ID
-	 * @return \OCP\Files\Folder
-	 * @since 8.2.0
-	 */
-	public function getUserFolder($userId);
+    /**
+     * Returns a view to user's files folder
+     *
+     * @param String $userId user ID
+     * @return \OCP\Files\Folder
+     * @since 8.2.0
+     */
+    public function getUserFolder($userId);
 }
 

lib/public/Files/StorageTimeoutException.php

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