Deprecate EntityManager*::getPartialReference()

Partial objects have been deprecated, so it makes no sense to still have
this way of getting some.

UPGRADE.md

@@ -1,5 +1,9 @@
 # Upgrade to 2.17
 
+## Deprecate `EntityManagerInterface::getPartialReference()`
+
+This method does not have a replacement and will be removed in 3.0.
+
 ## Deprecate not-enabling lazy-ghosts
 
 Not enabling lazy ghost objects is deprecated. In ORM 3.0, they will be always enabled.

lib/Doctrine/ORM/Decorator/EntityManagerDecorator.php

@@ -4,6 +4,7 @@
 
 namespace Doctrine\ORM\Decorator;
 
+use Doctrine\Deprecations\Deprecation;
 use Doctrine\ORM\EntityManagerInterface;
 use Doctrine\ORM\EntityRepository;
 use Doctrine\ORM\Query\ResultSetMapping;
@@ -170,6 +171,13 @@ public function getReference($entityName, $id)
  */
  public function getPartialReference($entityName, $identifier)
  {
+ Deprecation::trigger(
+ 'doctrine/orm',
+ 'https://github.com/doctrine/orm/pull/10987',
+ 'Method %s is deprecated and will be removed in 3.0.',
+ __METHOD__,
+ );
+
  return $this->wrapped->getPartialReference($entityName, $identifier);
  }
 

lib/Doctrine/ORM/EntityManager.php

@@ -571,6 +571,12 @@ public function getReference($entityName, $id)
  */
  public function getPartialReference($entityName, $identifier)
  {
+ Deprecation::trigger(
+ 'doctrine/orm',
+ 'https://github.com/doctrine/orm/pull/10987',
+ 'Method %s is deprecated and will be removed in 3.0.',
+ __METHOD__,
+ );
  $class = $this->metadataFactory->getMetadataFor(ltrim($entityName, '\\'));
 
  $entity = $this->unitOfWork->tryGetById($identifier, $class->rootEntityName);

lib/Doctrine/ORM/EntityManagerInterface.php

@@ -200,6 +200,8 @@ public function getReference($entityName, $id);
  * never be visible to the application (especially not event listeners) as it will
  * never be loaded in the first place.
  *
+ * @deprecated 2.7 This method is being removed from the ORM and won't have any replacement
+ *
  * @param string $entityName The name of the entity type.
  * @param mixed $identifier The entity identifier.
  * @psalm-param class-string<T> $entityName

psalm.xml

@@ -90,6 +90,7 @@
  <referencedMethod name="Doctrine\ORM\Configuration::ensureProductionSettings"/>
  <referencedMethod name="Doctrine\ORM\Configuration::newDefaultAnnotationDriver"/>
  <referencedMethod name="Doctrine\ORM\EntityManager::createConnection"/>
+ <referencedMethod name="Doctrine\ORM\EntityManagerInterface::getPartialReference"/>
  <referencedMethod name="Doctrine\ORM\Id\AbstractIdGenerator::generate"/>
  <referencedMethod name="Doctrine\ORM\ORMInvalidArgumentException::invalidEntityName"/>
  <referencedMethod name="Doctrine\ORM\ORMSetup::createDefaultAnnotationDriver"/>

tests/Doctrine/Tests/ORM/Decorator/EntityManagerDecoratorTest.php

@@ -4,6 +4,7 @@
 
 namespace Doctrine\Tests\ORM\Decorator;
 
+use Doctrine\Deprecations\PHPUnit\VerifyDeprecations;
 use Doctrine\ORM\Decorator\EntityManagerDecorator;
 use Doctrine\ORM\EntityManagerInterface;
 use Doctrine\ORM\Query\ResultSetMapping;
@@ -22,6 +23,8 @@
 
 class EntityManagerDecoratorTest extends TestCase
 {
+ use VerifyDeprecations;
+
  public const VOID_METHODS = [
  'persist',
  'remove',
@@ -122,4 +125,12 @@ public function testAllMethodCallsAreDelegatedToTheWrappedInstance($method, arra
 
  self::assertSame($return, $decorator->$method(...$parameters));
  }
+
+ public function testGetPartialReferenceIsDeprecated(): void
+ {
+ $this->expectDeprecationWithIdentifier('https://github.com/doctrine/orm/pull/10987');
+ $decorator = new class ($this->wrapped) extends EntityManagerDecorator {
+ };
+ $decorator->getPartialReference(stdClass::class, 1);
+ }
 }

tests/Doctrine/Tests/ORM/EntityManagerTest.php

@@ -131,6 +131,7 @@ public function testCreateQueryDqlIsOptional(): void
 
  public function testGetPartialReference(): void
  {
+ $this->expectDeprecationWithIdentifier('https://github.com/doctrine/orm/pull/10987');
  $user = $this->entityManager->getPartialReference(CmsUser::class, 42);
  self::assertTrue($this->entityManager->contains($user));
  self::assertEquals(42, $user->id);