Skip to content

Commit

Permalink
refactor(objectstorage): cleanup types
Browse files Browse the repository at this point in the history
Signed-off-by: Thomas Citharel <tcit@tcit.fr>
  • Loading branch information
tcitworld committed Feb 1, 2024
1 parent 72999b4 commit e7b709d
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 17 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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');
Expand All @@ -37,7 +40,7 @@ public function __construct($params) {
parent::__construct($params);
}

public function getId() {
public function getId(): string {
return 'object::appdata::preview:' . $this->internalId;
}
}
16 changes: 8 additions & 8 deletions lib/private/Files/ObjectStore/HomeObjectStoreStorage.php
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
*/
namespace OC\Files\ObjectStore;

use Exception;
use OCP\Files\IHomeStorage;
use OCP\IUser;

Expand All @@ -34,31 +35,30 @@ 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();
}

/**
* 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 {
Expand Down
11 changes: 7 additions & 4 deletions lib/private/Files/ObjectStore/ObjectStoreStorage.php
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -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'];
Expand Down
4 changes: 2 additions & 2 deletions tests/lib/Files/ObjectStore/ObjectStoreStorageOverwrite.php
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,15 @@
* 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;
}

public function getObjectStore(): IObjectStore {
return $this->objectStore;
}

public function setValidateWrites(bool $validate) {
public function setValidateWrites(bool $validate): void {
$this->validateWrites = $validate;
}
}

0 comments on commit e7b709d

Please sign in to comment.