php clean architecture

Um sich in englischer Sprache zu wenden, gehen Sie zu Readme.en

PHP Clean Architecture

Ein Tool zur Automatisierung der Kontrolle über die Qualität der Anwendung von Anwendungen, die auf PHP geschrieben wurden, sowie die Analyse und Visualisierung einiger Metriken zu vereinfachen.

Die Idee seiner Kreation wurde von dem Buch Pure Architecture (Robert Martin) inspiriert. Wenn Sie es noch nicht gelesen haben, können Sie sich mit seinen wichtigsten Ideen vertraut machen, auf denen das Tool basiert https://habr.com/en/post/504590/

Installation

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

Konfiguration

Als nächstes kopieren wir eine Beispielkonfiguration zum Stamm des Projekts

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

Alle Details der Konfiguration werden im Beispiel im Beispiel der Konfiguration https://github.com/chetkov/php-clean- architektur/bloB/master/example.phpca-config.php sowie in Artikeln https://habr.com/tpost/504590/ und Https:/habr.com/504590/- und Https:/habr.com/104590/- und Https:/Habr.

Verwendung

1. Bildung eines Berichts zur Analyse.

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

Der Bericht visualisiert den aktuellen Stand des Projekts, zeigt deutlich die Beziehung zwischen den Komponenten, deren Stärke, der Entfernung der Komponenten aus der Hauptsequenz und unterstreicht auch die unerwünschten Abhängigkeiten und andere architektonische Probleme, die auf der Grundlage der Konfiguration erkannt werden.

2. Überprüfen Sie CI.

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

Im Falle von Verstößen durch den von der Konfiguration festgelegten Beschränkungskodex informiert sie über die entdeckten Probleme und vervollständigt die Ausführung mit dem Fehler. Es wird empfohlen, den Start dieses Befehls in CI hinzuzufügen (dies garantiert die Einhaltung des Codes, der in die Baugruppe eingeht, konfigurierte Beschränkungen).

3. Zustand erlaubt.

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

Das Team wird den aktuellen Stand des Projekts, die Beziehung zwischen vorhandenen Klassen, zu einer separaten Datei beibehalten. Bei nachfolgenden PHPCA-Check-Starts werden Probleme im Zusammenhang mit dem erhaltenen Zustand ignoriert.

Dies ermöglicht es, PHP-XLEAN-Architektur einfach nicht nur mit neuen Projekten, sondern auch mit vorhandenen und bereits Problemen zu verbinden, wobei die Beseitigung Zeit in Anspruch nimmt.

4. Bericht/überprüfen Sie gemäß der Dateiliste

Wenn Sie das Vorhandensein von Problemen überprüfen oder ein Abhängigkeitsdiagramm erstellen und eine Analyse nicht im gesamten Projekt durchführen möchten, sondern in einem Teil davon (beispielsweise gemäß der Liste der geänderten Dateien), können Sie den Wert der Umgebungsvariablen phpca_allowed_paths festlegen:

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