php clean architecture

要在英语中进行联系，请访问readme.en

PHP干净的体系结构

一种用于自动控制PHP应用应用程序质量的工具，并简化了某些指标的分析和可视化。

其创作的想法的灵感来自《纯建筑》（Robert Martin）。如果您尚未阅读，您可以熟悉其工具基于的关键想法https://habr.com/en/post/504590/

安装

composer require v.chetkov/php-clean-architecture --dev

配置

接下来，我们将示例配置复制到项目的根源

cp vendor/v.chetkov/php-clean-architecture/example.phpca-config.php phpca-config.php

配置的所有详细信息在配置https://github.com/chetkov/chetkov/chetkov/php-clean-hactecture/blob/astench.phpca-config.php中以及作品中以及作品中以及作品https://habr.com/en/ppost/50590/和https：ppca-config.php中进行了详细描述。

用法

1. 形成报告。

vendor/bin/phpca-build-reports { ? path/to/phpca-config.php}

该报告可视化项目的当前状态，清楚地显示了组件之间的关系，它们的强度，从主序列中移除组件之间的关系，还突出了根据配置基础检测到的不需要的依赖性和其他建筑问题。

2. 检查CI。

vendor/bin/phpca-check { ? path/to/phpca-config.php}

如果由配置指定的限制代码违反，请告知发现的问题并通过错误完成执行。建议在CI中添加此命令的启动（这可以保证进入汇编的代码的合规性，配置的限制）

3. 允许的状态。

vendor/bin/phpca-allow-current-state { ? path/to/phpca-config.php}

团队将将项目的当前状态（现有类之间的关系）保存到一个单独的文件中。随后的PHPCA检查发布，将忽略与保留状态有关的问题。

这使得不仅可以轻松地将PHP-XLEAN-Architecture连接到新项目，还可以与现有的并且已经存在问题连接，消除需要时间。

4. 根据文件列表报告/检查

如果您想验证问题的存在或构建依赖图并不在整个项目上进行分析，而是在其某些部分（例如，根据更改的文件列表），您可以设置环境变量的值phpca_allowed_pa ​​ths：

 export PHPCA_ALLOWED_PATHS= ` git diff master --name-only ` PHPCA_REPORTS_DIR= ' phpca-report ' ; vendor/bin/phpca-build-reports { ? path/to/phpca-config.php}