aboutsummaryrefslogtreecommitdiffstats
path: root/lib/private/Files/ObjectStore
diff options
context:
space:
mode:
authorprovokateurin <kate@provokateurin.de>2024-09-06 09:44:04 +0200
committerprovokateurin <kate@provokateurin.de>2024-09-09 11:09:37 +0200
commit007be83a968e6aee649ff8de173163cb5ef93a86 (patch)
tree18e03c4a5562989bbd6482e9e6a47f3619b71e30 /lib/private/Files/ObjectStore
parentfc10fa592626d154a91d77d35c93beabdc7605c1 (diff)
downloadnextcloud-server-fix/oc/inheritdoc.tar.gz
nextcloud-server-fix/oc/inheritdoc.zip
fix(OC): Remove doc blocks for OCP implementationsfix/oc/inheritdoc
Signed-off-by: provokateurin <kate@provokateurin.de>
Diffstat (limited to 'lib/private/Files/ObjectStore')
-rw-r--r--lib/private/Files/ObjectStore/Azure.php13
-rw-r--r--lib/private/Files/ObjectStore/HomeObjectStoreStorage.php12
-rw-r--r--lib/private/Files/ObjectStore/ObjectStoreStorage.php23
-rw-r--r--lib/private/Files/ObjectStore/S3.php4
-rw-r--r--lib/private/Files/ObjectStore/StorageObjectStore.php16
-rw-r--r--lib/private/Files/ObjectStore/Swift.php14
6 files changed, 0 insertions, 82 deletions
diff --git a/lib/private/Files/ObjectStore/Azure.php b/lib/private/Files/ObjectStore/Azure.php
index 2dacdac1f8d..9359289da04 100644
--- a/lib/private/Files/ObjectStore/Azure.php
+++ b/lib/private/Files/ObjectStore/Azure.php
@@ -66,18 +66,10 @@ class Azure implements IObjectStore {
return $this->blobClient;
}
- /**
- * @return string the container or bucket name where objects are stored
- */
public function getStorageId() {
return 'azure::blob::' . $this->containerName;
}
- /**
- * @param string $urn the unified resource name used to identify the object
- * @return resource stream with the read data
- * @throws \Exception when something goes wrong, message will be logged
- */
public function readObject($urn) {
$blob = $this->getBlobClient()->getBlob($this->containerName, $urn);
return $blob->getContentStream();
@@ -91,11 +83,6 @@ class Azure implements IObjectStore {
$this->getBlobClient()->createBlockBlob($this->containerName, $urn, $stream, $options);
}
- /**
- * @param string $urn the unified resource name used to identify the object
- * @return void
- * @throws \Exception when something goes wrong, message will be logged
- */
public function deleteObject($urn) {
$this->getBlobClient()->deleteBlob($this->containerName, $urn);
}
diff --git a/lib/private/Files/ObjectStore/HomeObjectStoreStorage.php b/lib/private/Files/ObjectStore/HomeObjectStoreStorage.php
index b543d223f4c..daf6b5c83c9 100644
--- a/lib/private/Files/ObjectStore/HomeObjectStoreStorage.php
+++ b/lib/private/Files/ObjectStore/HomeObjectStoreStorage.php
@@ -14,12 +14,6 @@ use OCP\IUser;
class HomeObjectStoreStorage extends ObjectStoreStorage implements IHomeStorage {
protected IUser $user;
- /**
- * 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');
@@ -32,12 +26,6 @@ class HomeObjectStoreStorage extends ObjectStoreStorage implements IHomeStorage
return 'object::user:' . $this->user->getUID();
}
- /**
- * get the owner of a path
- *
- * @param string $path The path to get the owner
- * @return string uid
- */
public function getOwner($path): string {
return $this->user->getUID();
}
diff --git a/lib/private/Files/ObjectStore/ObjectStoreStorage.php b/lib/private/Files/ObjectStore/ObjectStoreStorage.php
index 228fc516677..8465ccede9d 100644
--- a/lib/private/Files/ObjectStore/ObjectStoreStorage.php
+++ b/lib/private/Files/ObjectStore/ObjectStoreStorage.php
@@ -38,10 +38,6 @@ class ObjectStoreStorage extends \OC\Files\Storage\Common implements IChunkedFil
private bool $handleCopiesAsOwned;
protected bool $validateWrites = true;
- /**
- * @param array $params
- * @throws \Exception
- */
public function __construct($params) {
if (isset($params['objectstore']) && $params['objectstore'] instanceof IObjectStore) {
$this->objectStore = $params['objectstore'];
@@ -126,14 +122,6 @@ class ObjectStoreStorage extends \OC\Files\Storage\Common implements IChunkedFil
return $path;
}
- /**
- * Object Stores use a NoopScanner because metadata is directly stored in
- * the file cache and cannot really scan the filesystem. The storage passed in is not used anywhere.
- *
- * @param string $path
- * @param \OC\Files\Storage\Storage (optional) the storage to pass to the scanner
- * @return \OC\Files\ObjectStore\ObjectStoreScanner
- */
public function getScanner($path = '', $storage = null) {
if (!$storage) {
$storage = $this;
@@ -446,13 +434,6 @@ class ObjectStoreStorage extends \OC\Files\Storage\Common implements IChunkedFil
$this->writeStream($path, fopen($tmpFile, 'r'), $size);
}
- /**
- * external changes are not supported, exclusive access to the object storage is assumed
- *
- * @param string $path
- * @param int $time
- * @return false
- */
public function hasUpdated($path, $time) {
return false;
}
@@ -686,10 +667,6 @@ class ObjectStoreStorage extends \OC\Files\Storage\Common implements IChunkedFil
return $this->objectStore->initiateMultipartUpload($urn);
}
- /**
- *
- * @throws GenericFileException
- */
public function putChunkedWritePart(
string $targetPath,
string $writeToken,
diff --git a/lib/private/Files/ObjectStore/S3.php b/lib/private/Files/ObjectStore/S3.php
index 72c19d951e4..63f2e53b5a8 100644
--- a/lib/private/Files/ObjectStore/S3.php
+++ b/lib/private/Files/ObjectStore/S3.php
@@ -19,10 +19,6 @@ class S3 implements IObjectStore, IObjectStoreMultiPartUpload {
$this->parseParams($parameters);
}
- /**
- * @return string the container or bucket name where objects are stored
- * @since 7.0.0
- */
public function getStorageId() {
return $this->id;
}
diff --git a/lib/private/Files/ObjectStore/StorageObjectStore.php b/lib/private/Files/ObjectStore/StorageObjectStore.php
index 5e7125e18a6..56f950dc09e 100644
--- a/lib/private/Files/ObjectStore/StorageObjectStore.php
+++ b/lib/private/Files/ObjectStore/StorageObjectStore.php
@@ -23,20 +23,10 @@ class StorageObjectStore implements IObjectStore {
$this->storage = $storage;
}
- /**
- * @return string the container or bucket name where objects are stored
- * @since 7.0.0
- */
public function getStorageId() {
$this->storage->getId();
}
- /**
- * @param string $urn the unified resource name used to identify the object
- * @return resource stream with the read data
- * @throws \Exception when something goes wrong, message will be logged
- * @since 7.0.0
- */
public function readObject($urn) {
$handle = $this->storage->fopen($urn, 'r');
if (is_resource($handle)) {
@@ -56,12 +46,6 @@ class StorageObjectStore implements IObjectStore {
}
}
- /**
- * @param string $urn the unified resource name used to identify the object
- * @return void
- * @throws \Exception when something goes wrong, message will be logged
- * @since 7.0.0
- */
public function deleteObject($urn) {
$this->storage->unlink($urn);
}
diff --git a/lib/private/Files/ObjectStore/Swift.php b/lib/private/Files/ObjectStore/Swift.php
index aa8b3bb34ec..857b9674a2c 100644
--- a/lib/private/Files/ObjectStore/Swift.php
+++ b/lib/private/Files/ObjectStore/Swift.php
@@ -45,9 +45,6 @@ class Swift implements IObjectStore {
return $this->swiftFactory->getContainer();
}
- /**
- * @return string the container name where objects are stored
- */
public function getStorageId() {
if (isset($this->params['bucket'])) {
return $this->params['bucket'];
@@ -77,12 +74,6 @@ class Swift implements IObjectStore {
}
}
- /**
- * @param string $urn the unified resource name used to identify the object
- * @return resource stream with the read data
- * @throws \Exception from openstack or GuzzleHttp libs when something goes wrong
- * @throws NotFoundException if file does not exist
- */
public function readObject($urn) {
try {
$publicUri = $this->getContainer()->getObject($urn)->getPublicUri();
@@ -108,11 +99,6 @@ class Swift implements IObjectStore {
return RetryWrapper::wrap($response->getBody()->detach());
}
- /**
- * @param string $urn Unified Resource Name
- * @return void
- * @throws \Exception from openstack lib when something goes wrong
- */
public function deleteObject($urn) {
$this->getContainer()->getObject($urn)->delete();
}