Add types to private/final/internal methods and constructors.

derrabus · derrabus · commit ff7c180fb1e5 · 2019-09-08T21:37:35.000+02:00
diff --git a/Compiler/AbstractRecursivePass.php b/Compiler/AbstractRecursivePass.php
@@ -192,15 +192,15 @@ protected function getReflectionMethod(Definition $definition, $method)
         return $r;
     }
 
-    private function getExpressionLanguage()
+    private function getExpressionLanguage(): ExpressionLanguage
     {
         if (null === $this->expressionLanguage) {
             if (!class_exists(ExpressionLanguage::class)) {
                 throw new LogicException('Unable to use expressions as the Symfony ExpressionLanguage component is not installed.');
             }
 
             $providers = $this->container->getExpressionLanguageProviders();
-            $this->expressionLanguage = new ExpressionLanguage(null, $providers, function ($arg) {
+            $this->expressionLanguage = new ExpressionLanguage(null, $providers, function (string $arg): string {
                 if ('""' === substr_replace($arg, '', 1, -1)) {
                     $id = stripcslashes(substr($arg, 1, -1));
                     $this->inExpression = true;
diff --git a/Compiler/AutowirePass.php b/Compiler/AutowirePass.php
@@ -81,6 +81,9 @@ protected function processValue($value, $isRoot = false)
         }
     }
 
+    /**
+     * @return mixed
+     */
     private function doProcessValue($value, bool $isRoot = false)
     {
         if ($value instanceof TypedReference) {
@@ -371,7 +374,7 @@ private function set(string $type, string $id)
         $this->ambiguousServiceTypes[$type][] = $id;
     }
 
-    private function createTypeNotFoundMessageCallback(TypedReference $reference, string $label)
+    private function createTypeNotFoundMessageCallback(TypedReference $reference, string $label): callable
     {
         if (null === $this->typesClone->container) {
             $this->typesClone->container = new ContainerBuilder($this->container->getParameterBag());
@@ -386,7 +389,7 @@ private function createTypeNotFoundMessageCallback(TypedReference $reference, st
         })->bindTo($this->typesClone);
     }
 
-    private function createTypeNotFoundMessage(TypedReference $reference, string $label, string $currentId)
+    private function createTypeNotFoundMessage(TypedReference $reference, string $label, string $currentId): string
     {
         if (!$r = $this->container->getReflectionClass($type = $reference->getType(), false)) {
             // either $type does not exist or a parent class does not exist
@@ -420,7 +423,7 @@ private function createTypeNotFoundMessage(TypedReference $reference, string $la
         return $message;
     }
 
-    private function createTypeAlternatives(ContainerBuilder $container, TypedReference $reference)
+    private function createTypeAlternatives(ContainerBuilder $container, TypedReference $reference): string
     {
         // try suggesting available aliases first
         if ($message = $this->getAliasesSuggestionForType($container, $type = $reference->getType())) {
@@ -444,7 +447,7 @@ private function createTypeAlternatives(ContainerBuilder $container, TypedRefere
         return sprintf(' You should maybe alias this %s to %s.', class_exists($type, false) ? 'class' : 'interface', $message);
     }
 
-    private function getAliasesSuggestionForType(ContainerBuilder $container, string $type)
+    private function getAliasesSuggestionForType(ContainerBuilder $container, string $type): ?string
     {
         $aliases = [];
         foreach (class_parents($type) + class_implements($type) as $parent) {
diff --git a/Compiler/RegisterEnvVarProcessorsPass.php b/Compiler/RegisterEnvVarProcessorsPass.php
@@ -60,7 +60,7 @@ public function process(ContainerBuilder $container)
         }
     }
 
-    private static function validateProvidedTypes($types, $class)
+    private static function validateProvidedTypes(string $types, string $class): array
     {
         $types = explode('|', $types);
 
diff --git a/Compiler/ResolveBindingsPass.php b/Compiler/ResolveBindingsPass.php
@@ -205,6 +205,9 @@ protected function processValue($value, $isRoot = false)
         return parent::processValue($value, $isRoot);
     }
 
+    /**
+     * @return mixed
+     */
     private function getBindingValue(BoundArgument $binding)
     {
         list($bindingValue, $bindingId) = $binding->getValues();
diff --git a/Compiler/ResolveHotPathPass.php b/Compiler/ResolveHotPathPass.php
@@ -26,7 +26,7 @@ class ResolveHotPathPass extends AbstractRecursivePass
     private $tagName;
     private $resolvedIds = [];
 
-    public function __construct($tagName = 'container.hot_path')
+    public function __construct(string $tagName = 'container.hot_path')
     {
         $this->tagName = $tagName;
     }
diff --git a/Compiler/ResolveInstanceofConditionalsPass.php b/Compiler/ResolveInstanceofConditionalsPass.php
@@ -44,7 +44,7 @@ public function process(ContainerBuilder $container)
         }
     }
 
-    private function processDefinition(ContainerBuilder $container, string $id, Definition $definition)
+    private function processDefinition(ContainerBuilder $container, string $id, Definition $definition): Definition
     {
         $instanceofConditionals = $definition->getInstanceofConditionals();
         $autoconfiguredInstanceof = $definition->isAutoconfigured() ? $container->getAutoconfiguredInstanceof() : [];
@@ -144,7 +144,7 @@ private function processDefinition(ContainerBuilder $container, string $id, Defi
         return $definition;
     }
 
-    private function mergeConditionals(array $autoconfiguredInstanceof, array $instanceofConditionals, ContainerBuilder $container)
+    private function mergeConditionals(array $autoconfiguredInstanceof, array $instanceofConditionals, ContainerBuilder $container): array
     {
         // make each value an array of ChildDefinition
         $conditionals = array_map(function ($childDef) { return [$childDef]; }, $autoconfiguredInstanceof);
diff --git a/Compiler/ResolveInvalidReferencesPass.php b/Compiler/ResolveInvalidReferencesPass.php
@@ -51,6 +51,8 @@ public function process(ContainerBuilder $container)
     /**
      * Processes arguments to determine invalid references.
      *
+     * @return mixed
+     *
      * @throws RuntimeException When an invalid reference is found
      */
     private function processValue($value, int $rootLevel = 0, int $level = 0)
diff --git a/Compiler/ServiceLocatorTagPass.php b/Compiler/ServiceLocatorTagPass.php
@@ -88,9 +88,8 @@ protected function processValue($value, $isRoot = false)
 
     /**
      * @param Reference[] $refMap
-     * @param string|null $callerId
      */
-    public static function register(ContainerBuilder $container, array $refMap, $callerId = null): Reference
+    public static function register(ContainerBuilder $container, array $refMap, string $callerId = null): Reference
     {
         foreach ($refMap as $id => $ref) {
             if (!$ref instanceof Reference) {
diff --git a/Container.php b/Container.php
@@ -422,9 +422,14 @@ protected function getEnv($name)
     }
 
     /**
+     * @param string|false $registry
+     * @param string|bool  $load
+     *
+     * @return mixed
+     *
      * @internal
      */
-    final protected function getService($registry, $id, $method, $load)
+    final protected function getService($registry, string $id, ?string $method, $load)
     {
         if ('service_container' === $id) {
             return $this;
diff --git a/ContainerBuilder.php b/ContainerBuilder.php
@@ -1236,7 +1236,7 @@ private function doResolveServices($value, array &$inlineServices = [], bool $is
 
                     yield $k => $this->resolveServices($v);
                 }
-            }, function () use ($value) {
+            }, function () use ($value): int {
                 $count = 0;
                 foreach ($value->getValues() as $v) {
                     foreach (self::getServiceConditionals($v) as $s) {
@@ -1641,7 +1641,7 @@ private function shareService(Definition $definition, $service, ?string $id, arr
         }
     }
 
-    private function getExpressionLanguage()
+    private function getExpressionLanguage(): ExpressionLanguage
     {
         if (null === $this->expressionLanguage) {
             if (!class_exists('Symfony\Component\ExpressionLanguage\ExpressionLanguage')) {
@@ -1653,7 +1653,7 @@ private function getExpressionLanguage()
         return $this->expressionLanguage;
     }
 
-    private function inVendors(string $path)
+    private function inVendors(string $path): bool
     {
         if (null === $this->vendors) {
             $resource = new ComposerResource();
diff --git a/Dumper/GraphvizDumper.php b/Dumper/GraphvizDumper.php
@@ -183,7 +183,7 @@ private function findNodes(): array
         return $nodes;
     }
 
-    private function cloneContainer()
+    private function cloneContainer(): ContainerBuilder
     {
         $parameterBag = new ParameterBag($this->container->getParameterBag()->all());
 
diff --git a/Dumper/PhpDumper.php b/Dumper/PhpDumper.php
@@ -684,7 +684,7 @@ private function addServiceMethodCalls(Definition $definition, string $variableN
         return $calls;
     }
 
-    private function addServiceProperties(Definition $definition, string $variableName = 'instance')
+    private function addServiceProperties(Definition $definition, string $variableName = 'instance'): string
     {
         $code = '';
         foreach ($definition->getProperties() as $name => $value) {
@@ -967,7 +967,7 @@ private function addServices(array &$services = null): string
         return $publicServices.$privateServices;
     }
 
-    private function generateServiceFiles(array $services)
+    private function generateServiceFiles(array $services): iterable
     {
         $definitions = $this->container->getDefinitions();
         ksort($definitions);
@@ -993,7 +993,7 @@ private function generateServiceFiles(array $services)
         }
     }
 
-    private function addNewInstance(Definition $definition, string $return = '', string $id = null)
+    private function addNewInstance(Definition $definition, string $return = '', string $id = null): string
     {
         $tail = $return ? ";\n" : '';
 
@@ -1914,7 +1914,7 @@ private function getNextVariableName(): string
         }
     }
 
-    private function getExpressionLanguage()
+    private function getExpressionLanguage(): ExpressionLanguage
     {
         if (null === $this->expressionLanguage) {
             if (!class_exists('Symfony\Component\ExpressionLanguage\ExpressionLanguage')) {
@@ -1941,7 +1941,7 @@ private function getExpressionLanguage()
         return $this->expressionLanguage;
     }
 
-    private function isHotPath(Definition $definition)
+    private function isHotPath(Definition $definition): bool
     {
         return $this->hotPathTag && $definition->hasTag($this->hotPathTag) && !$definition->isDeprecated();
     }
@@ -1965,6 +1965,9 @@ private function isSingleUsePrivateNode(ServiceReferenceGraphNode $node): bool
         return 1 === \count($ids);
     }
 
+    /**
+     * @return mixed
+     */
     private function export($value)
     {
         if (null !== $this->targetDirRegex && \is_string($value) && preg_match($this->targetDirRegex, $value, $matches, PREG_OFFSET_CAPTURE)) {
@@ -1988,6 +1991,9 @@ private function export($value)
         return $this->doExport($value, true);
     }
 
+    /**
+     * @return mixed
+     */
     private function doExport($value, bool $resolveEnv = false)
     {
         $shouldCacheValue = $resolveEnv && \is_string($value);
diff --git a/Dumper/XmlDumper.php b/Dumper/XmlDumper.php
@@ -338,11 +338,9 @@ private function escape(array $arguments): array
      *
      * @param mixed $value Value to convert
      *
-     * @return string
-     *
      * @throws RuntimeException When trying to dump object or resource
      */
-    public static function phpToXml($value)
+    public static function phpToXml($value): string
     {
         switch (true) {
             case null === $value:
diff --git a/Dumper/YamlDumper.php b/Dumper/YamlDumper.php
@@ -201,6 +201,8 @@ private function addParameters(): string
      * Dumps callable to YAML format.
      *
      * @param mixed $callable
+     *
+     * @return mixed
      */
     private function dumpCallable($callable)
     {
@@ -299,7 +301,7 @@ private function getParameterCall(string $id): string
         return sprintf('%%%s%%', $id);
     }
 
-    private function getExpressionCall(string $expression)
+    private function getExpressionCall(string $expression): string
     {
         return sprintf('@=%s', $expression);
     }
diff --git a/Extension/Extension.php b/Extension/Extension.php
@@ -111,7 +111,7 @@ final protected function processConfiguration(ConfigurationInterface $configurat
     /**
      * @internal
      */
-    final public function getProcessedConfigs()
+    final public function getProcessedConfigs(): array
     {
         try {
             return $this->processedConfigs;
diff --git a/Loader/Configurator/PrototypeConfigurator.php b/Loader/Configurator/PrototypeConfigurator.php
@@ -75,7 +75,7 @@ public function __destruct()
      *
      * @return $this
      */
-    final public function exclude($excludes)
+    final public function exclude($excludes): self
     {
         $this->excludes = (array) $excludes;
 
diff --git a/Loader/FileLoader.php b/Loader/FileLoader.php
@@ -102,7 +102,7 @@ protected function setDefinition($id, Definition $definition)
         }
     }
 
-    private function findClasses(string $namespace, string $pattern, array $excludePatterns)
+    private function findClasses(string $namespace, string $pattern, array $excludePatterns): array
     {
         $parameterBag = $this->container->getParameterBag();
 
diff --git a/Loader/IniFileLoader.php b/Loader/IniFileLoader.php
@@ -66,6 +66,8 @@ public function supports($resource, $type = null)
      * Note that the following features are not supported:
      *  * strings with escaped quotes are not supported "foo\"bar";
      *  * string concatenation ("foo" "bar").
+     *
+     * @return mixed
      */
     private function phpize(string $value)
     {
diff --git a/Loader/XmlFileLoader.php b/Loader/XmlFileLoader.php
@@ -435,7 +435,7 @@ private function processAnonymousServices(\DOMDocument $xml, string $file)
         }
     }
 
-    private function getArgumentsAsPhp(\DOMElement $node, string $name, string $file, bool $isChildDefinition = false)
+    private function getArgumentsAsPhp(\DOMElement $node, string $name, string $file, bool $isChildDefinition = false): array
     {
         $arguments = [];
         foreach ($this->getChildren($node, $name) as $arg) {
diff --git a/ServiceLocator.php b/ServiceLocator.php
@@ -64,8 +64,10 @@ public function __invoke($id)
 
     /**
      * @internal
+     *
+     * @return static
      */
-    public function withContext($externalId, Container $container)
+    public function withContext(string $externalId, Container $container)
     {
         $locator = clone $this;
         $locator->externalId = $externalId;
@@ -127,7 +129,7 @@ private function createCircularReferenceException(string $id, array $path): Cont
         return new ServiceCircularReferenceException($id, $path);
     }
 
-    private function formatAlternatives(array $alternatives = null, string $separator = 'and')
+    private function formatAlternatives(array $alternatives = null, string $separator = 'and'): string
     {
         $format = '"%s"%s';
         if (null === $alternatives) {
diff --git a/Tests/Compiler/ResolveParameterPlaceHoldersPassTest.php b/Tests/Compiler/ResolveParameterPlaceHoldersPassTest.php
@@ -71,7 +71,7 @@ public function testBindingsShouldBeResolved()
         $this->assertSame($this->container->getParameterBag()->resolveValue('%env(BAZ)%'), $boundValue);
     }
 
-    private function createContainerBuilder()
+    private function createContainerBuilder(): ContainerBuilder
     {
         $containerBuilder = new ContainerBuilder();
 
diff --git a/Tests/Dumper/YamlDumperTest.php b/Tests/Dumper/YamlDumperTest.php
@@ -110,7 +110,7 @@ public function testTaggedArguments()
         $this->assertStringEqualsFile(self::$fixturesPath.'/yaml/services_with_tagged_argument.yml', $dumper->dump());
     }
 
-    private function assertEqualYamlStructure($expected, $yaml, $message = '')
+    private function assertEqualYamlStructure(string $expected, string $yaml, string $message = '')
     {
         $parser = new Parser();
 

Original file line number	Diff line number	Diff line change
`@@ -192,15 +192,15 @@ protected function getReflectionMethod(Definition $definition, $method)`
`192`	`192`	`return $r;`
`193`	`193`	`}`
`194`	`194`
`195`		`- private function getExpressionLanguage()`
	`195`	`+ private function getExpressionLanguage(): ExpressionLanguage`
`196`	`196`	`{`
`197`	`197`	`if (null === $this->expressionLanguage) {`
`198`	`198`	`if (!class_exists(ExpressionLanguage::class)) {`
`199`	`199`	`throw new LogicException('Unable to use expressions as the Symfony ExpressionLanguage component is not installed.');`
`200`	`200`	`}`
`201`	`201`
`202`	`202`	`$providers = $this->container->getExpressionLanguageProviders();`
`203`		`- $this->expressionLanguage = new ExpressionLanguage(null, $providers, function ($arg) {`
	`203`	`+ $this->expressionLanguage = new ExpressionLanguage(null, $providers, function (string $arg): string {`
`204`	`204`	`if ('""' === substr_replace($arg, '', 1, -1)) {`
`205`	`205`	`$id = stripcslashes(substr($arg, 1, -1));`
`206`	`206`	`$this->inExpression = true;`
Original file line number	Diff line number	Diff line change
`@@ -81,6 +81,9 @@ protected function processValue($value, $isRoot = false)`
`81`	`81`	`}`
`82`	`82`	`}`
`83`	`83`
	`84`	`+ /**`
	`85`	`+ * @return mixed`
	`86`	`+ */`
`84`	`87`	`private function doProcessValue($value, bool $isRoot = false)`
`85`	`88`	`{`
`86`	`89`	`if ($value instanceof TypedReference) {`
`@@ -371,7 +374,7 @@ private function set(string $type, string $id)`
`371`	`374`	`$this->ambiguousServiceTypes[$type][] = $id;`
`372`	`375`	`}`
`373`	`376`
`374`		`- private function createTypeNotFoundMessageCallback(TypedReference $reference, string $label)`
	`377`	`+ private function createTypeNotFoundMessageCallback(TypedReference $reference, string $label): callable`
`375`	`378`	`{`
`376`	`379`	`if (null === $this->typesClone->container) {`
`377`	`380`	`$this->typesClone->container = new ContainerBuilder($this->container->getParameterBag());`
`@@ -386,7 +389,7 @@ private function createTypeNotFoundMessageCallback(TypedReference $reference, st`
`386`	`389`	`})->bindTo($this->typesClone);`
`387`	`390`	`}`
`388`	`391`
`389`		`- private function createTypeNotFoundMessage(TypedReference $reference, string $label, string $currentId)`
	`392`	`+ private function createTypeNotFoundMessage(TypedReference $reference, string $label, string $currentId): string`
`390`	`393`	`{`
`391`	`394`	`if (!$r = $this->container->getReflectionClass($type = $reference->getType(), false)) {`
`392`	`395`	`// either $type does not exist or a parent class does not exist`
`@@ -420,7 +423,7 @@ private function createTypeNotFoundMessage(TypedReference $reference, string $la`
`420`	`423`	`return $message;`
`421`	`424`	`}`
`422`	`425`
`423`		`- private function createTypeAlternatives(ContainerBuilder $container, TypedReference $reference)`
	`426`	`+ private function createTypeAlternatives(ContainerBuilder $container, TypedReference $reference): string`
`424`	`427`	`{`
`425`	`428`	`// try suggesting available aliases first`
`426`	`429`	`if ($message = $this->getAliasesSuggestionForType($container, $type = $reference->getType())) {`
`@@ -444,7 +447,7 @@ private function createTypeAlternatives(ContainerBuilder $container, TypedRefere`
`444`	`447`	`return sprintf(' You should maybe alias this %s to %s.', class_exists($type, false) ? 'class' : 'interface', $message);`
`445`	`448`	`}`
`446`	`449`
`447`		`- private function getAliasesSuggestionForType(ContainerBuilder $container, string $type)`
	`450`	`+ private function getAliasesSuggestionForType(ContainerBuilder $container, string $type): ?string`
`448`	`451`	`{`
`449`	`452`	`$aliases = [];`
`450`	`453`	`foreach (class_parents($type) + class_implements($type) as $parent) {`
Original file line number	Diff line number	Diff line change
`@@ -60,7 +60,7 @@ public function process(ContainerBuilder $container)`
`60`	`60`	`}`
`61`	`61`	`}`
`62`	`62`
`63`		`- private static function validateProvidedTypes($types, $class)`
	`63`	`+ private static function validateProvidedTypes(string $types, string $class): array`
`64`	`64`	`{`
`65`	`65`	`$types = explode('\|', $types);`
`66`	`66`
Original file line number	Diff line number	Diff line change
`@@ -205,6 +205,9 @@ protected function processValue($value, $isRoot = false)`
`205`	`205`	`return parent::processValue($value, $isRoot);`
`206`	`206`	`}`
`207`	`207`
	`208`	`+ /**`
	`209`	`+ * @return mixed`
	`210`	`+ */`
`208`	`211`	`private function getBindingValue(BoundArgument $binding)`
`209`	`212`	`{`
`210`	`213`	`list($bindingValue, $bindingId) = $binding->getValues();`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ class ResolveHotPathPass extends AbstractRecursivePass`
`26`	`26`	`private $tagName;`
`27`	`27`	`private $resolvedIds = [];`
`28`	`28`
`29`		`- public function __construct($tagName = 'container.hot_path')`
	`29`	`+ public function __construct(string $tagName = 'container.hot_path')`
`30`	`30`	`{`
`31`	`31`	`$this->tagName = $tagName;`
`32`	`32`	`}`
Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ public function process(ContainerBuilder $container)`
`44`	`44`	`}`
`45`	`45`	`}`
`46`	`46`
`47`		`- private function processDefinition(ContainerBuilder $container, string $id, Definition $definition)`
	`47`	`+ private function processDefinition(ContainerBuilder $container, string $id, Definition $definition): Definition`
`48`	`48`	`{`
`49`	`49`	`$instanceofConditionals = $definition->getInstanceofConditionals();`
`50`	`50`	`$autoconfiguredInstanceof = $definition->isAutoconfigured() ? $container->getAutoconfiguredInstanceof() : [];`
`@@ -144,7 +144,7 @@ private function processDefinition(ContainerBuilder $container, string $id, Defi`
`144`	`144`	`return $definition;`
`145`	`145`	`}`
`146`	`146`
`147`		`- private function mergeConditionals(array $autoconfiguredInstanceof, array $instanceofConditionals, ContainerBuilder $container)`
	`147`	`+ private function mergeConditionals(array $autoconfiguredInstanceof, array $instanceofConditionals, ContainerBuilder $container): array`
`148`	`148`	`{`
`149`	`149`	`// make each value an array of ChildDefinition`
`150`	`150`	`$conditionals = array_map(function ($childDef) { return [$childDef]; }, $autoconfiguredInstanceof);`
Original file line number	Diff line number	Diff line change
`@@ -51,6 +51,8 @@ public function process(ContainerBuilder $container)`
`51`	`51`	`/**`
`52`	`52`	`* Processes arguments to determine invalid references.`
`53`	`53`	`*`
	`54`	`+ * @return mixed`
	`55`	`+ *`
`54`	`56`	`* @throws RuntimeException When an invalid reference is found`
`55`	`57`	`*/`
`56`	`58`	`private function processValue($value, int $rootLevel = 0, int $level = 0)`
Original file line number	Diff line number	Diff line change
`@@ -1236,7 +1236,7 @@ private function doResolveServices($value, array &$inlineServices = [], bool $is`
`1236`	`1236`
`1237`	`1237`	`yield $k => $this->resolveServices($v);`
`1238`	`1238`	`}`
`1239`		`- }, function () use ($value) {`
	`1239`	`+ }, function () use ($value): int {`
`1240`	`1240`	`$count = 0;`
`1241`	`1241`	`foreach ($value->getValues() as $v) {`
`1242`	`1242`	`foreach (self::getServiceConditionals($v) as $s) {`
`@@ -1641,7 +1641,7 @@ private function shareService(Definition $definition, $service, ?string $id, arr`
`1641`	`1641`	`}`
`1642`	`1642`	`}`
`1643`	`1643`
`1644`		`- private function getExpressionLanguage()`
	`1644`	`+ private function getExpressionLanguage(): ExpressionLanguage`
`1645`	`1645`	`{`
`1646`	`1646`	`if (null === $this->expressionLanguage) {`
`1647`	`1647`	`if (!class_exists('Symfony\Component\ExpressionLanguage\ExpressionLanguage')) {`
`@@ -1653,7 +1653,7 @@ private function getExpressionLanguage()`
`1653`	`1653`	`return $this->expressionLanguage;`
`1654`	`1654`	`}`
`1655`	`1655`
`1656`		`- private function inVendors(string $path)`
	`1656`	`+ private function inVendors(string $path): bool`
`1657`	`1657`	`{`
`1658`	`1658`	`if (null === $this->vendors) {`
`1659`	`1659`	`$resource = new ComposerResource();`