josantonius / file
1.1.8
2022-08-13 19:14 UTC
Requires
- php: ^5.6 || ^7.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^2.3 || ^2.8
- phpmd/phpmd: ^2.6
- phpunit/phpunit: ^5.7 || ^6.0
- squizlabs/php_codesniffer: ^3.0
README
文件管理的PHP库。
要求
此库支持PHP版本5.6或更高版本,且与HHVM版本3.0或更高版本兼容。
安装
安装此扩展的首选方式是通过Composer。
要安装 PHP 文件库,只需
composer require Josantonius/File
上述命令只会安装必要的文件,如果您想 下载整个源代码,可以使用
composer require Josantonius/File --prefer-source
您还可以使用 Git 克隆完整仓库
$ git clone https://github.com/Josantonius/PHP-File.git
或 手动安装
wget https://raw.githubusercontent.com/Josantonius/PHP-File/master/src/File.php
可用方法
此库中的可用方法
- 检查文件是否存在于路径或URL中
File::exists($file);
属性 | 描述 | 类型 | 必需 | 默认 |
---|---|---|---|---|
$file | 路径或文件URL。 | 字符串 | 是 |
返回 (布尔值)
- 如果存在则删除文件
File::delete($file);
属性 | 描述 | 类型 | 必需 | 默认 |
---|---|---|---|---|
$file | 文件路径。 | 字符串 | 是 |
返回 (布尔值)
- 如果不存在则创建目录
File::createDir($path);
属性 | 描述 | 类型 | 必需 | 默认 |
---|---|---|---|---|
$path | 创建目录的路径。 | 字符串 | 是 |
返回 (布尔值)
- 递归复制目录
File::copyDirRecursively($from, $to);
属性 | 描述 | 类型 | 必需 | 默认 |
---|---|---|---|---|
$from | 复制来源的路径。 | 字符串 | 是 | |
$to | 复制的目标路径。 | 字符串 | 是 |
返回 (布尔值)
- 删除空目录
File::deleteEmptyDir($path);
属性 | 描述 | 类型 | 必需 | 默认 |
---|---|---|---|---|
$path | 要删除的路径。 | 字符串 | 是 |
返回 (布尔值)
- 递归删除目录
File::deleteDirRecursively($path);
属性 | 描述 | 类型 | 必需 | 默认 |
---|---|---|---|---|
$path | 要删除的路径。 | 字符串 | 是 |
返回 (布尔值)
- 从目录中获取文件
File::getFilesFromDir($path);
属性 | 描述 | 类型 | 必需 | 默认 |
---|---|---|---|---|
$path | 获取文件路径的路径。 | 字符串 | 是 |
返回 (布尔值)
快速开始
要使用此库与 Composer
require __DIR__ . '/vendor/autoload.php'; use Josantonius\File\File;
如果手动安装,则使用它
require_once __DIR__ . '/File.php'; use Josantonius\File\File;
用法
此库使用示例
- 检查本地文件是否存在
File::exists('path/to/file.php');
- 检查外部文件是否存在
File::exists('https://raw.githubusercontent.com/Josantonius/PHP-File/master/composer.json');
- 删除本地文件
File::delete(__DIR__ . '/test.txt');
- 创建目录
File::createDir(__DIR__ . '/test/');
- 删除空目录
File::deleteEmptyDir(__DIR__ . '/test/');
- 递归删除目录
File::deleteDirRecursively(__DIR__ . '/test/');
- 递归复制目录
File::copyDirRecursively(__DIR__ . '/test/', __DIR__ . '/copy/');
- 从目录获取文件路径
get_class(File::getFilesFromDir(__DIR__));
测试
要运行测试,您只需要composer和执行以下命令:
git clone https://github.com/Josantonius/PHP-File.git
cd PHP-File
composer install
使用PHPUnit运行单元测试
composer phpunit
composer phpcs
运行PHP Mess Detector测试以检测代码风格的不一致性
composer phpmd
运行所有之前的测试
composer tests
许可
此存储库采用MIT 许可。
版权所有 © 2017 - 2022,Josantonius