Decouple public API from Doctrine\Persistence\Proxy

[nicolas-grekas]

Related to doctrine/persistence#334
On the path to deprecating Doctrine\Persistence\Proxy in the future.

Adding EntityManager::isUninitializedEntity() will allow userland to decouple from the Proxy interface:

before:

if ($entity instanceof Proxy && !$entity->__isInitialized()) {
    $entity->__load();
}

after:

if ($em->isUninitializedEntity($entity)) {
    $em->initializeObject($entity);
}

[stof]

you should add the parameter and return types

[nicolas-grekas]

return type done, mixed for param is not compatible with PHP 7.1. @inheritDoc to the rescue, from doctrine/persistence#334

[stof]

if it is an internal API, can't we define the method in the interface directly ?

[nicolas-grekas]

Not possible because this overlaps with exiting declarations on legacy Proxy interfaces / implementations.

[nicolas-grekas]

PR green 🍏 (ignoring unrelated doc failures.)

[beberlei]

This changes code from not requiring the EntityManager, to requiring the entity manager to make this check.

Are we ok with this, since explicit proxy loading puts the code into "persistence context" that probably has the entity manager already?

[nicolas-grekas]

Are we ok with this, since explicit proxy loading puts the code into "persistence context" that probably has the entity manager already?

That's my though also yes: the code shouldn't care about proxy or not (as stated in the doc). But when caring, it means you have the EM not too far away (if not already there). The concept of a Doctrine proxy is in the same domain as Doctrine ORM/ODM in this context.