From e9cd9e62deece5f84c7ab95c869a3d162563a1bf Mon Sep 17 00:00:00 2001 From: Francis Ilechukwu Date: Sat, 2 Jan 2021 00:01:47 +0100 Subject: [PATCH 1/2] Added ommited function paramater description. --- user_guide_src/source/helpers/filesystem_helper.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/user_guide_src/source/helpers/filesystem_helper.rst b/user_guide_src/source/helpers/filesystem_helper.rst index 38dfe885408f..9b9b050f90c9 100644 --- a/user_guide_src/source/helpers/filesystem_helper.rst +++ b/user_guide_src/source/helpers/filesystem_helper.rst @@ -127,6 +127,7 @@ The following functions are available: :param string $path: Directory path :param bool $del_dir: Whether to also delete directories :param bool $htdocs: Whether to skip deleting .htaccess and index page files + :param bool $hidden: Whether to also delete hidden files (files beginning with a period) :returns: TRUE on success, FALSE in case of an error :rtype: bool From 7fd4e71db1f0931e9f2138d6ad5ceace5c684c2f Mon Sep 17 00:00:00 2001 From: Francis Ilechukwu Date: Sat, 2 Jan 2021 08:15:42 +0100 Subject: [PATCH 2/2] Fix function's signature and rename parameter. --- user_guide_src/source/helpers/filesystem_helper.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/user_guide_src/source/helpers/filesystem_helper.rst b/user_guide_src/source/helpers/filesystem_helper.rst index 9b9b050f90c9..f6dfb23242b7 100644 --- a/user_guide_src/source/helpers/filesystem_helper.rst +++ b/user_guide_src/source/helpers/filesystem_helper.rst @@ -122,10 +122,10 @@ The following functions are available: .. note:: This function acquires an exclusive lock on the file while writing to it. -.. php:function:: delete_files($path[, $del_dir = FALSE[, $htdocs = FALSE]]) +.. php:function:: delete_files($path[, $delDir = FALSE[, $htdocs = FALSE[, $hidden = FALSE]]]) :param string $path: Directory path - :param bool $del_dir: Whether to also delete directories + :param bool $delDir: Whether to also delete directories :param bool $htdocs: Whether to skip deleting .htaccess and index page files :param bool $hidden: Whether to also delete hidden files (files beginning with a period) :returns: TRUE on success, FALSE in case of an error