使用领域驱动设计开发的轻量级文件库

v0.5.3 2018-02-08 13:15 UTC

This package is not auto-updated.

Last update: 2024-09-24 01:51:19 UTC


README

使用领域驱动设计开发的轻量级PHP文件库

SensioLabsInsight Build Status Scrutinizer Code Quality Total Downloads Latest Stable Version Latest Unstable Version

BenGorFile是一个轻量级、灵活且易于使用的文件管理库。使用领域驱动设计,这个库提供了一套经过充分测试和文档化的代码库,已经实现了许多常见的用例,例如:

  • 上传文件
    • 默认
    • 通过哈希
  • 覆盖文件
  • 删除文件
  • 重命名文件

要求

PHP >= 5.5

安装

安装此组件的最简单方法是使用Composer

$ composer require bengor-file/file

文档

所有文档都存储在docs文件夹中。

查看文档!

测试

此库完全由PHPSpec,PHP的SpecBDD框架进行测试。

运行以下命令以启动测试

$ vendor/bin/phpspec run -fpretty

贡献

此库遵循PHP编码标准,因此pull requests需要执行Fabien Potencier的PHP-CS-Fixer。此外,如果PR创建了一些非PHP文件,请记住您需要手动添加许可证头。为了简化,我们提供了一个Composer脚本来包装与此过程相关的所有命令。

$ composer run-script cs

还有关于向此项目贡献的政策。Pull requests必须逐步解释,以便简化审查过程,以便接受和合并它们。新方法或代码改进必须与PHPSpec测试配对。

如果您想贡献,遵循Symfony贡献标准是一个好点子,所以请阅读项目文档中的贡献代码。如果您正在提交pull request,请遵循提交补丁部分的指南,并使用Pull Request模板

致谢

此库由以下人员创建:

@benatespina - benatespina@gmail.com
@gorkalaucirica - gorka.lauzirika@gmail.com

许可选项

License