php clean architecture

Para contactar en inglés, vaya a Readme.en

Arquitectura limpia PHP

Una herramienta para automatizar el control sobre la calidad de la aplicación de aplicaciones escritas en PHP, así como para simplificar el análisis y la visualización de algunas métricas.

La idea de su creación se inspiró en el libro Pure Architecture (Robert Martin). Si aún no lo ha leído, puede familiarizarse con sus ideas clave en las que la herramienta se basa https://habr.com/en/post/504590/

Instalación

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

Configuración

A continuación, copiamos una configuración de muestra en la raíz del proyecto

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

Todos los detalles de la configuración se describen en detalle en la muestra de la configuración https://github.com/chetkov/php-clean- arquitectura/blob/maestro/ejemplo.phpca-config.php, así como en artículos https://habr.com/en/post/504590/ y https://habr.com/post/62862223622362236/686

Uso

1. Formación de un informe para el análisis.

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

El informe visualiza el estado actual del proyecto, muestra claramente la relación entre los componentes, su fuerza, la eliminación de los componentes de la secuencia principal y también destaca las dependencias no deseadas y otros problemas arquitectónicos detectados sobre la base de la configuración.

2. Consulte el CI.

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

En caso de violación por el Código de Restricciones establecidas por la configuración, informa los problemas descubiertos y completa la ejecución con el error. Se recomienda agregar el lanzamiento de este comando en CI (esto garantiza el cumplimiento del código que llega al ensamblaje, restricciones configuradas)

3. Estado permitido.

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

El equipo mantendrá el estado actual del proyecto, la relación entre las clases existentes, en un archivo separado. Con los lanzamientos posteriores de PHPCA Check, se ignorarán los problemas relacionados con el estado preservado.

Esto permite conectar fácilmente la arquitectura PHP-XLEAN no solo a los nuevos proyectos, sino también a existir y ya tener problemas, cuya eliminación lleva tiempo.

4. Informe/verifique de acuerdo con la lista de archivos

Si desea verificar la presencia de problemas o construir un gráfico de dependencia y realizar un análisis que no sea en todo el proyecto, pero por alguna parte (por ejemplo, de acuerdo con la lista de archivos cambiados), puede establecer el valor de la variable de entorno phpca_allowed_paths ::

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