minor #33264 [4.4] Add return types on internal|final|private methods…

… (bis) (nicolas-grekas) This PR was merged into the 4.4 branch. Discussion ---------- [4.4] Add return types on internal|final|private methods (bis) | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - Found while working on #33259 `: self` is used for final methods only. I'd have preferred using `: object` but that's not possible on PHP 7.1 Commits ------- 23faee4 [4.4] Add return types on internal|final|private methods (bis)
symfony · Aug 20, 2019 · 22319a9 · 22319a9
2 parents 7eb5fee + 23faee4
commit 22319a9
Show file tree

Hide file tree

Showing 26 changed files with 86 additions and 83 deletions.
diff --git a/src/Symfony/Bridge/Twig/Mime/WrappedTemplatedEmail.php b/src/Symfony/Bridge/Twig/Mime/WrappedTemplatedEmail.php
@@ -63,7 +63,7 @@ public function attach(string $file, string $name = null, string $contentType =
     /**
      * @return $this
      */
-    public function setSubject(string $subject)
+    public function setSubject(string $subject): self
     {
         $this->message->subject($subject);
 
@@ -78,7 +78,7 @@ public function getSubject(): ?string
     /**
      * @return $this
      */
-    public function setReturnPath(string $address)
+    public function setReturnPath(string $address): self
     {
         $this->message->returnPath($address);
 
@@ -93,7 +93,7 @@ public function getReturnPath(): string
     /**
      * @return $this
      */
-    public function addFrom(string $address, string $name = null)
+    public function addFrom(string $address, string $name = null): self
     {
         $this->message->addFrom($name ? new NamedAddress($address, $name) : new Address($address));
 
@@ -111,7 +111,7 @@ public function getFrom(): array
     /**
      * @return $this
      */
-    public function addReplyTo(string $address)
+    public function addReplyTo(string $address): self
     {
         $this->message->addReplyTo($address);
 
@@ -129,7 +129,7 @@ public function getReplyTo(): array
     /**
      * @return $this
      */
-    public function addTo(string $address, string $name = null)
+    public function addTo(string $address, string $name = null): self
     {
         $this->message->addTo($name ? new NamedAddress($address, $name) : new Address($address));
 
@@ -147,7 +147,7 @@ public function getTo(): array
     /**
      * @return $this
      */
-    public function addCc(string $address, string $name = null)
+    public function addCc(string $address, string $name = null): self
     {
         $this->message->addCc($name ? new NamedAddress($address, $name) : new Address($address));
 
@@ -165,7 +165,7 @@ public function getCc(): array
     /**
      * @return $this
      */
-    public function addBcc(string $address, string $name = null)
+    public function addBcc(string $address, string $name = null): self
     {
         $this->message->addBcc($name ? new NamedAddress($address, $name) : new Address($address));
 
@@ -183,7 +183,7 @@ public function getBcc(): array
     /**
      * @return $this
      */
-    public function setPriority(int $priority)
+    public function setPriority(int $priority): self
     {
         $this->message->setPriority($priority);
 

diff --git a/src/Symfony/Component/Cache/CacheItem.php b/src/Symfony/Component/Cache/CacheItem.php
@@ -67,7 +67,7 @@ public function isHit()
      *
      * @return $this
      */
-    public function set($value)
+    public function set($value): self
     {
         $this->value = $value;
 
@@ -79,7 +79,7 @@ public function set($value)
      *
      * @return $this
      */
-    public function expiresAt($expiration)
+    public function expiresAt($expiration): self
     {
         if (null === $expiration) {
             $this->expiry = $this->defaultLifetime > 0 ? microtime(true) + $this->defaultLifetime : null;
@@ -97,7 +97,7 @@ public function expiresAt($expiration)
      *
      * @return $this
      */
-    public function expiresAfter($time)
+    public function expiresAfter($time): self
     {
         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): self
     {
         $this->tokens[] = $token;
 
@@ -68,7 +68,7 @@ public function push(Token $token)
      *
      * @return $this
      */
-    public function freeze()
+    public function freeze(): self
     {
         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): self
     {
         if ($on && !$this->hasFlag($flag)) {
             $this->flags += $flag;

diff --git a/src/Symfony/Component/DependencyInjection/ChildDefinition.php b/src/Symfony/Component/DependencyInjection/ChildDefinition.php
@@ -109,15 +109,15 @@ public function replaceArgument($index, $value)
     /**
      * @internal
      */
-    public function setAutoconfigured($autoconfigured)
+    public function setAutoconfigured($autoconfigured): self
     {
         throw new BadMethodCallException('A ChildDefinition cannot be autoconfigured.');
     }
 
     /**
      * @internal
      */
-    public function setInstanceofConditionals(array $instanceof)
+    public function setInstanceofConditionals(array $instanceof): self
     {
         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();
     }
@@ -167,7 +167,7 @@ public function __construct(ExtensionInterface $extension, ParameterBagInterface
     /**
      * {@inheritdoc}
      */
-    public function addCompilerPass(CompilerPassInterface $pass, $type = PassConfig::TYPE_BEFORE_OPTIMIZATION, int $priority = 0)
+    public function addCompilerPass(CompilerPassInterface $pass, $type = PassConfig::TYPE_BEFORE_OPTIMIZATION, int $priority = 0): self
     {
         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/Loader/Configurator/DefaultsConfigurator.php b/src/Symfony/Component/DependencyInjection/Loader/Configurator/DefaultsConfigurator.php
@@ -42,7 +42,7 @@ public function __construct(ServicesConfigurator $parent, Definition $definition
      *
      * @throws InvalidArgumentException when an invalid tag name or attribute is provided
      */
-    final public function tag(string $name, array $attributes = [])
+    final public function tag(string $name, array $attributes = []): self
     {
         if ('' === $name) {
             throw new InvalidArgumentException('The tag name in "_defaults" must be a non-empty string.');

diff --git a/src/Symfony/Component/DependencyInjection/Loader/Configurator/ParametersConfigurator.php b/src/Symfony/Component/DependencyInjection/Loader/Configurator/ParametersConfigurator.php
@@ -32,7 +32,7 @@ public function __construct(ContainerBuilder $container)
      *
      * @return $this
      */
-    final public function set(string $name, $value)
+    final public function set(string $name, $value): self
     {
         $this->container->setParameter($name, static::processValue($value, true));
 
@@ -44,7 +44,7 @@ final public function set(string $name, $value)
      *
      * @return $this
      */
-    final public function __invoke(string $name, $value)
+    final public function __invoke(string $name, $value): self
     {
         return $this->set($name, $value);
     }

diff --git a/src/Symfony/Component/DependencyInjection/Loader/Configurator/ReferenceConfigurator.php b/src/Symfony/Component/DependencyInjection/Loader/Configurator/ReferenceConfigurator.php
@@ -32,7 +32,7 @@ public function __construct(string $id)
     /**
      * @return $this
      */
-    final public function ignoreOnInvalid()
+    final public function ignoreOnInvalid(): self
     {
         $this->invalidBehavior = ContainerInterface::IGNORE_ON_INVALID_REFERENCE;
 
@@ -42,7 +42,7 @@ final public function ignoreOnInvalid()
     /**
      * @return $this
      */
-    final public function nullOnInvalid()
+    final public function nullOnInvalid(): self
     {
         $this->invalidBehavior = ContainerInterface::NULL_ON_INVALID_REFERENCE;
 
@@ -52,7 +52,7 @@ final public function nullOnInvalid()
     /**
      * @return $this
      */
-    final public function ignoreOnUninitialized()
+    final public function ignoreOnUninitialized(): self
     {
         $this->invalidBehavior = ContainerInterface::IGNORE_ON_UNINITIALIZED_REFERENCE;
 

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/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($option, \Closure $normalizer)
+    /**
+     * @return $this
+     */
+    public function setNormalizer($option, \Closure $normalizer): self
     {
         try {
             parent::setNormalizer($option, $normalizer);
@@ -35,7 +38,10 @@ public function setNormalizer($option, \Closure $normalizer)
         return $this;
     }
 
-    public function setAllowedValues($option, $allowedValues)
+    /**
+     * @return $this
+     */
+    public function setAllowedValues($option, $allowedValues): self
     {
         try {
             parent::setAllowedValues($option, $allowedValues);
@@ -46,7 +52,10 @@ public function setAllowedValues($option, $allowedValues)
         return $this;
     }
 
-    public function addAllowedValues($option, $allowedValues)
+    /**
+     * @return $this
+     */
+    public function addAllowedValues($option, $allowedValues): self
     {
         try {
             parent::addAllowedValues($option, $allowedValues);
@@ -57,7 +66,10 @@ public function addAllowedValues($option, $allowedValues)
         return $this;
     }
 
-    public function setAllowedTypes($option, $allowedTypes)
+    /**
+     * @return $this
+     */
+    public function setAllowedTypes($option, $allowedTypes): self
     {
         try {
             parent::setAllowedTypes($option, $allowedTypes);
@@ -68,7 +80,10 @@ public function setAllowedTypes($option, $allowedTypes)
         return $this;
     }
 
-    public function addAllowedTypes($option, $allowedTypes)
+    /**
+     * @return $this
+     */
+    public function addAllowedTypes($option, $allowedTypes): self
     {
         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/...ony/Component/HttpKernel/Controller/ArgumentResolver/NotTaggedControllerValueResolver.php b/...ony/Component/HttpKernel/Controller/ArgumentResolver/NotTaggedControllerValueResolver.php
@@ -58,7 +58,7 @@ public function supports(Request $request, ArgumentMetadata $argument)
     /**
      * {@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/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, $type = HttpKernelInterface::MASTER_REQUEST, $catch = true)
+    public function handle(Request $request, $type = HttpKernelInterface::MASTER_REQUEST, $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($ip, $url, $limit, $method, $start = null, $end = null, $statusCode = null)
+    public function find($ip, $url, $limit, $method, $start = null, $end = null, $statusCode = null): array
     {
         $file = $this->getIndexFilename();
 
@@ -113,7 +113,7 @@ public function purge()
     /**
      * {@inheritdoc}
      */
-    public function read($token)
+    public function read($token): ?Profile
     {
         if (!$token || !file_exists($file = $this->getFilename($token))) {
             return null;
@@ -127,7 +127,7 @@ public function read($token)
      *
      * @throws \RuntimeException
      */
-    public function write(Profile $profile)
+    public function write(Profile $profile): bool
     {
         $file = $this->getFilename($profile->getToken());