Narrow existing return types on private/internal/final/test methods

Author: nicolas-grekas

Loader/Configurator/CollectionConfigurator.php

@@ -75,10 +75,8 @@ final public function collection(string $name = ''): self
      * Sets the prefix to add to the path of all child routes.
      *
      * @param string|array $prefix the prefix, or the localized prefixes
-     *
-     * @return $this
      */
-    final public function prefix(string|array $prefix): self
+    final public function prefix(string|array $prefix): static
     {
         if (\is_array($prefix)) {
             if (null === $this->parentPrefixes) {
@@ -108,10 +106,8 @@ final public function prefix(string|array $prefix): self
      * Sets the host to use for all child routes.
      *
      * @param string|array $host the host, or the localized hosts
-     *
-     * @return $this
      */
-    final public function host(string|array $host): self
+    final public function host(string|array $host): static
     {
         $this->host = $host;
 

Loader/Configurator/ImportConfigurator.php

@@ -52,10 +52,8 @@ public function __destruct()
      * Sets the prefix to add to the path of all child routes.
      *
      * @param string|array $prefix the prefix, or the localized prefixes
-     *
-     * @return $this
      */
-    final public function prefix(string|array $prefix, bool $trailingSlashOnRoot = true): self
+    final public function prefix(string|array $prefix, bool $trailingSlashOnRoot = true): static
     {
         $this->addPrefix($this->route, $prefix, $trailingSlashOnRoot);
 
@@ -64,10 +62,8 @@ final public function prefix(string|array $prefix, bool $trailingSlashOnRoot = t
 
     /**
      * Sets the prefix to add to the name of all child routes.
-     *
-     * @return $this
      */
-    final public function namePrefix(string $namePrefix): self
+    final public function namePrefix(string $namePrefix): static
     {
         $this->route->addNamePrefix($namePrefix);
 
@@ -78,10 +74,8 @@ final public function namePrefix(string $namePrefix): self
      * Sets the host to use for all child routes.
      *
      * @param string|array $host the host, or the localized hosts
-     *
-     * @return $this
      */
-    final public function host(string|array $host): self
+    final public function host(string|array $host): static
     {
         $this->addHost($this->route, $host);
 

Loader/Configurator/RouteConfigurator.php

@@ -37,10 +37,8 @@ public function __construct(RouteCollection $collection, RouteCollection $route,
      * Sets the host to use for all child routes.
      *
      * @param string|array $host the host, or the localized hosts
-     *
-     * @return $this
      */
-    final public function host(string|array $host): self
+    final public function host(string|array $host): static
     {
         $this->addHost($this->route, $host);
 

Loader/Configurator/RoutingConfigurator.php

@@ -68,10 +68,7 @@ final public function env(): ?string
         return $this->env;
     }
 
-    /**
-     * @return static
-     */
-    final public function withPath(string $path): self
+    final public function withPath(string $path): static
     {
         $clone = clone $this;
         $clone->path = $clone->file = $path;

Loader/Configurator/Traits/RouteTrait.php

@@ -23,10 +23,8 @@ trait RouteTrait
 
     /**
      * Adds defaults.
-     *
-     * @return $this
      */
-    final public function defaults(array $defaults): self
+    final public function defaults(array $defaults): static
     {
         $this->route->addDefaults($defaults);
 
@@ -35,10 +33,8 @@ final public function defaults(array $defaults): self
 
     /**
      * Adds requirements.
-     *
-     * @return $this
      */
-    final public function requirements(array $requirements): self
+    final public function requirements(array $requirements): static
     {
         $this->route->addRequirements($requirements);
 
@@ -47,10 +43,8 @@ final public function requirements(array $requirements): self
 
     /**
      * Adds options.
-     *
-     * @return $this
      */
-    final public function options(array $options): self
+    final public function options(array $options): static
     {
         $this->route->addOptions($options);
 
@@ -59,10 +53,8 @@ final public function options(array $options): self
 
     /**
      * Whether paths should accept utf8 encoding.
-     *
-     * @return $this
      */
-    final public function utf8(bool $utf8 = true): self
+    final public function utf8(bool $utf8 = true): static
     {
         $this->route->addOptions(['utf8' => $utf8]);
 
@@ -71,10 +63,8 @@ final public function utf8(bool $utf8 = true): self
 
     /**
      * Sets the condition.
-     *
-     * @return $this
      */
-    final public function condition(string $condition): self
+    final public function condition(string $condition): static
     {
         $this->route->setCondition($condition);
 
@@ -83,10 +73,8 @@ final public function condition(string $condition): self
 
     /**
      * Sets the pattern for the host.
-     *
-     * @return $this
      */
-    final public function host(string $pattern): self
+    final public function host(string $pattern): static
     {
         $this->route->setHost($pattern);
 
@@ -98,10 +86,8 @@ final public function host(string $pattern): self
      * So an empty array means that any scheme is allowed.
      *
      * @param string[] $schemes
-     *
-     * @return $this
      */
-    final public function schemes(array $schemes): self
+    final public function schemes(array $schemes): static
     {
         $this->route->setSchemes($schemes);
 
@@ -113,10 +99,8 @@ final public function schemes(array $schemes): self
      * So an empty array means that any method is allowed.
      *
      * @param string[] $methods
-     *
-     * @return $this
      */
-    final public function methods(array $methods): self
+    final public function methods(array $methods): static
     {
         $this->route->setMethods($methods);
 
@@ -127,10 +111,8 @@ final public function methods(array $methods): self
      * Adds the "_controller" entry to defaults.
      *
      * @param callable|string|array $controller a callable or parseable pseudo-callable
-     *
-     * @return $this
      */
-    final public function controller(callable|string|array $controller): self
+    final public function controller(callable|string|array $controller): static
     {
         $this->route->addDefaults(['_controller' => $controller]);
 
@@ -139,10 +121,8 @@ final public function controller(callable|string|array $controller): self
 
     /**
      * Adds the "_locale" entry to defaults.
-     *
-     * @return $this
      */
-    final public function locale(string $locale): self
+    final public function locale(string $locale): static
     {
         $this->route->addDefaults(['_locale' => $locale]);
 
@@ -151,10 +131,8 @@ final public function locale(string $locale): self
 
     /**
      * Adds the "_format" entry to defaults.
-     *
-     * @return $this
      */
-    final public function format(string $format): self
+    final public function format(string $format): static
     {
         $this->route->addDefaults(['_format' => $format]);
 
@@ -163,10 +141,8 @@ final public function format(string $format): self
 
     /**
      * Adds the "_stateless" entry to defaults.
-     *
-     * @return $this
      */
-    final public function stateless(bool $stateless = true): self
+    final public function stateless(bool $stateless = true): static
     {
         $this->route->addDefaults(['_stateless' => $stateless]);