PSR Kodlama Standartları – PHP
İçindekiler
Bir şirkette çalışıyorsanız veya bir ekibe sahipsiniz. PHP proje geliştiriyorsanız kodların düzeni muhakkak sorun yaratır. Bazı geliştiriciler süslü parantezi aynı satırdan devam ettirirken bazıları bir alt satırdan başlatmaktadır. Bunun dışında bazıları class isimlerini testSinifi şeklinde verirken bazıları da TestSinifi olarak verebiliyor. Bu da okumayı zorlaştırıyor. PHP uzmanı yazılımcılar bu soruna çözüm olarak bazı standartlar belirlemişlerdir. Bu standartlar sayesinde kodlar tek bir düzende yazılmış oluyor.
PHP Standards Recommendations (PSR) Bu standartlara uyup uymamak sizin veya şirketinizin elinde. Yapılması zorunlu değil ama yapılırsa işleri kolayaştıran bir standart.
PSR-0 : Autoloading(Otomatik Yükleme) Standartları
- Autoloading yapısı üzerine kurulu bir mimariye sahiptir.
- Her sınıfın bir namespace’i olmalıdır.
- Her namespace’in bir üst namespace’i olmalıdır. Yani; \Proje_adi\namespace\class\
- Her namespace’in alt namespace’leri olabilir.
- Her namespace “_” işareti, / (DIRECTORY_SEPARATOR) olarak algılanmalıdır.
- Proje adında, sınıf isimlerinde büyük küçük harf kombinasyonları olabilir.
PSR-1 : Basic Coding Standard (Temel Kodlama Standartları)
PSR-1 standartları PSR-0 ı destekler ve bazı kod yazma stilleri vardır.
- Dosyalar UTF-8 ve BOM’suz olmalıdır.
- PHP dosyaları <?php başlamalı.
- Metot isimleri camelCase olmalıdır.
- Sınıf sabitleri tamamı büyük harften oluşmalıdır.
- Değişken isimlerinde StudlyCaps, camelCase veya hepsi küçük şekilde alt çizgi dahil kullanım olabilir. getOption, get_option
- Sınıf isimleri StudlyCaps olmalıdır.
PSR-2 : Coding Style Guide (Kodlama Stili)
PSR-1’i destekler.
- Her satırda önerilen 80 karakter, max 120 karakter olmalıdır.
- Satırlarda tab yerine 4 boşluk kullanılmalıdır. (whitespace).
- Namespace, class ismi, metot isminden sonra 1 boşluk bırakılmalı.
- Metot, sınıf oluşturulduğunda açılan süslü parantezler “{” ismin bitişinde değil bir alt satırda açılmalı.
- Operatörler ile değişkenler arasında bir karakter boşluk bırakılmalı.
- true,false,null küçük kullanılmalı.
PSR-3 : Logger Interface (Loglayıcı Arayüzü)
- Loglama üzerine kurulu standartlardır.
- 8 level log tipi olmasını öneriyor. (debug, info, notice, warning, error, critical, alert, emergency)
- Her metot string veya obje kabul edebilir.
- Mesaj içerisindeki placeholder lar, verilen array içerisindekiler ile değiştirilir.
- Mesaj içerisindeki placeholder lar {} arasında yazılır.
- Placeholder lar A-Z, a-z, 0-9, _ karakterlerinden oluşabilir.
Buna benzer 7-8 tane PHP standardı belirlenmiş. Bunları PSR standartları‘ndan takip edebilirsiniz. Düzenli iş yapmak istiyorsanız kullanmanızı tavsiye ederim. Bu konu hakkında düşüncelerinizi yorum yaparak bizlerle paylaşabilirsiniz.