Const MAX_KEYS

utopia-php · Sep 18, 2023 · a4a19b9 · a4a19b9
1 parent c9e972e
commit a4a19b9
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 6 deletions.
diff --git a/src/Storage/Device.php b/src/Storage/Device.php
@@ -5,10 +5,15 @@
 abstract class Device
 {
     /**
-     * Max chunk size while transfering file from one device to another
+     * Max chunk size while transferring file from one device to another
      */
     protected int $transferChunkSize = 20000000; //20 MB
 
+    /**
+     * Sets the maximum number of keys returned to the response. By default, the action returns up to 1,000 key names.
+     */
+    protected const MAX_KEYS = 1000;
+
     /**
      * Set Transfer Chunk Size
      *
@@ -275,7 +280,7 @@ abstract public function getPartitionTotalSpace(): float;
      * @param string $continuationToken
      * @return array<mixed>
      */
-    abstract public function getFiles(string $dir, int $keys = 1000, string $continuationToken = ''): array;
+    abstract public function getFiles(string $dir, int $keys = self::MAX_KEYS, string $continuationToken = ''): array;
 
     /**
      * Get the absolute path by resolving strings like ../, .., //, /\ and so on.

diff --git a/src/Storage/Device/Local.php b/src/Storage/Device/Local.php
@@ -507,7 +507,7 @@ public function getPartitionTotalSpace(): float
      * @param  string  $dir Directory to scan
      * @return string[]
      */
-    public function getFiles(string $dir, int $keys = 1000, string $continuationToken = ''): array
+    public function getFiles(string $dir, int $keys = self::MAX_KEYS, string $continuationToken = ''): array
     {
         if (! (\str_ends_with($dir, DIRECTORY_SEPARATOR))) {
             $dir .= DIRECTORY_SEPARATOR;

diff --git a/src/Storage/Device/S3.php b/src/Storage/Device/S3.php
@@ -481,9 +481,9 @@ public function delete(string $path, bool $recursive = false): bool
      *
      * @throws Exception
      */
-    private function listObjects(string $prefix = '', int $maxKeys = 1000, string $continuationToken = ''): array
+    private function listObjects(string $prefix = '', int $maxKeys = self::MAX_KEYS, string $continuationToken = ''): array
     {
-        if($maxKeys > 1000){
+        if($maxKeys > self::MAX_KEYS){
             throw new Exception('max-keys limit is 1000');
         }
 
@@ -671,7 +671,7 @@ public function getPartitionTotalSpace(): float
      *
      * @throws Exception
      */
-    public function getFiles(string $dir, int $keys = 1000, string $continuationToken = ''): array
+    public function getFiles(string $dir, int $keys = self::MAX_KEYS, string $continuationToken = ''): array
     {
         $data = $this->listObjects($dir, $keys, $continuationToken);