Die Installation von PHP Arkitect erfolgt über Composer. Befolgen Sie diese Schritte, um das Tool in Ihrem Projekt zu installieren:

1. Installieren Sie PHP Arkitect über Composer:
composer require --dev phparkitect/arkitect

2.Erstellen Sie Ihre Architekturregeln in einer PHP-Datei:

use Arkitect\Architecture\Rules\Rule;
use Arkitect\ClassSet;

$rules = [
   Rule::allClasses()
       ->that(new HaveNameMatching('*Controller'))
       ->should(new BeInOneOfTheseNamespaces('App\Controller'))
       ->because('Controllers should reside in the App\Controller namespace')
];

3. Führen Sie das Tool mit den definierten Regeln aus:
vendor/bin/arkitect check rules.php
 

Mögliche Stolpersteine:

• Stellen Sie sicher, dass Ihre Architekturregeln präzise und konsistent sind, um unnötige Verstöße zu vermeiden.

PHP Arkitect ist flexibel und erlaubt es, benutzerdefinierte Architekturregeln zu erstellen, die genau zu den Anforderungen Ihres Projekts passen. Sie können die Regeln so gestalten, dass sie die Struktur Ihrer Klassen, Schnittstellen und Namespaces gemäß den besten Praktiken überwachen.

Beispiel einer erweiterten Konfiguration:

use Arkitect\ClassSet;
use Arkitect\Architecture\Rules\Rule;
use Arkitect\Architecture\Assertions\ShouldHaveNameMatching;

$rules = [
   Rule::allClasses()
       ->that(new ShouldHaveNameMatching('*Service'))
       ->should(new BeInOneOfTheseNamespaces('App\Service'))
       ->because('Services should reside in the App\Service namespace')
];

Best Practices:

• Definieren Sie klare Architekturregeln zu Beginn eines Projekts, um eine konsistente Struktur zu gewährleisten.
• Verwenden Sie das Tool regelmäßig, um Verstöße frühzeitig zu erkennen und technische Schulden zu vermeiden.

PHP Arkitect hilft Ihnen, sicherzustellen, dass die Architekturregeln Ihres Projekts eingehalten werden. Es ist besonders nützlich für größere Projekte oder Projekte mit vielen Entwicklern, bei denen eine konsistente Struktur von entscheidender Bedeutung ist.

Typische Anwendungsfälle:

• Überwachung von Architekturkonformität: PHP Arkitect erkennt Verstöße gegen die definierten Architekturregeln und ermöglicht es Ihnen, diese Verstöße frühzeitig zu beheben.
• Refactoring von Legacy Code: Wenn Sie Legacy Code modernisieren, kann PHP Arkitect helfen, sicherzustellen, dass der umstrukturierte Code die aktuellen Architekturprinzipien einhält.

Beispiel zur Ausführung:
vendor/bin/arkitect check rules.php --format=json

Dieser Befehl führt die Prüfung durch und gibt die Ergebnisse im JSON-Format aus, was ideal für die Weiterverarbeitung oder Integration in andere Tools ist.

Unsere Agentur integriert PHP Arkitect erfolgreich in GitLab CI/CD-Pipelines, um sicherzustellen, dass jeder Commit und Merge Request automatisch auf Verstöße gegen Architekturregeln überprüft wird.

Beispiel einer GitLab CI-Konfiguration:

arkitect_check:
 stage: test
 script:
   - vendor/bin/arkitect check rules.php
 only:
   - merge_requests

Vorteile der Integration:

• Automatische Überprüfung der Architekturkonformität bei jedem Commit oder Merge Request.
• Sicherstellung, dass der Code konsistent bleibt und die definierten Architekturprinzipien erfüllt.
• Vermeidung von langfristigen technischen Schulden durch frühzeitige Erkennung von Verstößen.

PHP Arkitect ist ein unverzichtbares Tool, um die Einhaltung von Architekturprinzipien in PHP-Projekten sicherzustellen. Es hilft Entwicklern, strukturelle Verstöße frühzeitig zu erkennen und langfristige technische Schulden zu vermeiden. Unsere Agentur hat umfassende Erfahrung mit der Implementierung von PHP Arkitect und unterstützt Sie gerne bei der Integration in Ihre CI/CD-Pipelines. Kontaktieren Sie uns, wenn Sie Hilfe bei der Einrichtung oder Anpassung benötigen.

Weiterführende Ressourcen

• Offizielle PHP Arkitect Dokumentation
• GitHub Repository zu PHP Arkitect
• Best Practices für PHP-Architektur