php clean architecture

Untuk menghubungi dalam bahasa Inggris, pergi ke readme.en

Arsitektur Bersih PHP

Alat untuk mengotomatiskan kontrol atas kualitas aplikasi aplikasi yang ditulis pada PHP, serta menyederhanakan analisis dan visualisasi beberapa metrik.

Gagasan penciptaannya terinspirasi oleh buku Pure Architecture (Robert Martin). Jika Anda belum membacanya, Anda dapat membiasakan diri dengan ide -ide kuncinya di mana alat ini didasarkan pada https://habr.com/en/post/504590/

Instalasi

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

Konfigurasi

Selanjutnya, kami menyalin sampel konfigurasi ke root proyek

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

Semua detail konfigurasi dijelaskan secara rinci dalam sampel config https://github.com/chetkov/php-lean- arsitektur/blob/master/example.phpca-config.php, serta dalam artikel https:/habr.com/en/post/504590/ dan https:/habr.com/en.en/5

Penggunaan

1. Pembentukan laporan untuk analisis.

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

Laporan ini memvisualisasikan keadaan proyek saat ini, dengan jelas menampilkan hubungan antara komponen, kekuatan mereka, penghapusan komponen dari urutan utama, dan juga menyoroti ketergantungan yang tidak diinginkan dan masalah arsitektur lain yang terdeteksi berdasarkan konfigurasi.

2. Periksa CI.

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

Dalam hal pelanggaran oleh kode pembatasan yang ditetapkan oleh konfigurasi, itu menginformasikan masalah yang ditemukan dan menyelesaikan eksekusi dengan kesalahan. Disarankan untuk menambahkan peluncuran perintah ini di CI (ini menjamin kepatuhan kode yang masuk ke perakitan, pembatasan yang dikonfigurasi)

3. Negara bagian yang diizinkan.

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

Tim akan mempertahankan keadaan proyek saat ini, hubungan antara kelas yang ada, ke dalam file terpisah. Dengan peluncuran PHPCA-cek berikutnya, masalah yang terkait dengan keadaan yang diawetkan akan diabaikan.

Hal ini memungkinkan untuk dengan mudah menghubungkan arsitektur PHP-XLEAN tidak hanya ke proyek-proyek baru, tetapi juga dengan yang ada dan sudah memiliki masalah, penghapusan yang membutuhkan waktu.

4. Laporkan/Periksa sesuai dengan daftar file

Jika Anda ingin memverifikasi keberadaan masalah atau membangun grafik ketergantungan dan melakukan analisis bukan pada seluruh proyek, tetapi pada beberapa bagiannya (misalnya, menurut daftar file yang diubah), Anda dapat menetapkan nilai variabel lingkungan 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}