@@ -31,77 +31,77 @@ |
||
| 31 | 31 | */ |
| 32 | 32 | interface IMountManager { |
| 33 | 33 | |
| 34 | - /** |
|
| 35 | - * Add a new mount |
|
| 36 | - * |
|
| 37 | - * @param \OCP\Files\Mount\IMountPoint $mount |
|
| 38 | - * @since 8.2.0 |
|
| 39 | - */ |
|
| 40 | - public function addMount(IMountPoint $mount); |
|
| 34 | + /** |
|
| 35 | + * Add a new mount |
|
| 36 | + * |
|
| 37 | + * @param \OCP\Files\Mount\IMountPoint $mount |
|
| 38 | + * @since 8.2.0 |
|
| 39 | + */ |
|
| 40 | + public function addMount(IMountPoint $mount); |
|
| 41 | 41 | |
| 42 | - /** |
|
| 43 | - * Remove a mount |
|
| 44 | - * |
|
| 45 | - * @param string $mountPoint |
|
| 46 | - * @since 8.2.0 |
|
| 47 | - */ |
|
| 48 | - public function removeMount($mountPoint); |
|
| 42 | + /** |
|
| 43 | + * Remove a mount |
|
| 44 | + * |
|
| 45 | + * @param string $mountPoint |
|
| 46 | + * @since 8.2.0 |
|
| 47 | + */ |
|
| 48 | + public function removeMount($mountPoint); |
|
| 49 | 49 | |
| 50 | - /** |
|
| 51 | - * Change the location of a mount |
|
| 52 | - * |
|
| 53 | - * @param string $mountPoint |
|
| 54 | - * @param string $target |
|
| 55 | - * @since 8.2.0 |
|
| 56 | - */ |
|
| 57 | - public function moveMount($mountPoint, $target); |
|
| 50 | + /** |
|
| 51 | + * Change the location of a mount |
|
| 52 | + * |
|
| 53 | + * @param string $mountPoint |
|
| 54 | + * @param string $target |
|
| 55 | + * @since 8.2.0 |
|
| 56 | + */ |
|
| 57 | + public function moveMount($mountPoint, $target); |
|
| 58 | 58 | |
| 59 | - /** |
|
| 60 | - * Find the mount for $path |
|
| 61 | - * |
|
| 62 | - * @param string $path |
|
| 63 | - * @return \OCP\Files\Mount\IMountPoint |
|
| 64 | - * @since 8.2.0 |
|
| 65 | - */ |
|
| 66 | - public function find($path); |
|
| 59 | + /** |
|
| 60 | + * Find the mount for $path |
|
| 61 | + * |
|
| 62 | + * @param string $path |
|
| 63 | + * @return \OCP\Files\Mount\IMountPoint |
|
| 64 | + * @since 8.2.0 |
|
| 65 | + */ |
|
| 66 | + public function find($path); |
|
| 67 | 67 | |
| 68 | - /** |
|
| 69 | - * Find all mounts in $path |
|
| 70 | - * |
|
| 71 | - * @param string $path |
|
| 72 | - * @return \OCP\Files\Mount\IMountPoint[] |
|
| 73 | - * @since 8.2.0 |
|
| 74 | - */ |
|
| 75 | - public function findIn($path); |
|
| 68 | + /** |
|
| 69 | + * Find all mounts in $path |
|
| 70 | + * |
|
| 71 | + * @param string $path |
|
| 72 | + * @return \OCP\Files\Mount\IMountPoint[] |
|
| 73 | + * @since 8.2.0 |
|
| 74 | + */ |
|
| 75 | + public function findIn($path); |
|
| 76 | 76 | |
| 77 | - /** |
|
| 78 | - * Remove all registered mounts |
|
| 79 | - * |
|
| 80 | - * @since 8.2.0 |
|
| 81 | - */ |
|
| 82 | - public function clear(); |
|
| 77 | + /** |
|
| 78 | + * Remove all registered mounts |
|
| 79 | + * |
|
| 80 | + * @since 8.2.0 |
|
| 81 | + */ |
|
| 82 | + public function clear(); |
|
| 83 | 83 | |
| 84 | - /** |
|
| 85 | - * Find mounts by storage id |
|
| 86 | - * |
|
| 87 | - * @param string $id |
|
| 88 | - * @return \OCP\Files\Mount\IMountPoint[] |
|
| 89 | - * @since 8.2.0 |
|
| 90 | - */ |
|
| 91 | - public function findByStorageId($id); |
|
| 84 | + /** |
|
| 85 | + * Find mounts by storage id |
|
| 86 | + * |
|
| 87 | + * @param string $id |
|
| 88 | + * @return \OCP\Files\Mount\IMountPoint[] |
|
| 89 | + * @since 8.2.0 |
|
| 90 | + */ |
|
| 91 | + public function findByStorageId($id); |
|
| 92 | 92 | |
| 93 | - /** |
|
| 94 | - * @return \OCP\Files\Mount\IMountPoint[] |
|
| 95 | - * @since 8.2.0 |
|
| 96 | - */ |
|
| 97 | - public function getAll(); |
|
| 93 | + /** |
|
| 94 | + * @return \OCP\Files\Mount\IMountPoint[] |
|
| 95 | + * @since 8.2.0 |
|
| 96 | + */ |
|
| 97 | + public function getAll(); |
|
| 98 | 98 | |
| 99 | - /** |
|
| 100 | - * Find mounts by numeric storage id |
|
| 101 | - * |
|
| 102 | - * @param int $id |
|
| 103 | - * @return \OCP\Files\Mount\IMountPoint[] |
|
| 104 | - * @since 8.2.0 |
|
| 105 | - */ |
|
| 106 | - public function findByNumericId($id); |
|
| 99 | + /** |
|
| 100 | + * Find mounts by numeric storage id |
|
| 101 | + * |
|
| 102 | + * @param int $id |
|
| 103 | + * @return \OCP\Files\Mount\IMountPoint[] |
|
| 104 | + * @since 8.2.0 |
|
| 105 | + */ |
|
| 106 | + public function findByNumericId($id); |
|
| 107 | 107 | } |
@@ -32,25 +32,25 @@ |
||
| 32 | 32 | */ |
| 33 | 33 | class ForbiddenException extends \Exception { |
| 34 | 34 | |
| 35 | - /** @var bool */ |
|
| 36 | - private $retry; |
|
| 35 | + /** @var bool */ |
|
| 36 | + private $retry; |
|
| 37 | 37 | |
| 38 | - /** |
|
| 39 | - * @param string $message |
|
| 40 | - * @param bool $retry |
|
| 41 | - * @param \Exception $previous previous exception for cascading |
|
| 42 | - * @since 9.0.0 |
|
| 43 | - */ |
|
| 44 | - public function __construct($message, $retry, \Exception $previous = null) { |
|
| 45 | - parent::__construct($message, 0, $previous); |
|
| 46 | - $this->retry = $retry; |
|
| 47 | - } |
|
| 38 | + /** |
|
| 39 | + * @param string $message |
|
| 40 | + * @param bool $retry |
|
| 41 | + * @param \Exception $previous previous exception for cascading |
|
| 42 | + * @since 9.0.0 |
|
| 43 | + */ |
|
| 44 | + public function __construct($message, $retry, \Exception $previous = null) { |
|
| 45 | + parent::__construct($message, 0, $previous); |
|
| 46 | + $this->retry = $retry; |
|
| 47 | + } |
|
| 48 | 48 | |
| 49 | - /** |
|
| 50 | - * @return bool |
|
| 51 | - * @since 9.0.0 |
|
| 52 | - */ |
|
| 53 | - public function getRetry() { |
|
| 54 | - return (bool) $this->retry; |
|
| 55 | - } |
|
| 49 | + /** |
|
| 50 | + * @return bool |
|
| 51 | + * @since 9.0.0 |
|
| 52 | + */ |
|
| 53 | + public function getRetry() { |
|
| 54 | + return (bool) $this->retry; |
|
| 55 | + } |
|
| 56 | 56 | } |
@@ -34,46 +34,46 @@ |
||
| 34 | 34 | **/ |
| 35 | 35 | interface IMimeTypeDetector { |
| 36 | 36 | |
| 37 | - /** |
|
| 38 | - * detect mimetype only based on filename, content of file is not used |
|
| 39 | - * @param string $path |
|
| 40 | - * @return string |
|
| 41 | - * @since 8.2.0 |
|
| 42 | - **/ |
|
| 43 | - public function detectPath($path); |
|
| 37 | + /** |
|
| 38 | + * detect mimetype only based on filename, content of file is not used |
|
| 39 | + * @param string $path |
|
| 40 | + * @return string |
|
| 41 | + * @since 8.2.0 |
|
| 42 | + **/ |
|
| 43 | + public function detectPath($path); |
|
| 44 | 44 | |
| 45 | - /** |
|
| 46 | - * detect mimetype based on both filename and content |
|
| 47 | - * |
|
| 48 | - * @param string $path |
|
| 49 | - * @return string |
|
| 50 | - * @since 8.2.0 |
|
| 51 | - */ |
|
| 52 | - public function detect($path); |
|
| 45 | + /** |
|
| 46 | + * detect mimetype based on both filename and content |
|
| 47 | + * |
|
| 48 | + * @param string $path |
|
| 49 | + * @return string |
|
| 50 | + * @since 8.2.0 |
|
| 51 | + */ |
|
| 52 | + public function detect($path); |
|
| 53 | 53 | |
| 54 | - /** |
|
| 55 | - * Get a secure mimetype that won't expose potential XSS. |
|
| 56 | - * |
|
| 57 | - * @param string $mimeType |
|
| 58 | - * @return string |
|
| 59 | - * @since 8.2.0 |
|
| 60 | - */ |
|
| 61 | - public function getSecureMimeType($mimeType); |
|
| 54 | + /** |
|
| 55 | + * Get a secure mimetype that won't expose potential XSS. |
|
| 56 | + * |
|
| 57 | + * @param string $mimeType |
|
| 58 | + * @return string |
|
| 59 | + * @since 8.2.0 |
|
| 60 | + */ |
|
| 61 | + public function getSecureMimeType($mimeType); |
|
| 62 | 62 | |
| 63 | - /** |
|
| 64 | - * detect mimetype based on the content of a string |
|
| 65 | - * |
|
| 66 | - * @param string $data |
|
| 67 | - * @return string |
|
| 68 | - * @since 8.2.0 |
|
| 69 | - */ |
|
| 70 | - public function detectString($data); |
|
| 63 | + /** |
|
| 64 | + * detect mimetype based on the content of a string |
|
| 65 | + * |
|
| 66 | + * @param string $data |
|
| 67 | + * @return string |
|
| 68 | + * @since 8.2.0 |
|
| 69 | + */ |
|
| 70 | + public function detectString($data); |
|
| 71 | 71 | |
| 72 | - /** |
|
| 73 | - * Get path to the icon of a file type |
|
| 74 | - * @param string $mimeType the MIME type |
|
| 75 | - * @return string the url |
|
| 76 | - * @since 8.2.0 |
|
| 77 | - */ |
|
| 78 | - public function mimeTypeIcon($mimeType); |
|
| 72 | + /** |
|
| 73 | + * Get path to the icon of a file type |
|
| 74 | + * @param string $mimeType the MIME type |
|
| 75 | + * @return string the url |
|
| 76 | + * @since 8.2.0 |
|
| 77 | + */ |
|
| 78 | + public function mimeTypeIcon($mimeType); |
|
| 79 | 79 | } |
@@ -31,13 +31,13 @@ |
||
| 31 | 31 | * @since 8.0.0 |
| 32 | 32 | */ |
| 33 | 33 | interface IMountProvider { |
| 34 | - /** |
|
| 35 | - * Get all mountpoints applicable for the user |
|
| 36 | - * |
|
| 37 | - * @param \OCP\IUser $user |
|
| 38 | - * @param \OCP\Files\Storage\IStorageFactory $loader |
|
| 39 | - * @return \OCP\Files\Mount\IMountPoint[] |
|
| 40 | - * @since 8.0.0 |
|
| 41 | - */ |
|
| 42 | - public function getMountsForUser(IUser $user, IStorageFactory $loader); |
|
| 34 | + /** |
|
| 35 | + * Get all mountpoints applicable for the user |
|
| 36 | + * |
|
| 37 | + * @param \OCP\IUser $user |
|
| 38 | + * @param \OCP\Files\Storage\IStorageFactory $loader |
|
| 39 | + * @return \OCP\Files\Mount\IMountPoint[] |
|
| 40 | + * @since 8.0.0 |
|
| 41 | + */ |
|
| 42 | + public function getMountsForUser(IUser $user, IStorageFactory $loader); |
|
| 43 | 43 | } |
@@ -31,45 +31,45 @@ |
||
| 31 | 31 | * @since 8.0.0 |
| 32 | 32 | */ |
| 33 | 33 | interface IMountProviderCollection { |
| 34 | - /** |
|
| 35 | - * Get all configured mount points for the user |
|
| 36 | - * |
|
| 37 | - * @param \OCP\IUser $user |
|
| 38 | - * @return \OCP\Files\Mount\IMountPoint[] |
|
| 39 | - * @since 8.0.0 |
|
| 40 | - */ |
|
| 41 | - public function getMountsForUser(IUser $user); |
|
| 34 | + /** |
|
| 35 | + * Get all configured mount points for the user |
|
| 36 | + * |
|
| 37 | + * @param \OCP\IUser $user |
|
| 38 | + * @return \OCP\Files\Mount\IMountPoint[] |
|
| 39 | + * @since 8.0.0 |
|
| 40 | + */ |
|
| 41 | + public function getMountsForUser(IUser $user); |
|
| 42 | 42 | |
| 43 | - /** |
|
| 44 | - * Get the configured home mount for this user |
|
| 45 | - * |
|
| 46 | - * @param \OCP\IUser $user |
|
| 47 | - * @return \OCP\Files\Mount\IMountPoint |
|
| 48 | - * @since 9.1.0 |
|
| 49 | - */ |
|
| 50 | - public function getHomeMountForUser(IUser $user); |
|
| 43 | + /** |
|
| 44 | + * Get the configured home mount for this user |
|
| 45 | + * |
|
| 46 | + * @param \OCP\IUser $user |
|
| 47 | + * @return \OCP\Files\Mount\IMountPoint |
|
| 48 | + * @since 9.1.0 |
|
| 49 | + */ |
|
| 50 | + public function getHomeMountForUser(IUser $user); |
|
| 51 | 51 | |
| 52 | - /** |
|
| 53 | - * Add a provider for mount points |
|
| 54 | - * |
|
| 55 | - * @param \OCP\Files\Config\IMountProvider $provider |
|
| 56 | - * @since 8.0.0 |
|
| 57 | - */ |
|
| 58 | - public function registerProvider(IMountProvider $provider); |
|
| 52 | + /** |
|
| 53 | + * Add a provider for mount points |
|
| 54 | + * |
|
| 55 | + * @param \OCP\Files\Config\IMountProvider $provider |
|
| 56 | + * @since 8.0.0 |
|
| 57 | + */ |
|
| 58 | + public function registerProvider(IMountProvider $provider); |
|
| 59 | 59 | |
| 60 | - /** |
|
| 61 | - * Add a provider for home mount points |
|
| 62 | - * |
|
| 63 | - * @param \OCP\Files\Config\IHomeMountProvider $provider |
|
| 64 | - * @since 9.1.0 |
|
| 65 | - */ |
|
| 66 | - public function registerHomeProvider(IHomeMountProvider $provider); |
|
| 60 | + /** |
|
| 61 | + * Add a provider for home mount points |
|
| 62 | + * |
|
| 63 | + * @param \OCP\Files\Config\IHomeMountProvider $provider |
|
| 64 | + * @since 9.1.0 |
|
| 65 | + */ |
|
| 66 | + public function registerHomeProvider(IHomeMountProvider $provider); |
|
| 67 | 67 | |
| 68 | - /** |
|
| 69 | - * Get the mount cache which can be used to search for mounts without setting up the filesystem |
|
| 70 | - * |
|
| 71 | - * @return IUserMountCache |
|
| 72 | - * @since 9.0.0 |
|
| 73 | - */ |
|
| 74 | - public function getMountCache(); |
|
| 68 | + /** |
|
| 69 | + * Get the mount cache which can be used to search for mounts without setting up the filesystem |
|
| 70 | + * |
|
| 71 | + * @return IUserMountCache |
|
| 72 | + * @since 9.0.0 |
|
| 73 | + */ |
|
| 74 | + public function getMountCache(); |
|
| 75 | 75 | } |
@@ -31,75 +31,75 @@ |
||
| 31 | 31 | * @since 9.0.0 |
| 32 | 32 | */ |
| 33 | 33 | interface IUserMountCache { |
| 34 | - /** |
|
| 35 | - * Register mounts for a user to the cache |
|
| 36 | - * |
|
| 37 | - * @param IUser $user |
|
| 38 | - * @param IMountPoint[] $mounts |
|
| 39 | - * @since 9.0.0 |
|
| 40 | - */ |
|
| 41 | - public function registerMounts(IUser $user, array $mounts); |
|
| 34 | + /** |
|
| 35 | + * Register mounts for a user to the cache |
|
| 36 | + * |
|
| 37 | + * @param IUser $user |
|
| 38 | + * @param IMountPoint[] $mounts |
|
| 39 | + * @since 9.0.0 |
|
| 40 | + */ |
|
| 41 | + public function registerMounts(IUser $user, array $mounts); |
|
| 42 | 42 | |
| 43 | - /** |
|
| 44 | - * Get all cached mounts for a user |
|
| 45 | - * |
|
| 46 | - * @param IUser $user |
|
| 47 | - * @return ICachedMountInfo[] |
|
| 48 | - * @since 9.0.0 |
|
| 49 | - */ |
|
| 50 | - public function getMountsForUser(IUser $user); |
|
| 43 | + /** |
|
| 44 | + * Get all cached mounts for a user |
|
| 45 | + * |
|
| 46 | + * @param IUser $user |
|
| 47 | + * @return ICachedMountInfo[] |
|
| 48 | + * @since 9.0.0 |
|
| 49 | + */ |
|
| 50 | + public function getMountsForUser(IUser $user); |
|
| 51 | 51 | |
| 52 | - /** |
|
| 53 | - * Get all cached mounts by storage |
|
| 54 | - * |
|
| 55 | - * @param int $numericStorageId |
|
| 56 | - * @return ICachedMountInfo[] |
|
| 57 | - * @since 9.0.0 |
|
| 58 | - */ |
|
| 59 | - public function getMountsForStorageId($numericStorageId); |
|
| 52 | + /** |
|
| 53 | + * Get all cached mounts by storage |
|
| 54 | + * |
|
| 55 | + * @param int $numericStorageId |
|
| 56 | + * @return ICachedMountInfo[] |
|
| 57 | + * @since 9.0.0 |
|
| 58 | + */ |
|
| 59 | + public function getMountsForStorageId($numericStorageId); |
|
| 60 | 60 | |
| 61 | - /** |
|
| 62 | - * Get all cached mounts by root |
|
| 63 | - * |
|
| 64 | - * @param int $rootFileId |
|
| 65 | - * @return ICachedMountInfo[] |
|
| 66 | - * @since 9.0.0 |
|
| 67 | - */ |
|
| 68 | - public function getMountsForRootId($rootFileId); |
|
| 61 | + /** |
|
| 62 | + * Get all cached mounts by root |
|
| 63 | + * |
|
| 64 | + * @param int $rootFileId |
|
| 65 | + * @return ICachedMountInfo[] |
|
| 66 | + * @since 9.0.0 |
|
| 67 | + */ |
|
| 68 | + public function getMountsForRootId($rootFileId); |
|
| 69 | 69 | |
| 70 | - /** |
|
| 71 | - * Get all cached mounts that contain a file |
|
| 72 | - * |
|
| 73 | - * @param int $fileId |
|
| 74 | - * @return ICachedMountInfo[] |
|
| 75 | - * @since 9.0.0 |
|
| 76 | - */ |
|
| 77 | - public function getMountsForFileId($fileId); |
|
| 70 | + /** |
|
| 71 | + * Get all cached mounts that contain a file |
|
| 72 | + * |
|
| 73 | + * @param int $fileId |
|
| 74 | + * @return ICachedMountInfo[] |
|
| 75 | + * @since 9.0.0 |
|
| 76 | + */ |
|
| 77 | + public function getMountsForFileId($fileId); |
|
| 78 | 78 | |
| 79 | - /** |
|
| 80 | - * Remove all cached mounts for a user |
|
| 81 | - * |
|
| 82 | - * @param IUser $user |
|
| 83 | - * @since 9.0.0 |
|
| 84 | - */ |
|
| 85 | - public function removeUserMounts(IUser $user); |
|
| 79 | + /** |
|
| 80 | + * Remove all cached mounts for a user |
|
| 81 | + * |
|
| 82 | + * @param IUser $user |
|
| 83 | + * @since 9.0.0 |
|
| 84 | + */ |
|
| 85 | + public function removeUserMounts(IUser $user); |
|
| 86 | 86 | |
| 87 | - /** |
|
| 88 | - * Remove all mounts for a user and storage |
|
| 89 | - * |
|
| 90 | - * @param $storageId |
|
| 91 | - * @param string $userId |
|
| 92 | - * @return mixed |
|
| 93 | - * @since 9.0.0 |
|
| 94 | - */ |
|
| 95 | - public function removeUserStorageMount($storageId, $userId); |
|
| 87 | + /** |
|
| 88 | + * Remove all mounts for a user and storage |
|
| 89 | + * |
|
| 90 | + * @param $storageId |
|
| 91 | + * @param string $userId |
|
| 92 | + * @return mixed |
|
| 93 | + * @since 9.0.0 |
|
| 94 | + */ |
|
| 95 | + public function removeUserStorageMount($storageId, $userId); |
|
| 96 | 96 | |
| 97 | - /** |
|
| 98 | - * Remove all cached mounts for a storage |
|
| 99 | - * |
|
| 100 | - * @param $storageId |
|
| 101 | - * @return mixed |
|
| 102 | - * @since 9.0.0 |
|
| 103 | - */ |
|
| 104 | - public function remoteStorageMounts($storageId); |
|
| 97 | + /** |
|
| 98 | + * Remove all cached mounts for a storage |
|
| 99 | + * |
|
| 100 | + * @param $storageId |
|
| 101 | + * @return mixed |
|
| 102 | + * @since 9.0.0 |
|
| 103 | + */ |
|
| 104 | + public function remoteStorageMounts($storageId); |
|
| 105 | 105 | } |
@@ -31,13 +31,13 @@ |
||
| 31 | 31 | * @since 9.1.0 |
| 32 | 32 | */ |
| 33 | 33 | interface IHomeMountProvider { |
| 34 | - /** |
|
| 35 | - * Get all mountpoints applicable for the user |
|
| 36 | - * |
|
| 37 | - * @param \OCP\IUser $user |
|
| 38 | - * @param \OCP\Files\Storage\IStorageFactory $loader |
|
| 39 | - * @return \OCP\Files\Mount\IMountPoint|null |
|
| 40 | - * @since 9.1.0 |
|
| 41 | - */ |
|
| 42 | - public function getHomeMountForUser(IUser $user, IStorageFactory $loader); |
|
| 34 | + /** |
|
| 35 | + * Get all mountpoints applicable for the user |
|
| 36 | + * |
|
| 37 | + * @param \OCP\IUser $user |
|
| 38 | + * @param \OCP\Files\Storage\IStorageFactory $loader |
|
| 39 | + * @return \OCP\Files\Mount\IMountPoint|null |
|
| 40 | + * @since 9.1.0 |
|
| 41 | + */ |
|
| 42 | + public function getHomeMountForUser(IUser $user, IStorageFactory $loader); |
|
| 43 | 43 | } |
@@ -30,34 +30,34 @@ |
||
| 30 | 30 | */ |
| 31 | 31 | interface IObjectStore { |
| 32 | 32 | |
| 33 | - /** |
|
| 34 | - * @return string the container or bucket name where objects are stored |
|
| 35 | - * @since 7.0.0 |
|
| 36 | - */ |
|
| 37 | - function getStorageId(); |
|
| 33 | + /** |
|
| 34 | + * @return string the container or bucket name where objects are stored |
|
| 35 | + * @since 7.0.0 |
|
| 36 | + */ |
|
| 37 | + function getStorageId(); |
|
| 38 | 38 | |
| 39 | - /** |
|
| 40 | - * @param string $urn the unified resource name used to identify the object |
|
| 41 | - * @return resource stream with the read data |
|
| 42 | - * @throws \Exception when something goes wrong, message will be logged |
|
| 43 | - * @since 7.0.0 |
|
| 44 | - */ |
|
| 45 | - function readObject($urn); |
|
| 39 | + /** |
|
| 40 | + * @param string $urn the unified resource name used to identify the object |
|
| 41 | + * @return resource stream with the read data |
|
| 42 | + * @throws \Exception when something goes wrong, message will be logged |
|
| 43 | + * @since 7.0.0 |
|
| 44 | + */ |
|
| 45 | + function readObject($urn); |
|
| 46 | 46 | |
| 47 | - /** |
|
| 48 | - * @param string $urn the unified resource name used to identify the object |
|
| 49 | - * @param resource $stream stream with the data to write |
|
| 50 | - * @throws \Exception when something goes wrong, message will be logged |
|
| 51 | - * @since 7.0.0 |
|
| 52 | - */ |
|
| 53 | - function writeObject($urn, $stream); |
|
| 47 | + /** |
|
| 48 | + * @param string $urn the unified resource name used to identify the object |
|
| 49 | + * @param resource $stream stream with the data to write |
|
| 50 | + * @throws \Exception when something goes wrong, message will be logged |
|
| 51 | + * @since 7.0.0 |
|
| 52 | + */ |
|
| 53 | + function writeObject($urn, $stream); |
|
| 54 | 54 | |
| 55 | - /** |
|
| 56 | - * @param string $urn the unified resource name used to identify the object |
|
| 57 | - * @return void |
|
| 58 | - * @throws \Exception when something goes wrong, message will be logged |
|
| 59 | - * @since 7.0.0 |
|
| 60 | - */ |
|
| 61 | - function deleteObject($urn); |
|
| 55 | + /** |
|
| 56 | + * @param string $urn the unified resource name used to identify the object |
|
| 57 | + * @return void |
|
| 58 | + * @throws \Exception when something goes wrong, message will be logged |
|
| 59 | + * @since 7.0.0 |
|
| 60 | + */ |
|
| 61 | + function deleteObject($urn); |
|
| 62 | 62 | |
| 63 | 63 | } |
@@ -31,37 +31,37 @@ |
||
| 31 | 31 | **/ |
| 32 | 32 | interface IMimeTypeLoader { |
| 33 | 33 | |
| 34 | - /** |
|
| 35 | - * Get a mimetype from its ID |
|
| 36 | - * |
|
| 37 | - * @param int $id |
|
| 38 | - * @return string|null |
|
| 39 | - * @since 8.2.0 |
|
| 40 | - */ |
|
| 41 | - public function getMimetypeById($id); |
|
| 34 | + /** |
|
| 35 | + * Get a mimetype from its ID |
|
| 36 | + * |
|
| 37 | + * @param int $id |
|
| 38 | + * @return string|null |
|
| 39 | + * @since 8.2.0 |
|
| 40 | + */ |
|
| 41 | + public function getMimetypeById($id); |
|
| 42 | 42 | |
| 43 | - /** |
|
| 44 | - * Get a mimetype ID, adding the mimetype to the DB if it does not exist |
|
| 45 | - * |
|
| 46 | - * @param string $mimetype |
|
| 47 | - * @return int |
|
| 48 | - * @since 8.2.0 |
|
| 49 | - */ |
|
| 50 | - public function getId($mimetype); |
|
| 43 | + /** |
|
| 44 | + * Get a mimetype ID, adding the mimetype to the DB if it does not exist |
|
| 45 | + * |
|
| 46 | + * @param string $mimetype |
|
| 47 | + * @return int |
|
| 48 | + * @since 8.2.0 |
|
| 49 | + */ |
|
| 50 | + public function getId($mimetype); |
|
| 51 | 51 | |
| 52 | - /** |
|
| 53 | - * Test if a mimetype exists in the database |
|
| 54 | - * |
|
| 55 | - * @param string $mimetype |
|
| 56 | - * @return bool |
|
| 57 | - * @since 8.2.0 |
|
| 58 | - */ |
|
| 59 | - public function exists($mimetype); |
|
| 52 | + /** |
|
| 53 | + * Test if a mimetype exists in the database |
|
| 54 | + * |
|
| 55 | + * @param string $mimetype |
|
| 56 | + * @return bool |
|
| 57 | + * @since 8.2.0 |
|
| 58 | + */ |
|
| 59 | + public function exists($mimetype); |
|
| 60 | 60 | |
| 61 | - /** |
|
| 62 | - * Clear all loaded mimetypes, allow for re-loading |
|
| 63 | - * |
|
| 64 | - * @since 8.2.0 |
|
| 65 | - */ |
|
| 66 | - public function reset(); |
|
| 61 | + /** |
|
| 62 | + * Clear all loaded mimetypes, allow for re-loading |
|
| 63 | + * |
|
| 64 | + * @since 8.2.0 |
|
| 65 | + */ |
|
| 66 | + public function reset(); |
|
| 67 | 67 | } |