minor #33261 Add types to routing and DI configuration traits. (derrabus)

nicolas-grekas · nicolas-grekas · commit 7eb5feec51a4 · 2019-08-20T23:07:54.000+02:00
This PR was merged into the 4.4 branch. Discussion ---------- Add types to routing and DI configuration traits. | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | no | New feature? | no | BC breaks? | I don't think so. | Deprecations? | no | Tests pass? | yes | Fixed tickets | #32179, #33228 | License | MIT | Doc PR | N/A This PR backports the type declarations added to the configurator traits of the Routing and DI components. These traits expose only final methods, so it should be pretty safe to add return types to them. The only scenario I could make up where this change will break something is if a trait is used to override a method: https://3v4l.org/EAsk8 But I doubt that those traits are used that way. On master, we've used the `object` return type for the fluent methods. That type is not available on 4.4 where we have to support php 7.1. I'm using `self` instead. Since the methods are final and thus cannot be overridden, I believe that we shouldn't run into covariance issues here, so `self` should be safe. Commits ------- 1ca30c9 Add types to roting and DI configuration traits.
diff --git a/src/Symfony/Component/DependencyInjection/Loader/Configurator/Traits/AbstractTrait.php b/src/Symfony/Component/DependencyInjection/Loader/Configurator/Traits/AbstractTrait.php
@@ -19,7 +19,7 @@ trait AbstractTrait
      *
      * @return $this
      */
-    final public function abstract(bool $abstract = true)
+    final public function abstract(bool $abstract = true): self
     {
         $this->definition->setAbstract($abstract);
 
diff --git a/src/Symfony/Component/DependencyInjection/Loader/Configurator/Traits/ArgumentTrait.php b/src/Symfony/Component/DependencyInjection/Loader/Configurator/Traits/ArgumentTrait.php
@@ -16,11 +16,9 @@ trait ArgumentTrait
     /**
      * Sets the arguments to pass to the service constructor/factory method.
      *
-     * @param array $arguments An array of arguments
-     *
      * @return $this
      */
-    final public function args(array $arguments)
+    final public function args(array $arguments): self
     {
         $this->definition->setArguments(static::processValue($arguments, true));
 
@@ -35,7 +33,7 @@ final public function args(array $arguments)
      *
      * @return $this
      */
-    final public function arg($key, $value)
+    final public function arg($key, $value): self
     {
         $this->definition->setArgument($key, static::processValue($value, true));
 
diff --git a/src/Symfony/Component/DependencyInjection/Loader/Configurator/Traits/AutoconfigureTrait.php b/src/Symfony/Component/DependencyInjection/Loader/Configurator/Traits/AutoconfigureTrait.php
@@ -23,7 +23,7 @@ trait AutoconfigureTrait
      *
      * @throws InvalidArgumentException when a parent is already set
      */
-    final public function autoconfigure(bool $autoconfigured = true)
+    final public function autoconfigure(bool $autoconfigured = true): self
     {
         if ($autoconfigured && $this->definition instanceof ChildDefinition) {
             throw new InvalidArgumentException(sprintf('The service "%s" cannot have a "parent" and also have "autoconfigure". Try disabling autoconfiguration for the service.', $this->id));
diff --git a/src/Symfony/Component/DependencyInjection/Loader/Configurator/Traits/AutowireTrait.php b/src/Symfony/Component/DependencyInjection/Loader/Configurator/Traits/AutowireTrait.php
@@ -18,7 +18,7 @@ trait AutowireTrait
      *
      * @return $this
      */
-    final public function autowire(bool $autowired = true)
+    final public function autowire(bool $autowired = true): self
     {
         $this->definition->setAutowired($autowired);
 
diff --git a/src/Symfony/Component/DependencyInjection/Loader/Configurator/Traits/BindTrait.php b/src/Symfony/Component/DependencyInjection/Loader/Configurator/Traits/BindTrait.php
@@ -31,7 +31,7 @@ trait BindTrait
      *
      * @return $this
      */
-    final public function bind($nameOrFqcn, $valueOrRef)
+    final public function bind(string $nameOrFqcn, $valueOrRef): self
     {
         $valueOrRef = static::processValue($valueOrRef, true);
         if (!preg_match('/^(?:(?:array|bool|float|int|string)[ \t]*+)?\$/', $nameOrFqcn) && !$valueOrRef instanceof Reference) {
diff --git a/src/Symfony/Component/DependencyInjection/Loader/Configurator/Traits/CallTrait.php b/src/Symfony/Component/DependencyInjection/Loader/Configurator/Traits/CallTrait.php
@@ -25,7 +25,7 @@ trait CallTrait
      *
      * @throws InvalidArgumentException on empty $method param
      */
-    final public function call($method, array $arguments = [])
+    final public function call(string $method, array $arguments = []): self
     {
         $this->definition->addMethodCall($method, static::processValue($arguments, true));
 
diff --git a/src/Symfony/Component/DependencyInjection/Loader/Configurator/Traits/ClassTrait.php b/src/Symfony/Component/DependencyInjection/Loader/Configurator/Traits/ClassTrait.php
@@ -18,7 +18,7 @@ trait ClassTrait
      *
      * @return $this
      */
-    final public function class($class)
+    final public function class(?string $class): self
     {
         $this->definition->setClass($class);
 
diff --git a/src/Symfony/Component/DependencyInjection/Loader/Configurator/Traits/ConfiguratorTrait.php b/src/Symfony/Component/DependencyInjection/Loader/Configurator/Traits/ConfiguratorTrait.php
@@ -20,7 +20,7 @@ trait ConfiguratorTrait
      *
      * @return $this
      */
-    final public function configurator($configurator)
+    final public function configurator($configurator): self
     {
         $this->definition->setConfigurator(static::processValue($configurator, true));
 
diff --git a/src/Symfony/Component/DependencyInjection/Loader/Configurator/Traits/DecorateTrait.php b/src/Symfony/Component/DependencyInjection/Loader/Configurator/Traits/DecorateTrait.php
@@ -18,15 +18,13 @@ trait DecorateTrait
     /**
      * Sets the service that this service is decorating.
      *
-     * @param string|null $id        The decorated service id, use null to remove decoration
-     * @param string|null $renamedId The new decorated service id
-     * @param int         $priority  The priority of decoration
+     * @param string|null $id The decorated service id, use null to remove decoration
      *
      * @return $this
      *
      * @throws InvalidArgumentException in case the decorated service id and the new decorated service id are equals
      */
-    final public function decorate($id, $renamedId = null, $priority = 0)
+    final public function decorate(?string $id, string $renamedId = null, int $priority = 0): self
     {
         $this->definition->setDecoratedService($id, $renamedId, $priority);
 
diff --git a/src/Symfony/Component/DependencyInjection/Loader/Configurator/Traits/DeprecateTrait.php b/src/Symfony/Component/DependencyInjection/Loader/Configurator/Traits/DeprecateTrait.php
@@ -24,7 +24,7 @@ trait DeprecateTrait
      *
      * @throws InvalidArgumentException when the message template is invalid
      */
-    final public function deprecate($template = null)
+    final public function deprecate(string $template = null): self
     {
         $this->definition->setDeprecated(true, $template);
 
diff --git a/src/Symfony/Component/DependencyInjection/Loader/Configurator/Traits/FactoryTrait.php b/src/Symfony/Component/DependencyInjection/Loader/Configurator/Traits/FactoryTrait.php
@@ -22,7 +22,7 @@ trait FactoryTrait
      *
      * @return $this
      */
-    final public function factory($factory)
+    final public function factory($factory): self
     {
         if (\is_string($factory) && 1 === substr_count($factory, ':')) {
             $factoryParts = explode(':', $factory);
diff --git a/src/Symfony/Component/DependencyInjection/Loader/Configurator/Traits/FileTrait.php b/src/Symfony/Component/DependencyInjection/Loader/Configurator/Traits/FileTrait.php
@@ -16,11 +16,9 @@ trait FileTrait
     /**
      * Sets a file to require before creating the service.
      *
-     * @param string $file A full pathname to include
-     *
      * @return $this
      */
-    final public function file($file)
+    final public function file(string $file): self
     {
         $this->definition->setFile($file);
 
diff --git a/src/Symfony/Component/DependencyInjection/Loader/Configurator/Traits/LazyTrait.php b/src/Symfony/Component/DependencyInjection/Loader/Configurator/Traits/LazyTrait.php
@@ -20,7 +20,7 @@ trait LazyTrait
      *
      * @return $this
      */
-    final public function lazy($lazy = true)
+    final public function lazy($lazy = true): self
     {
         $this->definition->setLazy((bool) $lazy);
         if (\is_string($lazy)) {
diff --git a/src/Symfony/Component/DependencyInjection/Loader/Configurator/Traits/ParentTrait.php b/src/Symfony/Component/DependencyInjection/Loader/Configurator/Traits/ParentTrait.php
@@ -23,7 +23,7 @@ trait ParentTrait
      *
      * @throws InvalidArgumentException when parent cannot be set
      */
-    final public function parent(string $parent)
+    final public function parent(string $parent): self
     {
         if (!$this->allowParent) {
             throw new InvalidArgumentException(sprintf('A parent cannot be defined when either "_instanceof" or "_defaults" are also defined for service prototype "%s".', $this->id));
diff --git a/src/Symfony/Component/DependencyInjection/Loader/Configurator/Traits/PropertyTrait.php b/src/Symfony/Component/DependencyInjection/Loader/Configurator/Traits/PropertyTrait.php
@@ -18,7 +18,7 @@ trait PropertyTrait
      *
      * @return $this
      */
-    final public function property(string $name, $value)
+    final public function property(string $name, $value): self
     {
         $this->definition->setProperty($name, static::processValue($value, true));
 
diff --git a/src/Symfony/Component/DependencyInjection/Loader/Configurator/Traits/PublicTrait.php b/src/Symfony/Component/DependencyInjection/Loader/Configurator/Traits/PublicTrait.php
@@ -16,7 +16,7 @@ trait PublicTrait
     /**
      * @return $this
      */
-    final public function public()
+    final public function public(): self
     {
         $this->definition->setPublic(true);
 
@@ -26,7 +26,7 @@ final public function public()
     /**
      * @return $this
      */
-    final public function private()
+    final public function private(): self
     {
         $this->definition->setPublic(false);
 
diff --git a/src/Symfony/Component/DependencyInjection/Loader/Configurator/Traits/ShareTrait.php b/src/Symfony/Component/DependencyInjection/Loader/Configurator/Traits/ShareTrait.php
@@ -16,11 +16,9 @@ trait ShareTrait
     /**
      * Sets if the service must be shared or not.
      *
-     * @param bool $shared Whether the service must be shared or not
-     *
      * @return $this
      */
-    final public function share($shared = true)
+    final public function share(bool $shared = true): self
     {
         $this->definition->setShared($shared);
 
diff --git a/src/Symfony/Component/DependencyInjection/Loader/Configurator/Traits/SyntheticTrait.php b/src/Symfony/Component/DependencyInjection/Loader/Configurator/Traits/SyntheticTrait.php
@@ -19,7 +19,7 @@ trait SyntheticTrait
      *
      * @return $this
      */
-    final public function synthetic(bool $synthetic = true)
+    final public function synthetic(bool $synthetic = true): self
     {
         $this->definition->setSynthetic($synthetic);
 
diff --git a/src/Symfony/Component/DependencyInjection/Loader/Configurator/Traits/TagTrait.php b/src/Symfony/Component/DependencyInjection/Loader/Configurator/Traits/TagTrait.php
@@ -18,14 +18,11 @@ trait TagTrait
     /**
      * Adds a tag for this definition.
      *
-     * @param string $name       The tag name
-     * @param array  $attributes An array of attributes
-     *
      * @return $this
      */
-    final public function tag($name, array $attributes = [])
+    final public function tag(string $name, array $attributes = []): self
     {
-        if (!\is_string($name) || '' === $name) {
+        if ('' === $name) {
             throw new InvalidArgumentException(sprintf('The tag name for service "%s" must be a non-empty string.', $this->id));
         }
 
diff --git a/src/Symfony/Component/Routing/Loader/Configurator/Traits/RouteTrait.php b/src/Symfony/Component/Routing/Loader/Configurator/Traits/RouteTrait.php
@@ -26,7 +26,7 @@ trait RouteTrait
      *
      * @return $this
      */
-    final public function defaults(array $defaults)
+    final public function defaults(array $defaults): self
     {
         $this->route->addDefaults($defaults);
 
@@ -38,7 +38,7 @@ final public function defaults(array $defaults)
      *
      * @return $this
      */
-    final public function requirements(array $requirements)
+    final public function requirements(array $requirements): self
     {
         $this->route->addRequirements($requirements);
 
@@ -50,7 +50,7 @@ final public function requirements(array $requirements)
      *
      * @return $this
      */
-    final public function options(array $options)
+    final public function options(array $options): self
     {
         $this->route->addOptions($options);
 
@@ -62,7 +62,7 @@ final public function options(array $options)
      *
      * @return $this
      */
-    final public function utf8(bool $utf8 = true)
+    final public function utf8(bool $utf8 = true): self
     {
         $this->route->addOptions(['utf8' => $utf8]);
 
@@ -74,7 +74,7 @@ final public function utf8(bool $utf8 = true)
      *
      * @return $this
      */
-    final public function condition(string $condition)
+    final public function condition(string $condition): self
     {
         $this->route->setCondition($condition);
 
@@ -86,7 +86,7 @@ final public function condition(string $condition)
      *
      * @return $this
      */
-    final public function host(string $pattern)
+    final public function host(string $pattern): self
     {
         $this->route->setHost($pattern);
 
@@ -101,7 +101,7 @@ final public function host(string $pattern)
      *
      * @return $this
      */
-    final public function schemes(array $schemes)
+    final public function schemes(array $schemes): self
     {
         $this->route->setSchemes($schemes);
 
@@ -116,7 +116,7 @@ final public function schemes(array $schemes)
      *
      * @return $this
      */
-    final public function methods(array $methods)
+    final public function methods(array $methods): self
     {
         $this->route->setMethods($methods);
 
@@ -130,7 +130,7 @@ final public function methods(array $methods)
      *
      * @return $this
      */
-    final public function controller($controller)
+    final public function controller($controller): self
     {
         $this->route->addDefaults(['_controller' => $controller]);
 
@@ -142,7 +142,7 @@ final public function controller($controller)
      *
      * @return $this
      */
-    final public function locale(string $locale)
+    final public function locale(string $locale): self
     {
         $this->route->addDefaults(['_locale' => $locale]);
 
@@ -154,7 +154,7 @@ final public function locale(string $locale)
      *
      * @return $this
      */
-    final public function format(string $format)
+    final public function format(string $format): self
     {
         $this->route->addDefaults(['_format' => $format]);
 

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ trait AbstractTrait`
`19`	`19`	`*`
`20`	`20`	`* @return $this`
`21`	`21`	`*/`
`22`		`- final public function abstract(bool $abstract = true)`
	`22`	`+ final public function abstract(bool $abstract = true): self`
`23`	`23`	`{`
`24`	`24`	`$this->definition->setAbstract($abstract);`
`25`	`25`
Original file line number	Diff line number	Diff line change
`@@ -16,11 +16,9 @@ trait ArgumentTrait`
`16`	`16`	`/**`
`17`	`17`	`* Sets the arguments to pass to the service constructor/factory method.`
`18`	`18`	`*`
`19`		`- * @param array $arguments An array of arguments`
`20`		`- *`
`21`	`19`	`* @return $this`
`22`	`20`	`*/`
`23`		`- final public function args(array $arguments)`
	`21`	`+ final public function args(array $arguments): self`
`24`	`22`	`{`
`25`	`23`	`$this->definition->setArguments(static::processValue($arguments, true));`
`26`	`24`
`@@ -35,7 +33,7 @@ final public function args(array $arguments)`
`35`	`33`	`*`
`36`	`34`	`* @return $this`
`37`	`35`	`*/`
`38`		`- final public function arg($key, $value)`
	`36`	`+ final public function arg($key, $value): self`
`39`	`37`	`{`
`40`	`38`	`$this->definition->setArgument($key, static::processValue($value, true));`
`41`	`39`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ trait AutoconfigureTrait`
`23`	`23`	`*`
`24`	`24`	`* @throws InvalidArgumentException when a parent is already set`
`25`	`25`	`*/`
`26`		`- final public function autoconfigure(bool $autoconfigured = true)`
	`26`	`+ final public function autoconfigure(bool $autoconfigured = true): self`
`27`	`27`	`{`
`28`	`28`	`if ($autoconfigured && $this->definition instanceof ChildDefinition) {`
`29`	`29`	`throw new InvalidArgumentException(sprintf('The service "%s" cannot have a "parent" and also have "autoconfigure". Try disabling autoconfiguration for the service.', $this->id));`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ trait AutowireTrait`
`18`	`18`	`*`
`19`	`19`	`* @return $this`
`20`	`20`	`*/`
`21`		`- final public function autowire(bool $autowired = true)`
	`21`	`+ final public function autowire(bool $autowired = true): self`
`22`	`22`	`{`
`23`	`23`	`$this->definition->setAutowired($autowired);`
`24`	`24`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ trait BindTrait`
`31`	`31`	`*`
`32`	`32`	`* @return $this`
`33`	`33`	`*/`
`34`		`- final public function bind($nameOrFqcn, $valueOrRef)`
	`34`	`+ final public function bind(string $nameOrFqcn, $valueOrRef): self`
`35`	`35`	`{`
`36`	`36`	`$valueOrRef = static::processValue($valueOrRef, true);`
`37`	`37`	`if (!preg_match('/^(?:(?:array\|bool\|float\|int\|string)[ \t]*+)?\$/', $nameOrFqcn) && !$valueOrRef instanceof Reference) {`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ trait CallTrait`
`25`	`25`	`*`
`26`	`26`	`* @throws InvalidArgumentException on empty $method param`
`27`	`27`	`*/`
`28`		`- final public function call($method, array $arguments = [])`
	`28`	`+ final public function call(string $method, array $arguments = []): self`
`29`	`29`	`{`
`30`	`30`	`$this->definition->addMethodCall($method, static::processValue($arguments, true));`
`31`	`31`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ trait ClassTrait`
`18`	`18`	`*`
`19`	`19`	`* @return $this`
`20`	`20`	`*/`
`21`		`- final public function class($class)`
	`21`	`+ final public function class(?string $class): self`
`22`	`22`	`{`
`23`	`23`	`$this->definition->setClass($class);`
`24`	`24`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ trait ConfiguratorTrait`
`20`	`20`	`*`
`21`	`21`	`* @return $this`
`22`	`22`	`*/`
`23`		`- final public function configurator($configurator)`
	`23`	`+ final public function configurator($configurator): self`
`24`	`24`	`{`
`25`	`25`	`$this->definition->setConfigurator(static::processValue($configurator, true));`
`26`	`26`
Original file line number	Diff line number	Diff line change
`@@ -18,15 +18,13 @@ trait DecorateTrait`
`18`	`18`	`/**`
`19`	`19`	`* Sets the service that this service is decorating.`
`20`	`20`	`*`
`21`		`- * @param string\|null $id The decorated service id, use null to remove decoration`
`22`		`- * @param string\|null $renamedId The new decorated service id`
`23`		`- * @param int $priority The priority of decoration`
	`21`	`+ * @param string\|null $id The decorated service id, use null to remove decoration`
`24`	`22`	`*`
`25`	`23`	`* @return $this`
`26`	`24`	`*`
`27`	`25`	`* @throws InvalidArgumentException in case the decorated service id and the new decorated service id are equals`
`28`	`26`	`*/`
`29`		`- final public function decorate($id, $renamedId = null, $priority = 0)`
	`27`	`+ final public function decorate(?string $id, string $renamedId = null, int $priority = 0): self`
`30`	`28`	`{`
`31`	`29`	`$this->definition->setDecoratedService($id, $renamedId, $priority);`
`32`	`30`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ trait DeprecateTrait`
`24`	`24`	`*`
`25`	`25`	`* @throws InvalidArgumentException when the message template is invalid`
`26`	`26`	`*/`
`27`		`- final public function deprecate($template = null)`
	`27`	`+ final public function deprecate(string $template = null): self`
`28`	`28`	`{`
`29`	`29`	`$this->definition->setDeprecated(true, $template);`
`30`	`30`