diff options
Diffstat (limited to 'user_guide/helpers/file_helper.html')
| -rw-r--r-- | user_guide/helpers/file_helper.html | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/user_guide/helpers/file_helper.html b/user_guide/helpers/file_helper.html index d4b1f20b4..b3f81be1a 100644 --- a/user_guide/helpers/file_helper.html +++ b/user_guide/helpers/file_helper.html @@ -125,9 +125,10 @@ CodeIgniter uses a front controller so paths are always relative to the main sit <p>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.</p> -<h2>get_dir_file_info('<var>path/to/directory/</var>')</h2> +<h2>get_dir_file_info('<var>path/to/directory/</var>', <kbd>$top_level_only</kbd> = TRUE)</h2> -<p>Reads the specified directory and builds an array containing the filenames, filesize, dates, and permissions. Any sub-folders contained within the specified path are read as well.</p> +<p>Reads the specified directory and builds an array containing the filenames, filesize, dates, and permissions. Sub-folders contained within the specified path are only read if forced + by sending the second parameter, <kbd>$top_level_only</kbd> to <samp>FALSE</samp>, as this can be an intensive operation.</p> <h2>get_file_info('<var>path/to/file</var>', <kbd>$file_information</kbd>)</h2> |