minor #33259 [5.0] Add return types on internal|final|private methods (nicolas-grekas)

nicolas-grekas · nicolas-grekas · commit b8661725fff1 · 2019-08-20T23:47:25.000+02:00
This PR was merged into the 5.0-dev branch. Discussion ---------- [5.0] Add return types on internal|final|private methods | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #33228 #33236 | License | MIT | Doc PR | - I think some changes here can be backported to 4.4 Also, this fails with e.g. `Return value of Symfony\Component\Serializer\Normalizer\ArrayDenormalizer::denormalize() must be an object, array returned` Which means we need to update `DenormalizerInterface::denormalize()` with `@return object|array` in 3.4. Commits ------- 6f303b4 [5.0] Add return types on internal|final|private methods
diff --git a/src/Symfony/Bridge/Monolog/Handler/SwiftMailerHandler.php b/src/Symfony/Bridge/Monolog/Handler/SwiftMailerHandler.php
@@ -63,10 +63,8 @@ protected function send($content, array $records): void
 
     /**
      * {@inheritdoc}
-     *
-     * @return void
      */
-    public function reset()
+    public function reset(): void
     {
         $this->flushMemorySpool();
     }
diff --git a/src/Symfony/Bundle/FrameworkBundle/Test/TestContainer.php b/src/Symfony/Bundle/FrameworkBundle/Test/TestContainer.php
@@ -98,7 +98,7 @@ public function has($id): bool
     /**
      * {@inheritdoc}
      */
-    public function get($id, int $invalidBehavior = /* self::EXCEPTION_ON_INVALID_REFERENCE */ 1)
+    public function get($id, int $invalidBehavior = /* self::EXCEPTION_ON_INVALID_REFERENCE */ 1): ?object
     {
         return $this->getPrivateContainer()->has($id) ? $this->getPrivateContainer()->get($id) : $this->getPublicContainer()->get($id, $invalidBehavior);
     }
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Controller/AbstractControllerTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Controller/AbstractControllerTest.php
@@ -159,10 +159,8 @@ public function testGetUserWithEmptyContainer()
 
     /**
      * @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/src/Symfony/Component/Cache/Adapter/MemcachedAdapter.php b/src/Symfony/Component/Cache/Adapter/MemcachedAdapter.php
@@ -316,10 +316,7 @@ private function checkResultCode($result)
         throw new CacheException(sprintf('MemcachedAdapter client error: %s.', strtolower($this->client->getResultMessage())));
     }
 
-    /**
-     * @return \Memcached
-     */
-    private function getClient()
+    private function getClient(): \Memcached
     {
         if ($this->client) {
             return $this->client;
diff --git a/src/Symfony/Component/DomCrawler/Crawler.php b/src/Symfony/Component/DomCrawler/Crawler.php
@@ -898,7 +898,7 @@ public static function xpathLiteral(string $s)
      *
      * @return static
      */
-    private function filterRelativeXPath(string $xpath)
+    private function filterRelativeXPath(string $xpath): object
     {
         $prefixes = $this->findNamespacePrefixes($xpath);
 
@@ -1140,7 +1140,7 @@ private function findNamespacePrefixes(string $xpath): array
      *
      * @return static
      */
-    private function createSubCrawler($nodes)
+    private function createSubCrawler($nodes): object
     {
         $crawler = new static($nodes, $this->uri, $this->baseHref);
         $crawler->isHtml = $this->isHtml;
diff --git a/src/Symfony/Component/HttpKernel/EventListener/AbstractSessionListener.php b/src/Symfony/Component/HttpKernel/EventListener/AbstractSessionListener.php
@@ -128,7 +128,7 @@ public function onFinishRequest(FinishRequestEvent $event)
         }
     }
 
-    public static function getSubscribedEvents()
+    public static function getSubscribedEvents(): array
     {
         return [
             KernelEvents::REQUEST => ['onKernelRequest', 128],
diff --git a/src/Symfony/Component/HttpKernel/EventListener/AbstractTestSessionListener.php b/src/Symfony/Component/HttpKernel/EventListener/AbstractTestSessionListener.php
@@ -97,7 +97,7 @@ public function onKernelResponse(ResponseEvent $event)
         }
     }
 
-    public static function getSubscribedEvents()
+    public static function getSubscribedEvents(): array
     {
         return [
             KernelEvents::REQUEST => ['onKernelRequest', 192],
diff --git a/src/Symfony/Component/Mime/Email.php b/src/Symfony/Component/Mime/Email.php
@@ -515,7 +515,7 @@ private function createDataPart(array $attachment): DataPart
     /**
      * @return $this
      */
-    private function setHeaderBody(string $type, string $name, $body)
+    private function setHeaderBody(string $type, string $name, $body): object
     {
         $this->getHeaders()->setHeaderBody($type, $name, $body);
 
diff --git a/src/Symfony/Component/Translation/Translator.php b/src/Symfony/Component/Translation/Translator.php
@@ -180,10 +180,8 @@ public function setFallbackLocales(array $locales)
      * Gets the fallback locales.
      *
      * @internal
-     *
-     * @return array The fallback locales
      */
-    public function getFallbackLocales()
+    public function getFallbackLocales(): array
     {
         return $this->fallbackLocales;
     }

Original file line number	Diff line number	Diff line change
`@@ -63,10 +63,8 @@ protected function send($content, array $records): void`
`63`	`63`
`64`	`64`	`/**`
`65`	`65`	`* {@inheritdoc}`
`66`		`- *`
`67`		`- * @return void`
`68`	`66`	`*/`
`69`		`- public function reset()`
	`67`	`+ public function reset(): void`
`70`	`68`	`{`
`71`	`69`	`$this->flushMemorySpool();`
`72`	`70`	`}`
Original file line number	Diff line number	Diff line change
`@@ -98,7 +98,7 @@ public function has($id): bool`
`98`	`98`	`/**`
`99`	`99`	`* {@inheritdoc}`
`100`	`100`	`*/`
`101`		`- public function get($id, int $invalidBehavior = /* self::EXCEPTION_ON_INVALID_REFERENCE */ 1)`
	`101`	`+ public function get($id, int $invalidBehavior = /* self::EXCEPTION_ON_INVALID_REFERENCE */ 1): ?object`
`102`	`102`	`{`
`103`	`103`	`return $this->getPrivateContainer()->has($id) ? $this->getPrivateContainer()->get($id) : $this->getPublicContainer()->get($id, $invalidBehavior);`
`104`	`104`	`}`
Original file line number	Diff line number	Diff line change
`@@ -316,10 +316,7 @@ private function checkResultCode($result)`
`316`	`316`	`throw new CacheException(sprintf('MemcachedAdapter client error: %s.', strtolower($this->client->getResultMessage())));`
`317`	`317`	`}`
`318`	`318`
`319`		`- /**`
`320`		`- * @return \Memcached`
`321`		`- */`
`322`		`- private function getClient()`
	`319`	`+ private function getClient(): \Memcached`
`323`	`320`	`{`
`324`	`321`	`if ($this->client) {`
`325`	`322`	`return $this->client;`
Original file line number	Diff line number	Diff line change
`@@ -898,7 +898,7 @@ public static function xpathLiteral(string $s)`
`898`	`898`	`*`
`899`	`899`	`* @return static`
`900`	`900`	`*/`
`901`		`- private function filterRelativeXPath(string $xpath)`
	`901`	`+ private function filterRelativeXPath(string $xpath): object`
`902`	`902`	`{`
`903`	`903`	`$prefixes = $this->findNamespacePrefixes($xpath);`
`904`	`904`
`@@ -1140,7 +1140,7 @@ private function findNamespacePrefixes(string $xpath): array`
`1140`	`1140`	`*`
`1141`	`1141`	`* @return static`
`1142`	`1142`	`*/`
`1143`		`- private function createSubCrawler($nodes)`
	`1143`	`+ private function createSubCrawler($nodes): object`
`1144`	`1144`	`{`
`1145`	`1145`	`$crawler = new static($nodes, $this->uri, $this->baseHref);`
`1146`	`1146`	`$crawler->isHtml = $this->isHtml;`
Original file line number	Diff line number	Diff line change
`@@ -128,7 +128,7 @@ public function onFinishRequest(FinishRequestEvent $event)`
`128`	`128`	`}`
`129`	`129`	`}`
`130`	`130`
`131`		`- public static function getSubscribedEvents()`
	`131`	`+ public static function getSubscribedEvents(): array`
`132`	`132`	`{`
`133`	`133`	`return [`
`134`	`134`	`KernelEvents::REQUEST => ['onKernelRequest', 128],`
Original file line number	Diff line number	Diff line change
`@@ -97,7 +97,7 @@ public function onKernelResponse(ResponseEvent $event)`
`97`	`97`	`}`
`98`	`98`	`}`
`99`	`99`
`100`		`- public static function getSubscribedEvents()`
	`100`	`+ public static function getSubscribedEvents(): array`
`101`	`101`	`{`
`102`	`102`	`return [`
`103`	`103`	`KernelEvents::REQUEST => ['onKernelRequest', 192],`
Original file line number	Diff line number	Diff line change
`@@ -515,7 +515,7 @@ private function createDataPart(array $attachment): DataPart`
`515`	`515`	`/**`
`516`	`516`	`* @return $this`
`517`	`517`	`*/`
`518`		`- private function setHeaderBody(string $type, string $name, $body)`
	`518`	`+ private function setHeaderBody(string $type, string $name, $body): object`
`519`	`519`	`{`
`520`	`520`	`$this->getHeaders()->setHeaderBody($type, $name, $body);`
`521`	`521`
Original file line number	Diff line number	Diff line change
`@@ -180,10 +180,8 @@ public function setFallbackLocales(array $locales)`
`180`	`180`	`* Gets the fallback locales.`
`181`	`181`	`*`
`182`	`182`	`* @internal`
`183`		`- *`
`184`		`- * @return array The fallback locales`
`185`	`183`	`*/`
`186`		`- public function getFallbackLocales()`
	`184`	`+ public function getFallbackLocales(): array`
`187`	`185`	`{`
`188`	`186`	`return $this->fallbackLocales;`
`189`	`187`	`}`