PHP Kod Standartları

PSR - PHP Standart Tavsiyeleri

PHP-FIG tarafından 4+1 konu ele alınmış. Bunlar:

• PSR-0 : Autoloading(Otomatik Yükleme) Standartları { Artık Önerilmemektedir. PSR-4 yeni alternatifidir }
• PSR-1 : Temel Kodlama Standartları
• PSR-2 : Kodlama Stili 
• PSR-3 : Logger Interface
• PSR-4 : Geliştirilmiş Autoloader

PSR-0 : Autoloading(Otomatik Yükleme) Standartları { Artık Önerilmemektedir. PSR-4 yeni alternatifidir }

• Bir namespace'in ve class'ın sahip olması gereken yapı\<Sağlayıcı Adı>\(<Namespace>\)*<Class Adı>
• Her namespace'in üst seviye bir namespace'i olması gerekir.
• Her namespace'e alt namespace'ler eklenebilir.
• Her namespace dosya sistemi tarafından yüklenirken DIRECTORY_SEPARATOR dönüştürülür.
• Class adındaki her "_" karakteri DIRECTORY_SEPARATOR dönüştürülür. Namespaces'lerdeki  "_" karakterinin özel bir anlamı yoktur.
• Bir namespace'in ve class'ın sahip olması gereken yapı dosya sisteminden yüklendiğinde sonuna .php eklenir.
• Sağlayıcı adı, namespaces'ler ve class adları büyük veya küçük harflerin herhangi bir kombinasyonundan oluşabilir.

Bir kaç örnek

• \Doctrine\Common\IsolatedClassLoader =>/path/to/project/lib/vendor/Doctrine/Common/IsolatedClassLoader.php
• \Symfony\Core\Request => /path/to/project/lib/vendor/Symfony/Core/Request.php
• \Zend\Acl => /path/to/project/lib/vendor/Zend/Acl.php
• \namespace\package_name\Class_Name =>/path/to/project/lib/vendor/namespace/package_name/Class/Name.php

Örnek Uygulama

Aşağıdaki örnek autoload fonksiyonu, PSR-0 standartların nasıl otomatik yüklendiğini gösterir.

<?php

function autoload($className)
{
    $className = ltrim($className, '\\');
    $fileName  = '';
    $namespace = '';
    if ($lastNsPos = strrpos($className, '\\')) {
        $namespace = substr($className, 0, $lastNsPos);
        $className = substr($className, $lastNsPos + 1);
        $fileName  = str_replace('\\', DIRECTORY_SEPARATOR, $namespace) . DIRECTORY_SEPARATOR;
    }
    $fileName .= str_replace('_', DIRECTORY_SEPARATOR, $className) . '.php';

    require $fileName;
}
spl_autoload_register('autoload');

PSR-1 : Temel Kodlama Standartları

• Sadece <?php ve <?= etiketlerini kullanın.
• PHP kodları için sadece UTF-8 (BOM suz) kullanın.
• Yan etkileri ve açıklamaları birbirinden ayırın.
• PSR-0 yada PSR-4 uygulayın.
• Class adlarını StudlyCaps olarak yazın.
• Class constant'larını tamamiyle büyük harfler ile yazılmalı ayraç olarak sadece "_" kullanılmalıdır.
• Metot adları camelCase kullanılarak yazılmalıdır.

Yan etki ve açıklama satırı ayrım örneği (side effect: = yan etki)

<?php
// side effect: change ini settings
ini_set('error_reporting', E_ALL);

// side effect: loads a file
include "file.php";

// side effect: generates output
echo "\n";

// declaration
function foo()
{
    // function body
}
// şartlı tanımlamalar yan etki değil açıklamadır.
if (! function_exists('bar')) {
    function bar()
    {
        // function body
    }
}

PSR-2 : Kodlama Stili 

<?php
namespace Vendor\Package;

use FooInterface;
use BarClass as Bar;
use OtherVendor\OtherPackage\BazClass;

class Foo extends Bar implements FooInterface
{
    public function sampleFunction($a, $b = null)
    {
        if ($a === $b) {
            bar();
        } elseif ($a > $b) {
            $foo->bar($arg1);
        } else {
            BazClass::bar($arg2, $arg3);
        }
    }

    final public static function bar()
    {
        // method body
    }
}

• Log tipi olarak Syslog Protocol(RFC 5424)'ün 8 tipi(debug, info, notice, warning, error, critical, alert ve emergency) tanımlanmalıdır.

• İleti, bir string veya __toString() uygulayan nesne olmalıdır.

• Mesaj içerisindeki yer tutucular gelen içerikteki anahtarla değiştirilebilir.

• Yer tutucular süslü paranten içinde olmalıdır.

Log'lama verisi hazırlama (Interpolate = Aradaki veriyi değiştirmek)

<?php
  /**
   * Interpolates context values into the message placeholders.
   */
  function interpolate($message, array $context = array())
  {
      // build a replacement array with braces around the context keys
      $replace = array();
      foreach ($context as $key => $val) {
          $replace['{' . $key . '}'] = $val;
      }

      // interpolate replacement values into the message and return
      return strtr($message, $replace);
  }

  // a message with brace-delimited placeholder names
  $message = "User {username} created";

  // a context array of placeholder names => replacement values
  $context = array('username' => 'bolivar');

  // echoes "User bolivar created"
  echo interpolate($message, $context);

PSR-4 : Geliştirilmiş Autoloader

• \<NamespaceAdı>(\<AltNameSpaceler>)*\<ClassAdı>
• Tam nitelikli class adı "Sağlayıcı Namespace'si" olarak da bilinen bir üst düzey namespace'e sahip olmalı.
• Tam nitelikli class adının bir veya daha fazla namespace'i olabilir.
• Alt çizginin class adında herhangi bir bölümünü için özel bir anlamı yok
• Class adları büyük veya küçük harflerin herhangi bir kombinasyonundan oluşabilir.

PSR-0'da durum böyle iken:

vendor/
    vendor_name/
        package_name/
            src/
                Vendor_Name/
                    Package_Name/
                        ClassName.php       # Vendor_Name\Package_Name\ClassName
            tests/
                Vendor_Name/
                    Package_Name/
                        ClassNameTest.php   # Vendor_Name\Package_Name\ClassNameTest

PSR-4'de durum böyledir

vendor/
    vendor_name/
        package_name/
            src/
                ClassName.php       # Vendor_Name\Package_Name\ClassName
            tests/
                ClassNameTest.php   # Vendor_Name\Package_Name\ClassNameTest

Bu konuyu parça parça anlatmak istemediğimden tek yazı olarak paylaştım. Yazı biraz uzun olduğu için hatalar yada eksik bilgiler olabilir. Yorumlarınızla düzeltme yaparsanız sevinirim.

"Bu kod standartlarını ne yapıcam ben ya! ben böyle iyiyim" diyorsanız, siz bilirsiniz.  Zaten kullanmak zorunda değilsiniz öyle bir durum olsa php kendini bir kalıba sokar, yazılıma php ile başlayan çoğu insanı bu işten soğuturdu. Niye kullancağını örnekle açıklayıp yazımı bitireyim.

Bu standartları uygularsan imajın iyi olacak, etrafındakileri de mutlu edeceksin. Kullanmazsan okul kıyafetlerinle sokak maçı yapıp ardından ekibini de kavgaya katıp dövüşüp duracaksın.

Kendinize iyi bakın. :)