文件夹
一个文件夹处理类
| 自 |
1.7.0 |
|---|---|
| 已弃用 |
4.4 将在 6.0 中移除。请使用 Joomla\Filesystem\Folder 代替。 |
| 包 |
Joomla CMS |
方法
_items
读取文件夹中文件/文件夹的功能。
_items( path, filter, recurse, full, mixed||string|int exclude, excludeFilterString, findFiles) : mixed||string|int
| 自 |
1.7.0 |
|---|---|
| 已弃用 |
4.4 将在 6.0 中移除。请使用 Joomla\Filesystem\Folder::_items() 代替。 |
参数
- 路径
string要读取的文件夹的路径。- 过滤器
string文件名过滤器。- 递归
mixedTrue 表示递归搜索子文件夹，或整数以指定最大深度。- 完整
boolTrue 表示返回文件的完整路径。- 排除
array<string|int, mixed>包含不应在结果中显示的文件名的数组。- 排除过滤器字符串
string要排除的文件的正则表达式- 查找文件
boolTrue 表示读取文件，False 表示读取文件夹
响应
array<string|int, mixed>文件。
复制
复制文件夹。
copy( src, dest, path = '', force = false, useStreams = false) :
| 自 |
1.7.0 |
|---|---|
| 抛出 |
|
| 已弃用 |
4.4 将在 6.0 中移除。请使用 Joomla\Filesystem\Folder::copy() 代替。 |
参数
- 源
string源文件夹的路径。- 目标
string目标文件夹的路径。- 路径
string可选的基本路径，用于作为文件名的前缀。- 强制
bool强制复制。- 使用流
bool可选地强制覆盖文件夹/文件。
响应
bool成功时为 True。
创建
创建文件夹 - 以及所有必要的父文件夹。
create( path = '', mode = 0755) :
| 自 |
1.7.0 |
|---|---|
| 已弃用 |
4.4 将在 6.0 中移除。请使用 Joomla\Filesystem\Folder::create() 代替。框架类在发生错误时会抛出异常，您必须捕获这些异常。 |
参数
- 路径
string要从基本路径创建的路径。- 模式
int为创建的文件夹设置的目录权限。默认为 0755。
响应
bool如果成功则为 True。
删除
删除文件夹。
delete( path) :
| 自 |
1.7.0 |
|---|---|
| 已弃用 |
4.4 将在 6.0 中移除。请使用 Joomla\Filesystem\Folder::delete() 代替。框架类在发生错误时会抛出异常，您必须捕获这些异常。 |
参数
- 路径
string要删除的文件夹的路径。
响应
bool成功时为 True。
是否存在
标准 file_exists 函数的包装器
exists( path) :
| 自 |
1.7.0 |
|---|---|
| 已弃用 |
4.4 将在 6.0 中移除。请使用 is_dir() 代替。 |
参数
- 路径
string相对于安装目录的文件夹名称
响应
bool如果路径是文件夹则为 True
文件
实用程序函数，用于读取文件夹中的文件。
files( path, filter = '.', recurse = false, full = false, mixed||string|int exclude = ['.svn', 'CVS', '.DS_Store', '__MACOSX'], mixed||string|int excludeFilter = ['^..*', '.*~'], naturalSort = false) : array|bool
| 自 |
1.7.0 |
|---|---|
| 已弃用 |
4.4 将在 6.0 中移除。请使用 Joomla\Filesystem\Folder::files() 代替。框架类在发生错误时会抛出异常，您必须捕获这些异常。 |
参数
- 路径
string要读取的文件夹的路径。- 过滤器
string文件名过滤器。- 递归
mixedTrue 表示递归搜索子文件夹，或整数以指定最大深度。- 完整
boolTrue 表示返回文件的完整路径。- 排除
array<string|int, mixed>包含不应在结果中显示的文件名的数组。- 排除过滤器
array<string|int, mixed>要排除的过滤器的数组- 自然排序
boolFalse 表示 asort，True 表示 natsort
响应
array<string|int, mixed>|bool给定文件夹中的文件。
文件夹
实用程序函数，用于读取文件夹中的文件夹。
folders( path, filter = '.', recurse = false, full = false, mixed||string|int exclude = ['.svn', 'CVS', '.DS_Store', '__MACOSX'], mixed||string|int excludeFilter = ['^..*']) : mixed||string|int
| 自 |
1.7.0 |
|---|---|
| 已弃用 |
4.4 将在 6.0 中移除。请使用 Joomla\Filesystem\Folder::folders() 代替。框架类在发生错误时会抛出异常，您必须捕获这些异常。 |
参数
- 路径
string要读取的文件夹的路径。- 过滤器
string文件夹名称过滤器。- 递归
mixedTrue 表示递归搜索子文件夹，或整数以指定最大深度。- 完整
boolTrue 表示返回文件夹的完整路径。- 排除
array<string|int, mixed>包含不应在结果中显示的文件夹名称的数组。- 排除过滤器
array<string|int, mixed>包含与不应在结果中显示的文件夹匹配的正则表达式的数组。
响应
array<string|int, mixed>给定文件夹中的文件夹。
列出文件夹树
以适合树形显示的格式列出文件夹。
listFolderTree( path, filter, maxLevel = 3, level, parent) : mixed||string|int
| 自 |
1.7.0 |
|---|---|
| 已弃用 |
4.4 将在 6.0 中移除。请使用 Joomla\Filesystem\Folder::listFolderTree() 代替。 |
参数
- 路径
string要读取的文件夹的路径。- 过滤器
string文件夹名称过滤器。- 最大级别
int要递归读取的最大级别数，默认为 3。- 级别
int当前级别，可选。- 父级
int父文件夹的唯一标识符（如果有）。
响应
array<string|int, mixed>给定文件夹中的文件夹。
安全化
使路径名称安全使用。
makeSafe( path) :
| 自 |
1.7.0 |
|---|---|
| 已弃用 |
4.4 将在 6.0 中移除。请使用 Joomla\Filesystem\Folder::makeSafe() 代替。 |
参数
- 路径
string要清理的完整路径。
响应
string已清理的字符串。
移动
移动文件夹。
move( src, dest, path = '', useStreams = false) :
| 自 |
1.7.0 |
|---|---|
| 已弃用 |
4.4 将在 6.0 中移除。请使用 Joomla\Filesystem\Folder::move() 代替。框架类在发生错误时会抛出异常，您必须捕获这些异常。 |
参数
- 源
string源文件夹的路径。- 目标
string目标文件夹的路径。- 路径
string可选的基本路径，用于作为文件名的前缀。- 使用流
bool可选地使用流。
响应
mixed错误消息（如果为 false）或成功时的布尔值 true。