minor #33198 Add types to private and final methods (derrabus)

fabpot · fabpot · commit 2a1647a351fd · 2019-08-18T20:07:05.000+02:00
This PR was merged into the 4.4 branch. Discussion ---------- Add types to private and final methods | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #32179 | License | MIT | Doc PR | N/A Backports from #33154. Commits ------- 1b88067 Add types to private and final methods.
diff --git a/src/Symfony/Bridge/Doctrine/DataCollector/DoctrineDataCollector.php b/src/Symfony/Bridge/Doctrine/DataCollector/DoctrineDataCollector.php
@@ -119,7 +119,7 @@ public function getName()
         return 'db';
     }
 
-    private function sanitizeQueries(string $connectionName, array $queries)
+    private function sanitizeQueries(string $connectionName, array $queries): array
     {
         foreach ($queries as $i => $query) {
             $queries[$i] = $this->sanitizeQuery($connectionName, $query);
@@ -128,7 +128,7 @@ private function sanitizeQueries(string $connectionName, array $queries)
         return $queries;
     }
 
-    private function sanitizeQuery(string $connectionName, $query)
+    private function sanitizeQuery(string $connectionName, array $query): array
     {
         $query['explainable'] = true;
         if (null === $query['params']) {
diff --git a/src/Symfony/Bridge/Monolog/Formatter/ConsoleFormatter.php b/src/Symfony/Bridge/Monolog/Formatter/ConsoleFormatter.php
@@ -180,7 +180,7 @@ private function replacePlaceHolder(array $record)
         return $record;
     }
 
-    private function dumpData($data, $colors = null)
+    private function dumpData($data, bool $colors = null): string
     {
         if (null === $this->dumper) {
             return '';
diff --git a/src/Symfony/Bridge/Twig/Command/LintCommand.php b/src/Symfony/Bridge/Twig/Command/LintCommand.php
@@ -118,13 +118,13 @@ protected function findFiles($filename)
         throw new RuntimeException(sprintf('File or directory "%s" is not readable', $filename));
     }
 
-    private function validate(string $template, $file)
+    private function validate(string $template, string $file): array
     {
         $realLoader = $this->twig->getLoader();
         try {
-            $temporaryLoader = new ArrayLoader([(string) $file => $template]);
+            $temporaryLoader = new ArrayLoader([$file => $template]);
             $this->twig->setLoader($temporaryLoader);
-            $nodeTree = $this->twig->parse($this->twig->tokenize(new Source($template, (string) $file)));
+            $nodeTree = $this->twig->parse($this->twig->tokenize(new Source($template, $file)));
             $this->twig->compile($nodeTree);
             $this->twig->setLoader($realLoader);
         } catch (Error $e) {
diff --git a/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/AbstractPhpFileCacheWarmer.php b/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/AbstractPhpFileCacheWarmer.php
@@ -72,7 +72,7 @@ protected function warmUpPhpArrayAdapter(PhpArrayAdapter $phpArrayAdapter, array
     /**
      * @internal
      */
-    final protected function ignoreAutoloadException($class, \Exception $exception)
+    final protected function ignoreAutoloadException(string $class, \Exception $exception): void
     {
         try {
             ClassExistenceResource::throwOnRequiredClass($class, $exception);
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -1069,7 +1069,7 @@ private function registerAssetsConfiguration(array $config, ContainerBuilder $co
     /**
      * Returns a definition for an asset package.
      */
-    private function createPackageDefinition(?string $basePath, array $baseUrls, Reference $version)
+    private function createPackageDefinition(?string $basePath, array $baseUrls, Reference $version): Definition
     {
         if ($basePath && $baseUrls) {
             throw new \LogicException('An asset package cannot have base URLs and base paths.');
@@ -1085,7 +1085,7 @@ private function createPackageDefinition(?string $basePath, array $baseUrls, Ref
         return $package;
     }
 
-    private function createVersion(ContainerBuilder $container, ?string $version, ?string $format, ?string $jsonManifestPath, string $name)
+    private function createVersion(ContainerBuilder $container, ?string $version, ?string $format, ?string $jsonManifestPath, string $name): Reference
     {
         // Configuration prevents $version and $jsonManifestPath from being set
         if (null !== $version) {
diff --git a/src/Symfony/Component/BrowserKit/Cookie.php b/src/Symfony/Component/BrowserKit/Cookie.php
@@ -199,7 +199,7 @@ public static function fromString($cookie, $url = null)
         );
     }
 
-    private static function parseDate($dateValue)
+    private static function parseDate(string $dateValue): ?string
     {
         // trim single quotes around date if present
         if (($length = \strlen($dateValue)) > 1 && "'" === $dateValue[0] && "'" === $dateValue[$length - 1]) {
@@ -216,6 +216,8 @@ private static function parseDate($dateValue)
         if (false !== $date = date_create($dateValue, new \DateTimeZone('GMT'))) {
             return $date->format('U');
         }
+
+        return null;
     }
 
     /**
diff --git a/src/Symfony/Component/Filesystem/Filesystem.php b/src/Symfony/Component/Filesystem/Filesystem.php
@@ -740,7 +740,10 @@ private function getSchemeAndHierarchy(string $filename): array
         return 2 === \count($components) ? [$components[0], $components[1]] : [null, $components[0]];
     }
 
-    private static function box($func)
+    /**
+     * @return mixed
+     */
+    private static function box(callable $func)
     {
         self::$lastError = null;
         set_error_handler(__CLASS__.'::handleError');
diff --git a/src/Symfony/Component/Form/Extension/Core/Type/FileType.php b/src/Symfony/Component/Form/Extension/Core/Type/FileType.php
@@ -246,8 +246,8 @@ private function factorizeSizes(int $size, int $limit)
     /**
      * This method should be kept in sync with Symfony\Component\Validator\Constraints\FileValidator::moreDecimalsThan().
      */
-    private static function moreDecimalsThan($double, $numberOfDecimals)
+    private static function moreDecimalsThan(string $double, int $numberOfDecimals): bool
     {
-        return \strlen((string) $double) > \strlen(round($double, $numberOfDecimals));
+        return \strlen($double) > \strlen(round($double, $numberOfDecimals));
     }
 }
diff --git a/src/Symfony/Component/Form/FormFactoryBuilder.php b/src/Symfony/Component/Form/FormFactoryBuilder.php
@@ -47,10 +47,7 @@ class FormFactoryBuilder implements FormFactoryBuilderInterface
      */
     private $typeGuessers = [];
 
-    /**
-     * @param bool $forceCoreExtension
-     */
-    public function __construct($forceCoreExtension = false)
+    public function __construct(bool $forceCoreExtension = false)
     {
         $this->forceCoreExtension = $forceCoreExtension;
     }
diff --git a/src/Symfony/Component/Messenger/MessageBus.php b/src/Symfony/Component/Messenger/MessageBus.php
@@ -39,7 +39,7 @@ public function __construct(iterable $middlewareHandlers = [])
                 private $middlewareHandlers;
                 private $cachedIterator;
 
-                public function __construct($middlewareHandlers)
+                public function __construct(\Traversable $middlewareHandlers)
                 {
                     $this->middlewareHandlers = $middlewareHandlers;
                 }
diff --git a/src/Symfony/Component/PropertyAccess/PropertyAccessor.php b/src/Symfony/Component/PropertyAccess/PropertyAccessor.php
@@ -181,7 +181,7 @@ public function setValue(&$objectOrArray, $propertyPath, $value)
         }
     }
 
-    private static function throwInvalidArgumentException($message, $trace, $i, $propertyPath)
+    private static function throwInvalidArgumentException(string $message, array $trace, int $i, string $propertyPath): void
     {
         // the type mismatch is not caused by invalid arguments (but e.g. by an incompatible return type hint of the writer method)
         if (0 !== strpos($message, 'Argument ')) {
diff --git a/src/Symfony/Component/Security/Core/Authorization/AccessDecisionManager.php b/src/Symfony/Component/Security/Core/Authorization/AccessDecisionManager.php
@@ -66,7 +66,7 @@ public function decide(TokenInterface $token, array $attributes, $object = null)
      * If all voters abstained from voting, the decision will be based on the
      * allowIfAllAbstainDecisions property value (defaults to false).
      */
-    private function decideAffirmative(TokenInterface $token, array $attributes, $object = null)
+    private function decideAffirmative(TokenInterface $token, array $attributes, $object = null): bool
     {
         $deny = 0;
         foreach ($this->voters as $voter) {
@@ -106,7 +106,7 @@ private function decideAffirmative(TokenInterface $token, array $attributes, $ob
      * If all voters abstained from voting, the decision will be based on the
      * allowIfAllAbstainDecisions property value (defaults to false).
      */
-    private function decideConsensus(TokenInterface $token, array $attributes, $object = null)
+    private function decideConsensus(TokenInterface $token, array $attributes, $object = null): bool
     {
         $grant = 0;
         $deny = 0;
@@ -147,7 +147,7 @@ private function decideConsensus(TokenInterface $token, array $attributes, $obje
      * If all voters abstained from voting, the decision will be based on the
      * allowIfAllAbstainDecisions property value (defaults to false).
      */
-    private function decideUnanimous(TokenInterface $token, array $attributes, $object = null)
+    private function decideUnanimous(TokenInterface $token, array $attributes, $object = null): bool
     {
         $grant = 0;
         foreach ($this->voters as $voter) {
diff --git a/src/Symfony/Component/Security/Http/RememberMe/AbstractRememberMeServices.php b/src/Symfony/Component/Security/Http/RememberMe/AbstractRememberMeServices.php
@@ -22,6 +22,7 @@
 use Symfony\Component\Security\Core\Exception\UnsupportedUserException;
 use Symfony\Component\Security\Core\Exception\UsernameNotFoundException;
 use Symfony\Component\Security\Core\User\UserInterface;
+use Symfony\Component\Security\Core\User\UserProviderInterface;
 use Symfony\Component\Security\Http\Logout\LogoutHandlerInterface;
 use Symfony\Component\Security\Http\ParameterBagUtils;
 
@@ -221,7 +222,7 @@ protected function onLoginFail(Request $request, \Exception $exception = null)
      */
     abstract protected function onLoginSuccess(Request $request, Response $response, TokenInterface $token);
 
-    final protected function getUserProvider($class)
+    final protected function getUserProvider(string $class): UserProviderInterface
     {
         foreach ($this->userProviders as $provider) {
             if ($provider->supportsClass($class)) {
diff --git a/src/Symfony/Component/Translation/Command/XliffLintCommand.php b/src/Symfony/Component/Translation/Command/XliffLintCommand.php
@@ -106,7 +106,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
         return $this->display($io, $filesInfo);
     }
 
-    private function validate(string $content, $file = null)
+    private function validate(string $content, string $file = null): array
     {
         $errors = [];
 
diff --git a/src/Symfony/Component/Validator/Constraints/FileValidator.php b/src/Symfony/Component/Validator/Constraints/FileValidator.php
@@ -199,9 +199,9 @@ public function validate($value, Constraint $constraint)
         }
     }
 
-    private static function moreDecimalsThan($double, $numberOfDecimals)
+    private static function moreDecimalsThan(string $double, int $numberOfDecimals): bool
     {
-        return \strlen((string) $double) > \strlen(round($double, $numberOfDecimals));
+        return \strlen($double) > \strlen(round($double, $numberOfDecimals));
     }
 
     /**
diff --git a/src/Symfony/Component/Workflow/Registry.php b/src/Symfony/Component/Workflow/Registry.php
@@ -82,7 +82,11 @@ public function all($subject): array
         return $matched;
     }
 
-    private function supports(WorkflowInterface $workflow, $supportStrategy, $subject, $workflowName): bool
+    /**
+     * @param WorkflowSupportStrategyInterface $supportStrategy
+     * @param object                           $subject
+     */
+    private function supports(WorkflowInterface $workflow, $supportStrategy, $subject, ?string $workflowName): bool
     {
         if (null !== $workflowName && $workflowName !== $workflow->getName()) {
             return false;

Original file line number	Diff line number	Diff line change
`@@ -119,7 +119,7 @@ public function getName()`
`119`	`119`	`return 'db';`
`120`	`120`	`}`
`121`	`121`
`122`		`- private function sanitizeQueries(string $connectionName, array $queries)`
	`122`	`+ private function sanitizeQueries(string $connectionName, array $queries): array`
`123`	`123`	`{`
`124`	`124`	`foreach ($queries as $i => $query) {`
`125`	`125`	`$queries[$i] = $this->sanitizeQuery($connectionName, $query);`
`@@ -128,7 +128,7 @@ private function sanitizeQueries(string $connectionName, array $queries)`
`128`	`128`	`return $queries;`
`129`	`129`	`}`
`130`	`130`
`131`		`- private function sanitizeQuery(string $connectionName, $query)`
	`131`	`+ private function sanitizeQuery(string $connectionName, array $query): array`
`132`	`132`	`{`
`133`	`133`	`$query['explainable'] = true;`
`134`	`134`	`if (null === $query['params']) {`
Original file line number	Diff line number	Diff line change
`@@ -180,7 +180,7 @@ private function replacePlaceHolder(array $record)`
`180`	`180`	`return $record;`
`181`	`181`	`}`
`182`	`182`
`183`		`- private function dumpData($data, $colors = null)`
	`183`	`+ private function dumpData($data, bool $colors = null): string`
`184`	`184`	`{`
`185`	`185`	`if (null === $this->dumper) {`
`186`	`186`	`return '';`
Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,7 @@ protected function warmUpPhpArrayAdapter(PhpArrayAdapter $phpArrayAdapter, array`
`72`	`72`	`/**`
`73`	`73`	`* @internal`
`74`	`74`	`*/`
`75`		`- final protected function ignoreAutoloadException($class, \Exception $exception)`
	`75`	`+ final protected function ignoreAutoloadException(string $class, \Exception $exception): void`
`76`	`76`	`{`
`77`	`77`	`try {`
`78`	`78`	`ClassExistenceResource::throwOnRequiredClass($class, $exception);`
Original file line number	Diff line number	Diff line change
`@@ -1069,7 +1069,7 @@ private function registerAssetsConfiguration(array $config, ContainerBuilder $co`
`1069`	`1069`	`/**`
`1070`	`1070`	`* Returns a definition for an asset package.`
`1071`	`1071`	`*/`
`1072`		`- private function createPackageDefinition(?string $basePath, array $baseUrls, Reference $version)`
	`1072`	`+ private function createPackageDefinition(?string $basePath, array $baseUrls, Reference $version): Definition`
`1073`	`1073`	`{`
`1074`	`1074`	`if ($basePath && $baseUrls) {`
`1075`	`1075`	`throw new \LogicException('An asset package cannot have base URLs and base paths.');`
`@@ -1085,7 +1085,7 @@ private function createPackageDefinition(?string $basePath, array $baseUrls, Ref`
`1085`	`1085`	`return $package;`
`1086`	`1086`	`}`
`1087`	`1087`
`1088`		`- private function createVersion(ContainerBuilder $container, ?string $version, ?string $format, ?string $jsonManifestPath, string $name)`
	`1088`	`+ private function createVersion(ContainerBuilder $container, ?string $version, ?string $format, ?string $jsonManifestPath, string $name): Reference`
`1089`	`1089`	`{`
`1090`	`1090`	`// Configuration prevents $version and $jsonManifestPath from being set`
`1091`	`1091`	`if (null !== $version) {`
Original file line number	Diff line number	Diff line change
`@@ -199,7 +199,7 @@ public static function fromString($cookie, $url = null)`
`199`	`199`	`);`
`200`	`200`	`}`
`201`	`201`
`202`		`- private static function parseDate($dateValue)`
	`202`	`+ private static function parseDate(string $dateValue): ?string`
`203`	`203`	`{`
`204`	`204`	`// trim single quotes around date if present`
`205`	`205`	`if (($length = \strlen($dateValue)) > 1 && "'" === $dateValue[0] && "'" === $dateValue[$length - 1]) {`
`@@ -216,6 +216,8 @@ private static function parseDate($dateValue)`
`216`	`216`	`if (false !== $date = date_create($dateValue, new \DateTimeZone('GMT'))) {`
`217`	`217`	`return $date->format('U');`
`218`	`218`	`}`
	`219`	`+`
	`220`	`+ return null;`
`219`	`221`	`}`
`220`	`222`
`221`	`223`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -740,7 +740,10 @@ private function getSchemeAndHierarchy(string $filename): array`
`740`	`740`	`return 2 === \count($components) ? [$components[0], $components[1]] : [null, $components[0]];`
`741`	`741`	`}`
`742`	`742`
`743`		`- private static function box($func)`
	`743`	`+ /**`
	`744`	`+ * @return mixed`
	`745`	`+ */`
	`746`	`+ private static function box(callable $func)`
`744`	`747`	`{`
`745`	`748`	`self::$lastError = null;`
`746`	`749`	`set_error_handler(__CLASS__.'::handleError');`
Original file line number	Diff line number	Diff line change
`@@ -246,8 +246,8 @@ private function factorizeSizes(int $size, int $limit)`
`246`	`246`	`/**`
`247`	`247`	`* This method should be kept in sync with Symfony\Component\Validator\Constraints\FileValidator::moreDecimalsThan().`
`248`	`248`	`*/`
`249`		`- private static function moreDecimalsThan($double, $numberOfDecimals)`
	`249`	`+ private static function moreDecimalsThan(string $double, int $numberOfDecimals): bool`
`250`	`250`	`{`
`251`		`- return \strlen((string) $double) > \strlen(round($double, $numberOfDecimals));`
	`251`	`+ return \strlen($double) > \strlen(round($double, $numberOfDecimals));`
`252`	`252`	`}`
`253`	`253`	`}`
Original file line number	Diff line number	Diff line change
`@@ -47,10 +47,7 @@ class FormFactoryBuilder implements FormFactoryBuilderInterface`
`47`	`47`	`*/`
`48`	`48`	`private $typeGuessers = [];`
`49`	`49`
`50`		`- /**`
`51`		`- * @param bool $forceCoreExtension`
`52`		`- */`
`53`		`- public function __construct($forceCoreExtension = false)`
	`50`	`+ public function __construct(bool $forceCoreExtension = false)`
`54`	`51`	`{`
`55`	`52`	`$this->forceCoreExtension = $forceCoreExtension;`
`56`	`53`	`}`
Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ public function __construct(iterable $middlewareHandlers = [])`
`39`	`39`	`private $middlewareHandlers;`
`40`	`40`	`private $cachedIterator;`
`41`	`41`
`42`		`- public function __construct($middlewareHandlers)`
	`42`	`+ public function __construct(\Traversable $middlewareHandlers)`
`43`	`43`	`{`
`44`	`44`	`$this->middlewareHandlers = $middlewareHandlers;`
`45`	`45`	`}`