Add listAll() and search functionality

popphp · Oct 29, 2023 · 2e00b83 · 2e00b83
1 parent 2747eed
commit 2e00b83
Show file tree

Hide file tree

Showing 10 changed files with 199 additions and 21 deletions.
diff --git a/src/AbstractStorage.php b/src/AbstractStorage.php
@@ -122,19 +122,29 @@ abstract public function mkdir(string $directory): void;
      */
     abstract public function rmdir(string $directory): void;
 
+    /**
+     * List all
+     *
+     * @param  ?string $search
+     * @return array
+     */
+    abstract public function listAll(?string $search = null): array;
+
     /**
      * List directories
      *
+     * @param  ?string $search
      * @return array
      */
-    abstract public function listDirs(): array;
+    abstract public function listDirs(?string $search = null): array;
 
     /**
      * List files
      *
+     * @param  ?string $search
      * @return array
      */
-    abstract public function listFiles(): array;
+    abstract public function listFiles(?string $search = null): array;
 
     /**
      * Put file

diff --git a/src/Adapter/AbstractAdapter.php b/src/Adapter/AbstractAdapter.php
@@ -113,19 +113,32 @@ abstract public function mkdir(string $directory): void;
      */
     abstract public function rmdir(string $directory): void;
 
+    /**
+     * List all
+     *
+     * @param  ?string $search
+     * @return array
+     */
+    function listAll(?string $search = null): array
+    {
+        return array_merge($this->listDirs($search), $this->listFiles($search));
+    }
+
     /**
      * List directories
      *
+     * @param  ?string $search
      * @return array
      */
-    abstract public function listDirs(): array;
+    abstract public function listDirs(?string $search = null): array;
 
     /**
      * List files
      *
+     * @param  ?string $search
      * @return array
      */
-    abstract public function listFiles(): array;
+    abstract public function listFiles(?string $search = null): array;
 
     /**
      * Put file
@@ -314,4 +327,32 @@ protected function scrub(string $value): string
         return $value;
     }
 
+    /**
+     * Search and filter values
+     *
+     * @param  array  $objects
+     * @param  string $search
+     * @return array
+     */
+    protected function searchFilter(array $objects, string $search): array
+    {
+        if (str_starts_with($search, '*')) {
+            $search  = substr($search, 1);
+            $objects = array_filter($objects, function ($value) use ($search) {
+                return str_ends_with($value, $search);
+            });
+        } else if (str_ends_with($search, '*')) {
+            $search  = substr($search, 0, -1);
+            $objects = array_filter($objects, function ($value) use ($search) {
+                return str_starts_with($value, $search);
+            });
+        } else {
+            $objects = array_filter($objects, function ($value) use ($search) {
+                return ($value == $search);
+            });
+        }
+
+        return $objects;
+    }
+
 }
diff --git a/src/Adapter/Azure.php b/src/Adapter/Azure.php
@@ -197,9 +197,10 @@ public function rmdir(string $directory): void
     /**
      * List directories
      *
+     * @param  ?string $search
      * @return array
      */
-    public function listDirs(): array
+    public function listDirs(?string $search = null): array
     {
         $dirs = [];
 
@@ -248,15 +249,20 @@ public function listDirs(): array
             }
         }
 
+        if ($search !== null) {
+            $dirs = $this->searchFilter($dirs, $search);
+        }
+
         return $dirs;
     }
 
     /**
      * List files
      *
+     * @param  ?string $search
      * @return array
      */
-    public function listFiles(): array
+    public function listFiles(?string $search = null): array
     {
         $files = [];
 
@@ -290,6 +296,10 @@ public function listFiles(): array
             }
         }
 
+        if ($search !== null) {
+            $files = $this->searchFilter($files, $search);
+        }
+
         return $files;
     }
 

diff --git a/src/Adapter/Local.php b/src/Adapter/Local.php
@@ -56,29 +56,45 @@ public function rmdir(string $directory): void
     /**
      * List directories
      *
+     * @param  ?string $search
      * @return array
      */
-    public function listDirs(): array
+    public function listDirs(?string $search = null): array
     {
-        $directory = $this->directory;
-        return array_values(array_filter(scandir($directory), function($value) use ($directory) {
+        $directory   = $this->directory;
+        $directories =  array_map(function($value) {
+            return $value. DIRECTORY_SEPARATOR;
+        }, array_values(array_filter(scandir($directory), function($value) use ($directory) {
             return (($value != '.') && ($value != '..') && file_exists($directory . DIRECTORY_SEPARATOR . $value) &&
                 is_dir($directory . DIRECTORY_SEPARATOR . $value));
-        }));
+        })));
+
+        if ($search !== null) {
+            $directories = $this->searchFilter($directories, $search);
+        }
+
+        return $directories;
     }
 
     /**
      * List files
      *
+     * @param  ?string $search
      * @return array
      */
-    public function listFiles(): array
+    public function listFiles(?string $search = null): array
     {
         $directory = $this->directory;
-        return array_values(array_filter(scandir($directory), function($value) use ($directory) {
+        $files     = array_values(array_filter(scandir($directory), function($value) use ($directory) {
             return (($value != '.') && ($value != '..') && file_exists($directory . DIRECTORY_SEPARATOR . $value) &&
                 !is_dir($directory . DIRECTORY_SEPARATOR . $value) && is_file($directory . DIRECTORY_SEPARATOR . $value));
         }));
+
+        if ($search !== null) {
+            $files = $this->searchFilter($files, $search);
+        }
+
+        return $files;
     }
 
     /**

diff --git a/src/Adapter/S3.php b/src/Adapter/S3.php
@@ -125,9 +125,10 @@ public function rmdir(string $directory): void
     /**
      * List directories
      *
+     * @param  ?string $search
      * @return array
      */
-    public function listDirs(): array
+    public function listDirs(?string $search = null): array
     {
         $dirs   = [];
         $params = ['Bucket' => str_replace('s3://', '', $this->baseDirectory)];
@@ -148,16 +149,21 @@ public function listDirs(): array
             }
         }
 
+        if ($search !== null) {
+            $dirs = $this->searchFilter($dirs, $search);
+        }
+
         return $dirs;
 
     }
 
     /**
      * List files
      *
+     * @param  ?string $search
      * @return array
      */
-    public function listFiles(): array
+    public function listFiles(?string $search = null): array
     {
         $files   = [];
         $params  = ['Bucket' => str_replace('s3://', '', $this->baseDirectory), 'Delimiter' => '/'];
@@ -175,6 +181,10 @@ public function listFiles(): array
             }
         }
 
+        if ($search !== null) {
+            $files = $this->searchFilter($files, $search);
+        }
+
         return $files;
     }
 

diff --git a/src/Storage.php b/src/Storage.php
@@ -133,24 +133,37 @@ public function rmdir(string $directory): void
         $this->adapter->rmdir($directory);
     }
 
+    /**
+     * List all
+     *
+     * @param  ?string $search
+     * @return array
+     */
+    public function listAll(?string $search = null): array
+    {
+        return $this->adapter->listAll($search);
+    }
+
     /**
      * List directories
      *
+     * @param  ?string $search
      * @return array
      */
-    public function listDirs(): array
+    public function listDirs(?string $search = null): array
     {
-        return $this->adapter->listDirs();
+        return $this->adapter->listDirs($search);
     }
 
     /**
      * List files
      *
+     * @param  ?string $search
      * @return array
      */
-    public function listFiles(): array
+    public function listFiles(?string $search = null): array
     {
-        return $this->adapter->listFiles();
+        return $this->adapter->listFiles($search);
     }
 
     /**

diff --git a/src/StorageInterface.php b/src/StorageInterface.php
@@ -72,19 +72,29 @@ public function mkdir(string $directory): void;
      */
     public function rmdir(string $directory): void;
 
+    /**
+     * List all
+     *
+     * @param  ?string $search
+     * @return array
+     */
+    public function listAll(?string $search = null): array;
+
     /**
      * List directories
      *
+     * @param  ?string $search
      * @return array
      */
-    public function listDirs(): array;
+    public function listDirs(?string $search = null): array;
 
     /**
      * List files
      *
+     * @param  ?string $search
      * @return array
      */
-    public function listFiles(): array;
+    public function listFiles(?string $search = null): array;
 
     /**
      * Put file

diff --git a/tests/Adapter/AzureTest.php b/tests/Adapter/AzureTest.php
@@ -296,6 +296,14 @@ public function testListFiles()
         $this->assertTrue(is_array($this->storage->listFiles()));
     }
 
+    /**
+     * @group skip
+     */
+    public function testListFilesSearch()
+    {
+        $this->assertTrue(is_array($this->storage->listFiles('uploaded.txt')));
+    }
+
     /**
      * @group skip
      */
@@ -326,6 +334,14 @@ public function testGetFileType()
         $this->assertFalse($this->storage->getFileType('bad'));
     }
 
+    /**
+     * @group skip
+     */
+    public function testListDirsSearch()
+    {
+        $this->assertTrue(is_array($this->storage->listDirs('*foo/')));
+    }
+
     /**
      * @group skip
      */

diff --git a/tests/Adapter/S3Test.php b/tests/Adapter/S3Test.php
@@ -280,6 +280,14 @@ public function testListFiles()
         $this->assertTrue(is_array($this->storage->listFiles()));
     }
 
+    /**
+     * @group skip
+     */
+    public function testListFilesSearch()
+    {
+        $this->assertTrue(is_array($this->storage->listFiles('uploaded.txt')));
+    }
+
     /**
      * @group skip
      */
@@ -316,6 +324,14 @@ public function testListDirs()
         $this->assertTrue(is_array($this->storage->listDirs()));
     }
 
+    /**
+     * @group skip
+     */
+    public function testListDirsSearch()
+    {
+        $this->assertTrue(is_array($this->storage->listDirs('*test/')));
+    }
+
     /**
      * @group skip
      */