Refactor get_filenames output

Author: MGatner

system/Helpers/filesystem_helper.php

@@ -211,43 +211,33 @@ function delete_files(string $path, bool $del_dir = false, bool $htdocs = false,
 	 *
 	 * @param string  $source_dir   Path to source
 	 * @param boolean $include_path Whether to include the path as part of the filename
-	 * @param boolean $recursion    Internal variable to determine recursion status - do not use in calls
 	 *
 	 * @return array
 	 */
-	function get_filenames(string $source_dir, bool $include_path = false, bool $recursion = false): array
+	function get_filenames(string $source_dir, bool $include_path = false): array
 	{
-		static $fileData = [];
+		$files = [];
+
+		$source_dir = rtrim($source_dir, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
 
 		try
 		{
-			$fp = opendir($source_dir);
-			// reset the array and make sure $source_dir has a trailing slash on the initial call
-			if ($recursion === false)
+			foreach (new RecursiveIteratorIterator(
+					new RecursiveDirectoryIterator($source_dir, RecursiveDirectoryIterator::SKIP_DOTS),
+					RecursiveIteratorIterator::SELF_FIRST
+				) as $name => $object)
 			{
-				$fileData   = [];
-				$source_dir = rtrim(realpath($source_dir), DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
+				$files[] = $include_path ? $name : str_replace($source_dir, '', $name);
 			}
-
-			while (false !== ($file = readdir($fp)))
-			{
-				if (is_dir($source_dir . $file) && $file[0] !== '.')
-				{
-					get_filenames($source_dir . $file . DIRECTORY_SEPARATOR, $include_path, true);
-				}
-				elseif ($file[0] !== '.')
-				{
-					$fileData[] = ($include_path === true) ? $source_dir . $file : $file;
-				}
-			}
-
-			closedir($fp);
-			return $fileData;
 		}
-		catch (\Exception $fe)
+		catch (\Throwable $e)
 		{
 			return [];
 		}
+
+		sort($files);
+
+		return $files;
 	}
 }
 

tests/system/Helpers/FilesystemHelperTest.php

@@ -179,14 +179,17 @@ public function testDeleteFilesFailure()
 
 	public function testGetFilenames()
 	{
-		$this->assertTrue(function_exists('delete_files'));
+		$this->assertTrue(function_exists('get_filenames'));
 
-		// Not sure the directory names should actually show up
-		// here but this matches v3.x results.
 		$expected = [
-			'foo',
-			'boo',
+			'.hidden',
 			'AnEmptyFolder',
+			'boo',
+			'boo/far',
+			'boo/faz',
+			'foo',
+			'foo/bar',
+			'foo/baz',
 			'simpleFile',
 		];
 
@@ -197,19 +200,22 @@ public function testGetFilenames()
 
 	public function testGetFilenamesWithSource()
 	{
-		$this->assertTrue(function_exists('delete_files'));
+		$this->assertTrue(function_exists('get_filenames'));
+
+		$vfs = vfsStream::setup('root', null, $this->structure);
 
-		// Not sure the directory names should actually show up
-		// here but this matches v3.x results.
 		$expected = [
-			DIRECTORY_SEPARATOR . 'foo',
-			DIRECTORY_SEPARATOR . 'boo',
-			DIRECTORY_SEPARATOR . 'AnEmptyFolder',
-			DIRECTORY_SEPARATOR . 'simpleFile',
+			$vfs->url() . DIRECTORY_SEPARATOR . '.hidden',
+			$vfs->url() . DIRECTORY_SEPARATOR . 'AnEmptyFolder',
+			$vfs->url() . DIRECTORY_SEPARATOR . 'boo',
+			$vfs->url() . DIRECTORY_SEPARATOR . 'boo/far',
+			$vfs->url() . DIRECTORY_SEPARATOR . 'boo/faz',
+			$vfs->url() . DIRECTORY_SEPARATOR . 'foo',
+			$vfs->url() . DIRECTORY_SEPARATOR . 'foo/bar',
+			$vfs->url() . DIRECTORY_SEPARATOR . 'foo/baz',
+			$vfs->url() . DIRECTORY_SEPARATOR . 'simpleFile',
 		];
 
-		$vfs = vfsStream::setup('root', null, $this->structure);
-
 		$this->assertEquals($expected, get_filenames($vfs->url(), true));
 	}