Add return types

doctrine · Dec 15, 2023 · 937bc46 · 937bc46
1 parent a77f4d3
commit 937bc46
Show file tree

Hide file tree

Showing 17 changed files with 69 additions and 154 deletions.
diff --git a/UPGRADE.md b/UPGRADE.md
@@ -6,6 +6,13 @@ awareness about deprecated code.
 - Use of our low-overhead runtime deprecation API, details:
   https://github.com/doctrine/deprecations/
 
+# Upgrade to 2.0
+
+## BC BREAK: Add return types to all the methods
+
+All return types defined in phpdoc `@return` are now defined in the method signature,
+they must be added to your code if you extend the classes or implement the interfaces.
+
 # Upgrade to 1.8
 
 Executor and Purger classes are final, they cannot be extended.

diff --git a/src/AbstractFixture.php b/src/AbstractFixture.php
@@ -46,10 +46,8 @@ private function getReferenceRepository(): ReferenceRepository
      * @see Doctrine\Common\DataFixtures\ReferenceRepository::setReference
      *
      * @param object $object - managed object
-     *
-     * @return void
      */
-    public function setReference(string $name, object $object)
+    public function setReference(string $name, object $object): void
     {
         $this->getReferenceRepository()->setReference($name, $object);
     }
@@ -64,11 +62,9 @@ public function setReference(string $name, object $object)
      *
      * @param object $object - managed object
      *
-     * @return void
-     *
      * @throws BadMethodCallException - if repository already has a reference by $name.
      */
-    public function addReference(string $name, object $object)
+    public function addReference(string $name, object $object): void
     {
         $this->getReferenceRepository()->addReference($name, $object);
     }
@@ -81,12 +77,11 @@ public function addReference(string $name, object $object)
      *
      * @psalm-param class-string<T>|null $class
      *
-     * @return object
      * @psalm-return ($class is null ? object : T)
      *
      * @template T of object
      */
-    public function getReference(string $name, ?string $class = null)
+    public function getReference(string $name, ?string $class = null): object
     {
         if ($class === null) {
             Deprecation::trigger(
@@ -107,10 +102,8 @@ public function getReference(string $name, ?string $class = null)
      * @see Doctrine\Common\DataFixtures\ReferenceRepository::hasReference
      *
      * @psalm-param class-string|null $class
-     *
-     * @return bool
      */
-    public function hasReference(string $name, ?string $class = null)
+    public function hasReference(string $name, ?string $class = null): bool
     {
         if ($class === null) {
             Deprecation::trigger(

diff --git a/src/Executor/AbstractExecutor.php b/src/Executor/AbstractExecutor.php
@@ -48,60 +48,50 @@ public function __construct(ObjectManager $manager)
         $this->referenceRepository = new ReferenceRepository($manager);
     }
 
-    /** @return ReferenceRepository */
-    public function getReferenceRepository()
+    public function getReferenceRepository(): ReferenceRepository
     {
         return $this->referenceRepository;
     }
 
-    public function setReferenceRepository(ReferenceRepository $referenceRepository)
+    public function setReferenceRepository(ReferenceRepository $referenceRepository): void
     {
         $this->referenceRepository = $referenceRepository;
     }
 
     /**
      * Sets the Purger instance to use for this executor instance.
-     *
-     * @return void
      */
-    public function setPurger(PurgerInterface $purger)
+    public function setPurger(PurgerInterface $purger): void
     {
         $this->purger = $purger;
     }
 
-    /** @return PurgerInterface */
-    public function getPurger()
+    public function getPurger(): PurgerInterface
     {
         return $this->purger;
     }
 
     /**
      * Set the logger callable to execute with the log() method.
-     *
-     * @return void
      */
-    public function setLogger(callable $logger)
+    public function setLogger(callable $logger): void
     {
         $this->logger = $logger;
     }
 
     /**
      * Logs a message using the logger.
-     *
-     * @return void
      */
-    public function log(string $message)
+    public function log(string $message): void
     {
         $logger = $this->logger;
         $logger($message);
     }
 
     /**
      * Load a fixture with the given persistence manager.
-     *
-     * @return void
      */
-    public function load(ObjectManager $manager, FixtureInterface $fixture)
+    public function load(ObjectManager $manager, FixtureInterface $fixture): void
     {
         if ($this->logger) {
             $prefix = '';
@@ -124,11 +114,9 @@ public function load(ObjectManager $manager, FixtureInterface $fixture)
     /**
      * Purges the database before loading.
      *
-     * @return void
-     *
      * @throws Exception if the purger is not defined.
      */
-    public function purge()
+    public function purge(): void
     {
         if ($this->purger === null) {
             throw new Exception(
@@ -149,8 +137,6 @@ public function purge()
      *
      * @param FixtureInterface[] $fixtures Array of fixtures to execute.
      * @param bool               $append   Whether to append the data fixtures or purge the database before loading.
-     *
-     * @return void
      */
-    abstract public function execute(array $fixtures, bool $append = false);
+    abstract public function execute(array $fixtures, bool $append = false): void;
 }
diff --git a/src/Executor/MongoDBExecutor.php b/src/Executor/MongoDBExecutor.php
@@ -40,16 +40,13 @@ public function __construct(DocumentManager $dm, ?MongoDBPurger $purger = null)
 
     /**
      * Retrieve the DocumentManager instance this executor instance is using.
-     *
-     * @return DocumentManager
      */
-    public function getObjectManager()
+    public function getObjectManager(): DocumentManager
     {
         return $this->dm;
     }
 
-    /** @inheritDoc */
-    public function setReferenceRepository(ReferenceRepository $referenceRepository)
+    public function setReferenceRepository(ReferenceRepository $referenceRepository): void
     {
         $this->dm->getEventManager()->removeEventListener(
             $this->listener->getSubscribedEvents(),
@@ -62,7 +59,7 @@ public function setReferenceRepository(ReferenceRepository $referenceRepository)
     }
 
     /** @inheritDoc */
-    public function execute(array $fixtures, bool $append = false)
+    public function execute(array $fixtures, bool $append = false): void
     {
         if ($append === false) {
             $this->purge();

diff --git a/src/Executor/ORMExecutor.php b/src/Executor/ORMExecutor.php
@@ -16,7 +16,7 @@ class ORMExecutor extends AbstractExecutor
     use ORMExecutorCommon;
 
     /** @inheritDoc */
-    public function execute(array $fixtures, bool $append = false)
+    public function execute(array $fixtures, bool $append = false): void
     {
         $executor = $this;
         $this->em->wrapInTransaction(static function (EntityManagerInterface $em) use ($executor, $fixtures, $append) {

diff --git a/src/Executor/ORMExecutorCommon.php b/src/Executor/ORMExecutorCommon.php
@@ -43,16 +43,13 @@ public function __construct(EntityManagerInterface $em, ?ORMPurgerInterface $pur
 
     /**
      * Retrieve the EntityManagerInterface instance this executor instance is using.
-     *
-     * @return EntityManagerInterface
      */
-    public function getObjectManager()
+    public function getObjectManager(): EntityManagerInterface
     {
         return $this->originalManager;
     }
 
-    /** @inheritDoc */
-    public function setReferenceRepository(ReferenceRepository $referenceRepository)
+    public function setReferenceRepository(ReferenceRepository $referenceRepository): void
     {
         $this->em->getEventManager()->removeEventListener(
             $this->listener->getSubscribedEvents(),

diff --git a/src/Executor/PHPCRExecutor.php b/src/Executor/PHPCRExecutor.php
@@ -35,14 +35,13 @@ public function __construct(DocumentManagerInterface $dm, ?PHPCRPurger $purger =
         $this->setPurger($purger);
     }
 
-    /** @return DocumentManagerInterface */
-    public function getObjectManager()
+    public function getObjectManager(): DocumentManagerInterface
     {
         return $this->dm;
     }
 
     /** @inheritDoc */
-    public function execute(array $fixtures, bool $append = false)
+    public function execute(array $fixtures, bool $append = false): void
     {
         $that = $this;
 

diff --git a/src/Loader.php b/src/Loader.php
@@ -73,7 +73,7 @@ class Loader
      *
      * @return array $fixtures Array of loaded fixture object instances.
      */
-    public function loadFromDirectory(string $dir)
+    public function loadFromDirectory(string $dir): array
     {
         if (! is_dir($dir)) {
             throw new InvalidArgumentException(sprintf('"%s" does not exist', $dir));
@@ -94,7 +94,7 @@ public function loadFromDirectory(string $dir)
      *
      * @return array $fixtures Array of loaded fixture object instances.
      */
-    public function loadFromFile(string $fileName)
+    public function loadFromFile(string $fileName): array
     {
         if (! is_readable($fileName)) {
             throw new InvalidArgumentException(sprintf('"%s" does not exist or is not readable', $fileName));
@@ -107,20 +107,16 @@ public function loadFromFile(string $fileName)
 
     /**
      * Has fixture?
-     *
-     * @return bool
      */
-    public function hasFixture(FixtureInterface $fixture)
+    public function hasFixture(FixtureInterface $fixture): bool
     {
         return isset($this->fixtures[get_class($fixture)]);
     }
 
     /**
      * Get a specific fixture instance
-     *
-     * @return FixtureInterface
      */
-    public function getFixture(string $className)
+    public function getFixture(string $className): FixtureInterface
     {
         if (! isset($this->fixtures[$className])) {
             throw new InvalidArgumentException(sprintf(
@@ -197,10 +193,8 @@ public function getFixtures()
      * class.
      *
      * @psalm-param class-string<object> $className
-     *
-     * @return bool
      */
-    public function isTransient(string $className)
+    public function isTransient(string $className): bool
     {
         $rc = new ReflectionClass($className);
         if ($rc->isAbstract()) {
@@ -214,10 +208,8 @@ public function isTransient(string $className)
 
     /**
      * Creates the fixture object from the class.
-     *
-     * @return FixtureInterface
      */
-    protected function createFixture(string $class)
+    protected function createFixture(string $class): FixtureInterface
     {
         return new $class();
     }
@@ -253,10 +245,8 @@ private function orderFixturesByNumber(): void
 
     /**
      * Orders fixtures by dependencies
-     *
-     * @return void
      */
-    private function orderFixturesByDependencies()
+    private function orderFixturesByDependencies(): void
     {
         /** @psalm-var array<class-string<DependentFixtureInterface>, int> */
         $sequenceForClasses = [];

diff --git a/src/OrderedFixtureInterface.php b/src/OrderedFixtureInterface.php
@@ -13,8 +13,6 @@ interface OrderedFixtureInterface
 {
     /**
      * Get the order of this fixture
-     *
-     * @return int
      */
-    public function getOrder();
+    public function getOrder(): int;
 }
diff --git a/src/ProxyReferenceRepository.php b/src/ProxyReferenceRepository.php
@@ -21,10 +21,8 @@ class ProxyReferenceRepository extends ReferenceRepository
 {
     /**
      * Serialize reference repository
-     *
-     * @return string
      */
-    public function serialize()
+    public function serialize(): string
     {
         $unitOfWork       = $this->getManager()->getUnitOfWork();
         $simpleReferences = [];
@@ -46,10 +44,8 @@ public function serialize()
      * Unserialize reference repository
      *
      * @param string $serializedData Serialized data
-     *
-     * @return void
      */
-    public function unserialize(string $serializedData)
+    public function unserialize(string $serializedData): void
     {
         $repositoryData = unserialize($serializedData);
 
@@ -95,10 +91,8 @@ public function unserialize(string $serializedData)
      * Load data fixture reference repository
      *
      * @param string $baseCacheName Base cache name
-     *
-     * @return bool
      */
-    public function load(string $baseCacheName)
+    public function load(string $baseCacheName): bool
     {
         $filename = $baseCacheName . '.ser';
 
@@ -121,10 +115,8 @@ public function load(string $baseCacheName)
      * Save data fixture reference repository
      *
      * @param string $baseCacheName Base cache name
-     *
-     * @return void
      */
-    public function save(string $baseCacheName)
+    public function save(string $baseCacheName): void
     {
         $serializedData = $this->serialize();
 

diff --git a/src/Purger/MongoDBPurger.php b/src/Purger/MongoDBPurger.php
@@ -27,26 +27,21 @@ public function __construct(?DocumentManager $dm = null)
 
     /**
      * Set the DocumentManager instance this purger instance should use.
-     *
-     * @return void
      */
-    public function setDocumentManager(DocumentManager $dm)
+    public function setDocumentManager(DocumentManager $dm): void
     {
         $this->dm = $dm;
     }
 
     /**
      * Retrieve the DocumentManager instance this purger instance is using.
-     *
-     * @return DocumentManager
      */
-    public function getObjectManager()
+    public function getObjectManager(): DocumentManager
     {
         return $this->dm;
     }
 
-    /** @inheritDoc */
-    public function purge()
+    public function purge(): void
     {
         $metadatas = $this->dm->getMetadataFactory()->getAllMetadata();
         foreach ($metadatas as $metadata) {