diff options
| author | Pascal Kriete <pascal.kriete@ellislab.com> | 2010-01-07 19:14:28 +0100 |
|---|---|---|
| committer | Pascal Kriete <pascal.kriete@ellislab.com> | 2010-01-07 19:14:28 +0100 |
| commit | 98a447ac363d00d856c18f34ffbd4d14cad51eb3 (patch) | |
| tree | 782d1942ca26f4f7e53168a370739ca6fae80cd5 /user_guide | |
| parent | 8c4b5e78a8f3a87e30ffc3b09b897153ffe86193 (diff) | |
changing the second parameter in directory_map to an integer that controls recursion depth.
A depth of 0 is fully recursive to maintain backward compatibility with the boolean values.
Diffstat (limited to 'user_guide')
| -rw-r--r-- | user_guide/changelog.html | 1 | ||||
| -rw-r--r-- | user_guide/helpers/directory_helper.html | 6 |
2 files changed, 4 insertions, 3 deletions
diff --git a/user_guide/changelog.html b/user_guide/changelog.html index 93a7025f0..4758d49bc 100644 --- a/user_guide/changelog.html +++ b/user_guide/changelog.html @@ -81,6 +81,7 @@ SVN Revision: </p> <li>Deprecated the <kbd>dohash()</kbd> function in favour of <kbd>do_hash()</kbd> for naming consistency.</li> <li>Non-backwards compatible change made to <kbd>get_dir_file_info()</kbd> in the <a href="helpers/file_helper.html">File Helper</a>. No longer recurses by default so as to encourage responsible use (this function can cause server performance issues when used without caution).</li> + <li>Modified the second parameter of <kbd>directory_map()</kbd> in the <a href="helpers/directory_helper.html">Directory Helper</a> to accept an integer to specify recursion depth.</li> </ul> </li> </ul> diff --git a/user_guide/helpers/directory_helper.html b/user_guide/helpers/directory_helper.html index eae2c52ec..3b70799d0 100644 --- a/user_guide/helpers/directory_helper.html +++ b/user_guide/helpers/directory_helper.html @@ -78,10 +78,10 @@ and builds an array representation of it and all its contained files. Example:</ <p class="important"><strong>Note:</strong> Paths are almost always relative to your main index.php file.</p> -<p>Sub-folders contained within the directory will be mapped as well. If you wish to map -only the top level directory set the second parameter to <var>true</var> (boolean):</p> +<p>Sub-folders contained within the directory will be mapped as well. If you wish to control the recursion depth, +you can do so using the second parameter (integer). A depth of 1 will only map the top level directory:</p> -<code>$map = directory_map('./mydirectory/', TRUE);</code> +<code>$map = directory_map('./mydirectory/', 1);</code> <p>By default, hidden files will not be included in the returned array. To override this behavior, you may set a third parameter to <var>true</var> (boolean):</p> |