Class yii\helpers\BaseFileHelper

源目录

目标目录

目录复制选项。有效的选项是：

• dirMode：整型，为新复制的目录设置的权限。默认为 0775。
• fileMode：整型，为新复制的文件设置的权限。默认设置为当前环境设置。

• filter：回调方法，为每个目录或文件调用的PHP回调。 回调的签名应该是：function ($path)，$path 表示要过滤的完整路径。 回调可以返回以下值：

  • true：目录或文件将被复制（"only" 和 "except" 选项将被忽略）
  • false：目录或文件不会被复制（"only" 和 "except" 选项将被忽略）
  • null："only" 和 "except" 选项将决定是否复制目录或文件

• only：数组，如果文件路径想要被复制，它们应该匹配的模式列表。 如果路径末尾包含模式字符串，则路径与模式匹配。 比如说，'.php' 匹配所有以 '.php' 结尾的文件路径。 注意，'/' 模式中的字符在路径中同时匹配 '/' 和 '\'。 如果文件路径与两者中的模式匹配 "only" 和 "except"，它不会被复制。

• except：数组，如果文件或目录希望不被复制，它们应该匹配的模式的列表。 如果路径末尾包含模式字符串，则路径与模式匹配。 模式以 '/' 仅适用于目录路径，以及不以 '/' 结尾的模式适用于文件路径。 比如，'/a/b' 匹配以 '/a/b' 结尾的所有文件路径； 以及 '.svn/' 匹配以 '.svn' 结尾的目录路径。 注意，模式中的 '/' 字符匹配路径中的 '/' 和 '\' 匹配。
• caseSensitive：布尔类型，"only" 或 "except" 模式指定是否应该区分大小写。默认设置 true。
• recursive：布尔类型，子目录下的文件是否也应该被复制。默认值为 true。
• beforeCopy：回调类型，在复制每个子目录或文件之前调用的 PHP 回调。 如果回调返回 false，子目录或文件的复制操作将被取消。 回调的签名应该是：function ($from, $to)，$from 要复制的子目录或文件， 而 $to 是复制目标。
• afterCopy：回调类型，成功复制每个子目录或文件后调用的 PHP 回调。 回调的签名应该是：function ($from, $to)，$from 要复制的子目录或文件， 而 $to 是复制目标。
• copyEmptyDirectories：布尔类型，是否复制空目录。设置为 false 以避免创建不包含文件的目录。 这将影响最初不包含文件的目录和包含文件的目录 以及目标目的地不包含文件的目录，因为文件是通过 only 和 except 筛选的。 默认设置为 true。此选项从版本 2.0.12 开始可用。2.0.12 之前版本空目录依然可以复制。

如果无法打开目录抛出异常

要创建的目录的路径。

为创建的目录设置的权限。

如果父目录不存在是否需要创建它们。

Whether 目录创建成功

如果无法创建目录（例如 php 错误导致并行修改）

要检查的文件或目录的路径

过滤选项。 有关支持的选项的解释请参考 findFiles()。

文件或目录是否满足筛选选项。

将在其中查找文件的目录。

目录搜索选项。有效选项是：

• filter：回调，为每个目录或文件调用的 PHP 回调。 回调的签名应该是：function ($path)，$path 表示要过滤的完整路径。 回调可以返回以下值之一：

  • true：目录将被返回
  • false：该目录将不会被返回

• recursive：布尔型，是否还应该查找子目录下的文件。默认 true。

目录下找到的目录，没有特别的顺序。排序取决于所使用的文件系统。

如果目录无效抛出异常。

将在其中查找文件的目录。

目录搜索选项。有效选项是：

• filter：回调类型，为每个目录或文件调用的 PHP 回调。 回调的签名应该是：function ($path)，$path 指的是要过滤的完整路径。 回调可以返回以下值之一：

  • true：将返回的文件或目录（only 和 except 选项将被忽略）
  • false：不会返回目录或文件（only 和 except 选项将被忽略）
  • null：only 和 except 选项将决定文件或目录是否被返回

• except：数组，从结果匹配文件或目录路径中排除的模式列表。 以斜杠 ('/') 结尾的模式仅适用于目录路径, 模式不以 '/' 结尾仅适用于文件路径。 例如，'/a/b' 匹配所有以 '/a/b' 结尾的文件路径；以及 .svn/ 匹配以 .svn 结尾的目录路径。 如果模式不包含斜杠（/），则将其视为 shell glob 模式 并检查相对于 $dir 的路径名的匹配。 否则，该模式被视为适合由 fnmatch(3) 使用的 shell glob 使用 FNM_PATHNAME 标志：模式中的通配符与路径名中的 / 不匹配。 例如，views/*.php 匹配 views/index.php 但不匹配 views/controller/index.php。 前导斜杠与路径名的开头匹配。例如，/*.php 匹配 index.php 但不匹配 views/start/index.php。 一个可选的前缀 ! 它否定了模式；之前模式排除的任何匹配文件将再次包含在内。 如果否定模式匹配，则将覆盖较低优先级模式源。在第一个 ! 前放一个反斜杠 (\) 对于以文字 ! 开头的模式，例如，\!important!.txt。 注意，模式中的 '/' 字符与路径中的 '/' 和 '\' 匹配。

• only：数组，文件路径在返回时应匹配的模式列表。 目录路径未经过检查。使用与 except 选项中相同的模式匹配规则。 如果文件路径与 only 和 except，中的模式匹配，则不会返回。
• caseSensitive：布尔型，在 only 或 except 指定的模式下是否应区分大小写。默认为 true。
• recursive：布尔型，是否需要查找子目录下的文件。默认为 true。

在目录下找到的数组文件，没有特别的顺序。排序取决于使用的文件系统。

如果目录无效则抛出异常。

文件的 MIME 类型。

包含所有可用 MIME 类型信息的文件的路径（或别名）。 如果没有设置，将使用 $mimeMagicFile 指定的文件。

对应于指定 MIME 类型的扩展

文件名称。

可选的魔术数据库文件名（或别名），通常类似 /path/to/magic.mime。 这将作为第二个参数传递给 finfo_open() 当 fileinfo 扩展被安装时。如果 MIME 类型是基于 getMimeTypeByExtension() 并且为 null，它将通过 $mimeMagicFile 使用指定的文件。

在 finfo_open() 无法确定 MIME 类型的情况下， 是否使用文件扩展名来确定 MIME 类型。

MIME 类型（e.g. text/plain）。如果无法确定MIME类型，则返回 Null。

当 fileinfo PHP 扩展没有被安装并且 $checkExtension 设置 false。

文件的名字。

包含所有可用 MIME 类型信息的文件的路径（或别名）。 如果没有设置，将使用 $mimeMagicFile 指定的文件。

MIME 类型。如果无法确定 MIME 类型，则返回 Null。

包含 MIME 类型别名的文件的路径（或别名）。 如果没有设置，将使用 $mimeAliasesFile 指定的文件。

从文件扩展名到 MIME 类型的映射

包含所有可用 MIME 类型信息的文件的路径（或别名）。 如果没有设置，将使用 $mimeMagicFile 指定的文件。

从文件扩展名到 MIME 类型的映射

原始文件

文件应该本地化到的目标语言。 如果没有去设置，将使用 yii\base\Application::$language 的值。

原始文件所包含的语言。 如果没有去设置，将使用 yii\base\Application::$sourceLanguage 的值。

匹配的本地化文件，如果本地文件未找到可以使用原始文件。 如果目标语言代码和源语言代码相同，将返回原始文件。

原始选项

标准化选项

要标准化的文件/目录路径

要在规范化结果中使用的目录分隔符。默认是 DIRECTORY_SEPARATOR。

规范化文件/目录路径

递归删除的目录。

目录删除选项。有效的选项是：

• traverseSymlinks：布尔型，是否遍历符号链接的目录。 默认设置 false，这意味着符号链接目录的内容不会被删除。 默认情况下只有符号链接会被删除。

失败时抛出的异常