onramplab/laravel-auditing-log

提供审计日志的 Laravel 扩展包

v1.0.2 2023-03-30 09:41 UTC

This package is auto-updated.

Last update: 2024-08-30 01:39:42 UTC


README

Software License CircleCI Total Downloads

提供审计日志的 Laravel 扩展包

需求

  • PHP >= 8.0;
  • Laravel >= 8
  • doctrine/dbal >= 3.6
  • spatie/laravel-activitylog >= 4.7
  • composer.

特性

  • PSR-4 自动加载兼容结构;
  • PSR-2 代码风格兼容;
  • 使用 PHPUnit 6 进行单元测试;
  • 全面的指南和教程;
  • 易于在任何框架或纯 PHP 文件中使用;
  • 包含有用的工具以优化代码。

安装

composer require onramplab/laravel-auditing-log

这将为您创建一个基本的项目结构

  • /build 默认用于存储代码覆盖率输出;
  • /src 是您的代码所在之处,每个类都需要位于此文件夹中的单独文件中;
  • /tests 中的每个类在“包含”到其他地方之前都需要进行测试。因此,基本上我们在那里有测试类来测试其他类;
  • .gitignore 有一些我们不希望在 Git 中发布的文件,所以我们只是将它们添加到该文件中,让 Git “忽略”它们;
  • CHANGELOG.md 用于跟踪包更新;
  • CONTRIBUTION.md 贡献者公约代码准则;
  • LICENSE 其他程序员使用此库的自由条款;
  • README.md 这是库的迷你文档,如果您的库在 GitHub 和 Packagist 上发布,则通常是您的“主页”;
  • composer.json 存储有关您的库的信息,如包名称、作者和依赖项;
  • phpunit.xml 这是 PHPUnit 的配置文件,以便测试类能够测试您编写的类;
  • .travis.yml 为 Travis CI 提供基本配置,并配置了代码气候的测试覆盖率报告。

有关更多信息,请参阅原始 文章

有用工具

运行测试

php vendor/bin/phpunit

composer test

代码规范工具

php vendor/bin/phpcs --standard=PSR2 src/

composer psr2check

代码自动修复器

composer psr2autofix
composer insights:fix
rector:fix

构建文档

php vendor/bin/phpdoc -d "src" -t "docs"

composer docs

变更日志

为保持跟踪,请参阅 CHANGELOG.md

贡献

  1. 将其分支。
  2. 创建您的功能分支(git checkout -b my-new-feature)。
  3. 进行更改。
  4. 运行测试,如有必要,为您的代码添加新测试(phpunit)。
  5. 提交更改(git commit -am 'Added some feature')。
  6. 将更改推送到分支(git push origin my-new-feature)。
  7. 创建新的拉取请求。

请参阅 CONTRIBUTION.md

许可证

请参阅 LICENSE