Browse Source

Doc comments at "yii\helpers\base\FileHelper::findFiles()" have been recomposed using markdown format.

tags/2.0.0-beta
Klimov Paul 11 years ago
parent
commit
12d94c4a35
  1. 22
      framework/yii/helpers/base/FileHelper.php

22
framework/yii/helpers/base/FileHelper.php

@ -196,19 +196,15 @@ class FileHelper
* Returns the files found under the specified directory and subdirectories. * Returns the files found under the specified directory and subdirectories.
* @param string $dir the directory under which the files will be looked for. * @param string $dir the directory under which the files will be looked for.
* @param array $options options for file searching. Valid options are: * @param array $options options for file searching. Valid options are:
* <ul> * - fileTypes: array, list of file name suffix (without dot). Only files with these suffixes will be returned.
* <li>fileTypes: array, list of file name suffix (without dot). Only files with these suffixes will be returned.</li> * - exclude: array, list of directory and file exclusions. Each exclusion can be either a name or a path.
* <li>exclude: array, list of directory and file exclusions. Each exclusion can be either a name or a path. * If a file or directory name or path matches the exclusion, it will not be copied. For example, an exclusion of
* If a file or directory name or path matches the exclusion, it will not be copied. For example, an exclusion of * '.svn' will exclude all files and directories whose name is '.svn'. And an exclusion of '/a/b' will exclude
* '.svn' will exclude all files and directories whose name is '.svn'. And an exclusion of '/a/b' will exclude * file or directory '$src/a/b'. Note, that '/' should be used as separator regardless of the value of the DIRECTORY_SEPARATOR constant.
* file or directory '$src/a/b'. Note, that '/' should be used as separator regardless of the value of the DIRECTORY_SEPARATOR constant. * - level: integer, recursion depth, default=-1.
* </li> * Level -1 means searching for all directories and files under the directory;
* <li>level: integer, recursion depth, default=-1. * Level 0 means searching for only the files DIRECTLY under the directory;
* Level -1 means searching for all directories and files under the directory; * level N means searching for those directories that are within N levels.
* Level 0 means searching for only the files DIRECTLY under the directory;
* level N means searching for those directories that are within N levels.
* </li>
* </ul>
* @return array files found under the directory. The file list is sorted. * @return array files found under the directory. The file list is sorted.
*/ */
public static function findFiles($dir, array $options = array()) public static function findFiles($dir, array $options = array())

Loading…
Cancel
Save