PHP projelerinde bir ekip içinde çalışırken ya da açık kaynak kodları incelerken en büyük zorluklardan biri kod stilinin tutarsız olmasıdır. Farklı geliştiricilerin farklı girinti, süslü parantez ve isimlendirme tercihleri kodun okunurluğunu düşürür, diff çıktılarında gereksiz değişiklikler ortaya çıkar ve hata ayıklamayı zorlaştırır. PSR-12 (PHP Standard Recommendation 12) bu sorunları ortadan kaldırmak için hazırlanmış resmi bir stil rehberidir. Bu dersimizde PSR-12’nin temel kurallarını, Composer tabanlı php-cs-fixer ile otomatik uyarlama adımlarını ve gerçek hayatta karşılaşabileceğiniz sık hataları ele alacağız.
Temel Kurallar
PSR-12, PSR-1 ve PSR-2’nin üzerine inşa edilmiştir ve aşağıdaki başlıkları kapsar:
- Dosya kodlaması: UTF-8 without BOM.
- Satır uzunluğu: 120 karakteri geçmemeli, mümkünse 80 karakter.
- Girinti: 4 boşluk, sekme (tab) kullanılmaz.
- Süslü parantezler: Açılış
{aynı satırda, kapanış}ise yeni satırda ve aynı girintide. - Namespace ve use bildirimleri: Dosyanın en üstünde, bir satır boşlukla ayrılmış olarak.
- Sınıf, metod ve özellik isimlendirmesi:
StudlyCaps(sınıf),camelCase(metod ve özellik). - Fonksiyon ve metod çağrıları: Parantezden önce boşluk yok, argümanlar arasında bir boşluk bırakılmaz.
Bu kuralların hepsi bir araya geldiğinde kodunuz hem makine hem de insan tarafından daha rahat anlaşılır hâle gelir.
Adım Adım Uygulama
PSR-12’yi projeye entegre etmenin en pratik yolu php-cs-fixer gibi bir kod formatlayıcı kullanmaktır. Aşağıdaki adımları takip ederek ortamınızı hazırlayabilirsiniz:
- Composer ile kurulum: Proje kök dizininizde
composer require --dev friendsofphp/php-cs-fixerkomutunu çalıştırın. - Yapılandırma dosyası oluşturma: Proje köküne
.php-cs-fixer.phpadında bir dosya ekleyin ve içinde PSR-12 kurallarını etkinleştirin.<?php return (new PhpCsFixer\Config()) ->setRules(['@PSR12' => true]) ->setFinder( PhpCsFixer\Finder::create() ->in(__DIR__) ->exclude('vendor') ); ?> - Formatlayıcıyı çalıştırma:
vendor/bin/php-cs-fixer fixkomutunu çalıştırarak tüm.phpdosyalarınızı PSR-12’ye uygun hâle getirin. - CI entegrasyonu: GitHub Actions, GitLab CI ya da Jenkins gibi CI sistemlerine aynı komutu ekleyerek kodun her push’ta kontrol edilmesini sağlayın.
Bu adımları tamamladığınızda, ekip içinde “Kod stilini kontrol etmek” sorunu otomatik olarak çözülmüş olur.
Örnek Kod
Aşağıda PSR-12’ye tam uyumlu bir sınıf örneği bulacaksınız. Bu örnek, bir User nesnesi oluşturup basit bir greet metodu içeriyor.
<?php
namespace App\Model;
use DateTimeImmutable;
class User
{
private string $firstName;
private string $lastName;
private DateTimeImmutable $createdAt;
public function __construct(string $firstName, string $lastName)
{
$this->firstName = $firstName;
$this->lastName = $lastName;
$this->createdAt = new DateTimeImmutable();
}
public function greet(): string
{
return sprintf(
"Merhaba, %s %s! Hesabınız %s tarihinde oluşturulmuş.",
$this->firstName,
$this->lastName,
$this->createdAt->format('Y-m-d')
);
}
}
// Kullanım örneği
$user = new User('Ahmet', 'Yılmaz');
echo $user->greet();
?>Yukarıdaki kodda dikkat edilmesi gereken noktalar:
- Namespace ve
useifadeleri dosyanın en üstünde, bir satır boşlukla ayrılmış. - Sınıf adı
StudlyCapsbiçiminde. - Özellikler ve metodlar
camelCase. - Girinti 4 boşluk, sekme yok.
- Açılış süslü parantez aynı satırda, kapanış ise yeni satırda.
Aşağıdaki örnek ise aynı mantığı bir fonksiyon içinde gösterir. Fonksiyonlar da PSR-12 kurallarına uygun olarak yazılmalıdır.
<?php
function calculateSum(int $a, int $b): int
{
return $a + $b;
}
echo calculateSum(5, 7); // 12
?>Sık Yapılan Hatalar
PSR-12’yi uygularken yeni başlayanların sıkça yaptığı hatalar şunlardır:
- Tab karakteri kullanmak: IDE ayarlarında “Tab yerine 4 boşluk” seçeneğini etkinleştirin.
- Süslü parantezin yeni satırda olması:
{her zaman aynı satırda olmalı. - Namespace ve use bildirimlerinde boşluk eksikliği:
namespace App\Model;satırından sonra bir boş satır bırakın. - Satır uzunluğunu aşmak: Uzun ifadeleri birden fazla satıra bölün,
breakvecontinuegibi anahtar kelimelerden önce satır sonu ekleyin. - Değişken isimlerinde büyük harf kullanmak: Değişkenler
camelCaseolmalı, sınıf isimleriStudlyCaps.
Bu hataları önceden fark etmek için php-cs-fixer çıktısını inceleyin ve CI sürecine --dry-run parametresi ekleyerek sadece rapor almayı tercih edin.
Özet
PSR-12, PHP ekosisteminde kod tutarlılığını sağlamak için evrensel bir kılavuz sunar. 4 boşluk girinti, aynı satırda açılış süslü parantez, doğru isimlendirme kuralları ve dosya kodlaması gibi temel prensipleri benimseyerek:
- Okunabilirliği %30‑40 artırırsınız.
- Diff’lerde gereksiz değişiklikleri azaltırsınız.
- Yeni ekip üyelerinin projeye adaptasyon süresini kısaltırsınız.
Composer ile php-cs-fixer kurulumunu tamamladıktan sonra vendor/bin/php-cs-fixer fix komutunu düzenli olarak çalıştırmak, stil uyumsuzluklarını önceden yakalamanızı sağlar. Ayrıca CI entegrasyonu sayesinde kodun her push’ta kontrol edilmesi, stil ihlallerinin üretime geçmesini engeller.
Sık Sorulan Sorular
Soru 1: PSR-12, PSR-1 ve PSR-2’yi tamamen mi kapsar?
Cevap: Evet. PSR-12, PSR-1 (temel kodlama standartları) ve PSR-2 (eski kod stili) üzerine ek kurallar getirir ve bunları birleştirir. Dolayısıyla PSR-12’ye geçmek, önceki iki standardı da otomatik olarak benimsemiş olur.
Soru 2: Projede zaten farklı bir stil kullanılıyor, PSR-12’ye geçmek çok maliyetli mi?
Cevap: Geçiş sürecinde php-cs-fixer “dry‑run” modu ile mevcut kodun ne kadar değişeceğini görebilirsiniz. Büyük bir kod tabanı için adım adım (örneğin paket bazlı) dönüşüm yapmak, riskleri azaltır.
Soru 3: PSR-12’ye uymayan bir kodun çalışması engellenir mi?
Cevap: Hayır, PSR-12 sadece stil tavsiyesidir, çalışmayı etkilemez. Ancak ekip içinde tutarlılık sağlamak ve bakım maliyetini düşürmek için uygulanması şiddetle tavsiye edilir.
Yorumlar
Henüz onaylanmış yorum yok. İlk yorumu siz yazın.
Yorum yaz
Yorumunuz yönetici onayından sonra yayınlanır.