bengor / file
v0.5.3
2018-02-08 13:15 UTC
Requires
- php: ^5.5 || ^7.0
- ramsey/uuid: ^3.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^1.11
- phpspec/phpspec: ^2.5
README
使用领域驱动设计开发的轻量级PHP文件库
BenGorFile 是一个 轻量级、灵活且易于使用 的文件管理库。使用 领域驱动设计,该库提供了一个经过充分测试和文档化的代码库,已实现了许多常见用例,例如
- 上传文件
- 默认
- 按哈希值
- 覆盖文件
- 删除文件
- 重命名文件
要求
PHP >= 5.5
安装
安装此组件最简单的方法是使用 Composer
$ composer require bengor-file/file
文档
所有文档存储在 docs
文件夹中。
测试
此库完全由 PHPSpec,PHP的SpecBDD框架 测试。
运行以下命令以启动测试
$ vendor/bin/phpspec run -fpretty
贡献
此库遵循PHP编码标准,因此拉取请求需要执行 Fabien Potencier 的 PHP-CS-Fixer。此外,如果PR创建了一些非PHP文件,请记住您必须手动添加许可证头。为了简化,我们提供了一个Composer脚本,该脚本封装了与此过程相关的所有命令。
$ composer run-script cs
还有关于贡献此项目的政策。拉取请求必须逐步解释,以便于审查过程以便接受和合并它们。新方法或代码改进必须与 PHPSpec 测试配对。
如果您想做出贡献,遵循Symfony贡献标准是个好主意,因此请阅读项目文档中的 贡献代码。如果您正在提交拉取请求,请遵循 提交补丁 部分中的指南,并使用 拉取请求模板。
致谢
此库由以下人员创建
@benatespina - benatespina@gmail.com
@gorkalaucirica - gorka.lauzirika@gmail.com