[9.x] Rename scope parameter on Runway tag (#741)

Author: duncanmcclean

docs/templating.mdx

@@ -47,7 +47,7 @@ protected function food(Builder $query): void
 ```
 
 ```antlers
-{{ runway:post scope="food" }}
+{{ runway:post query_scope="food" }}
 	<h2>{{ title }}</h2>
 	<p>{{ intro_text }}</p>
 {{ /runway:post }}
@@ -56,15 +56,15 @@ protected function food(Builder $query): void
 If you need to you can provide arguments to the scope like so:
 
 ```antlers
-{{ runway:post scope="food:argument" }}
+{{ runway:post query_scope="food:argument" }}
 ```
 
 In the above example, `argument` can either be a string or we'll grab it from 'the context' (the available variables) if we can find it.
 
 You may also provide multiple scopes, if that's something you need...
 
 ```antlers
-{{ runway:post scope="food:argument|fastfood" }}
+{{ runway:post query_scope="food:argument|fastfood" }}
 ```
 
 ### Filtering

docs/upgrade-guides/v8-to-v9.mdx

@@ -42,6 +42,16 @@ We highly recommend upgrading all the way to Laravel 12 and PHP 8.4.
 
 ## Medium impact changes
 
+### The `scope` parameter on the Runway tag has been renamed
+**Affects app using the `scope` parameter on the Runway tag**
+
+The `scope` parameter on the Runway tag has been renamed to `query_scope` to avoid conflicts with Antlers' own `scope` parameter.
+
+```antlers
+{{ runway:post scope="food" }} {{# [!code --] #}}
+{{ runway:post query_scope="food" }} {{# [!code ++] #}}
+```
+
 ### `runway:rebuild-uri-cache` no longer removes global query scopes
 
 The `runway:rebuild-uri-cache` command no longer removes global query scopes when querying models. If you were relying on this behaviour, you may remove global scopes using the `runwayRoutes` query scope:

src/Tags/RunwayTag.php

@@ -64,13 +64,13 @@ protected function query(): Builder
             $query->select(explode(',', (string) $select));
         }
 
-        if ($scopes = $this->params->get('scope')) {
-            $scopes = explode('|', (string) $scopes);
+        if ($queryScopes = $this->params->get('query_scope')) {
+            $queryScopes = explode('|', (string) $queryScopes);
 
-            foreach ($scopes as $scope) {
-                $scopeName = explode(':', $scope)[0];
-                $scopeArguments = isset(explode(':', $scope)[1])
-                    ? explode(',', explode(':', $scope)[1])
+            foreach ($queryScopes as $queryScope) {
+                $scopeName = explode(':', $queryScope)[0];
+                $scopeArguments = isset(explode(':', $queryScope)[1])
+                    ? explode(',', explode(':', $queryScope)[1])
                     : [];
 
                 foreach ($scopeArguments as $key => $scopeArgument) {

tests/Tags/RunwayTagTest.php

@@ -93,7 +93,7 @@ public function can_get_models_with_scope_parameter()
         $posts[4]->update(['title' => 'Burger']);
 
         $this->tag->setParameters([
-            'scope' => 'food',
+            'query_scope' => 'food',
         ]);
 
         $usage = $this->tag->wildcard('post');
@@ -118,7 +118,7 @@ public function can_get_models_with_scope_parameter_and_scope_arguments()
         ]);
 
         $this->tag->setParameters([
-            'scope' => 'fruit:fab',
+            'query_scope' => 'fruit:fab',
         ]);
 
         $usage = $this->tag->wildcard('post');
@@ -141,7 +141,7 @@ public function can_get_models_with_scope_parameter_and_scope_arguments_and_mult
         ]);
 
         $this->tag->setParameters([
-            'scope' => 'food|fruit:fab',
+            'query_scope' => 'food|fruit:fab',
         ]);
 
         $usage = $this->tag->wildcard('post');