fix issue 1556: Replace EntityManager with EntityManagerInterface in method declarations, etc.

Oliver Tischlinger · Oliver Tischlinger · commit 79dbb42aec23 · 2018-02-26T12:41:15.000+01:00
diff --git a/lib/Gedmo/Mapping/Event/Adapter/ORM.php b/lib/Gedmo/Mapping/Event/Adapter/ORM.php
@@ -2,10 +2,10 @@
 
 namespace Gedmo\Mapping\Event\Adapter;
 
+use Doctrine\ORM\EntityManagerInterface;
 use Gedmo\Mapping\Event\AdapterInterface;
 use Gedmo\Exception\RuntimeException;
 use Doctrine\Common\EventArgs;
-use Doctrine\ORM\EntityManager;
 use Doctrine\ORM\Event\LifecycleEventArgs;
 
 /**
@@ -23,7 +23,7 @@ class ORM implements AdapterInterface
     private $args;
 
     /**
-     * @var \Doctrine\ORM\EntityManager
+     * @var \Doctrine\ORM\EntityManagerInterface
      */
     private $em;
 
@@ -75,9 +75,9 @@ public function __call($method, $args)
     /**
      * Set the entity manager
      *
-     * @param \Doctrine\ORM\EntityManager $em
+     * @param \Doctrine\ORM\EntityManagerInterface $em
      */
-    public function setEntityManager(EntityManager $em)
+    public function setEntityManager(EntityManagerInterface $em)
     {
         $this->em = $em;
     }
diff --git a/lib/Gedmo/References/Mapping/Event/Adapter/ODM.php b/lib/Gedmo/References/Mapping/Event/Adapter/ODM.php
@@ -4,7 +4,7 @@
 
 use Doctrine\ODM\MongoDB\DocumentManager;
 use Doctrine\ODM\MongoDB\Proxy\Proxy as MongoDBProxy;
-use Doctrine\ORM\EntityManager;
+use Doctrine\ORM\EntityManagerInterface;
 use Doctrine\ORM\Proxy\Proxy as ORMProxy;
 use Gedmo\Mapping\Event\Adapter\ODM as BaseAdapterODM;
 use Gedmo\References\Mapping\Event\ReferencesAdapter;
@@ -28,7 +28,7 @@ public function getIdentifier($om, $object, $single = true)
             return $this->extractIdentifier($om, $object, $single);
         }
 
-        if ($om instanceof EntityManager) {
+        if ($om instanceof EntityManagerInterface) {
             if ($object instanceof ORMProxy) {
                 $id = $om->getUnitOfWork()->getEntityIdentifier($object);
             } else {
@@ -88,7 +88,7 @@ public function extractIdentifier($om, $object, $single = true)
     /**
      * Override so we don't get an exception. We want to allow this.
      */
-    private function throwIfNotEntityManager(EntityManager $em)
+    private function throwIfNotEntityManager(EntityManagerInterface $em)
     {
     }
 }
diff --git a/lib/Gedmo/References/Mapping/Event/Adapter/ORM.php b/lib/Gedmo/References/Mapping/Event/Adapter/ORM.php
@@ -5,7 +5,7 @@
 use Doctrine\ODM\MongoDB\DocumentManager as MongoDocumentManager;
 use Doctrine\ODM\MongoDB\Proxy\Proxy as MongoDBProxy;
 use Doctrine\ODM\PHPCR\DocumentManager as PhpcrDocumentManager;
-use Doctrine\ORM\EntityManager;
+use Doctrine\ORM\EntityManagerInterface;
 use Doctrine\ORM\Proxy\Proxy as ORMProxy;
 use Gedmo\Exception\InvalidArgumentException;
 use Gedmo\Mapping\Event\Adapter\ORM as BaseAdapterORM;
@@ -26,7 +26,7 @@ final class ORM extends BaseAdapterORM implements ReferencesAdapter
      */
     public function getIdentifier($om, $object, $single = true)
     {
-        if ($om instanceof EntityManager) {
+        if ($om instanceof EntityManagerInterface) {
             return $this->extractIdentifier($om, $object, $single);
         }
 
diff --git a/lib/Gedmo/Sortable/Entity/Repository/SortableRepository.php b/lib/Gedmo/Sortable/Entity/Repository/SortableRepository.php
@@ -2,8 +2,8 @@
 
 namespace Gedmo\Sortable\Entity\Repository;
 
+use Doctrine\ORM\EntityManagerInterface;
 use Doctrine\ORM\EntityRepository;
-use Doctrine\ORM\EntityManager;
 use Doctrine\ORM\Mapping\ClassMetadata;
 use Gedmo\Sortable\SortableListener;
 
@@ -25,7 +25,7 @@ class SortableRepository extends EntityRepository
     protected $config = null;
     protected $meta = null;
 
-    public function __construct(EntityManager $em, ClassMetadata $class)
+    public function __construct(EntityManagerInterface $em, ClassMetadata $class)
     {
         parent::__construct($em, $class);
         $sortableListener = null;
diff --git a/lib/Gedmo/Tool/Wrapper/AbstractWrapper.php b/lib/Gedmo/Tool/Wrapper/AbstractWrapper.php
@@ -2,9 +2,9 @@
 
 namespace Gedmo\Tool\Wrapper;
 
-use Doctrine\ORM\EntityManager;
 use Doctrine\ODM\MongoDB\DocumentManager;
 use Doctrine\Common\Persistence\ObjectManager;
+use Doctrine\ORM\EntityManagerInterface;
 use Gedmo\Tool\WrapperInterface;
 use Gedmo\Exception\UnsupportedObjectManagerException;
 
@@ -57,7 +57,7 @@ abstract class AbstractWrapper implements WrapperInterface
      */
     public static function wrap($object, ObjectManager $om)
     {
-        if ($om instanceof EntityManager) {
+        if ($om instanceof EntityManagerInterface) {
             return new EntityWrapper($object, $om);
         } elseif ($om instanceof DocumentManager) {
             return new MongoDocumentWrapper($object, $om);
diff --git a/lib/Gedmo/Tool/Wrapper/EntityWrapper.php b/lib/Gedmo/Tool/Wrapper/EntityWrapper.php
@@ -2,7 +2,7 @@
 
 namespace Gedmo\Tool\Wrapper;
 
-use Doctrine\ORM\EntityManager;
+use Doctrine\ORM\EntityManagerInterface;
 use Doctrine\ORM\Proxy\Proxy;
 
 /**
@@ -32,9 +32,9 @@ class EntityWrapper extends AbstractWrapper
      * Wrap entity
      *
      * @param object                      $entity
-     * @param \Doctrine\ORM\EntityManager $em
+     * @param \Doctrine\ORM\EntityManagerInterface $em
      */
-    public function __construct($entity, EntityManager $em)
+    public function __construct($entity, EntityManagerInterface $em)
     {
         $this->om = $em;
         $this->object = $entity;
diff --git a/lib/Gedmo/Translatable/Entity/Repository/TranslationRepository.php b/lib/Gedmo/Translatable/Entity/Repository/TranslationRepository.php
@@ -2,10 +2,10 @@
 
 namespace Gedmo\Translatable\Entity\Repository;
 
+use Doctrine\ORM\EntityManagerInterface;
 use Gedmo\Translatable\TranslatableListener;
 use Doctrine\ORM\EntityRepository;
 use Doctrine\ORM\Query;
-use Doctrine\ORM\EntityManager;
 use Doctrine\ORM\Mapping\ClassMetadata;
 use Gedmo\Tool\Wrapper\EntityWrapper;
 use Gedmo\Translatable\Mapping\Event\Adapter\ORM as TranslatableAdapterORM;
@@ -31,7 +31,7 @@ class TranslationRepository extends EntityRepository
     /**
      * {@inheritdoc}
      */
-    public function __construct(EntityManager $em, ClassMetadata $class)
+    public function __construct(EntityManagerInterface $em, ClassMetadata $class)
     {
         if ($class->getReflectionClass()->isSubclassOf('Gedmo\Translatable\Entity\MappedSuperclass\AbstractPersonalTranslation')) {
             throw new \Gedmo\Exception\UnexpectedValueException('This repository is useless for personal translations');
diff --git a/lib/Gedmo/Tree/Entity/Repository/AbstractTreeRepository.php b/lib/Gedmo/Tree/Entity/Repository/AbstractTreeRepository.php
@@ -2,8 +2,8 @@
 
 namespace Gedmo\Tree\Entity\Repository;
 
+use Doctrine\ORM\EntityManagerInterface;
 use Doctrine\ORM\EntityRepository;
-use Doctrine\ORM\EntityManager;
 use Doctrine\ORM\Mapping\ClassMetadata;
 use Gedmo\Tool\Wrapper\EntityWrapper;
 use Gedmo\Tree\RepositoryUtils;
@@ -29,7 +29,7 @@ abstract class AbstractTreeRepository extends EntityRepository implements Reposi
     /**
      * {@inheritdoc}
      */
-    public function __construct(EntityManager $em, ClassMetadata $class)
+    public function __construct(EntityManagerInterface $em, ClassMetadata $class)
     {
         parent::__construct($em, $class);
         $treeListener = null;
diff --git a/lib/Gedmo/Tree/RepositoryUtils.php b/lib/Gedmo/Tree/RepositoryUtils.php
@@ -50,7 +50,7 @@ public function childrenHierarchy($node = null, $direct = false, array $options
 
         if ($node !== null) {
             if ($node instanceof $meta->name) {
-                $wrapperClass = $this->om instanceof \Doctrine\ORM\EntityManager ?
+                $wrapperClass = $this->om instanceof \Doctrine\ORM\EntityManagerInterface ?
                     '\Gedmo\Tool\Wrapper\EntityWrapper' :
                     '\Gedmo\Tool\Wrapper\MongoDocumentWrapper';
                 $wrapped = new $wrapperClass($node, $this->om);
diff --git a/lib/Gedmo/Tree/Strategy/ORM/Closure.php b/lib/Gedmo/Tree/Strategy/ORM/Closure.php
@@ -3,8 +3,8 @@
 namespace Gedmo\Tree\Strategy\ORM;
 
 use Doctrine\DBAL\Connection;
+use Doctrine\ORM\EntityManagerInterface;
 use Doctrine\ORM\Version;
-use Doctrine\ORM\EntityManager;
 use Doctrine\ORM\Mapping\ClassMetadataInfo;
 use Doctrine\Common\Persistence\ObjectManager;
 use Gedmo\Tree\Strategy;
@@ -403,11 +403,11 @@ public function processScheduledUpdate($em, $node, AdapterInterface $ea)
     /**
      * Update node and closures
      *
-     * @param EntityManager $em
+     * @param EntityManagerInterface $em
      * @param object        $node
      * @param object        $oldParent
      */
-    public function updateNode(EntityManager $em, $node, $oldParent)
+    public function updateNode(EntityManagerInterface $em, $node, $oldParent)
     {
         $wrapped = AbstractWrapper::wrap($node, $em);
         $meta = $wrapped->getMetadata();
diff --git a/lib/Gedmo/Tree/Strategy/ORM/Nested.php b/lib/Gedmo/Tree/Strategy/ORM/Nested.php
@@ -2,12 +2,12 @@
 
 namespace Gedmo\Tree\Strategy\ORM;
 
+use Doctrine\ORM\EntityManagerInterface;
 use Doctrine\ORM\Mapping\ClassMetadata;
 use Gedmo\Exception\UnexpectedValueException;
 use Doctrine\ORM\Proxy\Proxy;
 use Gedmo\Tool\Wrapper\AbstractWrapper;
 use Gedmo\Tree\Strategy;
-use Doctrine\ORM\EntityManager;
 use Gedmo\Tree\TreeListener;
 use Gedmo\Mapping\Event\AdapterInterface;
 
@@ -276,14 +276,14 @@ public function processPostRemove($em, $entity, AdapterInterface $ea)
      * Update the $node with a diferent $parent
      * destination
      *
-     * @param EntityManager $em
+     * @param EntityManagerInterface $em
      * @param object        $node     - target node
      * @param object        $parent   - destination node
      * @param string        $position
      *
      * @throws \Gedmo\Exception\UnexpectedValueException
      */
-    public function updateNode(EntityManager $em, $node, $parent, $position = 'FirstChild')
+    public function updateNode(EntityManagerInterface $em, $node, $parent, $position = 'FirstChild')
     {
         $wrapped = AbstractWrapper::wrap($node, $em);
 
@@ -511,13 +511,13 @@ public function updateNode(EntityManager $em, $node, $parent, $position = 'First
     /**
      * Get the edge of tree
      *
-     * @param EntityManager $em
+     * @param EntityManagerInterface $em
      * @param string        $class
      * @param integer       $rootId
      *
      * @return integer
      */
-    public function max(EntityManager $em, $class, $rootId = 0)
+    public function max(EntityManagerInterface $em, $class, $rootId = 0)
     {
         $meta = $em->getClassMetadata($class);
         $config = $this->listener->getConfiguration($em, $meta->name);
@@ -539,13 +539,13 @@ public function max(EntityManager $em, $class, $rootId = 0)
     /**
      * Shift tree left and right values by delta
      *
-     * @param EntityManager  $em
+     * @param EntityManagerInterface  $em
      * @param string         $class
      * @param integer        $first
      * @param integer        $delta
      * @param integer|string $root
      */
-    public function shiftRL(EntityManager $em, $class, $first, $delta, $root = null)
+    public function shiftRL(EntityManagerInterface $em, $class, $first, $delta, $root = null)
     {
         $meta = $em->getClassMetadata($class);
         $config = $this->listener->getConfiguration($em, $class);
@@ -611,7 +611,7 @@ public function shiftRL(EntityManager $em, $class, $first, $delta, $root = null)
      * Shift range of right and left values on tree
      * depending on tree level difference also
      *
-     * @param EntityManager  $em
+     * @param EntityManagerInterface  $em
      * @param string         $class
      * @param integer        $first
      * @param integer        $last
@@ -620,7 +620,7 @@ public function shiftRL(EntityManager $em, $class, $first, $delta, $root = null)
      * @param integer|string $destRoot
      * @param integer        $levelDelta
      */
-    public function shiftRangeRL(EntityManager $em, $class, $first, $last, $delta, $root = null, $destRoot = null, $levelDelta = null)
+    public function shiftRangeRL(EntityManagerInterface $em, $class, $first, $last, $delta, $root = null, $destRoot = null, $levelDelta = null)
     {
         $meta = $em->getClassMetadata($class);
         $config = $this->listener->getConfiguration($em, $class);
diff --git a/lib/Gedmo/Tree/TreeListener.php b/lib/Gedmo/Tree/TreeListener.php
@@ -72,7 +72,7 @@ public function getStrategy(ObjectManager $om, $class)
                 throw new \Gedmo\Exception\UnexpectedValueException("Tree object class: {$class} must have tree metadata at this point");
             }
             $managerName = 'UnsupportedManager';
-            if ($om instanceof \Doctrine\ORM\EntityManager) {
+            if ($om instanceof \Doctrine\ORM\EntityManagerInterface) {
                 $managerName = 'ORM';
             } elseif ($om instanceof \Doctrine\ODM\MongoDB\DocumentManager) {
                 $managerName = 'ODM\\MongoDB';
diff --git a/lib/Gedmo/Uploadable/Event/UploadableBaseEventArgs.php b/lib/Gedmo/Uploadable/Event/UploadableBaseEventArgs.php
@@ -3,7 +3,7 @@
 namespace Gedmo\Uploadable\Event;
 
 use Doctrine\Common\EventArgs;
-use Doctrine\ORM\EntityManager;
+use Doctrine\ORM\EntityManagerInterface;
 use Gedmo\Uploadable\FileInfo\FileInfoInterface;
 use Gedmo\Uploadable\UploadableListener;
 
@@ -25,7 +25,7 @@ abstract class UploadableBaseEventArgs extends EventArgs
     private $uploadableListener;
 
     /**
-     * @var \Doctrine\ORM\EntityManager
+     * @var \Doctrine\ORM\EntityManagerInterface
      */
     private $em;
 
@@ -56,13 +56,13 @@ abstract class UploadableBaseEventArgs extends EventArgs
 
     /**
      * @param UploadableListener          $listener
-     * @param \Doctrine\ORM\EntityManager $em
+     * @param \Doctrine\ORM\EntityManagerInterface $em
      * @param array                       $config
      * @param FileInfoInterface           $fileInfo
      * @param object                      $entity
      * @param string                      $action
      */
-    public function __construct(UploadableListener $listener, EntityManager $em, array $config, FileInfoInterface $fileInfo, $entity, $action)
+    public function __construct(UploadableListener $listener, EntityManagerInterface $em, array $config, FileInfoInterface $fileInfo, $entity, $action)
     {
         $this->uploadableListener = $listener;
         $this->em = $em;
@@ -85,7 +85,7 @@ public function getListener()
     /**
      * Retrieve associated EntityManager
      *
-     * @return \Doctrine\ORM\EntityManager
+     * @return \Doctrine\ORM\EntityManagerInterface
      */
     public function getEntityManager()
     {

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`
`5`	`5`	`use Doctrine\ODM\MongoDB\DocumentManager;`
`6`	`6`	`use Doctrine\ODM\MongoDB\Proxy\Proxy as MongoDBProxy;`
`7`		`-use Doctrine\ORM\EntityManager;`
	`7`	`+use Doctrine\ORM\EntityManagerInterface;`
`8`	`8`	`use Doctrine\ORM\Proxy\Proxy as ORMProxy;`
`9`	`9`	`use Gedmo\Mapping\Event\Adapter\ODM as BaseAdapterODM;`
`10`	`10`	`use Gedmo\References\Mapping\Event\ReferencesAdapter;`
`@@ -28,7 +28,7 @@ public function getIdentifier($om, $object, $single = true)`
`28`	`28`	`return $this->extractIdentifier($om, $object, $single);`
`29`	`29`	`}`
`30`	`30`
`31`		`- if ($om instanceof EntityManager) {`
	`31`	`+ if ($om instanceof EntityManagerInterface) {`
`32`	`32`	`if ($object instanceof ORMProxy) {`
`33`	`33`	`$id = $om->getUnitOfWork()->getEntityIdentifier($object);`
`34`	`34`	`} else {`
`@@ -88,7 +88,7 @@ public function extractIdentifier($om, $object, $single = true)`
`88`	`88`	`/**`
`89`	`89`	`* Override so we don't get an exception. We want to allow this.`
`90`	`90`	`*/`
`91`		`- private function throwIfNotEntityManager(EntityManager $em)`
	`91`	`+ private function throwIfNotEntityManager(EntityManagerInterface $em)`
`92`	`92`	`{`
`93`	`93`	`}`
`94`	`94`	`}`