From 30798eb6c238a0090fd42d2b44644f4fc24d8c8d Mon Sep 17 00:00:00 2001 From: Thomas Citharel Date: Fri, 20 Oct 2023 09:08:08 +0200 Subject: [PATCH] refactor(objectstorage): cleanup types Signed-off-by: Thomas Citharel --- .../AppdataPreviewObjectStoreStorage.php | 9 ++++++--- .../Files/ObjectStore/HomeObjectStoreStorage.php | 16 ++++++++-------- .../Files/ObjectStore/ObjectStoreStorage.php | 11 +++++++---- .../ObjectStore/ObjectStoreStorageOverwrite.php | 4 ++-- 4 files changed, 23 insertions(+), 17 deletions(-) diff --git a/lib/private/Files/ObjectStore/AppdataPreviewObjectStoreStorage.php b/lib/private/Files/ObjectStore/AppdataPreviewObjectStoreStorage.php index 2f6db935236af..2c473cb6da95b 100644 --- a/lib/private/Files/ObjectStore/AppdataPreviewObjectStoreStorage.php +++ b/lib/private/Files/ObjectStore/AppdataPreviewObjectStoreStorage.php @@ -26,9 +26,12 @@ namespace OC\Files\ObjectStore; class AppdataPreviewObjectStoreStorage extends ObjectStoreStorage { - /** @var string */ - private $internalId; + private string $internalId; + /** + * @param array $params + * @throws \Exception + */ public function __construct($params) { if (!isset($params['internal-id'])) { throw new \Exception('missing id in parameters'); @@ -37,7 +40,7 @@ public function __construct($params) { parent::__construct($params); } - public function getId() { + public function getId(): string { return 'object::appdata::preview:' . $this->internalId; } } diff --git a/lib/private/Files/ObjectStore/HomeObjectStoreStorage.php b/lib/private/Files/ObjectStore/HomeObjectStoreStorage.php index feceb706e19df..443c5147742c8 100644 --- a/lib/private/Files/ObjectStore/HomeObjectStoreStorage.php +++ b/lib/private/Files/ObjectStore/HomeObjectStoreStorage.php @@ -26,6 +26,7 @@ */ namespace OC\Files\ObjectStore; +use Exception; use OCP\Files\IHomeStorage; use OCP\IUser; @@ -34,17 +35,19 @@ class HomeObjectStoreStorage extends ObjectStoreStorage implements IHomeStorage /** * The home user storage requires a user object to create a unique storage id + * * @param array $params + * @throws Exception */ public function __construct($params) { if (! isset($params['user']) || ! $params['user'] instanceof IUser) { - throw new \Exception('missing user object in parameters'); + throw new Exception('missing user object in parameters'); } $this->user = $params['user']; parent::__construct($params); } - public function getId() { + public function getId(): string { return 'object::user:' . $this->user->getUID(); } @@ -52,13 +55,10 @@ public function getId() { * get the owner of a path * * @param string $path The path to get the owner - * @return false|string uid + * @return string uid */ - public function getOwner($path) { - if (is_object($this->user)) { - return $this->user->getUID(); - } - return false; + public function getOwner($path): string { + return $this->user->getUID(); } public function getUser(): IUser { diff --git a/lib/private/Files/ObjectStore/ObjectStoreStorage.php b/lib/private/Files/ObjectStore/ObjectStoreStorage.php index 5c2881bef0f41..3e0fbd1591956 100644 --- a/lib/private/Files/ObjectStore/ObjectStoreStorage.php +++ b/lib/private/Files/ObjectStore/ObjectStoreStorage.php @@ -47,6 +47,7 @@ use OCP\Files\ObjectStore\IObjectStoreMultiPartUpload; use OCP\Files\Storage\IChunkedFileWrite; use OCP\Files\Storage\IStorage; +use OCP\ILogger; class ObjectStoreStorage extends \OC\Files\Storage\Common implements IChunkedFileWrite { use CopyDirectory; @@ -55,13 +56,15 @@ class ObjectStoreStorage extends \OC\Files\Storage\Common implements IChunkedFil protected string $id; private string $objectPrefix = 'urn:oid:'; - private $logger; + private ILogger $logger; private bool $handleCopiesAsOwned; + protected bool $validateWrites = true; - /** @var bool */ - protected $validateWrites = true; - + /** + * @param array $params + * @throws \Exception + */ public function __construct($params) { if (isset($params['objectstore']) && $params['objectstore'] instanceof IObjectStore) { $this->objectStore = $params['objectstore']; diff --git a/tests/lib/Files/ObjectStore/ObjectStoreStorageOverwrite.php b/tests/lib/Files/ObjectStore/ObjectStoreStorageOverwrite.php index b85f6289c9485..9c3981315359b 100644 --- a/tests/lib/Files/ObjectStore/ObjectStoreStorageOverwrite.php +++ b/tests/lib/Files/ObjectStore/ObjectStoreStorageOverwrite.php @@ -30,7 +30,7 @@ * Allow overwriting the object store instance for test purposes */ class ObjectStoreStorageOverwrite extends ObjectStoreStorage { - public function setObjectStore(IObjectStore $objectStore) { + public function setObjectStore(IObjectStore $objectStore): void { $this->objectStore = $objectStore; } @@ -38,7 +38,7 @@ public function getObjectStore(): IObjectStore { return $this->objectStore; } - public function setValidateWrites(bool $validate) { + public function setValidateWrites(bool $validate): void { $this->validateWrites = $validate; } }