minor #32993 Turned return type annotations of private methods into php return types (derrabus)

nicolas-grekas · nicolas-grekas · commit 9ea8dc8d6c8c · 2019-08-08T10:48:45.000+02:00
This PR was merged into the 4.4 branch. Discussion ---------- Turned return type annotations of private methods into php return types | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | N/A | License | MIT | Doc PR | N/A As discussed with @nicolas-grekas in symfony/symfony#30323 (comment), this PR attempts to turn `@return` annotations on private methods into return type declarations. Commits ------- f54ca001fe Turned return type annotations of private methods into php return types.
diff --git a/CacheWarmer/SerializerCacheWarmer.php b/CacheWarmer/SerializerCacheWarmer.php
@@ -74,7 +74,7 @@ protected function doWarmUp($cacheDir, ArrayAdapter $arrayAdapter)
      *
      * @return XmlFileLoader[]|YamlFileLoader[]
      */
-    private function extractSupportedLoaders(array $loaders)
+    private function extractSupportedLoaders(array $loaders): array
     {
         $supportedLoaders = [];
 
diff --git a/CacheWarmer/TemplateFinder.php b/CacheWarmer/TemplateFinder.php
@@ -72,7 +72,7 @@ public function findAllTemplates()
      *
      * @return TemplateReferenceInterface[]
      */
-    private function findTemplatesInFolder(string $dir)
+    private function findTemplatesInFolder(string $dir): array
     {
         $templates = [];
 
@@ -96,7 +96,7 @@ private function findTemplatesInFolder(string $dir)
      *
      * @return TemplateReferenceInterface[]
      */
-    private function findTemplatesInBundle(BundleInterface $bundle)
+    private function findTemplatesInBundle(BundleInterface $bundle): array
     {
         $name = $bundle->getName();
         $templates = array_unique(array_merge(
diff --git a/CacheWarmer/ValidatorCacheWarmer.php b/CacheWarmer/ValidatorCacheWarmer.php
@@ -89,7 +89,7 @@ protected function warmUpPhpArrayAdapter(PhpArrayAdapter $phpArrayAdapter, array
      *
      * @return XmlFileLoader[]|YamlFileLoader[]
      */
-    private function extractSupportedLoaders(array $loaders)
+    private function extractSupportedLoaders(array $loaders): array
     {
         $supportedLoaders = [];
 
diff --git a/Console/Descriptor/MarkdownDescriptor.php b/Console/Descriptor/MarkdownDescriptor.php
@@ -392,10 +392,7 @@ protected function describeCallable($callable, array $options = [])
         throw new \InvalidArgumentException('Callable is not describable.');
     }
 
-    /**
-     * @return string
-     */
-    private function formatRouterConfig(array $array)
+    private function formatRouterConfig(array $array): string
     {
         if (!$array) {
             return 'NONE';
diff --git a/Console/Descriptor/XmlDescriptor.php b/Console/Descriptor/XmlDescriptor.php
@@ -390,7 +390,7 @@ private function getContainerDefinitionDocument(Definition $definition, string $
     /**
      * @return \DOMNode[]
      */
-    private function getArgumentNodes(array $arguments, \DOMDocument $dom)
+    private function getArgumentNodes(array $arguments, \DOMDocument $dom): array
     {
         $nodes = [];
 
diff --git a/Tests/Command/RouterMatchCommandTest.php b/Tests/Command/RouterMatchCommandTest.php
@@ -41,10 +41,7 @@ public function testWithNotMatchPath()
         $this->assertStringContainsString('None of the routes match the path "/test"', $tester->getDisplay());
     }
 
-    /**
-     * @return CommandTester
-     */
-    private function createCommandTester()
+    private function createCommandTester(): CommandTester
     {
         $application = new Application($this->getKernel());
         $application->add(new RouterMatchCommand($this->getRouter()));
diff --git a/Tests/Command/TranslationDebugCommandTest.php b/Tests/Command/TranslationDebugCommandTest.php
@@ -140,10 +140,7 @@ protected function tearDown()
         $this->fs->remove($this->translationDir);
     }
 
-    /**
-     * @return CommandTester
-     */
-    private function createCommandTester($extractedMessages = [], $loadedMessages = [], $kernel = null, array $transPaths = [], array $viewsPaths = [])
+    private function createCommandTester($extractedMessages = [], $loadedMessages = [], $kernel = null, array $transPaths = [], array $viewsPaths = []): CommandTester
     {
         $translator = $this->getMockBuilder('Symfony\Component\Translation\Translator')
             ->disableOriginalConstructor()
diff --git a/Tests/Command/TranslationUpdateCommandTest.php b/Tests/Command/TranslationUpdateCommandTest.php
@@ -118,10 +118,7 @@ protected function tearDown()
         $this->fs->remove($this->translationDir);
     }
 
-    /**
-     * @return CommandTester
-     */
-    private function createCommandTester($extractedMessages = [], $loadedMessages = [], HttpKernel\KernelInterface $kernel = null, array $transPaths = [], array $viewsPaths = [])
+    private function createCommandTester($extractedMessages = [], $loadedMessages = [], HttpKernel\KernelInterface $kernel = null, array $transPaths = [], array $viewsPaths = []): CommandTester
     {
         $translator = $this->getMockBuilder('Symfony\Component\Translation\Translator')
             ->disableOriginalConstructor()
diff --git a/Tests/Command/XliffLintCommandTest.php b/Tests/Command/XliffLintCommandTest.php
@@ -72,10 +72,7 @@ public function testLintFilesFromBundleDirectory()
         $this->assertStringContainsString('[OK] All 0 XLIFF files contain valid syntax', trim($tester->getDisplay()));
     }
 
-    /**
-     * @return CommandTester
-     */
-    private function createCommandTester($application = null)
+    private function createCommandTester($application = null): CommandTester
     {
         if (!$application) {
             $application = new BaseApplication();
diff --git a/Tests/Command/YamlLintCommandTest.php b/Tests/Command/YamlLintCommandTest.php
@@ -109,10 +109,7 @@ public function testLintFilesFromBundleDirectory()
         $this->assertStringContainsString('[OK] All 0 YAML files contain valid syntax', trim($tester->getDisplay()));
     }
 
-    /**
-     * @return string Path to the new file
-     */
-    private function createFile($content)
+    private function createFile($content): string
     {
         $filename = tempnam(sys_get_temp_dir().'/yml-lint-test', 'sf-');
         file_put_contents($filename, $content);
@@ -122,10 +119,7 @@ private function createFile($content)
         return $filename;
     }
 
-    /**
-     * @return CommandTester
-     */
-    private function createCommandTester($application = null)
+    private function createCommandTester($application = null): CommandTester
     {
         if (!$application) {
             $application = new BaseApplication();
diff --git a/Tests/Controller/ControllerTraitTest.php b/Tests/Controller/ControllerTraitTest.php
@@ -98,12 +98,7 @@ public function testGetUserWithEmptyContainer()
         $controller->getUser();
     }
 
-    /**
-     * @param $token
-     *
-     * @return Container
-     */
-    private function getContainerWithTokenStorage($token = null)
+    private function getContainerWithTokenStorage($token = null): Container
     {
         $tokenStorage = $this->getMockBuilder('Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorage')->getMock();
         $tokenStorage
diff --git a/Tests/Functional/ConfigDebugCommandTest.php b/Tests/Functional/ConfigDebugCommandTest.php
@@ -74,10 +74,7 @@ public function testDumpWithPrefixedEnv()
         $this->assertStringContainsString("cookie_httponly: '%env(bool:COOKIE_HTTPONLY)%'", $tester->getDisplay());
     }
 
-    /**
-     * @return CommandTester
-     */
-    private function createCommandTester()
+    private function createCommandTester(): CommandTester
     {
         $command = $this->application->find('debug:config');
 
diff --git a/Tests/Functional/ConfigDumpReferenceCommandTest.php b/Tests/Functional/ConfigDumpReferenceCommandTest.php
@@ -73,10 +73,7 @@ public function testDumpAtPathXml()
         $this->assertStringContainsString('[ERROR] The "path" option is only available for the "yaml" format.', $tester->getDisplay());
     }
 
-    /**
-     * @return CommandTester
-     */
-    private function createCommandTester()
+    private function createCommandTester(): CommandTester
     {
         $command = $this->application->find('config:dump-reference');
 
diff --git a/Tests/Routing/RouterTest.php b/Tests/Routing/RouterTest.php
@@ -16,6 +16,7 @@
 use Symfony\Bundle\FrameworkBundle\Routing\Router;
 use Symfony\Component\Config\Loader\LoaderInterface;
 use Symfony\Component\DependencyInjection\Config\ContainerParametersResource;
+use Symfony\Component\DependencyInjection\Container;
 use Symfony\Component\DependencyInjection\Exception\RuntimeException;
 use Symfony\Component\Routing\Route;
 use Symfony\Component\Routing\RouteCollection;
@@ -501,10 +502,7 @@ public function getNonStringValues()
         return [[null], [false], [true], [new \stdClass()], [['foo', 'bar']], [[[]]]];
     }
 
-    /**
-     * @return \Symfony\Component\DependencyInjection\Container
-     */
-    private function getServiceContainer(RouteCollection $routes)
+    private function getServiceContainer(RouteCollection $routes): Container
     {
         $loader = $this->getMockBuilder('Symfony\Component\Config\Loader\LoaderInterface')->getMock();
 
diff --git a/Tests/Templating/TimedPhpEngineTest.php b/Tests/Templating/TimedPhpEngineTest.php
@@ -15,6 +15,11 @@
 use Symfony\Bundle\FrameworkBundle\Templating\TimedPhpEngine;
 use Symfony\Bundle\FrameworkBundle\Tests\TestCase;
 use Symfony\Component\DependencyInjection\Container;
+use Symfony\Component\Stopwatch\Stopwatch;
+use Symfony\Component\Stopwatch\StopwatchEvent;
+use Symfony\Component\Templating\Loader\Loader;
+use Symfony\Component\Templating\Storage\StringStorage;
+use Symfony\Component\Templating\TemplateNameParserInterface;
 
 /**
  * @group legacy
@@ -42,18 +47,12 @@ public function testThatRenderLogsTime()
         $engine->render('index.php');
     }
 
-    /**
-     * @return Container
-     */
-    private function getContainer()
+    private function getContainer(): Container
     {
         return $this->getMockBuilder('Symfony\Component\DependencyInjection\Container')->getMock();
     }
 
-    /**
-     * @return \Symfony\Component\Templating\TemplateNameParserInterface
-     */
-    private function getTemplateNameParser()
+    private function getTemplateNameParser(): TemplateNameParserInterface
     {
         $templateReference = $this->getMockBuilder('Symfony\Component\Templating\TemplateReferenceInterface')->getMock();
         $templateNameParser = $this->getMockBuilder('Symfony\Component\Templating\TemplateNameParserInterface')->getMock();
@@ -64,32 +63,24 @@ private function getTemplateNameParser()
         return $templateNameParser;
     }
 
-    /**
-     * @return GlobalVariables
-     */
-    private function getGlobalVariables()
+    private function getGlobalVariables(): GlobalVariables
     {
         return $this->getMockBuilder('Symfony\Bundle\FrameworkBundle\Templating\GlobalVariables')
             ->disableOriginalConstructor()
             ->getMock();
     }
 
-    /**
-     * @return \Symfony\Component\Templating\Storage\StringStorage
-     */
-    private function getStorage()
+    private function getStorage(): StringStorage
     {
         return $this->getMockBuilder('Symfony\Component\Templating\Storage\StringStorage')
             ->disableOriginalConstructor()
             ->getMockForAbstractClass();
     }
 
     /**
-     * @param \Symfony\Component\Templating\Storage\StringStorage $storage
-     *
-     * @return \Symfony\Component\Templating\Loader\Loader
+     * @param StringStorage $storage
      */
-    private function getLoader($storage)
+    private function getLoader($storage): Loader
     {
         $loader = $this->getMockForAbstractClass('Symfony\Component\Templating\Loader\Loader');
         $loader->expects($this->once())
@@ -99,20 +90,14 @@ private function getLoader($storage)
         return $loader;
     }
 
-    /**
-     * @return \Symfony\Component\Stopwatch\StopwatchEvent
-     */
-    private function getStopwatchEvent()
+    private function getStopwatchEvent(): StopwatchEvent
     {
         return $this->getMockBuilder('Symfony\Component\Stopwatch\StopwatchEvent')
             ->disableOriginalConstructor()
             ->getMock();
     }
 
-    /**
-     * @return \Symfony\Component\Stopwatch\Stopwatch
-     */
-    private function getStopwatch()
+    private function getStopwatch(): Stopwatch
     {
         return $this->getMockBuilder('Symfony\Component\Stopwatch\Stopwatch')->getMock();
     }

Original file line number	Diff line number	Diff line change
`@@ -74,7 +74,7 @@ protected function doWarmUp($cacheDir, ArrayAdapter $arrayAdapter)`
`74`	`74`	`*`
`75`	`75`	`* @return XmlFileLoader[]\|YamlFileLoader[]`
`76`	`76`	`*/`
`77`		`- private function extractSupportedLoaders(array $loaders)`
	`77`	`+ private function extractSupportedLoaders(array $loaders): array`
`78`	`78`	`{`
`79`	`79`	`$supportedLoaders = [];`
`80`	`80`
Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,7 @@ public function findAllTemplates()`
`72`	`72`	`*`
`73`	`73`	`* @return TemplateReferenceInterface[]`
`74`	`74`	`*/`
`75`		`- private function findTemplatesInFolder(string $dir)`
	`75`	`+ private function findTemplatesInFolder(string $dir): array`
`76`	`76`	`{`
`77`	`77`	`$templates = [];`
`78`	`78`
`@@ -96,7 +96,7 @@ private function findTemplatesInFolder(string $dir)`
`96`	`96`	`*`
`97`	`97`	`* @return TemplateReferenceInterface[]`
`98`	`98`	`*/`
`99`		`- private function findTemplatesInBundle(BundleInterface $bundle)`
	`99`	`+ private function findTemplatesInBundle(BundleInterface $bundle): array`
`100`	`100`	`{`
`101`	`101`	`$name = $bundle->getName();`
`102`	`102`	`$templates = array_unique(array_merge(`
Original file line number	Diff line number	Diff line change
`@@ -89,7 +89,7 @@ protected function warmUpPhpArrayAdapter(PhpArrayAdapter $phpArrayAdapter, array`
`89`	`89`	`*`
`90`	`90`	`* @return XmlFileLoader[]\|YamlFileLoader[]`
`91`	`91`	`*/`
`92`		`- private function extractSupportedLoaders(array $loaders)`
	`92`	`+ private function extractSupportedLoaders(array $loaders): array`
`93`	`93`	`{`
`94`	`94`	`$supportedLoaders = [];`
`95`	`95`
Original file line number	Diff line number	Diff line change
`@@ -392,10 +392,7 @@ protected function describeCallable($callable, array $options = [])`
`392`	`392`	`throw new \InvalidArgumentException('Callable is not describable.');`
`393`	`393`	`}`
`394`	`394`
`395`		`- /**`
`396`		`- * @return string`
`397`		`- */`
`398`		`- private function formatRouterConfig(array $array)`
	`395`	`+ private function formatRouterConfig(array $array): string`
`399`	`396`	`{`
`400`	`397`	`if (!$array) {`
`401`	`398`	`return 'NONE';`
Original file line number	Diff line number	Diff line change
`@@ -390,7 +390,7 @@ private function getContainerDefinitionDocument(Definition $definition, string $`
`390`	`390`	`/**`
`391`	`391`	`* @return \DOMNode[]`
`392`	`392`	`*/`
`393`		`- private function getArgumentNodes(array $arguments, \DOMDocument $dom)`
	`393`	`+ private function getArgumentNodes(array $arguments, \DOMDocument $dom): array`
`394`	`394`	`{`
`395`	`395`	`$nodes = [];`
`396`	`396`
Original file line number	Diff line number	Diff line change
`@@ -41,10 +41,7 @@ public function testWithNotMatchPath()`
`41`	`41`	`$this->assertStringContainsString('None of the routes match the path "/test"', $tester->getDisplay());`
`42`	`42`	`}`
`43`	`43`
`44`		`- /**`
`45`		`- * @return CommandTester`
`46`		`- */`
`47`		`- private function createCommandTester()`
	`44`	`+ private function createCommandTester(): CommandTester`
`48`	`45`	`{`
`49`	`46`	`$application = new Application($this->getKernel());`
`50`	`47`	`$application->add(new RouterMatchCommand($this->getRouter()));`
Original file line number	Diff line number	Diff line change
`@@ -140,10 +140,7 @@ protected function tearDown()`
`140`	`140`	`$this->fs->remove($this->translationDir);`
`141`	`141`	`}`
`142`	`142`
`143`		`- /**`
`144`		`- * @return CommandTester`
`145`		`- */`
`146`		`- private function createCommandTester($extractedMessages = [], $loadedMessages = [], $kernel = null, array $transPaths = [], array $viewsPaths = [])`
	`143`	`+ private function createCommandTester($extractedMessages = [], $loadedMessages = [], $kernel = null, array $transPaths = [], array $viewsPaths = []): CommandTester`
`147`	`144`	`{`
`148`	`145`	`$translator = $this->getMockBuilder('Symfony\Component\Translation\Translator')`
`149`	`146`	`->disableOriginalConstructor()`
Original file line number	Diff line number	Diff line change
`@@ -118,10 +118,7 @@ protected function tearDown()`
`118`	`118`	`$this->fs->remove($this->translationDir);`
`119`	`119`	`}`
`120`	`120`
`121`		`- /**`
`122`		`- * @return CommandTester`
`123`		`- */`
`124`		`- private function createCommandTester($extractedMessages = [], $loadedMessages = [], HttpKernel\KernelInterface $kernel = null, array $transPaths = [], array $viewsPaths = [])`
	`121`	`+ private function createCommandTester($extractedMessages = [], $loadedMessages = [], HttpKernel\KernelInterface $kernel = null, array $transPaths = [], array $viewsPaths = []): CommandTester`
`125`	`122`	`{`
`126`	`123`	`$translator = $this->getMockBuilder('Symfony\Component\Translation\Translator')`
`127`	`124`	`->disableOriginalConstructor()`
Original file line number	Diff line number	Diff line change
`@@ -72,10 +72,7 @@ public function testLintFilesFromBundleDirectory()`
`72`	`72`	`$this->assertStringContainsString('[OK] All 0 XLIFF files contain valid syntax', trim($tester->getDisplay()));`
`73`	`73`	`}`
`74`	`74`
`75`		`- /**`
`76`		`- * @return CommandTester`
`77`		`- */`
`78`		`- private function createCommandTester($application = null)`
	`75`	`+ private function createCommandTester($application = null): CommandTester`
`79`	`76`	`{`
`80`	`77`	`if (!$application) {`
`81`	`78`	`$application = new BaseApplication();`
Original file line number	Diff line number	Diff line change
`@@ -109,10 +109,7 @@ public function testLintFilesFromBundleDirectory()`
`109`	`109`	`$this->assertStringContainsString('[OK] All 0 YAML files contain valid syntax', trim($tester->getDisplay()));`
`110`	`110`	`}`
`111`	`111`
`112`		`- /**`
`113`		`- * @return string Path to the new file`
`114`		`- */`
`115`		`- private function createFile($content)`
	`112`	`+ private function createFile($content): string`
`116`	`113`	`{`
`117`	`114`	`$filename = tempnam(sys_get_temp_dir().'/yml-lint-test', 'sf-');`
`118`	`115`	`file_put_contents($filename, $content);`
`@@ -122,10 +119,7 @@ private function createFile($content)`
`122`	`119`	`return $filename;`
`123`	`120`	`}`
`124`	`121`
`125`		`- /**`
`126`		`- * @return CommandTester`
`127`		`- */`
`128`		`- private function createCommandTester($application = null)`
	`122`	`+ private function createCommandTester($application = null): CommandTester`
`129`	`123`	`{`
`130`	`124`	`if (!$application) {`
`131`	`125`	`$application = new BaseApplication();`