此包已被弃用且不再维护。作者建议使用symfony/filesystem包。

PHP文件管理库。

1.1.8 2022-08-13 19:14 UTC

This package is auto-updated.

Last update: 2022-08-13 19:18:40 UTC


README

Latest Stable Version License

西班牙语版本

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

或者<强>手动安装

下载File.php:

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

使用PSR2代码标准测试与PHPCS

composer phpcs

运行PHP Mess Detector测试以检测代码风格的不一致性

composer phpmd

运行所有之前的测试

composer tests

许可

此存储库在MIT 许可下发布。

版权所有 © 2017 - 2022, Josantonius