Add type declarations where backwards compatible (#1122)

Add type declarations where backwards compatible
doctrine · Jan 7, 2020 · e52fb91 · e52fb91
2 parents 2178612 + f7f2f7a
commit e52fb91
Show file tree

Hide file tree

Showing 26 changed files with 105 additions and 151 deletions.
diff --git a/ConnectionFactory.php b/ConnectionFactory.php
@@ -96,11 +96,9 @@ public function createConnection(array $params, Configuration $config = null, Ev
      * and the platform version is unknown.
      * For details have a look at DoctrineBundle issue #673.
      *
-     * @return AbstractPlatform
-     *
      * @throws DBALException
      */
-    private function getDatabasePlatform(Connection $connection)
+    private function getDatabasePlatform(Connection $connection) : AbstractPlatform
     {
         try {
             return $connection->getDatabasePlatform();
@@ -119,7 +117,7 @@ private function getDatabasePlatform(Connection $connection)
     /**
      * initialize the types
      */
-    private function initializeTypes()
+    private function initializeTypes() : void
     {
         foreach ($this->typesConfig as $typeName => $typeConfig) {
             if (Type::hasType($typeName)) {

diff --git a/Controller/ProfilerController.php b/Controller/ProfilerController.php
@@ -74,7 +74,10 @@ public function explainAction($token, $connectionName, $query)
         ]));
     }
 
-    private function explainSQLitePlatform(Connection $connection, $query)
+    /**
+     * @param mixed[] $query
+     */
+    private function explainSQLitePlatform(Connection $connection, array $query)
     {
         $params = $query['params'];
 

diff --git a/DependencyInjection/Compiler/EntityListenerPass.php b/DependencyInjection/Compiler/EntityListenerPass.php
@@ -88,7 +88,7 @@ public function process(ContainerBuilder $container)
         }
     }
 
-    private function attachToListener(ContainerBuilder $container, $name, string $class, array $attributes)
+    private function attachToListener(ContainerBuilder $container, string $name, string $class, array $attributes) : void
     {
         $listenerId = sprintf('doctrine.orm.%s_listeners.attach_entity_listeners', $name);
 

diff --git a/DependencyInjection/Compiler/ServiceRepositoryCompilerPass.php b/DependencyInjection/Compiler/ServiceRepositoryCompilerPass.php
@@ -11,7 +11,7 @@ final class ServiceRepositoryCompilerPass implements CompilerPassInterface
 {
     const REPOSITORY_SERVICE_TAG = 'doctrine.repository_service';
 
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container) : void
     {
         // when ORM is not enabled
         if (! $container->hasDefinition('doctrine.orm.container_repository_factory')) {

diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -49,7 +49,7 @@ public function getConfigTreeBuilder() : TreeBuilder
     /**
      * Add DBAL section to configuration tree
      */
-    private function addDbalSection(ArrayNodeDefinition $node)
+    private function addDbalSection(ArrayNodeDefinition $node) : void
     {
         $node
             ->children()
@@ -103,10 +103,8 @@ private function addDbalSection(ArrayNodeDefinition $node)
 
     /**
      * Return the dbal connections node
-     *
-     * @return ArrayNodeDefinition
      */
-    private function getDbalConnectionsNode()
+    private function getDbalConnectionsNode() : ArrayNodeDefinition
     {
         $treeBuilder = new TreeBuilder('connections');
         $node        = $treeBuilder->getRootNode();
@@ -185,7 +183,7 @@ private function getDbalConnectionsNode()
      *
      * These keys are available for slave configurations too.
      */
-    private function configureDbalDriverNode(ArrayNodeDefinition $node)
+    private function configureDbalDriverNode(ArrayNodeDefinition $node) : void
     {
         $node
             ->children()
@@ -295,7 +293,7 @@ private function configureDbalDriverNode(ArrayNodeDefinition $node)
     /**
      * Add the ORM section to configuration tree
      */
-    private function addOrmSection(ArrayNodeDefinition $node)
+    private function addOrmSection(ArrayNodeDefinition $node) : void
     {
         $node
             ->children()
@@ -377,10 +375,8 @@ private function addOrmSection(ArrayNodeDefinition $node)
 
     /**
      * Return ORM target entity resolver node
-     *
-     * @return NodeDefinition
      */
-    private function getOrmTargetEntityResolverNode()
+    private function getOrmTargetEntityResolverNode() : NodeDefinition
     {
         $treeBuilder = new TreeBuilder('resolve_target_entities');
         $node        = $treeBuilder->getRootNode();
@@ -396,10 +392,8 @@ private function getOrmTargetEntityResolverNode()
 
     /**
      * Return ORM entity listener node
-     *
-     * @return NodeDefinition
      */
-    private function getOrmEntityListenersNode()
+    private function getOrmEntityListenersNode() : NodeDefinition
     {
         $treeBuilder = new TreeBuilder('entity_listeners');
         $node        = $treeBuilder->getRootNode();
@@ -482,10 +476,8 @@ private function getOrmEntityListenersNode()
 
     /**
      * Return ORM entity manager node
-     *
-     * @return ArrayNodeDefinition
      */
-    private function getOrmEntityManagersNode()
+    private function getOrmEntityManagersNode() : ArrayNodeDefinition
     {
         $treeBuilder = new TreeBuilder('entity_managers');
         $node        = $treeBuilder->getRootNode();
@@ -644,12 +636,8 @@ private function getOrmEntityManagersNode()
 
     /**
      * Return a ORM cache driver node for an given entity manager
-     *
-     * @param string $name
-     *
-     * @return ArrayNodeDefinition
      */
-    private function getOrmCacheDriverNode($name)
+    private function getOrmCacheDriverNode(string $name) : ArrayNodeDefinition
     {
         $treeBuilder = new TreeBuilder($name);
         $node        = $treeBuilder->getRootNode();
@@ -673,10 +661,8 @@ private function getOrmCacheDriverNode($name)
 
     /**
      * Find proxy auto generate modes for their names and int values
-     *
-     * @return array
      */
-    private function getAutoGenerateModes()
+    private function getAutoGenerateModes() : array
     {
         $constPrefix = 'AUTOGENERATE_';
         $prefixLen   = strlen($constPrefix);

diff --git a/DependencyInjection/DoctrineExtension.php b/DependencyInjection/DoctrineExtension.php
@@ -760,10 +760,8 @@ protected function loadOrmCacheDrivers(array $entityManager, ContainerBuilder $c
 
     /**
      * Loads a property info extractor for each defined entity manager.
-     *
-     * @param string $entityManagerName
      */
-    private function loadPropertyInfoExtractor($entityManagerName, ContainerBuilder $container)
+    private function loadPropertyInfoExtractor(string $entityManagerName, ContainerBuilder $container) : void
     {
         $propertyExtractorDefinition = $container->register(sprintf('doctrine.orm.%s_entity_manager.property_info_extractor', $entityManagerName), DoctrineExtractor::class);
         $argumentId                  = sprintf('doctrine.orm.%s_entity_manager', $entityManagerName);

diff --git a/ManagerConfigurator.php b/ManagerConfigurator.php
@@ -13,12 +13,12 @@ class ManagerConfigurator
     /** @var string[] */
     private $enabledFilters = [];
 
-    /** @var string[] */
+    /** @var array<string,array<string,string>> */
     private $filtersParameters = [];
 
     /**
-     * @param string[] $enabledFilters
-     * @param string[] $filtersParameters
+     * @param string[]                           $enabledFilters
+     * @param array<string,array<string,string>> $filtersParameters
      */
     public function __construct(array $enabledFilters, array $filtersParameters)
     {
@@ -37,7 +37,7 @@ public function configure(EntityManagerInterface $entityManager)
     /**
      * Enables filters for a given entity manager
      */
-    private function enableFilters(EntityManagerInterface $entityManager)
+    private function enableFilters(EntityManagerInterface $entityManager) : void
     {
         if (empty($this->enabledFilters)) {
             return;
@@ -56,11 +56,8 @@ private function enableFilters(EntityManagerInterface $entityManager)
 
     /**
      * Sets default parameters for a given filter
-     *
-     * @param string    $name   Filter name
-     * @param SQLFilter $filter Filter object
      */
-    private function setFilterParameters($name, SQLFilter $filter)
+    private function setFilterParameters(string $name, SQLFilter $filter) : void
     {
         if (empty($this->filtersParameters[$name])) {
             return;

diff --git a/Mapping/DisconnectedMetadataFactory.php b/Mapping/DisconnectedMetadataFactory.php
@@ -126,15 +126,9 @@ public function findNamespaceAndPathForMetadata(ClassMetadataCollection $metadat
     /**
      * Get a base path for a class
      *
-     * @param string $name      class name
-     * @param string $namespace class namespace
-     * @param string $path      class path
-     *
-     * @return string
-     *
      * @throws RuntimeException When base path not found.
      */
-    private function getBasePathForClass($name, $namespace, $path)
+    private function getBasePathForClass(string $name, string $namespace, string $path) : string
     {
         $namespace   = str_replace('\\', '/', $namespace);
         $search      = str_replace('\\', '/', $path);
@@ -147,12 +141,7 @@ private function getBasePathForClass($name, $namespace, $path)
         return $destination;
     }
 
-    /**
-     * @param string $namespace
-     *
-     * @return ClassMetadataCollection
-     */
-    private function getMetadataForNamespace($namespace)
+    private function getMetadataForNamespace(string $namespace) : ClassMetadataCollection
     {
         $metadata = [];
         foreach ($this->getAllMetadata() as $m) {
@@ -166,12 +155,7 @@ private function getMetadataForNamespace($namespace)
         return new ClassMetadataCollection($metadata);
     }
 
-    /**
-     * @param string $entity
-     *
-     * @return ClassMetadataCollection
-     */
-    private function getMetadataForClass($entity)
+    private function getMetadataForClass(string $entity) : ClassMetadataCollection
     {
         foreach ($this->registry->getManagers() as $em) {
             $cmf = new DisconnectedClassMetadataFactory();
@@ -188,7 +172,7 @@ private function getMetadataForClass($entity)
     /**
      * @return ClassMetadata[]
      */
-    private function getAllMetadata()
+    private function getAllMetadata() : array
     {
         $metadata = [];
         foreach ($this->registry->getManagers() as $em) {

diff --git a/Repository/ContainerRepositoryFactory.php b/Repository/ContainerRepositoryFactory.php
@@ -39,7 +39,7 @@ public function __construct(ContainerInterface $container = null)
     /**
      * {@inheritdoc}
      */
-    public function getRepository(EntityManagerInterface $entityManager, $entityName)
+    public function getRepository(EntityManagerInterface $entityManager, $entityName) : ObjectRepository
     {
         $metadata            = $entityManager->getClassMetadata($entityName);
         $repositoryServiceId = $metadata->customRepositoryClassName;
@@ -72,8 +72,10 @@ public function getRepository(EntityManagerInterface $entityManager, $entityName
         return $this->getOrCreateRepository($entityManager, $metadata);
     }
 
-    private function getOrCreateRepository(EntityManagerInterface $entityManager, ClassMetadata $metadata)
-    {
+    private function getOrCreateRepository(
+        EntityManagerInterface $entityManager,
+        ClassMetadata $metadata
+    ) : ObjectRepository {
         $repositoryHash = $metadata->getName() . spl_object_hash($entityManager);
         if (isset($this->managedRepositories[$repositoryHash])) {
             return $this->managedRepositories[$repositoryHash];

diff --git a/Tests/Builder/BundleConfigurationBuilder.php b/Tests/Builder/BundleConfigurationBuilder.php
@@ -21,7 +21,7 @@ public static function createBuilderWithBaseValues()
         return $builder;
     }
 
-    public function addBaseConnection()
+    public function addBaseConnection() : self
     {
         $this->addConnection([
             'connections' => [
@@ -32,7 +32,7 @@ public function addBaseConnection()
         return $this;
     }
 
-    public function addBaseEntityManager()
+    public function addBaseEntityManager() : self
     {
         $this->addEntityManager([
             'default_entity_manager' => 'default',
@@ -48,7 +48,7 @@ public function addBaseEntityManager()
         return $this;
     }
 
-    public function addBaseSecondLevelCache()
+    public function addBaseSecondLevelCache() : self
     {
         $this->addSecondLevelCache([
             'region_cache_driver' => ['type' => 'pool', 'pool' => 'my_pool'],
@@ -60,28 +60,28 @@ public function addBaseSecondLevelCache()
         return $this;
     }
 
-    public function addConnection($config)
+    public function addConnection($config) : self
     {
         $this->configuration['dbal'] = $config;
 
         return $this;
     }
 
-    public function addEntityManager($config)
+    public function addEntityManager($config) : self
     {
         $this->configuration['orm'] = $config;
 
         return $this;
     }
 
-    public function addSecondLevelCache($config, $manager = 'default')
+    public function addSecondLevelCache($config, $manager = 'default') : self
     {
         $this->configuration['orm']['entity_managers'][$manager]['second_level_cache'] = $config;
 
         return $this;
     }
 
-    public function build()
+    public function build() : array
     {
         return $this->configuration;
     }

diff --git a/Tests/Command/CreateDatabaseDoctrineTest.php b/Tests/Command/CreateDatabaseDoctrineTest.php
@@ -3,8 +3,8 @@
 namespace Doctrine\Bundle\DoctrineBundle\Tests\Command;
 
 use Doctrine\Bundle\DoctrineBundle\Command\CreateDatabaseDoctrineCommand;
+use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
-use PHPUnit_Framework_MockObject_MockObject;
 use Symfony\Component\Console\Application;
 use Symfony\Component\Console\Tester\CommandTester;
 
@@ -86,12 +86,9 @@ public function testExecuteWithShardOption() : void
     }
 
     /**
-     * @param string       $connectionName Connection name
-     * @param mixed[]|null $params         Connection parameters
-     *
-     * @return PHPUnit_Framework_MockObject_MockObject
+     * @param mixed[]|null $params Connection parameters
      */
-    private function getMockContainer($connectionName, $params = null)
+    private function getMockContainer(string $connectionName, array $params = null) : MockObject
     {
         // Mock the container and everything you'll need here
         $mockDoctrine = $this->getMockBuilder('Doctrine\Persistence\ManagerRegistry')

diff --git a/Tests/Command/DropDatabaseDoctrineTest.php b/Tests/Command/DropDatabaseDoctrineTest.php
@@ -3,8 +3,8 @@
 namespace Doctrine\Bundle\DoctrineBundle\Tests\Command;
 
 use Doctrine\Bundle\DoctrineBundle\Command\DropDatabaseDoctrineCommand;
+use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
-use PHPUnit_Framework_MockObject_MockObject;
 use Symfony\Component\Console\Application;
 use Symfony\Component\Console\Tester\CommandTester;
 
@@ -75,12 +75,9 @@ public function testExecuteWithoutOptionForceWillFailWithAttentionMessage() : vo
     }
 
     /**
-     * @param string     $connectionName Connection name
-     * @param array|null $params         Connection parameters
-     *
-     * @return PHPUnit_Framework_MockObject_MockObject
+     * @param array|null $params Connection parameters
      */
-    private function getMockContainer($connectionName, $params = null)
+    private function getMockContainer(string $connectionName, array $params = null) : MockObject
     {
         // Mock the container and everything you'll need here
         $mockDoctrine = $this->getMockBuilder('Doctrine\Persistence\ManagerRegistry')
-Original file line number
+Diff line change
@@ Expand Up / @@ -88,7 +88,7 @@ public function process(ContainerBuilder $container) @@
             }
         }
-        private function attachToListener(ContainerBuilder $container, $name, string $class, array $attributes)
+        private function attachToListener(ContainerBuilder $container, string $name, string $class, array $attributes) : void
         {
             $listenerId = sprintf('doctrine.orm.%s_listeners.attach_entity_listeners', $name);
@@ Expand Down @@