文件

一个文件处理类

自版本

1.0

Joomla 框架

方法

复制

复制文件

copy( src,  dest,  path = null,  useStreams = false) : 
静态
自版本

1.0

抛出

文件系统异常

意外值异常

参数

源文件

string源文件路径

目标文件

string目标文件路径

路径

string可选的基本路径,用于作为文件名的前缀

使用流

bool是否使用流

返回值

bool成功则返回 true

删除

删除文件或文件数组

delete( file) : 
静态
自版本

1.0

抛出

文件系统异常

参数

文件

mixed文件名或文件名数组

返回值

bool成功则返回 true

获取扩展名

获取文件名的扩展名

getExt( file) : 
静态
自版本

3.0.0

参数

文件

string文件名

返回值

string文件扩展名

使文件缓存失效

如果存在 opcache* 函数,并且这是一个 PHP 文件,则立即使新写入文件的任何 opcache 失效。

invalidateFileCache( file) : 
静态

参数

文件

string要从 opcache 中清除的文件路径

返回值

安全化文件名

使文件名安全可用

makeSafe( file, mixed||string|int stripChars = ['#^.#']) : 
静态
自版本

1.0

参数

文件

string文件名(非完整路径)

要删除的字符

array<string|int, mixed>正则表达式数组(默认情况下将删除任何前导句点)

返回值

string已清理的字符串

移动

移动文件

move( src,  dest,  path = '',  useStreams = false) : 
静态
自版本

1.0

抛出

文件系统异常

参数

源文件

string源文件路径

目标文件

string目标文件路径

路径

string可选的基本路径,用于作为文件名的前缀

使用流

bool是否使用流

返回值

bool成功则返回 true

去除扩展名

从文件名中去除最后一个扩展名

stripExt( file) : 
静态
自版本

1.0

参数

文件

string文件名

返回值

string不带扩展名的文件名

上传

将上传的文件移动到目标文件夹

upload( src,  dest,  useStreams = false) : 
静态
自版本

1.0

抛出

文件系统异常

参数

源文件

stringphp(临时)上传文件的名称

目标文件

string要将上传的文件移动到的路径(包括文件名)

使用流

bool是否使用流

返回值

bool成功则返回 true

写入

将内容写入文件

write( file,  buffer,  useStreams = false,  appendToFile = false) : 
静态
自版本

1.0

参数

文件

string完整的文件路径

缓冲区

string要写入的缓冲区

使用流

bool是否使用流

追加到文件

bool追加到文件,而不是覆盖它。

返回值

bool成功则返回 true