diff options
author | Derek Jones <derek.jones@ellislab.com> | 2011-10-18 05:57:44 +0200 |
---|---|---|
committer | Derek Jones <derek.jones@ellislab.com> | 2011-10-18 05:57:44 +0200 |
commit | 961684280faccb7f32da700201422ecd8a454a0a (patch) | |
tree | 25eecf4970ca27e667bc35d611dfb6da9e28955c | |
parent | 84bcc6e9b8b1648d3a52102d2a96d617c60508f0 (diff) |
updated Directory helper docs to use proper PHP method Sphinx roles
-rw-r--r-- | user_guide_src/source/helpers/directory_helper.rst | 27 |
1 files changed, 13 insertions, 14 deletions
diff --git a/user_guide_src/source/helpers/directory_helper.rst b/user_guide_src/source/helpers/directory_helper.rst index 6c259adb1..fd169886c 100644 --- a/user_guide_src/source/helpers/directory_helper.rst +++ b/user_guide_src/source/helpers/directory_helper.rst @@ -18,15 +18,20 @@ This helper is loaded using the following code The following functions are available: -directory_map('source directory') -================================= +directory_map() +=============== This function reads the directory path specified in the first parameter and builds an array representation of it and all its contained files. + +.. php:method:: directory_map($source_dir[, $directory_depth = 0[, $hidden = FALSE]]) -Example - -:: + :param string $source_dir: path to the ource directory + :param integer $directory_depth: depth of directories to traverse (0 = + fully recursive, 1 = current dir, etc) + :param boolean $hidden: whether to include hidden directories + +Examples:: $map = directory_map('./mydirectory/'); @@ -35,23 +40,17 @@ Example 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 - -:: +parameter (integer). A depth of 1 will only map the top level directory:: $map = directory_map('./mydirectory/', 1); By default, hidden files will not be included in the returned array. To -override this behavior, you may set a third parameter to true (boolean) - -:: +override this behavior, you may set a third parameter to true (boolean):: $map = directory_map('./mydirectory/', FALSE, TRUE); Each folder name will be an array index, while its contained files will -be numerically indexed. Here is an example of a typical array - -:: +be numerically indexed. Here is an example of a typical array:: Array ( [libraries] => Array |