README

• 安装
• 简介
• API
  • 创建
  • getFiles
  • getFolders
  • getName
  • isFolder
  • remove
  • removeFiles
  • removeFolders
  • truncate
• 贡献

====

安装

composer install eden/folder

====

简介

以这种方式实例化文件夹。

$folder = eden('folder', '/some/path/to/folder');

====

API

====

创建

给定路径创建文件夹

用法

eden('folder', '/some/path/to/folder')->create(int $chmod);

参数

• int $chmod - UNIX权限级别

返回 Eden\Folder\Index

示例

eden('folder', '/some/path/to/folder')->create();

====

getFiles

返回给定路径和可选模式的文件列表

用法

eden('folder', '/some/path/to/folder')->getFiles(string|null $regex, bool $recursive);

参数

• string|null $regex - 匹配文件的正则表达式
• bool $recursive - 递归查看文件夹

返回 array

示例

eden('folder', '/some/path/to/folder')->getFiles();

====

getFolders

返回给定路径和可选正则表达式的文件夹列表

用法

eden('folder', '/some/path/to/folder')->getFolders(string|null $regex, bool $recursive);

参数

• string|null $regex - 匹配文件夹的正则表达式
• bool $recursive - 递归查看文件夹

返回 array

示例

eden('folder', '/some/path/to/folder')->getFolders();

====

getName

返回目录的名称。只是名称

用法

eden('folder', '/some/path/to/folder')->getName();

参数

返回 string - 名称

====

isFolder

检查此路径是否是真实文件

用法

eden('folder', '/some/path/to/folder')->isFolder(string|null $path);

参数

• string|null $path - 测试的路径

返回 bool

示例

eden('folder', '/some/path/to/folder')->isFolder();

====

remove

根据路径删除文件夹

用法

eden('folder', '/some/path/to/folder')->remove();

参数

返回 Eden\Folder\Index

====

removeFiles

根据路径删除文件和可选的正则表达式

用法

eden('folder', '/some/path/to/folder')->removeFiles(string|null regular);

参数

• string|null regular - 表达式

返回 Eden\Folder\Index

示例

eden('folder', '/some/path/to/folder')->removeFiles();

====

removeFolders

根据路径删除文件夹和可选的正则表达式

用法

eden('folder', '/some/path/to/folder')->removeFolders(string $regex);

参数

• string $regex - 测试的正则表达式

返回 Eden\Folder\Index

示例

eden('folder', '/some/path/to/folder')->removeFolders();

====

truncate

根据路径删除文件和文件夹

用法

eden('folder', '/some/path/to/folder')->truncate();

参数

返回 Eden\Folder\Index

====

#向Eden贡献

对 Eden 的贡献遵循Github工作流程。请在贡献之前阅读。

##设置您的机器并使用Eden存储库和您的分支

1. 分支存储库
2. 启动本地终端，从您的分支的 v4 分支创建一个新分支，分支名称描述了您的更改。可能的分支名称类型
   • bugfix
   • feature
   • improvement
3. 进行更改。始终确保对提交进行签名（git commit -s -m "提交信息"）

##创建pull请求

1. 请在创建pull请求之前确保运行 phpunit。
2. 将您的代码推送到您的远程分支。
3. 返回到GitHub上的您的分支，并提交pull请求。
4. Eden开发者将审查您的代码，并在它被分类为合适时合并。