bug symfony#24722 Replace more docblocks by type-hints (nicolas-grekas)

This PR was merged into the 4.0-dev branch.

Discussion
----------

Replace more docblocks by type-hints

| Q             | A
| ------------- | ---
| Branch?       | master
| Bug fix?      | no
| New feature?  | no
| BC breaks?    | yes (but only on constructors and final methods)
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | -
| License       | MIT
| Doc PR        | -

Commits
-------

aaf2265 Replace more docblocks by type-hints

Author: nicolas-grekas

src/Symfony/Bridge/Doctrine/DataCollector/DoctrineDataCollector.php

@@ -165,12 +165,8 @@ private function sanitizeQuery($connectionName, $query)
      * The return value is an array with the sanitized value and a boolean
      * indicating if the original value was kept (allowing to use the sanitized
      * value to explain the query).
-     *
-     * @param mixed $var
-     *
-     * @return array
      */
-    private function sanitizeParam($var)
+    private function sanitizeParam($var): array
     {
         if (is_object($var)) {
             $className = get_class($var);

src/Symfony/Bridge/Doctrine/DependencyInjection/CompilerPass/DoctrineValidationPass.php

@@ -23,10 +23,7 @@ class DoctrineValidationPass implements CompilerPassInterface
 {
     private $managerType;
 
-    /**
-     * @param string $managerType
-     */
-    public function __construct($managerType)
+    public function __construct(string $managerType)
     {
         $this->managerType = $managerType;
     }
@@ -43,12 +40,8 @@ public function process(ContainerBuilder $container)
     /**
      * Gets the validation mapping files for the format and extends them with
      * files matching a doctrine search pattern (Resources/config/validation.orm.xml).
-     *
-     * @param ContainerBuilder $container
-     * @param string           $mapping
-     * @param string           $extension
      */
-    private function updateValidatorMappingFiles(ContainerBuilder $container, $mapping, $extension)
+    private function updateValidatorMappingFiles(ContainerBuilder $container, string $mapping, string $extension)
     {
         if (!$container->hasParameter('validator.mapping.loader.'.$mapping.'_files_loader.mapping_files')) {
             return;

src/Symfony/Bridge/Doctrine/DependencyInjection/CompilerPass/RegisterEventListenersAndSubscribersPass.php

@@ -37,7 +37,7 @@ class RegisterEventListenersAndSubscribersPass implements CompilerPassInterface
      *                                manager's service ID for a connection name
      * @param string $tagPrefix       Tag prefix for listeners and subscribers
      */
-    public function __construct($connections, $managerTemplate, $tagPrefix)
+    public function __construct(string $connections, string $managerTemplate, string $tagPrefix)
     {
         $this->connections = $connections;
         $this->managerTemplate = $managerTemplate;

src/Symfony/Bridge/Doctrine/DependencyInjection/CompilerPass/RegisterMappingsPass.php

@@ -117,7 +117,7 @@ abstract class RegisterMappingsPass implements CompilerPassInterface
      *                                                      register alias
      * @param string[]             $aliasMap                Map of alias to namespace
      */
-    public function __construct($driver, array $namespaces, array $managerParameters, $driverPattern, $enabledParameter = false, $configurationPattern = '', $registerAliasMethodName = '', array $aliasMap = array())
+    public function __construct($driver, array $namespaces, array $managerParameters, string $driverPattern, $enabledParameter = false, string $configurationPattern = '', string $registerAliasMethodName = '', array $aliasMap = array())
     {
         $this->driver = $driver;
         $this->namespaces = $namespaces;

src/Symfony/Bridge/Doctrine/DependencyInjection/Security/UserProvider/EntityFactory.php

@@ -27,7 +27,7 @@ class EntityFactory implements UserProviderFactoryInterface
     private $key;
     private $providerId;
 
-    public function __construct($key, $providerId)
+    public function __construct(string $key, string $providerId)
     {
         $this->key = $key;
         $this->providerId = $providerId;

src/Symfony/Bridge/Doctrine/Form/ChoiceList/DoctrineChoiceLoader.php

@@ -14,7 +14,6 @@
 use Doctrine\Common\Persistence\ObjectManager;
 use Symfony\Component\Form\ChoiceList\ArrayChoiceList;
 use Symfony\Component\Form\ChoiceList\ChoiceListInterface;
-use Symfony\Component\Form\ChoiceList\Factory\ChoiceListFactoryInterface;
 use Symfony\Component\Form\ChoiceList\Loader\ChoiceLoaderInterface;
 
 /**
@@ -45,9 +44,8 @@ class DoctrineChoiceLoader implements ChoiceLoaderInterface
      * @param string                     $class        The class name of the loaded objects
      * @param IdReader                   $idReader     The reader for the object IDs
      * @param null|EntityLoaderInterface $objectLoader The objects loader
-     * @param ChoiceListFactoryInterface $factory      The factory for creating the loaded choice list
      */
-    public function __construct(ObjectManager $manager, $class, $idReader = null, $objectLoader = null, $factory = null)
+    public function __construct(ObjectManager $manager, string $class, IdReader $idReader = null, EntityLoaderInterface $objectLoader = null)
     {
         $classMetadata = $manager->getClassMetadata($class);
 

src/Symfony/Bridge/Doctrine/PropertyInfo/DoctrineExtractor.php

@@ -157,13 +157,9 @@ public function getTypes($class, $property, array $context = array())
     /**
      * Determines whether an association is nullable.
      *
-     * @param array $associationMapping
-     *
-     * @return bool
-     *
      * @see https://github.com/doctrine/doctrine2/blob/v2.5.4/lib/Doctrine/ORM/Tools/EntityGenerator.php#L1221-L1246
      */
-    private function isAssociationNullable(array $associationMapping)
+    private function isAssociationNullable(array $associationMapping): bool
     {
         if (isset($associationMapping['id']) && $associationMapping['id']) {
             return false;
@@ -185,12 +181,8 @@ private function isAssociationNullable(array $associationMapping)
 
     /**
      * Gets the corresponding built-in PHP type.
-     *
-     * @param string $doctrineType
-     *
-     * @return string|null
      */
-    private function getPhpType($doctrineType)
+    private function getPhpType(string $doctrineType): ?string
     {
         switch ($doctrineType) {
             case DBALType::SMALLINT:
@@ -217,5 +209,7 @@ private function getPhpType($doctrineType)
             case DBALType::OBJECT:
                 return Type::BUILTIN_TYPE_OBJECT;
         }
+
+        return null;
     }
 }

src/Symfony/Bridge/Doctrine/Security/User/EntityUserProvider.php

@@ -33,7 +33,7 @@ class EntityUserProvider implements UserProviderInterface
     private $class;
     private $property;
 
-    public function __construct(ManagerRegistry $registry, $classOrAlias, $property = null, $managerName = null)
+    public function __construct(ManagerRegistry $registry, string $classOrAlias, string $property = null, string $managerName = null)
     {
         $this->registry = $registry;
         $this->managerName = $managerName;

src/Symfony/Bridge/Doctrine/Tests/DependencyInjection/DoctrineExtensionTest.php

@@ -187,12 +187,9 @@ public function providerBasicDrivers()
     }
 
     /**
-     * @param string $class
-     * @param array  $config
-     *
      * @dataProvider providerBasicDrivers
      */
-    public function testLoadBasicCacheDriver($class, array $config, array $expectedCalls = array())
+    public function testLoadBasicCacheDriver(string $class, array $config, array $expectedCalls = array())
     {
         $container = $this->createContainer();
         $cacheName = 'metadata_cache';

src/Symfony/Bridge/Doctrine/Tests/Fixtures/Type/StringWrapper.php

@@ -15,10 +15,7 @@ class StringWrapper
 {
     private $string;
 
-    /**
-     * @param string $string
-     */
-    public function __construct($string = null)
+    public function __construct(string $string = null)
     {
         $this->string = $string;
     }