minor #33294 Add return types to internal & magic methods when possib…

…le (nicolas-grekas) This PR was merged into the 4.4 branch. Discussion ---------- Add return types to internal & magic methods when possible | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #33236 #33228 | License | MIT | Doc PR | - Commits ------- 962dcfe Add return types to internal & magic methods when possible
symfony · Aug 22, 2019 · 47322db · 47322db
2 parents 3051c59 + 962dcfe
commit 47322db
Show file tree

Hide file tree

Showing 80 changed files with 171 additions and 138 deletions.
diff --git a/src/Symfony/Bridge/Doctrine/Tests/DataCollector/DoctrineDataCollectorTest.php b/src/Symfony/Bridge/Doctrine/Tests/DataCollector/DoctrineDataCollectorTest.php
@@ -205,7 +205,7 @@ private function createCollector($queries)
 
 class StringRepresentableClass
 {
-    public function __toString()
+    public function __toString(): string
     {
         return 'string representation';
     }

diff --git a/src/Symfony/Bridge/Doctrine/Tests/Fixtures/CompositeIntIdEntity.php b/src/Symfony/Bridge/Doctrine/Tests/Fixtures/CompositeIntIdEntity.php
@@ -34,7 +34,7 @@ public function __construct($id1, $id2, $name)
         $this->name = $name;
     }
 
-    public function __toString()
+    public function __toString(): string
     {
         return $this->name;
     }

diff --git a/src/Symfony/Bridge/Doctrine/Tests/Fixtures/CompositeStringIdEntity.php b/src/Symfony/Bridge/Doctrine/Tests/Fixtures/CompositeStringIdEntity.php
@@ -34,7 +34,7 @@ public function __construct($id1, $id2, $name)
         $this->name = $name;
     }
 
-    public function __toString()
+    public function __toString(): string
     {
         return $this->name;
     }

diff --git a/src/Symfony/Bridge/Doctrine/Tests/Fixtures/Person.php b/src/Symfony/Bridge/Doctrine/Tests/Fixtures/Person.php
@@ -38,7 +38,7 @@ public function __construct($id, $name)
         $this->name = $name;
     }
 
-    public function __toString()
+    public function __toString(): string
     {
         return (string) $this->name;
     }

diff --git a/src/Symfony/Bridge/Doctrine/Tests/Fixtures/SingleAssociationToIntIdEntity.php b/src/Symfony/Bridge/Doctrine/Tests/Fixtures/SingleAssociationToIntIdEntity.php
@@ -31,7 +31,7 @@ public function __construct(SingleIntIdNoToStringEntity $entity, $name)
         $this->name = $name;
     }
 
-    public function __toString()
+    public function __toString(): string
     {
         return (string) $this->name;
     }

diff --git a/src/Symfony/Bridge/Doctrine/Tests/Fixtures/SingleIntIdEntity.php b/src/Symfony/Bridge/Doctrine/Tests/Fixtures/SingleIntIdEntity.php
@@ -33,7 +33,7 @@ public function __construct($id, $name)
         $this->name = $name;
     }
 
-    public function __toString()
+    public function __toString(): string
     {
         return (string) $this->name;
     }

diff --git a/src/Symfony/Bridge/Doctrine/Tests/Fixtures/SingleStringCastableIdEntity.php b/src/Symfony/Bridge/Doctrine/Tests/Fixtures/SingleStringCastableIdEntity.php
@@ -35,7 +35,7 @@ public function __construct($id, $name)
         $this->name = $name;
     }
 
-    public function __toString()
+    public function __toString(): string
     {
         return (string) $this->name;
     }
@@ -50,7 +50,7 @@ public function __construct($id)
         $this->id = $id;
     }
 
-    public function __toString()
+    public function __toString(): string
     {
         return (string) $this->id;
     }

diff --git a/src/Symfony/Bridge/Doctrine/Tests/Fixtures/SingleStringIdEntity.php b/src/Symfony/Bridge/Doctrine/Tests/Fixtures/SingleStringIdEntity.php
@@ -30,7 +30,7 @@ public function __construct($id, $name)
         $this->name = $name;
     }
 
-    public function __toString()
+    public function __toString(): string
     {
         return $this->name;
     }

diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/AppKernel.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/AppKernel.php
@@ -79,7 +79,7 @@ protected function build(ContainerBuilder $container)
         $container->register('logger', NullLogger::class);
     }
 
-    public function __sleep()
+    public function __sleep(): array
     {
         return ['varDir', 'testCase', 'rootConfig', 'environment', 'debug'];
     }

diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Kernel/ConcreteMicroKernel.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Kernel/ConcreteMicroKernel.php
@@ -64,7 +64,7 @@ public function getLogDir(): string
         return $this->cacheDir;
     }
 
-    public function __sleep()
+    public function __sleep(): array
     {
         throw new \BadMethodCallException('Cannot serialize '.__CLASS__);
     }

diff --git a/src/Symfony/Bundle/TwigBundle/TemplateIterator.php b/src/Symfony/Bundle/TwigBundle/TemplateIterator.php
@@ -43,7 +43,7 @@ public function __construct(KernelInterface $kernel, string $rootDir, array $pat
     }
 
     /**
-     * {@inheritdoc}
+     * @return \Traversable
      */
     public function getIterator()
     {

diff --git a/src/Symfony/Component/Config/Resource/GlobResource.php b/src/Symfony/Component/Config/Resource/GlobResource.php
@@ -91,6 +91,9 @@ public function __sleep(): array
         return ['prefix', 'pattern', 'recursive', 'hash', 'forExclusion', 'excludedPrefixes'];
     }
 
+    /**
+     * @return \Traversable
+     */
     public function getIterator()
     {
         if (!file_exists($this->prefix) || (!$this->recursive && '' === $this->pattern)) {

diff --git a/src/Symfony/Component/Console/Helper/TableRows.php b/src/Symfony/Component/Console/Helper/TableRows.php
@@ -23,7 +23,7 @@ public function __construct(callable $generator)
         $this->generator = $generator;
     }
 
-    public function getIterator()
+    public function getIterator(): \Traversable
     {
         $g = $this->generator;
 

diff --git a/src/Symfony/Component/Console/Tests/Formatter/OutputFormatterTest.php b/src/Symfony/Component/Console/Tests/Formatter/OutputFormatterTest.php
@@ -339,7 +339,7 @@ public function testFormatAndWrap()
 
 class TableCell
 {
-    public function __toString()
+    public function __toString(): string
     {
         return '<info>some info</info>';
     }

diff --git a/src/Symfony/Component/Console/Tests/Helper/QuestionHelperTest.php b/src/Symfony/Component/Console/Tests/Helper/QuestionHelperTest.php
@@ -835,7 +835,7 @@ public function __construct(array $values)
         $this->values = $values;
     }
 
-    public function getIterator()
+    public function getIterator(): \Traversable
     {
         return new \ArrayIterator($this->values);
     }

diff --git a/src/Symfony/Component/Console/Tests/Logger/ConsoleLoggerTest.php b/src/Symfony/Component/Console/Tests/Logger/ConsoleLoggerTest.php
@@ -204,7 +204,7 @@ public function testContextExceptionKeyCanBeExceptionOrOtherValues()
 
 class DummyTest
 {
-    public function __toString()
+    public function __toString(): string
     {
     }
 }
diff --git a/src/Symfony/Component/DependencyInjection/Argument/RewindableGenerator.php b/src/Symfony/Component/DependencyInjection/Argument/RewindableGenerator.php
@@ -28,14 +28,14 @@ public function __construct(callable $generator, $count)
         $this->count = $count;
     }
 
-    public function getIterator()
+    public function getIterator(): \Traversable
     {
         $g = $this->generator;
 
         return $g();
     }
 
-    public function count()
+    public function count(): int
     {
         if (\is_callable($count = $this->count)) {
             $this->count = $count();

diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/includes/ProjectExtension.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/includes/ProjectExtension.php
@@ -25,17 +25,17 @@ public function load(array $configs, ContainerBuilder $configuration)
         return $configuration;
     }
 
-    public function getXsdValidationBasePath()
+    public function getXsdValidationBasePath(): string
     {
         return false;
     }
 
-    public function getNamespace()
+    public function getNamespace(): string
     {
         return 'http://www.example.com/schema/project';
     }
 
-    public function getAlias()
+    public function getAlias(): string
     {
         return 'project';
     }

diff --git a/...Symfony/Component/DependencyInjection/Tests/Fixtures/includes/ProjectWithXsdExtension.php b/...Symfony/Component/DependencyInjection/Tests/Fixtures/includes/ProjectWithXsdExtension.php
@@ -2,17 +2,17 @@
 
 class ProjectWithXsdExtension extends ProjectExtension
 {
-    public function getXsdValidationBasePath()
+    public function getXsdValidationBasePath(): string
     {
         return __DIR__.'/schema';
     }
 
-    public function getNamespace()
+    public function getNamespace(): string
     {
         return 'http://www.example.com/schema/projectwithxsd';
     }
 
-    public function getAlias()
+    public function getAlias(): string
     {
         return 'projectwithxsd';
     }

diff --git a/.../Component/DependencyInjection/Tests/Fixtures/includes/ProjectWithXsdExtensionInPhar.phar b/.../Component/DependencyInjection/Tests/Fixtures/includes/ProjectWithXsdExtensionInPhar.phar
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/includes/classes.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/includes/classes.php
@@ -83,17 +83,17 @@ public function callPassed()
 
 class DummyProxyDumper implements ProxyDumper
 {
-    public function isProxyCandidate(Definition $definition)
+    public function isProxyCandidate(Definition $definition): bool
     {
         return $definition->isLazy();
     }
 
-    public function getProxyFactoryCode(Definition $definition, $id, $factoryCall = null)
+    public function getProxyFactoryCode(Definition $definition, $id, $factoryCall = null): string
     {
         return "        // lazy factory for {$definition->getClass()}\n\n";
     }
 
-    public function getProxyCode(Definition $definition)
+    public function getProxyCode(Definition $definition): string
     {
         return "// proxy code for {$definition->getClass()}\n";
     }

diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/includes/createphar.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/includes/createphar.php
@@ -11,17 +11,17 @@
 
 class ProjectWithXsdExtensionInPhar extends ProjectExtension
 {
-    public function getXsdValidationBasePath()
+    public function getXsdValidationBasePath(): string
     {
         return __DIR__.'/schema';
     }
 
-    public function getNamespace()
+    public function getNamespace(): string
     {
         return 'http://www.example.com/schema/projectwithxsdinphar';
     }
 
-    public function getAlias()
+    public function getAlias(): string
     {
         return 'projectwithxsdinphar';
     }

diff --git a/src/Symfony/Component/Finder/Iterator/ExcludeDirectoryFilterIterator.php b/src/Symfony/Component/Finder/Iterator/ExcludeDirectoryFilterIterator.php
@@ -68,6 +68,9 @@ public function accept()
         return true;
     }
 
+    /**
+     * @return bool
+     */
     public function hasChildren()
     {
         return $this->isRecursive && $this->iterator->hasChildren();

diff --git a/src/Symfony/Component/Finder/Iterator/SortableIterator.php b/src/Symfony/Component/Finder/Iterator/SortableIterator.php
@@ -80,6 +80,9 @@ public function __construct(\Traversable $iterator, $sort, bool $reverseOrder =
         }
     }
 
+    /**
+     * @return \Traversable
+     */
     public function getIterator()
     {
         if (1 === $this->sort) {

diff --git a/src/Symfony/Component/Finder/Tests/Iterator/Iterator.php b/src/Symfony/Component/Finder/Tests/Iterator/Iterator.php
@@ -33,7 +33,7 @@ public function rewind()
         reset($this->values);
     }
 
-    public function valid()
+    public function valid(): bool
     {
         return false !== $this->current();
     }

diff --git a/src/Symfony/Component/Form/Extension/DataCollector/FormDataCollector.php b/src/Symfony/Component/Form/Extension/DataCollector/FormDataCollector.php
@@ -234,7 +234,7 @@ public function getData()
     /**
      * @internal
      */
-    public function __sleep()
+    public function __sleep(): array
     {
         foreach ($this->data['forms_by_hash'] as &$form) {
             if (isset($form['type_class']) && !$form['type_class'] instanceof ClassStub) {

diff --git a/src/Symfony/Component/Form/FormBuilder.php b/src/Symfony/Component/Form/FormBuilder.php
@@ -158,7 +158,7 @@ public function all()
     }
 
     /**
-     * {@inheritdoc}
+     * @return int
      */
     public function count()
     {

diff --git a/src/Symfony/Component/Form/Tests/ChoiceList/Factory/DefaultChoiceListFactoryTest.php b/src/Symfony/Component/Form/Tests/ChoiceList/Factory/DefaultChoiceListFactoryTest.php
@@ -860,7 +860,7 @@ public function __construct($property)
         $this->property = $property;
     }
 
-    public function __toString()
+    public function __toString(): string
     {
         return $this->property;
     }

diff --git a/src/Symfony/Component/Form/Tests/Fixtures/CustomArrayObject.php b/src/Symfony/Component/Form/Tests/Fixtures/CustomArrayObject.php
@@ -24,7 +24,7 @@ public function __construct(array $array = null)
         $this->array = $array ?: [];
     }
 
-    public function offsetExists($offset)
+    public function offsetExists($offset): bool
     {
         return \array_key_exists($offset, $this->array);
     }
@@ -48,12 +48,12 @@ public function offsetUnset($offset)
         unset($this->array[$offset]);
     }
 
-    public function getIterator()
+    public function getIterator(): \Traversable
     {
         return new \ArrayIterator($this->array);
     }
 
-    public function count()
+    public function count(): int
     {
         return \count($this->array);
     }
@@ -63,7 +63,7 @@ public function __serialize(): array
         return $this->array;
     }
 
-    public function serialize()
+    public function serialize(): string
     {
         return serialize($this->__serialize());
     }

diff --git a/src/Symfony/Component/Form/Tests/SimpleFormTest.php b/src/Symfony/Component/Form/Tests/SimpleFormTest.php
@@ -32,7 +32,7 @@ public function __construct($count)
         $this->count = $count;
     }
 
-    public function count()
+    public function count(): int
     {
         return $this->count;
     }
@@ -47,7 +47,7 @@ public function __construct($count)
         $this->iterator = new \ArrayIterator($count > 0 ? array_fill(0, $count, 'Foo') : []);
     }
 
-    public function getIterator()
+    public function getIterator(): \Traversable
     {
         return $this->iterator;
     }

diff --git a/src/Symfony/Component/Form/Util/InheritDataAwareIterator.php b/src/Symfony/Component/Form/Util/InheritDataAwareIterator.php
@@ -34,7 +34,7 @@ public function getChildren()
     }
 
     /**
-     * {@inheritdoc}
+     * @return bool
      */
     public function hasChildren()
     {

diff --git a/src/Symfony/Component/Form/Util/OrderedHashMap.php b/src/Symfony/Component/Form/Util/OrderedHashMap.php
@@ -99,7 +99,7 @@ public function __construct(array $elements = [])
     }
 
     /**
-     * {@inheritdoc}
+     * @return bool
      */
     public function offsetExists($key)
     {
@@ -157,15 +157,15 @@ public function offsetUnset($key)
     }
 
     /**
-     * {@inheritdoc}
+     * @return \Traversable
      */
     public function getIterator()
     {
         return new OrderedHashMapIterator($this->elements, $this->orderedKeys, $this->managedCursors);
     }
 
     /**
-     * {@inheritdoc}
+     * @return int
      */
     public function count()
     {