文件
文件处理类
| 自 |
1.7.0 |
|---|---|
| 已弃用 |
4.4 起，将在 6.0 中移除。请改用 Joomla\Filesystem\File。 |
| 包 |
Joomla CMS |
方法
追加
将内容追加到文件
append( file, buffer, useStreams = false) :
| 自 |
3.6.0 |
|---|
参数
- 文件
string完整的文件路径- 缓冲区
string要写入的缓冲区- 使用流
bool使用流
响应
bool成功时为 True
能否刷新文件缓存
首先，我们检查是否启用了 opcache。然后，我们检查 opcache_invalidate 函数是否可用。最后，我们检查主机是否使用 opcache.restrict_api 限制了哪些脚本可以使用 opcache_invalidate。
canFlushFileCache() :
$_SERVER['SCRIPT_FILENAME'] 估算原始文件的路径，但 realpath() 是必要的，因为当从 CLI 运行时，SCRIPT_FILENAME 可以是相对路径。如果主机设置了此选项，请检查 opcache.restrict_api 中的路径是否与原始文件路径的开头匹配。
| 自 |
4.0.1 |
|---|---|
| 已弃用 |
4.4 起，将在 6.0 中移除。请改用 Joomla\Filesystem\File::invalidateFileCache()。此方法将被移除，且不会提供替代方案。 |
响应
bool如果我们可以继续使用 opcache_invalidate 从 OPCache 中刷新文件，则为 TRUE
复制
复制文件
copy( src, dest, path = null, useStreams = false) :
| 自 |
1.7.0 |
|---|---|
| 已弃用 |
4.4 起，将在 6.0 中移除。请改用 Joomla\Filesystem\File::copy()。框架类在发生错误时会抛出异常，您需要捕获这些异常。 |
参数
- 源文件
string源文件的路径- 目标文件
string目标文件的路径- 路径
string可选的基本路径，用于作为文件名前缀- 使用流
bool是否使用流
响应
bool成功时为 True
删除
删除文件或文件数组
delete( file) :
| 自 |
1.7.0 |
|---|---|
| 已弃用 |
4.4 起，将在 6.0 中移除。请改用 Joomla\Filesystem\File::delete()。框架类在发生错误时会抛出异常，您需要捕获这些异常。 |
参数
- 文件
mixed文件名或文件名数组
响应
bool成功时为 True
是否存在
标准 file_exists 函数的包装器
exists( file) :
| 自 |
1.7.0 |
|---|---|
| 已弃用 |
4.4 起，将在 6.0 中移除。请改用 is_file()。 |
参数
- 文件
string文件路径
响应
bool如果路径是文件，则为 True
获取扩展名
获取文件名的扩展名
getExt( file) :
| 自 |
1.7.0 |
|---|
参数
- 文件
string文件名
响应
string文件扩展名
使文件缓存失效
如果存在 opcache* 函数，并且这是一个 PHP 文件，则立即使新写入/删除的文件的 opcache 失效。
invalidateFileCache( filepath, force = true) :
| 自 |
4.0.1 |
|---|---|
| 已弃用 |
4.4 起，将在 6.0 中移除。请改用 Joomla\Filesystem\File::invalidateFileCache()。 |
参数
- 文件路径
string刚刚写入的文件的路径，用于从 opcache 中刷新- 强制
bool如果设置为 true，则无论是否需要失效，都将使脚本失效
响应
bool如果脚本的 opcode 缓存已失效/无需失效，则为 TRUE；如果 opcode 缓存已禁用或 opcache_invalidate 返回 FALSE 的其他条件（例如文件未找到），则为 FALSE。
使文件名安全
使文件名安全可用
makeSafe( file) :
| 自 |
1.7.0 |
|---|---|
| 已弃用 |
4.4 起，将在 6.0 中移除。请改用 Joomla\Filesystem\File::makeSafe()。 |
参数
- 文件
string文件名（非完整路径）
响应
string已清理的字符串
移动
移动文件
move( src, dest, path = '', useStreams = false) :
| 自 |
1.7.0 |
|---|---|
| 已弃用 |
4.4 起，将在 6.0 中移除。请改用 Joomla\Filesystem\File::move()。框架类在发生错误时会抛出异常，您需要捕获这些异常。 |
参数
- 源文件
string源文件的路径- 目标文件
string目标文件的路径- 路径
string可选的基本路径，用于作为文件名前缀- 使用流
bool是否使用流
响应
bool成功时为 True
去除扩展名
从文件名中去除最后一个扩展名
stripExt( file) :
| 自 |
1.7.0 |
|---|---|
| 已弃用 |
4.4 起，将在 6.0 中移除。请改用 Joomla\Filesystem\File::stripExt()。 |
参数
- 文件
string文件名
响应
string不带扩展名的文件名
上传
将上传的文件移动到目标文件夹
upload( src, dest, useStreams = false, allowUnsafe = false, mixed||string|int safeFileOptions = []) :
| 自 |
1.7.0 |
|---|---|
| 已弃用 |
4.4 起，将在 6.0 中移除。请改用 Joomla\Filesystem\File::upload()。框架类在发生错误时会抛出异常，您需要捕获这些异常。 |
参数
- 源文件
stringphp（临时）上传文件的名称- 目标文件
string要将上传的文件移动到的路径（包括文件名）- 使用流
bool是否使用流- 允许不安全
bool允许上传不安全的文件- 安全文件选项
array<string|int, mixed>传递给 InputFilter::isSafeFile 的选项
响应
bool成功时为 True
写入
将内容写入文件
write( file, buffer, useStreams = false) :
| 自 |
1.7.0 |
|---|---|
| 已弃用 |
4.4 起，将在 6.0 中移除。请改用 Joomla\Filesystem\File::write()。 |
参数
- 文件
string完整的文件路径- 缓冲区
string要写入的缓冲区- 使用流
bool使用流
响应
bool成功时为 True
属性
能否刷新文件缓存
如果启用了 OPCache，并且我们有权使文件失效，则为 true
| 自 |
4.0.1 |
|---|
类型
布尔值