php clean architecture

Pour contacter en anglais, allez à Readme.en

Architecture propre PHP

Un outil d'automatisation de contrôle sur la qualité de l'application d'applications écrits sur PHP, ainsi que de simplifier l'analyse et la visualisation de certaines mesures.

L'idée de sa création a été inspirée par le livre Pure Architecture (Robert Martin). Si vous ne l'avez pas encore lu, vous pouvez vous familiariser avec ses idées clés sur lesquelles l'outil est basé https://habr.com/en/post/504590/

Installation

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

Configuration

Ensuite, nous copie un exemple de configuration à la racine du projet

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

Tous les détails de la configuration sont décrits en détail dans l'échantillon de la configuration https://github.com/chetkov/php-clean- architecture / blob / maître / example.phpca-config.php, ainsi que dans les articles https://habr.com/en/post/504590/ et https://habr.com/enst/666236/

Usage

1. Formation d'un rapport pour l'analyse.

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

Le rapport visualise l'état actuel du projet, affiche clairement la relation entre les composants, leur résistance, l'élimination des composants de la séquence principale, et met également en évidence les dépendances indésirables et autres problèmes architecturaux détectés sur la base de la configuration.

2. Vérifiez CI.

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

En cas de violation par le code de restrictions défini par la configuration, il informe les problèmes découverts et termine l'exécution avec l'erreur. Il est recommandé d'ajouter le lancement de cette commande dans CI (cela garantit la conformité du code qui entre dans l'assemblage, les restrictions configurées)

3. État autorisé.

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

L'équipe conservera l'état actuel du projet, la relation entre les classes existantes, dans un fichier séparé. Avec les lancements ultérieurs de PHPCA-CHECK, les problèmes liés à l'état préservé seront ignorés.

Cela permet de connecter facilement l'architecture PHP-xlean non seulement aux nouveaux projets, mais aussi à des problèmes existants et déjà ayant des problèmes, dont l'élimination prend du temps.

4. Rapport / vérification conformément à la liste des fichiers

Si vous souhaitez vérifier la présence de problèmes ou créer un graphique de dépendance et effectuer une analyse non pas sur l'ensemble du projet, mais par une partie de celui-ci (par exemple, selon la liste des fichiers modifiés), vous pouvez définir la valeur de la variable d'environnement 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}