README

FyreFileSystem 是一个免费、开源的 PHP 文件/文件夹库。

目录

• 安装
• 文件
• 文件夹

安装

使用 Composer

composer require fyre/filesystem

在 PHP 中

use Fyre\FileSystem\File;
use Fyre\FileSystem\Folder;

文件

• $path 是表示文件路径的字符串。
• $create 是一个布尔值，表示是否在文件不存在时创建它，默认为 false。

$file = new File($path, $create);

访问时间

获取文件访问时间。

$accessTime = $file->accessTime();

基本名称

获取文件名。

$baseName = $file->baseName();

Chmod

更改文件权限。

• $permissions 是表示文件权限的数字。

$file->chmod($permissions);

关闭

关闭文件句柄。

$file->close();

内容

获取文件内容。

$contents = $file->contents();

复制

将文件复制到新的目的地。

• $destination 是表示目标路径的字符串。
• $overwrite 是一个布尔值，表示是否覆盖现有文件，默认为 true。

$file->copy($destination, $overwrite);

创建

创建文件。

$file->create();

Csv

从文件中解析 CSV 值。

• $length 是表示最大行长度的数字，默认为 0。
• $separator 是表示字段分隔符的字符串，默认为 ","。
• $enclosure 是表示字段封装字符的字符串，默认为 """。
• $escape 是表示转义字符的字符串，默认为 "\"。

$data = $file->csv($length, $separator, $enclosure, $escape);

删除

删除文件。

$file->delete();

目录名

获取目录名。

$dirName = $file->dirName();

结束

确定指针是否在文件末尾。

$ended = $file->ended();

存在

确定文件是否存在。

$exists = $file->exists();

扩展名

获取文件扩展名。

$extension = $file->extension();

文件名

获取文件名（不带扩展名）。

$fileName = $file->fileName();

文件夹

获取 文件夹。

$folder = $file->folder();

组

获取文件组。

$group = $file->group();

可执行

确定文件是否可执行。

$isExecutable = $file->isExecutable();

可读

确定文件是否可读。

$isReadable = $file->isReadable();

可写

确定文件是否可写。

$isWritable = $file->isWritable();

锁定

锁定文件句柄。

• $operation 是表示锁定操作的数字，默认为 LOCK_SH。

$lock = $file->lock($operation);

MIME 类型

获取 MIME 内容类型。

$mimeType = $file->mimeType();

修改时间

获取文件修改时间。

$modifiedTime = $file->modifiedTime();

打开

打开文件句柄。

• $mode 是表示访问模式的字符串，默认为 "r"。

$open = $file->open($mode);

所有者

获取文件所有者。

$owner = $file->owner();

路径

获取文件的完整路径。

$path = $file->path();

权限

获取文件权限。

$permissions = $file->permissions();

读取

读取文件数据。

• $length 是表示要读取的字节数的数字。

$data = $file->read($length);

重置

重置指针位置。

$file->rewind();

寻找

移动指针位置。

• $offset 是表示指针位置的数字。

$file->seek($offset);

大小

获取文件大小（以字节为单位）。

$size = $file->size();

告诉

获取当前指针位置。

$offset = $file->tell();

触摸

触摸文件。

• $time 是表示修改时间戳的数字，默认为 time()。
• $accessTime 是表示访问时间戳的数字，默认为 $time。

$file->touch($time, $accessTime);

截断

截断文件。

• $size 是一个表示截断到的大小数字，默认为 0。

$file->truncate($size);

解锁

解锁文件句柄。

$file->unlock();

写入

将数据写入文件。

• $data 是表示要写入数据的字符串。

$file->write($data);

文件夹

• $path 是表示文件夹路径的字符串。
• $create 是一个布尔值，指示是否在不存在时创建文件夹，默认为 false。
• $permissions 是一个表示创建文件夹时权限的数字，默认为 0755。

$folder = new Folder($path, $create, $permissions);

内容

获取文件夹内容。

$contents = $folder->contents();

此方法将返回一个包含文件夹内容的数组，其中包含 File 和 Folder 对象。

复制

将文件夹复制到新位置。

• $destination 是表示目标路径的字符串。
• $overwrite 是一个布尔值，指示是否覆盖现有文件，默认为 true。

$folder->copy($destination, $overwrite);

创建

创建文件夹。

• $permissions 是一个表示创建文件夹时权限的数字，默认为 0755。

$folder->create($permissions);

删除

删除文件夹（包括所有内容）。

$folder->delete();

清空

清空文件夹。

$folder->empty();

存在

确定文件夹是否存在。

$exists = $folder->exists();

是否为空

确定文件夹是否为空。

$isEmpty = $folder->isEmpty();

移动

将文件夹移动到新位置。

• $destination 是表示目标路径的字符串。
• $overwrite 是一个布尔值，指示是否覆盖现有文件，默认为 true。

$folder->move($destination, $overwrite);

名称

获取文件夹名称。

$name = $folder->name();

路径

获取文件夹的完整路径。

$path = $folder->path();

大小

获取文件夹大小（以字节为单位）。

$size = $folder->size();