[7.x] Scoped resource routes (#33752)

* [7.x] Scoped resource routes

* cast to array

* Fallback to default key if the given key is null

* add check against keys

* don't call method if no need

Author: iamgergo

src/Illuminate/Database/Eloquent/Model.php

@@ -1581,6 +1581,8 @@ public function resolveChildRouteBinding($childType, $value, $field)
     {
         $relationship = $this->{Str::plural(Str::camel($childType))}();
 
+        $field = $field ?: $relationship->getRelated()->getRouteKeyName();
+
         if ($relationship instanceof HasManyThrough ||
             $relationship instanceof BelongsToMany) {
             return $relationship->where($relationship->getRelated()->getTable().'.'.$field, $value)->first();

src/Illuminate/Routing/ImplicitRouteBinding.php

@@ -37,7 +37,7 @@ public static function resolveForRoute($container, $route)
 
             $parent = $route->parentOfParameter($parameterName);
 
-            if ($parent instanceof UrlRoutable && $route->bindingFieldFor($parameterName)) {
+            if ($parent instanceof UrlRoutable && in_array($parameterName, array_keys($route->bindingFields()))) {
                 if (! $model = $parent->resolveChildRouteBinding(
                     $parameterName, $parameterValue, $route->bindingFieldFor($parameterName)
                 )) {

src/Illuminate/Routing/PendingResourceRegistration.php

@@ -195,6 +195,19 @@ public function shallow($shallow = true)
         return $this;
     }
 
+    /**
+     * Indicate that the resource routes should be scoped using the given binding fields.
+     *
+     * @param  array  $fields
+     * @return \Illuminate\Routing\PendingResourceRegistration
+     */
+    public function scoped(array $fields = [])
+    {
+        $this->options['bindingFields'] = $fields;
+
+        return $this;
+    }
+
     /**
      * Register the resource route.
      *

src/Illuminate/Routing/ResourceRegistrar.php

@@ -95,9 +95,15 @@ public function register($name, $controller, array $options = [])
         $collection = new RouteCollection;
 
         foreach ($this->getResourceMethods($defaults, $options) as $m) {
-            $collection->add($this->{'addResource'.ucfirst($m)}(
+            $route = $this->{'addResource'.ucfirst($m)}(
                 $name, $base, $controller, $options
-            ));
+            );
+
+            if (isset($options['bindingFields'])) {
+                $this->setResourceBindingFields($route, $options['bindingFields']);
+            }
+
+            $collection->add($route);
         }
 
         return $collection;
@@ -313,6 +319,24 @@ protected function getShallowName($name, $options)
                     : $name;
     }
 
+    /**
+     * Set the route's binding fields if the resource is scoped.
+     *
+     * @param  \Illuminate\Routing\Route  $route
+     * @param  array  $bindingFields
+     * @return void
+     */
+    protected function setResourceBindingFields($route, $bindingFields)
+    {
+        preg_match_all('/(?<={).*?(?=})/', $route->uri, $matches);
+
+        $fields = array_fill_keys($matches[0], null);
+
+        $route->setBindingFields(array_replace(
+            $fields, array_intersect_key($bindingFields, $fields)
+        ));
+    }
+
     /**
      * Get the base resource URI for a given resource.
      *

tests/Routing/RouteRegistrarTest.php

@@ -357,6 +357,31 @@ public function testCanSetShallowOptionOnRegisteredResource()
         $this->assertFalse($this->router->getRoutes()->hasNamedRoute('users.tasks.show'));
     }
 
+    public function testCanSetScopedOptionOnRegisteredResource()
+    {
+        $this->router->resource('users.tasks', RouteRegistrarControllerStub::class)->scoped();
+        $this->assertSame(
+            ['user' => null],
+            $this->router->getRoutes()->getByName('users.tasks.index')->bindingFields()
+        );
+        $this->assertSame(
+            ['user' => null, 'task' => null],
+            $this->router->getRoutes()->getByName('users.tasks.show')->bindingFields()
+        );
+
+        $this->router->resource('users.tasks', RouteRegistrarControllerStub::class)->scoped([
+            'task' => 'slug',
+        ]);
+        $this->assertSame(
+            ['user' => null],
+            $this->router->getRoutes()->getByName('users.tasks.index')->bindingFields()
+        );
+        $this->assertSame(
+            ['user' => null, 'task' => 'slug'],
+            $this->router->getRoutes()->getByName('users.tasks.show')->bindingFields()
+        );
+    }
+
     public function testCanExcludeMethodsOnRegisteredApiResource()
     {
         $this->router->apiResource('users', RouteRegistrarControllerStub::class)