Hataları önlemek ve işleri kolaylaştırmak için Symfony2 ile birlikte ek kütüphanelerinizin versiyonlarının yönetildiği bir dosya ve bunun için tek basit bir komutla çalıştırabileğiniz bir program geliştirilmiş. Bu program git versiyon kontrol sistemini kullanıyor, dolayısıyla git sisteminin bilgisayarınızda yüklü olması gerekiyor. Eğer git yüklü değilse Windows’ta yüklemek için şuradaki talimatları izleyebilirsiniz.

deps Dosyası ve bin/vendors komutu

Öncelikle Symfony2 framework şu adresten ek kütüphaneler olmadan (without vendors) indiriyoruz, arşiv dosyasını açıyoruz. Arşivin açıldığı  klasörde deps ve deps.lock isminde 2 adet dosya göreceksiniz. Deps dosyasındaki her bir blok ek kütüphaneleri göstermekte ve ek kütüphaneler kurmak için kullanacağımız program bu dosyayı okuyor. Deps.lock dosyası ise yüklediğiniz kütüphanenin git tarafından oluşturulan ve o commit’e ait commit-hash bilgisini (burada bahsetmiştim) tutuyor.

Peki yeni bir kütüphane yüklemek için ne yapacağız? Oldukça basit, deps dosyasına yeni bir kayıt gireceğiz. Deps dosyasına göz atarsanız kayıtlar genel olarak şöyledir:

[FOSUserBundle]
 git=git://github.com/FriendsOfSymfony/FOSUserBundle.git
 target=bundles/FOS/UserBundle
 version=1.2.0

Bu blokta [] içindeki bilgi ek kütüphanemizin ismini gösterir. Eğer target parametresiyle herhangi bir klasör belirmediyseniz varsayılan olarak burada verilen isimde bir klasör yaratılır ve dosyalar bu klasöre indirilir.

git=<git_repo_url> kısmına yazılan adres kısım ek kütüphanenini alınacağı adresi gösterir. Bu adrese git ve http/https ile başlayan kütüphane adreslerini girebilirsiniz. Gerekli olan parametreler aslında bu kadar, fakat diğer parametrelere de göz atalım.

target=<vendor_target> kısmında kütüphane dosyalarının indirileceği klasörü giriyoruz. Buraya girilen klasör <proje_klasörü>/vendor altında yaratılıyor.

Son olarak version= <versiyon> kısmında ise bir kütüphane için belli bir versiyon ve ya branch belirtebiliyoruz.

Deps dosyasında kayıtlı olan ek kütüphaneleri indirmek için proje klasörüne geçtikten yapmamız gereken sadece aşağıdaki komutu çalıştırmak:

php bin/vendors install

Bu komuttan sonra eğer vendor klasörünüzde hiçbir klasör görmezseniz ve ya klasörleriniz hepsi boşsa, git sistemini işletim sisteminize düzgün kuramamış olabilirsiniz. Eğer bazı kütüphaneler yüklenemiyorsa tekrar denediğinizde bunlar da yüklenecektir. İlk kez çalıştırdığınızda bu işlem zaman alabilir, sabırlı olun

Sistem Nasıl İşliyor?

Peki sistem nasıl işliyor, yukarıdaki komutu çalıştırdığımda neler oluyor diyenler için aşağıdaki şemayı hazırladım. Ek kütüphanelerimiz hayırlı olsun

[Exception] Facebook needs the CURL PHP extension.

Biraz araştırdığımda, WAMP gibi 3'ü bir yerde kurulumlarda Apache tarafından kullanılan php.ini dosyası ile konsoldan aşağıdaki şekilde çağırdığımız php komutunun farklı php.ini dosyası kullandığını öğrendim.

php app/console container:debug

Yani wamp’ın menüsünü kullanarak curl uzantısını aktifleştirseniz bile aslında konsoldan çağrılan php programının kullandığı php.ini değişmiyor. WAMP için örnek vermek gerekirse, C:\wamp\bin\php\php5.3.8 klasöründeki php.ini dosyasını şu şekilde düzenlemek gerekiyor:

;extension=php_curl.dll

extension=php_curl.dll

Geliştirme sırasında veritabanı sıklıkla değişir, özellikle database migration yapısı kullanmıyorsanız tabloları tekrar yaratmak zorunda kalırsınız. Benzer şekilde veritabanı yapınıza yeni tablolar eklenebilir, sistemin düzgün işlemesi için gerekli veriler (örneğin parametre tabloları) olabilir ya da ekibinize yeni yazılımcılar katılabilir. Bu gibi durumlarda tabloları kullanan ekranlar için tekrar test verileri girmek gerekir. İşte bu test verisi girme işlemini otomatik olarak gerçekleştirmek istediğimiz zaman, Doctrine ORM’de yer alan database fixtures özelliğini kullanabiliriz.

Kurulum

Symfony 2′de database fixtures özelliğini kullanmak için DoctrineFixturesBundle paketini yüklemek gerekiyor. Bunun için proje klasörümüzde yer alan deps dosyasına aşağıdaki bilgileri ekliyoruz:

[doctrine-fixtures]
git=http://github.com/doctrine/data-fixtures.git

[DoctrineFixturesBundle]
git=http://github.com/symfony/DoctrineFixturesBundle.git
target=/bundles/Symfony/Bundle/DoctrineFixturesBundle

Bu eklemeleri yaptıktan sonra komut satırından ilgili proje klasörüne gelip ek kütüphanelerin kurulumunu sağlayan ilgili komutu çalıştırıyoruz:

php bin\vendors install

Eğer kurulum sorunsuz tamamlandıysa {proje_klasoru}/vendor/doctrine-fixtures klasörünü olmalı.

Şu aşamada paketin kaynak kodunu projeye ekledik ama uygulamamız bu paketi henüz kullanmıyor. Bu nedenle paketi yüklemek için gerekli kodları ilgili sayfalara eklemek gerekiyor. Önce ilgili isim alanının (namespace) uygulama tarafından tanınması için {proje_klasoru}\app\autoload.php dosyasına aşağıdaki kodları ekliyoruz:

$loader->registerNamespaces(
       array( // ...
             'Doctrine\\Common\\DataFixtures' => __DIR__.'/../vendor/doctrine-fixtures/lib',
             'Doctrine\\Common' => __DIR__.'/../vendor/doctrine-common/lib',
             // ... ));

Burada dikkat edilmesi gereken nokta, Doctrine\\Common\\DataFixtures satırının Doctrine\\Common satırından önce gelmesi gerektiğidir. Symfony’de kullanılan isim alanları, yukarıdaki registerNamespaces() metodundaki sırasıyla kontrol edilir, bu nedenle ilk olarak Doctrine\\Common satırı gelirse, bir alt isim alanını gösteren satır dikkate alınmayacak ve Doctrine\\Common\\DataFixtures isim alanı kayıt edilemeyecektir. Yani her zaman daha özel, yani daha alt seviye isim alanlarını gösteren satırlar daha önce gelmelidir.

Fixture Yaratalım!

Test verilerini otomatik olarak oluşturacak dosyalar, Symfony’de PHP sınıflarından oluşmaktadır. Bu dosyalar, yani fixture dosyaları, ilgili paketin {paket_klasoru}/DataFixtures/ORM klasörü altında yer almalıdır (örneğin Dubluve/TestBundle/DataFixtures/ORM). Eğer MongoDB kullanmayı düşünüyorsanız  {paket_klasoru}/DataFixtures/MongoDB altında dosyaları tutmalısınız. Yükleyeceğiniz dosyanın adı önemli değil, fakat anlamlı olması açısından, örneğin User nesnesi için LoadUserData.php  olarak isimlendirebilirsiniz.

Peki dosyayı yarattık, içeriği nasıl oluşturacağız? Birçok uygulamada temel ihtiyaç olan kullanıcı nesnesine, geçerli bir kullanıcı için test verisi oluşturalım. Nesnemiz User, sahip olduğu özellikler username ve password ve daha önceden {paket_klasoru}/Entity altında ilgili sınıfı yaratmış olalım. Örnek kod aşağıdaki gibi olmalı:

// src/Dubluve/TestBundle/DataFixtures/ORM/LoadUserData.php

 namespace Dubluve\TestBundle\DataFixtures\ORM;
 use Doctrine\Common\DataFixtures\FixtureInterface;
 use Dubluve\TestBundle\Entity\User;
 use Doctrine\Common\Persistence\ObjectManager;

 class LoadUserData implements FixtureInterface {
   public function load(ObjectManager $manager) {
     $userAdmin = new User();
     $userAdmin->setUsername('admin');
     $userAdmin->setPassword('test');
     $manager->persist($userAdmin);
     $manager->flush();
   }
 }

User nesnesi ve benzer nesneler için fixture sınıfları oluşturduktan sonra tüm bu değişiklikleri veritabanına uygulamak için aşağıdaki komutlardan, mongodb kullanıyorsanız 2. komutu, yoksa sadece ilkini çalıştırıyoruz:

php app/console doctrine:fixtures:load
php app/console doctrine:mongodb:fixtures:load

Meraklısına Detaylar

Yukarıdaki örnek basit anlamda fixture kullanımını anlatıyor. Fakat veritabanınızda muhtemelen birbiriyle ilişkili birçok nesne olacak ve bunları birbiriyle ilişkilendirerek veritabana girmek isteyeceksiniz. Bunun için DoctrineFixtures paketine ilişki kurma ve ard arda fixture çalıştırma özellikler bulunuyor. Aşağıdaki örnekte ilk olarak kullanıcı tablosuna ve kullanıcı grubu tablosuna birer kayıt ekleyip, ara tabloda ilişkilendireğiz.

// src/Dubluve/TestBundle/DataFixtures/ORM/LoadUserData.php
namespace Dubluve\TestBundle\DataFixtures\ORM;

use Doctrine\Common\DataFixtures\AbstractFixture;
use Doctrine\Common\DataFixtures\OrderedFixtureInterface;
use Dubluve\TestBundle\Entity\User;
use Doctrine\Common\Persistence\ObjectManager;

class LoadUserData extends AbstractFixture implements OrderedFixtureInterface
{
    public function load(ObjectManager $manager)
    {
        $userAdmin = new User();
        $userAdmin->setUsername('admin');
        $userAdmin->setPassword('test');

        $manager->persist($userAdmin);
        $manager->flush();

        $this->addReference('admin-user', $userAdmin);
    }

    public function getOrder()
    {
        return 1; // the order in which fixtures will be loaded
    }
}

Yukarıdaki sınıfta, daha önceki fixture sınıfından farklı olarak getOrder() fonksiyonunu görüyoruz. Bu fonksiyon, yeni kullanıdığımız  AbstractFixture sınıfından miras geliyor ve fixture sınıfının hangi sıralamada çalıştırılacağını ifade ediyor. Fonksiyondan 1 değerinin dönmesi, ilk olarak bu fixture sınıfının çalıştırılacağını belirtiyor.

Yine farklı bir satır olan $this->addReference(‘admin-user’, $userAdmin) satırı bu fixture sınıfında $userAdmin nesnesini kullanarak veritabanına kaydettiğimiz kayıt için bir referans oluşturuyor. Bu referansı daha sonra başka bir fixture sınıfında kullanacağız.

Kullanıcı grubu için yaratacağımız fixture sınıfı da şu şekilde:

// src/Dubluve/TestBundle/ORM/LoadGroupData.php
namespace Dubluve\TestBundle\DataFixtures\ORM;

use Doctrine\Common\DataFixtures\AbstractFixture;
use Doctrine\Common\DataFixtures\OrderedFixtureInterface;
use Dubluve\TestBundle\Entity\Group;
use Doctrine\Common\Persistence\ObjectManager;

class LoadGroupData extends AbstractFixture implements OrderedFixtureInterface

{
    public function load(ObjectManager $manager)
{

        $groupAdmin = new Group();
        $groupAdmin->setGroupName('admin');

        $manager->persist($groupAdmin);
        $manager->flush();

        $this->addReference('admin-group', $groupAdmin);
    }

    public function getOrder()
    {
        return 2;
    }
}

Son olarak da referans oluşturduğumuz bu iki kayıt için ara tabloya kayıt yaratacak fixture sınıfını oluşturuyoruz:

// src/Dubluve/TestBundle/DataFixtures/ORM/LoadUserGroupData.php
namespace Dubluve\TestBundle\DataFixtures\ORM;

use Doctrine\Common\DataFixtures\AbstractFixture;
use Doctrine\Common\DataFixtures\OrderedFixtureInterface;
use Dubluve\TestBundle\Entity\UserGroup;
use Doctrine\Common\Persistence\ObjectManager;

class LoadUserGroupData extends AbstractFixture implements OrderedFixtureInterface
{
    public function load(ObjectManager $manager)
    {
        $userGroupAdmin = new UserGroup();
        $userGroupAdmin->setUser($manager->merge($this->getReference('admin-user')));
        $userGroupAdmin->setGroup($manager->merge($this->getReference('admin-group')));

        $manager->persist($userGroupAdmin);
        $manager->flush();
    }

    public function getOrder()
    {
        return 3;
    }
}

Bu sınıfları yarattıktan sonra yukarıda yaptığımız gibi ilgili konsol komutunu çalıştırıp, bu kayıtları veritabanına kaydedebiliriz.

Zevkle yazılım geliştireceğiniz günler dilerim!

Daha önceden Ruby On Rails’ta kullandığım ve çok faydalı bulduğum “database migrations” özelliğinin Symfony2′nin resmi paketlerinden biri olduğunu öğrendiğimde gerçekten çok sevindim. Database migrations, veritabanında sık sık değişiklik olan projelerde, bu değişikliklerin takibini kolaylaştıran ve değişiklikleri tek tek uygulamayı ve geri almayı sağlayan bir özelliktir. Her yapılan değişiklik için bir migration kaydı (Symfony2′de bu kayıt bir PHP sınıfı, Ruby On Rails’te Ruby sınıfıdır) oluşturulur. Bu sınıfta genel olarak iki farklı fonksiyon yardımıyla yapılan değişiklik ve geri alma işlemleri tanımlanır.

Kurulum

Symfony2′de database migrations özelliğini kullanmak için DoctrineMigrationsBundle isimli paketi kurmak gerekiyor. Hali hazırda çalışan bir Symfony2 projemiz olduğunu varsayarak, bu paketi kurabilmek için deps dosyasına aşağıdaki satırları ekliyoruz:

[doctrine-migrations]
git=http://github.com/doctrine/migrations.git
[DoctrineMigrationsBundle]
git=http://github.com/symfony/DoctrineMigrationsBundle.git
target=/bundles/Symfony/Bundle/DoctrineMigrationsBundle

Daha sonra paket kurulumunun başlaması için, komut satırında proje klasörüne geçiyor ve tüm paketlerin güncellenmesi için ilgili komutu çalıştırıyoruz. Projenin D:\ diskinde olduğunu ve WampServer kullandığımızı varsayıyorum:

cd d:\wamp\www\{proje_klasoru}
php bin/vendors install

Paket kurulumu tamamlandı, fakat şu an bu paketi projemizde kullanamıyoruz. Paketi projede kullanabilmek için önce bu paketin ait olduğu isim alanını (namespace) projemizin tanımasını sağlamalıyız. Bunun için projemizin app klasöründe yer alan autoload.php dosyasına aşağıdaki şekilde ekleme yapıyoruz:

public function registerBundles()
{
$bundles = array(
//...
new Symfony\Bundle\DoctrineMigrationsBundle\DoctrineMigrationsBundle(),
);
}

Sonrasında paketin yazılım tarafından yüklenmesi için aşağıdaki kodu {proje_klasoru}/app/AppKernel.php dosyasına ekliyoruz:

public function registerBundles()
{
    $bundles = array(
        // Burada daha önceden yüklemiş olduğunuz başka paketler olabilir...
        new Symfony\Bundle\DoctrineMigrationsBundle\DoctrineMigrationsBundle(),
    );
}

Paket Kullanımı

Paketle ilgili tüm ayarlar bitti, şimdi biraz kullanımdan bahsedelim. Öncelikle belirtelim ki, DoctrineMigrationsBundle paketi, Symfony2′yi komut satırından kullanırken bize ek komutlar sağlıyor. Bu da tabii ki migration kullanmak için büyük kolaylık sağlıyor. Windows komut satırında, projemizin klasöründeyken, aşağıdaki komutu çalıştırarak yeni migration komutlarını görebiliriz:

php app\console | find "migrations"

Bu komutlardan örneğin “status”, bize şu anki durum hakkında bilgi verir:

$ php app\console doctrine:migrations:status

== Configuration

>> Name: Application Migrations
 >> Database Driver: pdo_mysql
 >> Database Name: {veritabani_adi}
 >> Configuration Source: manually configured
 >> Version Table Name: migration_versions
 >> Migrations Namespace: Application\Migrations
 >> Migrations Directory: D:\wamp\www\{proje_klasoru}\app/DoctrineMigrations
 >> Current Version: 2012-01-10 09:00:34 (20120110090034)
 >> Latest Version: 2012-01-10 09:00:34 (20120110090034)
 >> Executed Migrations: 2
 >> Available Migrations: 2
 >> New Migrations: 0

DoctrineMigrationsBundle paketi, hangi değişikliklerin yapıldığını, şu an projenin hangi değişiklik versiyonunda olduğunu, veritabanında kendi tablolarında tutuyor. Yani tablo değişiklikleri için bir nevi versiyon kontrolü sistemi oluşturuyor. İlk yüklemeden sonra, paketin kendi tabloları henüz veritabanında olmadığı için, bu tabloları oluşturmak gerekiyor. Bu tabloları oluşturmak için komut satırında aşağıdaki komutları çalıştırıyoruz:

php app\console doctrine:migrations:diff

php app\console doctrine:migrations:migrate

Yeni Migration Yaratmak

Paket tabloları yaratıldı. Artık migrations kullanarak tablolarımızda değişiklikler yapabileceğiz. O zaman hemen bir migration sınıfı yaratalım ve içeriğini inceleyelim Yine komut satırında aşağıdaki komutu çalıştırıyoruz:

php app\console doctrine:migrations:generate

Yeni bir migration dosyası ve sınıfı projemizin app\DoctrineMigrations klasöründe yaratılmış oldu. Bu dosyada up() ve down() isminde iki fonksiyon bulunuyor. Bu fonksiyonlardan up() ilgili migration uygulandığında yapılacak değişikliği, down() ise bu değişiklik geri alındğında yapılması gerekenleri içeriyor. Bir migration dosyasının içeriği örneğin şu şekilde olabilir:

< ?php  namespace DoctrineMigrations;  use Doctrine\DBAL\Migrations\AbstractMigration, Doctrine\DBAL\Schema\Schema;  class Version20100416130422 extends AbstractMigration {  	public function up(Schema $schema) {  		$this->addSql('CREATE TABLE addresses (id INT NOT NULL, street VARCHAR(255) NOT NULL, PRIMARY KEY(id)) ENGINE = InnoDB');
	} 

	public function down(Schema $schema) {
		$this->addSql('DROP TABLE addresses');
	}
}

Her bir veritabanı değişikliği için yeni bir sınıf üretmek ve ilgili komutları burada tutmak biraz zor gelebilir. Fakat asıl güzel nokta burada ortaya çıkıyor: Symfony2′de veritabanı değişiklikleri otomatik tespit edilerek ilgili migration dosyası otomatik yaratılıyor. Mesela yeni bir alan ekledik, bunu ilgili entity sınıfına ekliyoruz, fakat migration oluşturmuyoruz. Komut satırından

php app\console doctrine:migrations:diff

komutunu çalıştırdığımızda, veritabanının mevcut hali ile entity sınıfları karşılaştırılıyor ve değişiklikler migration sınıfı olarak otomatik generate ediliyor. Bize sadece

php app\console doctrine:migrations:migrate

komutunu çalıştırmak ve yeni değişiklikleri uygulamak kalıyor.

Eski Bir Migration Anına Dönmek

Projemizin ilerleyen safhalarında, yaptığımız bazı değişiklikleri geri almamız gerekirse, istediğimiz herhangi bir ana dönmek de oldukça kolay. Yaratılan migration sınıflarının özel bir isimlendirme metodu olduğun fark etmişsinizdir. Bu sınıflar Version{migration_id}.php olarak oluşturulurlar. Buradaki migration_id ilgili değişikliği tekil olarak temsil eder. Eski bir migration anına (örneğin 20120110085916) dönmek için aşağıdaki komutu komut satırında çalıştırmak yeterli:

php app/console doctrine:migrations:migrate 20120110085916

İşte bu kadar kolay!

Hem database migration tanımıyla yeni tanışanlar, hem de daha önceden Ruby on Rails gibi framework’lerde bu özelliği kullanmış olanlar için umarım faydalı olmuştur.
Zevkle yazılım geliştireceğiniz günler dilerim!