Symfony2 - Share Entity Between Bundles with different relationships

Question:

How do you share an entity between multiple bundles with different relationships?

For example both the ZooAnimalBundle and FarmAnimalBundle need a User Entity. A third Bundle AccountUserBundle has the User Entity.

In both the Zoo and Farm AnimalBundles I create a User Entity like so:

use Account\UserBundle\Entity\User as BaseUser;


class User extends BaseUser 
{
}

I then have a Hospital entity in Zoo:

class Hospital {
/**
 * @ORM\ManyToMany(targetEntity="Zoo\AnaimalBundle\Entity\User")
 * @ORM\JoinTable(name="users_zoo_animals")
 */
protected $users; 

And a Room entity in Farm:

class Room {
/**
 * @ORM\ManyToMany(targetEntity="Farm\AnaimalBundle\Entity\User")
 * @ORM\JoinTable(name="users_farm_animals")
 */
protected $users; 

Everything works so far in that I can call Zoo.Room->getUsers() or Farm.Hospital->getUsers()

However the problem is I'm not sure on how to set up the inverse relationship in their respective User entities.

If for example I update the FarmAnimal User Entity and run doctrine:generate:entities

/**
 * @ORM\Entity
 */
class User extends BaseUser
{
    /**
     * @ORM\ManyToMany(targetEntity="Room", mappedBy="users", cascade={"persist"})
     */
    protected $rooms;
}

It will copy the protected $properties from BaseUser and create all the set and get methods which is not what I want. What is the correct way of setting up these relationships?

Update

If you don't setup the inverse relationship, how would you select all users where hospital.id = 1

    $qb = $this->getEntityManager()->createQueryBuilder()
        ->select(
            'u'
        )
        ->from('Account\UserBundle\Entity\User','u')
        ->leftJoin('u.hospitals', 'h')
        ->andWhere('h.id = :hospital_id')
            ->setParameter('hospital_id',$hospital_id);

This gives the error:

   Class Account\UserBundle\Entity\User has no association named hospitals 

I know I could select from hospital and join user because that relationship does exist but I need to select users because I am using them with Doctrine\ORM\Tools\Pagination\Paginator

The query would be

    $qb = $this->createQueryBuilder('a')
        ->select(
            'h', 'u'
        )
        ->leftJoin('h.users', 'u')

The problem with this is Paginator only sees one result Hospital because the Users are attached to it.

You can define abstract entity dependencies and implement them with other bundles.

First, each of the bundles depending on a user entity should define a User interface. For example:

namespace Foo\BarBundle\Entity;

interface UserInterface
{
    public function getId();

    public function getEmail();

    // other getters
}

Then, in each entity depending on the user, define the relationship, e.g.:

namespace Foo\BarBundle\Entity;

use Doctrine\ORM\Mapping as ORM;
use Symfony\Component\Validator\Constraints as Assert;

/**
 * @ORM\Entity
 */
class Something
{
    /**
     * @ORM\ManyToOne(targetEntity="UserInterface")
     * @Assert\NotNull
     */
    protected $User;

    // add other fields as required
}

Now you need to register the User entity as an implementation of the UserInterfaces:

namespace Foo\UserBundle\Entity;

use Foo\BarBundle\Entity\UserInterface as BarUserInterface;
use Foo\FoobarBundle\Entity\UserInterface as FoobarUserInterface;

/**
 * @ORM\Entity
 */
class User implements BarUserInterface, FoobarUserInterface
{
    // implement the demanded methods
}

Then add the following to app/config/config.yml:

doctrine:
    orm:
        resolve_target_entities:
            Foo\BarBundle\Entity\UserInterface: Foo\UserBundle\Entity\User
            Foo\FooarBundle\Entity\UserInterface: Foo\UserBundle\Entity\User

(Heads up: there will usually already be a doctrine.orm node which you'll have to extend.)

This is not a perfect solution, because you cannot really say which fields the user entity should have. On the other hand, it's strictly OOP, as you don't have to know about internals of the User implementation – you just need it to return the right values.

Related:

Symfony2: changing the request class and updating the test environment

Remove automaticaly entity in BD when choice value not selected (or null selected)

Symfony Crawler: how to check that a link to a particular page exists

Setting cookie for AngularJS translate locale using PHP

symfony twig render dynamic twig code

Symfony2 creating and persisting entity relationships

Unable to configure Symfony (3rd party) bundle

Force Uppercase on Symfony2 form text field

Setup VPS with a Symfony2 project from git repository

Deserializing or parse XML response in Symfony2

comparison operator is not working in twig

How to select all rows that don't have one-to-many entity with certain value using Doctrine

Update session in symfony2 for shoppingg cart

How adapt the path to the previous and next article

Symfony\Component\Config\Exception\FileLoaderLoadException] error

Validation of a form before submission

Symfony2/Twig - iterate over select options

Symfony one-to-one, unidirectional relation

Symfony change validation message globally

How to create a console command in Symfony2 application

Symfony/Twig radio style formbuilder

Symfony files which are included in CSS are not found when using assetic

order attribute of an object in Synfony

ClassNotFoundException Symfony UserBundle

Symfony2: ajax call redirection if session timedout

Symfony 2 - Class “Mingle\StandardBundle\Entity\Product” is not a valid entity or mapped superclass

Symfony2 service unable to find template

Symfony2 move app.php from web directory to root directory

doctrine does not hydration when select custom fields

Store entity from session doesn't work => $em->persist()

wkhtmltopdf on openSuSE: cannot connect to X server

How to write and use Monolog handlers and channels

With a OneToMany relation between entities, how create the right queryBuilder with Doctrine (on the Inversed Side entity)

AngularJS execute some action in all application instances

Class inheritance in Symfony2

Symfony Entity query builder that checks for free spots

Set Auth Token manually for different firewall

Unique Entity Error message

Symfony/Twig how to render a Route set by anotation?

WebTestCase, Silex and $_GET

Using crontab to call wget every 5 minutes

Symfony 2 unable to pass entity repository to form

Logs an entire array using Monolog [closed]

Symfony2 Catchable Fatal Error: Argument 1 passed to entity Catchable Fatal Error: Argument 1 passed to entity