Doctrine2 i Symfony2

Wciąż poznaję Symfony2. Nadszedł czas na wybranie i przetestowanie** ORMa. Symfony2 jest wystarczająco elastyczne, aby współpracować z praktycznie dowolnym (nowoczesnym) PHPowym ORMem. Równocześnie dostajemy rozsądną **domyślną opcję w postaci Doctrine2. Już dawno zrezygnowałem z Propela na rzecz Doctrine 1.2. Odkąd pojawiło się Doctrine 2.0, innych rozwiązań poważnie nie rozważam. Na dzień dzisiejszy Doctrine2 jest bezkonkurencyjny. Naukę zacząłem od zapisu i odczytu danych. Uwaga: Nie jest to tutorial, ale przegląd podstaw Doctrine2. Tutoriale możemy znaleźć w dokumentacji Doctrine2 i Symfony2.

Utrwalanie danych

W Doctrine1 mieliśmy dogodną możliwość definiowania mapowań obiektów na relacje w schemacie yml. Podobny mechanizm dostępny jest również w Doctrine2. Jest też coś lepszego. Co naprawdę podoba mi się w Doctrine2 to fakt, że możemy zapisać w bazie danych obiekt dowolnej klasy definiując mapowanie przy pomocy anotacji:

use Doctrine\ORM\Mapping as ORM;

/**
 * @ORM\Entity
 * @ORM\Table(name="articles")
 */
class Article
{
    /**
     * @ORM\Id
     * @ORM\Column(type="integer")
     */
    private $id = null;

    /**
     * @ORM\Column(type="string", length="255")
     */
    private $title = null;

    /**
     * @ORM\Column(type="boolean", name="is_active")
     */
    private $isActive = false;
}

Dzięki temu trzymamy klasę i mapowanie w jednym miejscu, zamiast w dwóch. Kolejną nowością jest to, że nie musimy już dziedziczyć po wspólnej klasie rekordu. Zauważmy, że klasa Article nie dziedziczy po niczym. Oprócz anotacji nie ma w niej nic nadzwyczajnego. Ponieważ nasze obiekty są lekkie, ma to dość znaczący wypływ na wydajność i pamięciożerność. Efektem ubocznym jest to, że podczas debugowania nie wyplujemy na ekran połowy frameworka przy zrzucania danych print_r() lub var_dump(). _ Ale gdzie się podziała metoda _save()? Doctrine2 nie implementuje wzorca active record. Nie mamy save, delete, czy innych typowych dla tego wzorca metod. Odpowiedzialność za te operacje przekazana jest do menedżera encji (Entity Manager). W Symfony2 menedżer encji dostępny jest w DIC (Dependency Injection Container). Zapisanie encji sprowadza się do:

$article = new Article();
$article->setTitle('Doctrine2 i Symfony2');

$entityManager = $this->get('doctrine.orm.entity_manager');
$entityManager->persist($article);
$entityManager->flush();

Bardzo podoba mi się to, że pracujemy z prostymi obiektami (POPO - Plain Old PHP Objects). Nasze klasy wolne są od kodu odpowiedzialnego za zapisywanie ich instancji do bazy danych.

Pobieranie danych

Po zapisaniu danych miło byłoby je odzyskać ;) Doctrine2 kontynuuje koncepcje DQL i pomocnych "szukaczy" (finder methods):

$entityManager = $this->get('doctrine.orm.entity_manager');
$article = $entityManager->find('Article', $id);

Zapytania wykonywane są przez menedżer encji. Za kulisami menedżer przekazuje wywołanie do obiektu repozytorium (wzorzec repository). Wszystko działa bez dodatkowych zabiegów, bo mamy do dyspozycji domyślną implementację repozytorium. Oczywiście możemy ją zmienić. Ponieważ nie lubię pisać zapytań bezpośrednio w kontrolerze, szukałem miejsca, gdzie byłoby im lepiej (czegoś podobnego do klas *Table z Doctrine1). Konwencją wydaje się być pisanie własnych klas repozytorium (Custom Repositories w dokumentacji Doctrine):

class ArticleRepository extends EntityRepository
{
    public function getActiveArticles()
    {
        return $this->_em->createQuery('SELECT a FROM Article a WHERE a.isActive = ?', true)->getResult();
    }
}

W encji musimy wskazać Doctrine klasę repozytorium, której chcemy użyć zamiast domyślnej:

use Doctrine\ORM\Mapping as ORM;

/**
 * @ORM\Entity(repositoryClass="ArticleRepository")
 * @ORM\Table(name="articles")
 */
class Article
{
  // ...
}

Co dalej?

Będę kontynuował naukę Doctrine2 podczas pracy  nad projektem w Symfony2. Jest jeszcze sporo ciekawych zagadnień, które znam bardzo pobieżnie (takie jak zdarzenia, walidatory, dziedziczenie). Poza tym Doctrine udostępnia sporą ilość anotacji, o których tu nie wspomniałem (jak związki pomiędzy obiektami).