Class yii\helpers\BaseFileHelper

The source directory

The destination directory

Options for directory copy. Valid options are:

• dirMode: integer, the permission to be set for newly copied directories. Defaults to 0775.
• fileMode: integer, the permission to be set for newly copied files. Defaults to the current environment setting.

• filter: callback, a PHP callback that is called for each directory or file. The signature of the callback should be: function ($path), where $path refers the full path to be filtered. The callback can return one of the following values:

  • true: the directory or file will be copied (the "only" and "except" options will be ignored)
  • false: the directory or file will NOT be copied (the "only" and "except" options will be ignored)
  • null: the "only" and "except" options will determine whether the directory or file should be copied
• only: array, list of patterns that the file paths should match if they want to be copied. A path matches a pattern if it contains the pattern string at its end. For example, '.php' matches all file paths ending with '.php'. Note, the '/' characters in a pattern matches both '/' and '\' in the paths. If a file path matches a pattern in both "only" and "except", it will NOT be copied.
• except: array, list of patterns that the files or directories should match if they want to be excluded from being copied. A path matches a pattern if it contains the pattern string at its end. Patterns ending with '/' apply to directory paths only, and patterns not ending with '/' apply to file paths only. For example, '/a/b' matches all file paths ending with '/a/b'; and '.svn/' matches directory paths ending with '.svn'. Note, the '/' characters in a pattern matches both '/' and '\' in the paths.
• caseSensitive: boolean, whether patterns specified at "only" or "except" should be case sensitive. Defaults to true.
• recursive: boolean, whether the files under the subdirectories should also be copied. Defaults to true.
• beforeCopy: callback, a PHP callback that is called before copying each sub-directory or file. If the callback returns false, the copy operation for the sub-directory or file will be cancelled. The signature of the callback should be: function ($from, $to), where $from is the sub-directory or file to be copied from, while $to is the copy target.
• afterCopy: callback, a PHP callback that is called after each sub-directory or file is successfully copied. The signature of the callback should be: function ($from, $to), where $from is the sub-directory or file copied from, while $to is the copy target.
• copyEmptyDirectories: boolean, whether to copy empty directories. Set this to false to avoid creating directories that do not contain files. This affects directories that do not contain files initially as well as directories that do not contain files at the target destination because files have been filtered via only or except. Defaults to true. This option is available since version 2.0.12. Before 2.0.12 empty directories are always copied.

if unable to open directory

Path of the directory to be created.

The permission to be set for the created directory.

Whether to create parent directories if they do not exist.

Whether the directory is created successfully

if the directory could not be created (i.e. php error due to parallel changes)

The path of the file or directory to be checked

The filtering options. See findFiles() for explanations of the supported options.

Whether the file or directory satisfies the filtering options.

The directory under which the files will be looked for.

Options for directory searching. Valid options are:

• filter: callback, a PHP callback that is called for each directory or file. The signature of the callback should be: function ($path), where $path refers the full path to be filtered. The callback can return one of the following values:

  • true: the directory will be returned
  • false: the directory will NOT be returned

• recursive: boolean, whether the files under the subdirectories should also be looked for. Defaults to true.

Directories found under the directory, in no particular order. Ordering depends on the files system used.

if the dir is invalid.

The directory under which the files will be looked for.

Options for file searching. Valid options are:

• filter: callback, a PHP callback that is called for each directory or file. The signature of the callback should be: function ($path), where $path refers the full path to be filtered. The callback can return one of the following values:

  • true: the directory or file will be returned (the only and except options will be ignored)
  • false: the directory or file will NOT be returned (the only and except options will be ignored)
  • null: the only and except options will determine whether the directory or file should be returned
• except: array, list of patterns excluding from the results matching file or directory paths. Patterns ending with slash ('/') apply to directory paths only, and patterns not ending with '/' apply to file paths only. For example, '/a/b' matches all file paths ending with '/a/b'; and .svn/ matches directory paths ending with .svn. If the pattern does not contain a slash (/), it is treated as a shell glob pattern and checked for a match against the pathname relative to $dir. Otherwise, the pattern is treated as a shell glob suitable for consumption by fnmatch(3) with the FNM_PATHNAME flag: wildcards in the pattern will not match a / in the pathname. For example, views/*.php matches views/index.php but not views/controller/index.php. A leading slash matches the beginning of the pathname. For example, /*.php matches index.php but not views/start/index.php. An optional prefix ! which negates the pattern; any matching file excluded by a previous pattern will become included again. If a negated pattern matches, this will override lower precedence patterns sources. Put a backslash (\) in front of the first ! for patterns that begin with a literal !, for example, \!important!.txt. Note, the '/' characters in a pattern matches both '/' and '\' in the paths.
• only: array, list of patterns that the file paths should match if they are to be returned. Directory paths are not checked against them. Same pattern matching rules as in the except option are used. If a file path matches a pattern in both only and except, it will NOT be returned.
• caseSensitive: boolean, whether patterns specified at only or except should be case sensitive. Defaults to true.
• recursive: boolean, whether the files under the subdirectories should also be looked for. Defaults to true.

Files found under the directory, in no particular order. Ordering depends on the files system used.

if the dir is invalid.

File MIME type.

The path (or alias) of the file that contains all available MIME type information. If this is not set, the file specified by $mimeMagicFile will be used.

The extensions corresponding to the specified MIME type

The file name.

Name of the optional magic database file (or alias), usually something like /path/to/magic.mime. This will be passed as the second parameter to finfo_open() when the fileinfo extension is installed. If the MIME type is being determined based via getMimeTypeByExtension() and this is null, it will use the file specified by $mimeMagicFile.

Whether to use the file extension to determine the MIME type in case finfo_open() cannot determine it.

The MIME type (e.g. text/plain). Null is returned if the MIME type cannot be determined.

when the fileinfo PHP extension is not installed and $checkExtension is false.

The file name.

The path (or alias) of the file that contains all available MIME type information. If this is not set, the file specified by $mimeMagicFile will be used.

The MIME type. Null is returned if the MIME type cannot be determined.

The path (or alias) of the file that contains MIME type aliases. If this is not set, the file specified by $mimeAliasesFile will be used.

The mapping from file extensions to MIME types

The path (or alias) of the file that contains all available MIME type information. If this is not set, the file specified by $mimeMagicFile will be used.

The mapping from file extensions to MIME types

The original file

The target language that the file should be localized to. If not set, the value of yii\base\Application::$language will be used.

The language that the original file is in. If not set, the value of yii\base\Application::$sourceLanguage will be used.

The matching localized file, or the original file if the localized version is not found. If the target and the source language codes are the same, the original file will be returned.

Raw options

Normalized options

The file/directory path to be normalized

The directory separator to be used in the normalized result. Defaults to DIRECTORY_SEPARATOR.

The normalized file/directory path

The directory to be deleted recursively.

Options for directory remove. Valid options are:

• traverseSymlinks: boolean, whether symlinks to the directories should be traversed too. Defaults to false, meaning the content of the symlinked directory would not be deleted. Only symlink would be removed in that default case.

in case of failure