Herencia entre entidades y consultas DQL relacionadas

Herencia entre entidades

Una de las características que tiene Doctrine es que se puede usar la herencia de clases para representar aquellas tablas que heredan de una tabla «base».

Pongamos un ejemplo:

• Tenemos una tabla Rol («padre») y de ella heredan 3 tipos de roles distintos(RolPlataforma, RolOrganizacion, RolEdicion), pero que comparten los mismos atributos que la tabla Rol «padre», excepto que se cada «entidad» hija se relacionan con entidades diferentes. Aqui el diagrama UML que representa el caso:
• Ahora la parte de las entidades:
  • Entity Padre Role

• /**
   * @ORM\Table(name="role")
   * @ORM\InheritanceType("JOINED")
   * @ORM\DiscriminatorColumn(name="discr", type="string")
   * @ORM\DiscriminatorMap({
   *     "role" = "Role",
   *     "role_edition" = "RoleEdition",
   *     "role_org" = "RoleOrganization",
   *     "role_plat" = "RolePlatform"
   * })
   */
  class Role 
  {
   const ROLE_EDITION = 'RoleEdition';
   const ROLE_ORGANIZATION = 'RoleOrganization';
   const ROLE_PLATFORM = 'RolePlatform';
   const ROLE = 'Role';
  
   /**
   * @ORM\Id
   * @ORM\Column(type="integer", nullable=false)
   * @ORM\GeneratedValue()
   */
   protected $id;
  
   /**
   * @ORM\Column(name="rol_borrado", type="boolean", nullable=false)
   */
   private $deleted = false;
  
   /**
   * @ORM\ManyToMany(targetEntity="efor\UsuarioBundle\Entity\User", mappedBy="roleUser")
   */
   private $user;
  
  //...
  
  //OTROS CAMPOS NO RELEVANTES PARA EL EJEMPLO
  //SETTERS Y GETTERS Y OTROS METODOS.

• Con la anotacion estamos indicando que se va a hacer herencia de tablas y que los tipos de discriminador van a ser los que pone en el «DiscriminatorMap». De esta entidad nunca se van a instanciar objetos, siempre se instanciaran objetos de las entidades hijas, por lo que podriamos definirla como Abstracta.
• Entity descendiente RolePlatform

  • /**
     * @ORM\Table(name="rol_plataforma")
     * @ORM\Entity
     */
    class RolePlatform extends Role
    {
        protected $discr = self::ROLE_PLATFORM;
    
        /**
         * @ORM\ManyToOne(targetEntity="efor\AppBundle\Entity\Platform", inversedBy="rolePlatform")
         */
        private $platform;
    
        //otros campos
    }

• Entity descendiente RoleOrganization

• /**
   * @ORM\Table(name="rol_organizacion")
   * @ORM\Entity
   */
  class RoleOrganization extends Role
  {
      protected $discr = self::ROLE_ORGANIZATION;
  
      /**
       * @ORM\ManyToOne(targetEntity="efor\AppBundle\Entity\Organization", inversedBy="roleOrganization", cascade={"persist"})
       */
      private $organization;
  
      //otros campos
  }

• Entity descendiente RoleEdition

• /**
   * @ORM\Table(name="rol_edicion")
   * @ORM\Entity
   */
  class RoleEdition extends Role
  {
      protected $discr = self::ROLE_EDITION;
  
      /**
       * @ORM\ManyToOne(targetEntity="efor\AppBundle\Entity\Edition", inversedBy="roleEdition")
       */
      private $edition;
  
      //otros campos
  }

Si os fijas cada entidad hija tiene una relacion distinta a otra entidad, por eso necesitabamos usar la herencia entre entidades, porque podemos crear objetos que se relacionan con entidades distintas en funcion del tipo de relacion que queramos tener.

En la documentación de Doctrine explica los tipos de herencia entre entidades y algunas consideraciones a tener en cuenta cuando se usa la herencia. Os dejo aqui la documentacion:

-http://doctrine-orm.readthedocs.org/projects/doctrine-orm/en/latest/reference/inheritance-mapping.html#class-table-inheritance

-http://doctrine-orm.readthedocs.org/projects/doctrine-orm/en/latest/reference/inheritance-mapping.html#single-table-inheritance

-http://stackoverflow.com/questions/7504680/doctrine-2-how-to-write-a-dql-select-statement-to-search-some-but-not-all-the

Consultas DQL filtradas por el campo discriminador:

Una de las dudas que surgen al trabajar con la herencia en Doctrine es saber como puedes filtrar las consultas por el campo discriminatorio. En mi caso, necesitaba filtrar los resultados por aquellos objetos que eran de una determinada clase del discriminador(RoleOrganization) y despues de buscar, encontre que se puede hacer algo asi:

public function findUsersFilteredByRoleOrganization(User $loggedUser, Role $selectedRole)
{
    $qb = $this->getEntityManager()->createQueryBuilder();
    $usersResult = $qb
    ->select('user')
    ->from('UsuarioBundle:User', 'user')
    ->join('user.roleUser', 'roleUser')
    ->where('roleUser INSTANCE OF AppBundle:RoleOrganization')
    ->getQuery();

    return $usersResult->getResult();
}

Si os dais cuenta, hemos hecho uso del INSTANCE OF dentro del Where de la consulta DQL, la cual se traduce por esto en SQL:

SELECT t0_.*
INNER JOIN rol_usuario t2_ ON t0_.id = t2_.user_id
INNER JOIN rol t1_ ON t1_.id = t2_.role_id
LEFT JOIN rol_edition t3_ ON t1_.id = t3_.id
LEFT JOIN rol_org t4_ ON t1_.id = t4_.id
LEFT JOIN rol_plataforma t5_ ON t1_.id = t5_.id
WHERE t1_.discr IN (‘role_org’)

De esta forma solo obtenemos los objetos del tipo «RoleOrganization» que queremos.

Espero que os sirve de ayuda, ya que la documentacion de Doctrine no es muy explicita en este aspecto y no lo explica muy bien que digamos.

Recordad compartir este articulo para que llegue al maximo de amigos de Symfony.

Saludos ¡¡