Contingut

1 Doctrine

Doctrine

Una de les tasques més comunes i desafiadores per a qualsevol aplicació implica la persistència i la lectura d'informació cap a i des d'una base de dades. Encara que el framework Symfony no integra cap ORM per defecte, l'edició estàndard de Symfony, que és la distribució més utilitzada, ve integrada amb Doctrine, una biblioteca, l'únic objectiu de la qual és donar eines poderoses per fer-ho fàcil.

La llibreria Doctrine proporciona eines per simplificar l'accés i maneig de la informació de la base de dades.

La millor manera per explicar el framework doctrine és mitjançant exmples. Per aixó, es configura l'accés a la base de dades amb doctrine i s'exemplificarà amb la creació d'un objecte anomenat Product.

Configuracio de Doctrine i la Base de Dades

Ès necessari configurar la informació per accedir a la base de dades. Per convenció, aquesta informació es configura en l'arxiu app/config/parameters.yml:

# app/config/parameters.yml
parameters:
    database_driver:   pdo_mysql
    database_host:     localhost
    database_name:     test_project
    database_user:     root
    database_password: password

Ara que doctrine ja coneix l'usuari, la contrasenya i la Base de Dades a utilitzar, pots crear-la amb la següent comanda:

$ php app/console doctrine:database:create

Creant una classe Entity

Imagina que estàs desenvolupant una aplicació en la qual vas a mostrar productes. Oblidant-te de Doctrine i de les bases de dades, segurament estàs pensant a utilitzar un objecte Product per representar als productes. Crea aquesta classe dins del directori Entity del bundle AcmeStoreBundle:

// src/Acme/StoreBundle/Entity/Product.php
namespace Acme\StoreBundle\Entity;
 
class Product
{
    protected $name;
 
    protected $price;
 
    protected $description;
}

És una classe molt senzilla que només s'utilitza per emmagatzemar dades. Encara que es tracta d'una classe molt bàsica, compleix el seu objectiu de representar als productes de la teva aplicació. No obstant això, aquesta classe no es pot guardar en una base de dades — és només una classe PHP simple.

Podràs generar les classes de tipus entitat més fàcilment amb la següent comanda. Una vegada executat, Doctrine et farà diverses preguntes per generar l'entitat de forma interactiva:

$ php app/console doctrine:generate:entity

Mapeig d'objectes PHP a tables de BD

En comptes de treballar amb files i taules, Doctrine et permet guardar i obtenir objectes sencers a partir de la informació de la base de dades. El truc perquè això funcioni consisteix en mapear una classe PHP a una taula de la base de dades i després, mapear les propietats de la classe PHP a les columnes d'aquesta taula:

Només has d'afegir algunes metadades a la classe PHP per configurar com es mapean la classe Product i les seves propietats. Aquestes metadades es poden configurar en arxius YAML, XML o directament mitjançant anotacions a la pròpia classe PHP:

// src/Acme/StoreBundle/Entity/Product.php
namespace Acme\StoreBundle\Entity;
 
use Doctrine\ORM\Mapping as ORM;
 
/**
 * @ORM\Entity
 * @ORM\Table(name="product")
 */
class Product
{
    /**
     * @ORM\Id
     * @ORM\Column(type="integer")
     * @ORM\GeneratedValue(strategy="AUTO")
     */
    protected $id;
 
    /**
     * @ORM\Column(type="string", length=100)
     */
    protected $name;
 
    /**
     * @ORM\Column(type="decimal", scale=2)
     */
    protected $price;
 
    /**
     * @ORM\Column(type="text")
     */
    protected $description;
}

El nom de la taula és opcional i si ho omets, es genera automàticament en funció del nom de la classe PHP.

Pots consultar la documentació oficial de Doctrine sobre el mapeig. Tingues en compte que en la documentació de Doctrine no s'explica que si utilitzes anotacions, has de prefixar-les totes amb la cadena ORM\ (per exemple, ORM\Column(...)). Igualment, no t'oblidis d'afegir la declaració use Doctrine\ORM\Mapping as ORM; al principi de les teves classes per importar el prefix ORM\.

Consulta la secció Quoting reserved words de la documentació de Doctrine per conèixer la llista completa de paraules reservades.

Generant getters i setters

Recordem la classe Product que havíem creat:

// src/Acme/StoreBundle/Entity/Product.php
namespace Acme\StoreBundle\Entity;
 
class Product
{
    protected $name;
 
    protected $price;
 
    protected $description;
}

Doctrine ja sap com persistir els objectes de tipus Product en la base de dades, però aquesta classe no és molt útil de moment. Com Product és una classe PHP normal i corrent, és necessari crear mètodes getters i setters' (getName(), setName(), etc.) per poder accedir a les seves propietats (perquè són de tipus protected). Com això és bastant habitual, existeix un comando perquè Doctrine anyada aquests mètodes automàticament:

$ php app/console doctrine:generate:entities Acme/StoreBundle/Entity/Product

Creant les taules de la base de dades (el esquema)

Encara que tens una classe Product utilitzable amb informació de mapatge perquè Doctrine sàpiga persistir-la, encara no tens la seva corresponent taula product en la base de dades. Afortunadament, Doctrine pot crear automàticament totes les taules necessàries en la base de dades (una per a cada entitat coneguda de la teva aplicació). Per a això, executa la següent comanda:

$ php app/console doctrine:schema:update --force

Internament compara l'estructura que hauria de tenir la teva base de dades (segons la informació de mapatge de les teves entitats) amb l'estructura que realment té i genera les sentències SQL necessàries per actualitzar l'estructura de la base de dades.

En altres paraules, si afegeixes una nova propietat a la classe Product i executes aquest comando una altra vegada, es genera una sentència de tipus ALTER TABLE per afegir la nova columna a la taula product existent.

Persistint objectes a la base de dades

Ara que tens mapeada una entitat Product i la seva taula product corresponent, ja pots persistir la informació en la base de dades. De fet, persistir informació dins d'un controlador és bastant senzill. Afegeix el següent mètode al controlador DefaultController del bundle:

// src/Acme/StoreBundle/Controller/DefaultController.php
 
// ...
use Acme\StoreBundle\Entity\Product;
use Symfony\Component\HttpFoundation\Response;
 
public function createAction()
{
    $product = new Product();
    $product->setName('A Foo Bar');
    $product->setPrice('19.99');
    $product->setDescription('Lorem ipsum dolor');
 
    $em = $this->getDoctrine()->getManager();
    $em->persist($product);
    $em->flush();
 
    return new Response('Created product id '.$product->getId());
}

Explicació de les parts més importants del codi anterior:

Línies 9-12 En aquesta secció, creguis una instància i treballes amb l'objecte $product com faries amb qualsevol altre objecte PHP normal.
Línia 14 Aquesta línia obté el entity manager o gestor d'entitats de Doctrine, que s'utilitza per persistir i recuperar objectes cap a i des de la base de dades.
Línia 15 El mètode persist() li diu a Doctrine que ha de persistir l'objecte $product, però encara no es genera (i per tant, tampoc s'executa) la sentència SQL corresponent.
Línia 16 Quan es diu al mètode flush(), Doctrine examina tots els objectes que està gestionant per veure si és necessari persistir-los en la base de dades. En aquest exemple, l'objecte $product encara no s'ha persistit, per la qual cosa el gestor de l'entitat executa una consulta de tipus INSERT i crea una fila en la taula product.

Buscant objectes a la base de dades

Buscar informació de la base de dades i recuperar en forma d'objecte és encara més fàcil. Imagina que has configurat una ruta de l'aplicació per mostrar la informació d'un producte a partir del valor del seu aneu. El codi del controlador corresponent podria ser el següent:

public function showAction($id)
{
    $product = $this->getDoctrine()
        ->getRepository('AcmeStoreBundle:Product')
        ->find($id);
 
    if (!$product) {
        throw $this->createNotFoundException(
            'No product found for id '.$id
        );
    }
 
    // ... (pasar el objeto $product a una plantilla)
}

Doctrine sempre utilitza el que es coneix com a "repositori. Aquests repositoris són com a classes PHP el treball de les quals consisteix a ajudar-te a buscar les entitats d'una determinada classe. Pots accedir al repositori de l'entitat d'una classe mitjançant el codi:

$repository = $this->getDoctrine()
    ->getRepository('AcmeStoreBundle:Product');

Una vegada que obtens el repositori, tens accés a tot tipus de mètodes útils:

// consulta por la clave principal (generalmente 'id')
$product = $repository->find($id);
 
// métodos con nombres dinámicos para buscar un valor en función de alguna columna
$product = $repository->findOneById($id);
$product = $repository->findOneByName('foo');
 
// obtiene todos los productos
$products = $repository->findAll();
 
// busca productos basándose en el valor de una columna
$products = $repository->findByPrice(19.99);

També pots utilitzar els mètodes findBy i findOneBy per obtenir objectes en funció de vàries condicions:

// busca un producto con ese nombre y ese precio
$product = $repository->findOneBy(array(
    'name'  => 'foo', 'price' => 19.99
));
 
// obtiene todos los productos con un nombre determinado
// y ordena los resultados por precio
$product = $repository->findBy(
    array('name'  => 'foo'),
    array('price' => 'ASC')
);

Actualitzant un objecte

Una vegada que hagis obtingut un objecte de Doctrine, actualitzar-ho és relativament fàcil. Suposem que l'aplicació disposa d'una ruta que actualitza la informació del producte que el seu aneu es indica:

public function updateAction($id)
{
    $em = $this->getDoctrine()->getManager();
    $product = $em->getRepository('AcmeStoreBundle:Product')->find($id);
 
    if (!$product) {
        throw $this->createNotFoundException(
            'No product found for id '.$id
        );
    }
 
    $product->setName('New product name!');
    $em->flush();
 
    return $this->redirect($this->generateUrl('homepage'));
}

Actualitzar un objecte requereix de tres passos:

Obtenir l'objecte utilitzant Doctrine.
Modificar l'objecte.
Invocar al mètode flush() del entity manager.

Observa que no fa falta cridar al mètode $em->persist($product). Aquest mètode sive per avisar a Doctrine que vas a manipular un determinat objecte. En aquest cas, com l'objecte $product ho has obtingut mitjançant una consulta a Doctrine, aquest ja sap que ha d'estar atent als possibles canvis de l'objecte.

Eliminant un objecte

Eliminar objectes és un procés similar, però requereix invocar el mètode remove() del entity manager:

$em->remove($product);
$em->flush();

Com pot ser que imaginis, el mètode remove() avisa a Doctrine que vols eliminar aquesta entitat de la base de dades, però no l'esborra realment. La consulta DELETE corresponent no es genera ni s'executa fins que no s'invoca el mètode flush().

Exercici

Actualitza l'exercici CRUD realitzat a la UF anterior per a que utilitzi BD amb Doctrine.

Buscant Objectes amb el generador de consultes de Doctrine

Imagina que vols buscar tots aquells productes el preu dels quals sigui superior a 19.99 i retornar els resultats ordenats del més barat al més car. Aquesta cerca es pot realitzar de la següent manera amb el QueryBuilder de Doctrine:

$repository = $this->getDoctrine()
    ->getRepository('AcmeStoreBundle:Product');
 
$query = $repository->createQueryBuilder('p')
    ->where('p.price > :price')
    ->setParameter('price', '19.99')
    ->orderBy('p.price', 'ASC')
    ->getQuery();
 
$products = $query->getResult();

L'objecte QueryBuilder conté tots els mètodes necessaris per construir la consulta. En cridar al mètode getQuery(), el query builder retorna l'objecte de tipus Query amb el qual realment s'executa la consulta. El mètode getResult() retorna un array de resultats. Per obtenir solament un resultat, utilitza getSingleResult() (que llança una excepció quan no hi ha cap resultat) o getOneOrNullResult():

$product = $query->getOneOrNullResult();

Consulta la documentació de QueryBuilder per obtenir més informació.

Buscant objetes amb DQL

A més del QueryBuilder, Doctrine també et permet realitzar consultes directament amb el seu llenguatge DQL:

$em = $this->getDoctrine()->getManager();
$query = $em->createQuery(
    'SELECT p
       FROM AcmeStoreBundle:Product p
      WHERE p.price > :price
   ORDER BY p.price ASC'
)->setParameter('price', '19.99');
 
$products = $query->getResult();

La sintaxi DQL és increïblement poderosa, permetent-te unir fàcilment diferents entitats (el tema de les relacions s'explica més endavant), realitzar agrupacions, etc. Per a més informació, consulta la documentació oficial de Doctrine Query Language.

A2- Framework de capes per a DDBB (20h)

Contingut

Doctrine

Configuracio de Doctrine i la Base de Dades

Creant una classe Entity

Mapeig d'objectes PHP a tables de BD

Generant getters i setters

Creant les taules de la base de dades (el esquema)

Persistint objectes a la base de dades

Buscant objectes a la base de dades

Actualitzant un objecte

Eliminant un objecte

Exercici

Buscant Objectes amb el generador de consultes de Doctrine

Buscant objetes amb DQL

Menú de navegació

Eines de l'usuari

Espais de noms

Variants

Vistes

Més

Cerca

Navegació

Mòduls

Eines