Fungsi alat ini
Formatter PHP mengubah kode PHP yang berantakan, di-minify, atau indentasinya tidak konsisten menjadi kode rapi yang mengikuti standar penulisan komunitas. Alat ini menangani sintaks modern termasuk typed dan readonly property, constructor promotion, arrow function, enum, ekspresi match, dan attribute.
Alat ini menjalankan Prettier dengan plugin PHP resminya, kombinasi yang sama dengan yang dipakai banyak tim Laravel dan Symfony di editor dan pre-commit hook mereka, sehingga hasilnya sama dengan yang akan dihasilkan tooling Anda.
Cara menggunakannya
- Tempel kode PHP, atau buka file
.php. Tag pembuka<?phpopsional untuk potongan kode pendek. - Kode yang sudah diformat muncul di sebelah kanan saat Anda mengetik.
- Sesuaikan opsinya:
- Indentasi: 4 spasi adalah standar PSR; 2 spasi dan tab juga tersedia.
- Lebar baris: baris yang lebih panjang dari ini dipecah di tempat yang diizinkan sintaks.
- Kurung kurawal: letakkan kurung kurawal class dan function di baris berikutnya (PER / PSR-12) atau di baris yang sama.
- Versi PHP: versi tertua yang harus menjalankan kode.
- Kutip tunggal dan Koma di akhir untuk daftar multi-baris.
- Salin atau unduh hasilnya.
Jika kode memiliki kesalahan sintaks, pesannya menyebutkan apa yang diharapkan parser serta baris dan kolom tempat parser berhenti.
Contoh
Contohnya adalah controller bergaya Laravel yang semuanya dijejalkan menjadi satu: pernyataan use berkelompok, array property, constructor promotion, pemanggilan validasi, if yang ditulis dalam satu baris, dan array_map dengan arrow function. Setelah diformat, kurung kurawal setiap method pindah ke barisnya sendiri, operator dan => mendapat spasi, isi if diuraikan, dan pemanggilan response()->json() yang panjang dipecah dengan satu item array per baris dan koma di akhir.
Yang tidak diubah
Formatter hanya mengubah tata letak. Formatter tidak mengganti nama variabel, mengurutkan ulang pernyataan use, mengubah array() ke sintaks pendek, atau memperbaiki logika. Komentar, termasuk blok PHPDoc, dipertahankan dan diindentasi ulang bersama kode di sekitarnya.
Tips
- Gunakan lebar baris dan versi PHP yang sama dengan konfigurasi Prettier atau PHP-CS-Fixer proyek Anda agar diff tidak dipenuhi perubahan yang tidak perlu.
- Memformat potongan kode yang disalin dari log atau stack trace membuatnya jauh lebih mudah dibaca.
- Jika Anda membagikan kode di sebuah issue, format dulu agar reviewer bisa fokus pada apa yang dilakukan kode tersebut.
FAQ
› Gaya penulisan kode apa yang diikuti?
Secara bawaan, output mengikuti PER Coding Style, penerus PSR-12 yang diterbitkan oleh PHP-FIG. Kurung kurawal class dan method ditempatkan di barisnya sendiri, kurung kurawal struktur kontrol tetap di baris yang sama, dan indentasinya empat spasi.
› Mengapa versi PHP berpengaruh?
Sebagian sintaks hanya valid mulai versi tertentu. Koma di akhir daftar parameter, misalnya, membutuhkan PHP 8.0, jadi dengan target yang lebih lama formatter tidak menambahkannya. Pilih versi tertua yang harus menjalankan kode Anda.
› Bisakah memformat file yang mencampur HTML dan PHP?
Bisa. File template dengan HTML inline dan short echo tag didukung. Bagian PHP diformat, sedangkan HTML di antaranya dibiarkan apa adanya.
› Apakah kode saya diunggah?
Tidak. Formatter berjalan sepenuhnya di browser Anda dan tidak ada yang dikirim ke server.