Restore flat file return option

Author: MGatner

system/Helpers/filesystem_helper.php

@@ -209,12 +209,12 @@ function delete_files(string $path, bool $del_dir = false, bool $htdocs = false,
 	 * Reads the specified directory and builds an array containing the filenames.
 	 * Any sub-folders contained within the specified path are read as well.
 	 *
-	 * @param string  $source_dir   Path to source
-	 * @param boolean $include_path Whether to include the path as part of the filename
+	 * @param string $source_dir   Path to source
+	 * @param mixed  $include_path Whether to include the path as part of the filename; empty for no path, 'relative' for a relative path, not empty for full path
 	 *
 	 * @return array
 	 */
-	function get_filenames(string $source_dir, bool $include_path = false): array
+	function get_filenames(string $source_dir, $include_path = ''): array
 	{
 		$files = [];
 
@@ -228,7 +228,18 @@ function get_filenames(string $source_dir, bool $include_path = false): array
 					RecursiveIteratorIterator::SELF_FIRST
 				) as $name => $object)
 			{
-				$files[] = $include_path ? $name : str_replace($source_dir, '', $name);
+				if (empty($include_path))
+				{
+					$files[] = pathinfo($name, PATHINFO_BASENAME);
+				}
+				elseif ($include_path === 'relative')
+				{
+					$files[] = str_replace($source_dir, '', $name);
+				}
+				else
+				{
+					$files[] = $name;
+				}
 			}
 		}
 		catch (\Throwable $e)

tests/system/Helpers/FilesystemHelperTest.php

@@ -178,6 +178,29 @@ public function testDeleteFilesFailure()
 	//--------------------------------------------------------------------
 
 	public function testGetFilenames()
+	{
+		$this->assertTrue(function_exists('delete_files'));
+
+		// Not sure the directory names should actually show up
+		// here but this matches v3.x results.
+		$expected = [
+			'.hidden',
+			'AnEmptyFolder',
+			'bar',
+			'baz',
+			'boo',
+			'far',
+			'faz',
+			'foo',
+			'simpleFile',
+		];
+
+		$vfs = vfsStream::setup('root', null, $this->structure);
+
+		$this->assertEquals($expected, get_filenames($vfs->url(), false));
+	}
+
+	public function testGetFilenamesWithRelativeSource()
 	{
 		$this->assertTrue(function_exists('get_filenames'));
 
@@ -195,10 +218,10 @@ public function testGetFilenames()
 
 		$vfs = vfsStream::setup('root', null, $this->structure);
 
-		$this->assertEquals($expected, get_filenames($vfs->url(), false));
+		$this->assertEquals($expected, get_filenames($vfs->url(), 'relative'));
 	}
 
-	public function testGetFilenamesWithSource()
+	public function testGetFilenamesWithFullSource()
 	{
 		$this->assertTrue(function_exists('get_filenames'));
 

user_guide_src/source/helpers/filesystem_helper.rst

@@ -148,13 +148,14 @@ The following functions are available:
 .. php:function:: get_filenames($source_dir[, $include_path = FALSE])
 
 	:param	string	$source_dir: Directory path
-	:param	bool	$include_path: Whether to include the path as part of the filenames
+	:param	string	$include_path: Whether to include the path as part of the filename; empty for no path, 'relative' for a relative path, not empty for full path
 	:returns:	An array of file names
 	:rtype:	array
 
 	Takes a server path as input and returns an array containing the names of all files
 	contained within it. The file path can optionally be added to the file names by setting
-	the second parameter to TRUE, otherwise file names will be relative to the source.
+	the second parameter to 'relative' for relative paths or any other non-empty value for
+	a full file path.
 
 	Example::