[5.0] Add return types on internal|final|private methods

nicolas-grekas · nicolas-grekas · commit c4c24b8ca4f2 · 2019-08-20T22:25:27.000+02:00
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/Cache/CacheItem.php b/src/Symfony/Component/Cache/CacheItem.php
@@ -61,9 +61,9 @@ public function isHit(): bool
     /**
      * {@inheritdoc}
      *
-     * @return static
+     * @return $this
      */
-    public function set($value)
+    public function set($value): object
     {
         $this->value = $value;
 
@@ -73,9 +73,9 @@ public function set($value)
     /**
      * {@inheritdoc}
      *
-     * @return static
+     * @return $this
      */
-    public function expiresAt($expiration)
+    public function expiresAt($expiration): object
     {
         if (null === $expiration) {
             $this->expiry = $this->defaultLifetime > 0 ? microtime(true) + $this->defaultLifetime : null;
@@ -91,9 +91,9 @@ public function expiresAt($expiration)
     /**
      * {@inheritdoc}
      *
-     * @return static
+     * @return $this
      */
-    public function expiresAfter($time)
+    public function expiresAfter($time): object
     {
         if (null === $time) {
             $this->expiry = $this->defaultLifetime > 0 ? microtime(true) + $this->defaultLifetime : null;
diff --git a/src/Symfony/Component/CssSelector/Parser/TokenStream.php b/src/Symfony/Component/CssSelector/Parser/TokenStream.php
@@ -56,7 +56,7 @@ class TokenStream
      *
      * @return $this
      */
-    public function push(Token $token)
+    public function push(Token $token): object
     {
         $this->tokens[] = $token;
 
@@ -68,7 +68,7 @@ public function push(Token $token)
      *
      * @return $this
      */
-    public function freeze()
+    public function freeze(): object
     {
         return $this;
     }
diff --git a/src/Symfony/Component/CssSelector/XPath/Extension/ExtensionInterface.php b/src/Symfony/Component/CssSelector/XPath/Extension/ExtensionInterface.php
@@ -30,40 +30,38 @@ interface ExtensionInterface
      *
      * @return callable[]
      */
-    public function getNodeTranslators();
+    public function getNodeTranslators(): array;
 
     /**
      * Returns combination translators.
      *
      * @return callable[]
      */
-    public function getCombinationTranslators();
+    public function getCombinationTranslators(): array;
 
     /**
      * Returns function translators.
      *
      * @return callable[]
      */
-    public function getFunctionTranslators();
+    public function getFunctionTranslators(): array;
 
     /**
      * Returns pseudo-class translators.
      *
      * @return callable[]
      */
-    public function getPseudoClassTranslators();
+    public function getPseudoClassTranslators(): array;
 
     /**
      * Returns attribute operation translators.
      *
      * @return callable[]
      */
-    public function getAttributeMatchingTranslators();
+    public function getAttributeMatchingTranslators(): array;
 
     /**
      * Returns extension name.
-     *
-     * @return string
      */
-    public function getName();
+    public function getName(): string;
 }
diff --git a/src/Symfony/Component/CssSelector/XPath/Extension/NodeExtension.php b/src/Symfony/Component/CssSelector/XPath/Extension/NodeExtension.php
@@ -41,7 +41,7 @@ public function __construct(int $flags = 0)
     /**
      * @return $this
      */
-    public function setFlag(int $flag, bool $on)
+    public function setFlag(int $flag, bool $on): object
     {
         if ($on && !$this->hasFlag($flag)) {
             $this->flags += $flag;
diff --git a/src/Symfony/Component/DependencyInjection/ChildDefinition.php b/src/Symfony/Component/DependencyInjection/ChildDefinition.php
@@ -108,16 +108,20 @@ public function replaceArgument($index, $value)
 
     /**
      * @internal
+     *
+     * @return $this
      */
-    public function setAutoconfigured(bool $autoconfigured)
+    public function setAutoconfigured(bool $autoconfigured): object
     {
         throw new BadMethodCallException('A ChildDefinition cannot be autoconfigured.');
     }
 
     /**
      * @internal
+     *
+     * @return $this
      */
-    public function setInstanceofConditionals(array $instanceof)
+    public function setInstanceofConditionals(array $instanceof): object
     {
         throw new BadMethodCallException('A ChildDefinition cannot have instanceof conditionals set on it.');
     }
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/MergeExtensionConfigurationPass.php b/src/Symfony/Component/DependencyInjection/Compiler/MergeExtensionConfigurationPass.php
@@ -137,7 +137,7 @@ public function freezeAfterProcessing(Extension $extension, ContainerBuilder $co
     /**
      * {@inheritdoc}
      */
-    public function getEnvPlaceholders()
+    public function getEnvPlaceholders(): array
     {
         return null !== $this->processedEnvPlaceholders ? $this->processedEnvPlaceholders : parent::getEnvPlaceholders();
     }
@@ -166,8 +166,10 @@ public function __construct(ExtensionInterface $extension, ParameterBagInterface
 
     /**
      * {@inheritdoc}
+     *
+     * @return $this
      */
-    public function addCompilerPass(CompilerPassInterface $pass, string $type = PassConfig::TYPE_BEFORE_OPTIMIZATION, int $priority = 0)
+    public function addCompilerPass(CompilerPassInterface $pass, string $type = PassConfig::TYPE_BEFORE_OPTIMIZATION, int $priority = 0): object
     {
         throw new LogicException(sprintf('You cannot add compiler pass "%s" from extension "%s". Compiler passes must be registered before the container is compiled.', \get_class($pass), $this->extensionClass));
     }
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/ScalarFactory.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/ScalarFactory.php
@@ -7,7 +7,7 @@ final class ScalarFactory
     /**
      * @return string
      */
-    public static function getSomeValue()
+    public static function getSomeValue(): string
     {
         return 'some value';
     }
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/DomCrawler/FormFieldRegistry.php b/src/Symfony/Component/DomCrawler/FormFieldRegistry.php
@@ -143,7 +143,7 @@ public function all(): array
      *
      * @return static
      */
-    private static function create(string $base, array $values)
+    private static function create(string $base, array $values): object
     {
         $registry = new static();
         $registry->base = $base;
diff --git a/src/Symfony/Component/Form/Util/OptionsResolverWrapper.php b/src/Symfony/Component/Form/Util/OptionsResolverWrapper.php
@@ -24,7 +24,10 @@ class OptionsResolverWrapper extends OptionsResolver
 {
     private $undefined = [];
 
-    public function setNormalizer(string $option, \Closure $normalizer)
+    /**
+     * @return $this
+     */
+    public function setNormalizer(string $option, \Closure $normalizer): object
     {
         try {
             parent::setNormalizer($option, $normalizer);
@@ -35,7 +38,10 @@ public function setNormalizer(string $option, \Closure $normalizer)
         return $this;
     }
 
-    public function setAllowedValues(string $option, $allowedValues)
+    /**
+     * @return $this
+     */
+    public function setAllowedValues(string $option, $allowedValues): object
     {
         try {
             parent::setAllowedValues($option, $allowedValues);
@@ -46,7 +52,10 @@ public function setAllowedValues(string $option, $allowedValues)
         return $this;
     }
 
-    public function addAllowedValues(string $option, $allowedValues)
+    /**
+     * @return $this
+     */
+    public function addAllowedValues(string $option, $allowedValues): object
     {
         try {
             parent::addAllowedValues($option, $allowedValues);
@@ -57,7 +66,10 @@ public function addAllowedValues(string $option, $allowedValues)
         return $this;
     }
 
-    public function setAllowedTypes(string $option, $allowedTypes)
+    /**
+     * @return $this
+     */
+    public function setAllowedTypes(string $option, $allowedTypes): object
     {
         try {
             parent::setAllowedTypes($option, $allowedTypes);
@@ -68,7 +80,10 @@ public function setAllowedTypes(string $option, $allowedTypes)
         return $this;
     }
 
-    public function addAllowedTypes(string $option, $allowedTypes)
+    /**
+     * @return $this
+     */
+    public function addAllowedTypes(string $option, $allowedTypes): object
     {
         try {
             parent::addAllowedTypes($option, $allowedTypes);
@@ -84,7 +99,7 @@ public function resolve(array $options = []): array
         throw new AccessException('Resolve options is not supported.');
     }
 
-    public function getUndefinedOptions()
+    public function getUndefinedOptions(): array
     {
         return array_keys($this->undefined);
     }
diff --git a/src/Symfony/Component/HttpKernel/Controller/ArgumentResolver/NotTaggedControllerValueResolver.php b/src/Symfony/Component/HttpKernel/Controller/ArgumentResolver/NotTaggedControllerValueResolver.php
@@ -58,7 +58,7 @@ public function supports(Request $request, ArgumentMetadata $argument): bool
     /**
      * {@inheritdoc}
      */
-    public function resolve(Request $request, ArgumentMetadata $argument)
+    public function resolve(Request $request, ArgumentMetadata $argument): iterable
     {
         if (\is_array($controller = $request->attributes->get('_controller'))) {
             $controller = $controller[0].'::'.$controller[1];
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/HttpKernel/HttpClientKernel.php b/src/Symfony/Component/HttpKernel/HttpClientKernel.php
@@ -39,7 +39,7 @@ public function __construct(HttpClientInterface $client = null)
         $this->client = $client ?? HttpClient::create();
     }
 
-    public function handle(Request $request, int $type = HttpKernelInterface::MASTER_REQUEST, bool $catch = true)
+    public function handle(Request $request, int $type = HttpKernelInterface::MASTER_REQUEST, bool $catch = true): Response
     {
         $headers = $this->getHeaders($request);
         $body = '';
diff --git a/src/Symfony/Component/HttpKernel/Profiler/FileProfilerStorage.php b/src/Symfony/Component/HttpKernel/Profiler/FileProfilerStorage.php
@@ -47,7 +47,7 @@ public function __construct(string $dsn)
     /**
      * {@inheritdoc}
      */
-    public function find(?string $ip, ?string $url, ?int $limit, ?string $method, int $start = null, int $end = null, string $statusCode = null)
+    public function find(?string $ip, ?string $url, ?int $limit, ?string $method, int $start = null, int $end = null, string $statusCode = null): array
     {
         $file = $this->getIndexFilename();
 
@@ -113,7 +113,7 @@ public function purge()
     /**
      * {@inheritdoc}
      */
-    public function read(string $token)
+    public function read(string $token): ?Profile
     {
         if (!$token || !file_exists($file = $this->getFilename($token))) {
             return null;
@@ -127,7 +127,7 @@ public function read(string $token)
      *
      * @throws \RuntimeException
      */
-    public function write(Profile $profile)
+    public function write(Profile $profile): bool
     {
         $file = $this->getFilename($profile->getToken());
 
diff --git a/src/Symfony/Component/HttpKernel/Profiler/ProfilerStorageInterface.php b/src/Symfony/Component/HttpKernel/Profiler/ProfilerStorageInterface.php
@@ -35,7 +35,7 @@ interface ProfilerStorageInterface
      *
      * @return array An array of tokens
      */
-    public function find(?string $ip, ?string $url, ?int $limit, ?string $method, int $start = null, int $end = null);
+    public function find(?string $ip, ?string $url, ?int $limit, ?string $method, int $start = null, int $end = null): array;
 
     /**
      * Reads data associated with the given token.
@@ -44,14 +44,14 @@ public function find(?string $ip, ?string $url, ?int $limit, ?string $method, in
      *
      * @return Profile|null The profile associated with token
      */
-    public function read(string $token);
+    public function read(string $token): ?Profile;
 
     /**
      * Saves a Profile.
      *
      * @return bool Write operation successful
      */
-    public function write(Profile $profile);
+    public function write(Profile $profile): bool;
 
     /**
      * Purges all data from the database.
diff --git a/src/Symfony/Component/Intl/Data/Generator/RegionDataGenerator.php b/src/Symfony/Component/Intl/Data/Generator/RegionDataGenerator.php
diff --git a/src/Symfony/Component/Ldap/Security/LdapUser.php b/src/Symfony/Component/Ldap/Security/LdapUser.php
diff --git a/src/Symfony/Component/Mime/Email.php b/src/Symfony/Component/Mime/Email.php
diff --git a/src/Symfony/Component/Security/Core/Encoder/NativePasswordEncoder.php b/src/Symfony/Component/Security/Core/Encoder/NativePasswordEncoder.php
diff --git a/src/Symfony/Component/Serializer/Mapping/AttributeMetadata.php b/src/Symfony/Component/Serializer/Mapping/AttributeMetadata.php
diff --git a/src/Symfony/Component/Serializer/Mapping/AttributeMetadataInterface.php b/src/Symfony/Component/Serializer/Mapping/AttributeMetadataInterface.php
diff --git a/src/Symfony/Component/Serializer/Mapping/ClassMetadata.php b/src/Symfony/Component/Serializer/Mapping/ClassMetadata.php
diff --git a/src/Symfony/Component/Serializer/Mapping/ClassMetadataInterface.php b/src/Symfony/Component/Serializer/Mapping/ClassMetadataInterface.php
diff --git a/src/Symfony/Component/Serializer/Normalizer/DenormalizerInterface.php b/src/Symfony/Component/Serializer/Normalizer/DenormalizerInterface.php
diff --git a/src/Symfony/Component/Translation/Translator.php b/src/Symfony/Component/Translation/Translator.php

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
`@@ -61,9 +61,9 @@ public function isHit(): bool`
`61`	`61`	`/**`
`62`	`62`	`* {@inheritdoc}`
`63`	`63`	`*`
`64`		`- * @return static`
	`64`	`+ * @return $this`
`65`	`65`	`*/`
`66`		`- public function set($value)`
	`66`	`+ public function set($value): object`
`67`	`67`	`{`
`68`	`68`	`$this->value = $value;`
`69`	`69`
`@@ -73,9 +73,9 @@ public function set($value)`
`73`	`73`	`/**`
`74`	`74`	`* {@inheritdoc}`
`75`	`75`	`*`
`76`		`- * @return static`
	`76`	`+ * @return $this`
`77`	`77`	`*/`
`78`		`- public function expiresAt($expiration)`
	`78`	`+ public function expiresAt($expiration): object`
`79`	`79`	`{`
`80`	`80`	`if (null === $expiration) {`
`81`	`81`	`$this->expiry = $this->defaultLifetime > 0 ? microtime(true) + $this->defaultLifetime : null;`
`@@ -91,9 +91,9 @@ public function expiresAt($expiration)`
`91`	`91`	`/**`
`92`	`92`	`* {@inheritdoc}`
`93`	`93`	`*`
`94`		`- * @return static`
	`94`	`+ * @return $this`
`95`	`95`	`*/`
`96`		`- public function expiresAfter($time)`
	`96`	`+ public function expiresAfter($time): object`
`97`	`97`	`{`
`98`	`98`	`if (null === $time) {`
`99`	`99`	`$this->expiry = $this->defaultLifetime > 0 ? microtime(true) + $this->defaultLifetime : null;`
Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,7 @@ class TokenStream`
`56`	`56`	`*`
`57`	`57`	`* @return $this`
`58`	`58`	`*/`
`59`		`- public function push(Token $token)`
	`59`	`+ public function push(Token $token): object`
`60`	`60`	`{`
`61`	`61`	`$this->tokens[] = $token;`
`62`	`62`
`@@ -68,7 +68,7 @@ public function push(Token $token)`
`68`	`68`	`*`
`69`	`69`	`* @return $this`
`70`	`70`	`*/`
`71`		`- public function freeze()`
	`71`	`+ public function freeze(): object`
`72`	`72`	`{`
`73`	`73`	`return $this;`
`74`	`74`	`}`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ public function __construct(int $flags = 0)`
`41`	`41`	`/**`
`42`	`42`	`* @return $this`
`43`	`43`	`*/`
`44`		`- public function setFlag(int $flag, bool $on)`
	`44`	`+ public function setFlag(int $flag, bool $on): object`
`45`	`45`	`{`
`46`	`46`	`if ($on && !$this->hasFlag($flag)) {`
`47`	`47`	`$this->flags += $flag;`
Original file line number	Diff line number	Diff line change
`@@ -108,16 +108,20 @@ public function replaceArgument($index, $value)`
`108`	`108`
`109`	`109`	`/**`
`110`	`110`	`* @internal`
	`111`	`+ *`
	`112`	`+ * @return $this`
`111`	`113`	`*/`
`112`		`- public function setAutoconfigured(bool $autoconfigured)`
	`114`	`+ public function setAutoconfigured(bool $autoconfigured): object`
`113`	`115`	`{`
`114`	`116`	`throw new BadMethodCallException('A ChildDefinition cannot be autoconfigured.');`
`115`	`117`	`}`
`116`	`118`
`117`	`119`	`/**`
`118`	`120`	`* @internal`
	`121`	`+ *`
	`122`	`+ * @return $this`
`119`	`123`	`*/`
`120`		`- public function setInstanceofConditionals(array $instanceof)`
	`124`	`+ public function setInstanceofConditionals(array $instanceof): object`
`121`	`125`	`{`
`122`	`126`	`throw new BadMethodCallException('A ChildDefinition cannot have instanceof conditionals set on it.');`
`123`	`127`	`}`
Original file line number	Diff line number	Diff line change
`@@ -137,7 +137,7 @@ public function freezeAfterProcessing(Extension $extension, ContainerBuilder $co`
`137`	`137`	`/**`
`138`	`138`	`* {@inheritdoc}`
`139`	`139`	`*/`
`140`		`- public function getEnvPlaceholders()`
	`140`	`+ public function getEnvPlaceholders(): array`
`141`	`141`	`{`
`142`	`142`	`return null !== $this->processedEnvPlaceholders ? $this->processedEnvPlaceholders : parent::getEnvPlaceholders();`
`143`	`143`	`}`
`@@ -166,8 +166,10 @@ public function __construct(ExtensionInterface $extension, ParameterBagInterface`
`166`	`166`
`167`	`167`	`/**`
`168`	`168`	`* {@inheritdoc}`
	`169`	`+ *`
	`170`	`+ * @return $this`
`169`	`171`	`*/`
`170`		`- public function addCompilerPass(CompilerPassInterface $pass, string $type = PassConfig::TYPE_BEFORE_OPTIMIZATION, int $priority = 0)`
	`172`	`+ public function addCompilerPass(CompilerPassInterface $pass, string $type = PassConfig::TYPE_BEFORE_OPTIMIZATION, int $priority = 0): object`
`171`	`173`	`{`
`172`	`174`	`throw new LogicException(sprintf('You cannot add compiler pass "%s" from extension "%s". Compiler passes must be registered before the container is compiled.', \get_class($pass), $this->extensionClass));`
`173`	`175`	`}`