[5.x] Support scopes as query methods

src/Query/Builder.php

@@ -10,9 +10,12 @@
 use InvalidArgumentException;
 use Statamic\Contracts\Query\Builder as Contract;
 use Statamic\Extensions\Pagination\LengthAwarePaginator;
+use Statamic\Query\Scopes\AppliesScopes;
 
 abstract class Builder implements Contract
 {
+ use AppliesScopes;
+
  protected $columns;
  protected $limit;
  protected $offset = 0;
@@ -33,6 +36,13 @@ abstract class Builder implements Contract
  '<=' => 'LessThanOrEqualTo',
  ];
 
+ public function __call($method, $args)
+ {
+ $this->appplyScope($method);
+
+ return $this;
+ }
+
  public function select($columns = ['*'])
  {
  $this->columns = $columns;

src/Query/EloquentQueryBuilder.php

@@ -5,10 +5,13 @@
 use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
 use Statamic\Contracts\Query\Builder;
 use Statamic\Extensions\Pagination\LengthAwarePaginator;
+use Statamic\Query\Scopes\AppliesScopes;
 use Statamic\Support\Arr;
 
 abstract class EloquentQueryBuilder implements Builder
 {
+ use AppliesScopes;
+
  protected $builder;
  protected $columns;
 
@@ -21,6 +24,8 @@ public function __call($method, $args)
  {
  $this->builder->$method(...$args);
 
+ $this->appplyScope($method);
+
  return $this;
  }
 

src/Query/Scopes/AppliesScopes.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace Statamic\Query\Scopes;
+
+use Statamic\Facades\Scope;
+
+trait AppliesScopes
+{
+ public function appplyScope($method, $context = [])
+ {
+ // Throw an exception if the scope doesn't exist.
+ if (! $scope = Scope::find(snake_case($method))) {
+ throw new \Exception("The [$method] scope does not exist.");
+ }
+
+ // Apply the scope to all builders if none were defined.
+ if ($scope->builders()->isEmpty()) {
+ return $scope->apply($this, $context);
+ }
+
+ // Only apply the scope to the defined builders.
+ if ($scope->builders()->contains(get_class($this))) {
+ return $scope->apply($this, $context);
+ }
+
+ // Throw an exception if a user is trying to access a scope that is not supported by this builder.
+ throw new \Exception("The [" . get_class($this) . "] query builder does not support the [$method] scope.");
+ }
+}

src/Query/Scopes/Scope.php

@@ -2,6 +2,7 @@
 
 namespace Statamic\Query\Scopes;
 
+use Statamic\Statamic;
 use Statamic\Extend\HasHandle;
 use Statamic\Extend\RegistersItself;
 
@@ -10,6 +11,7 @@ abstract class Scope
  use RegistersItself, HasHandle;
 
  protected static $binding = 'scopes';
+ protected static $builders = [];
 
  /**
  * Apply the scope to a given query builder.
@@ -19,4 +21,16 @@ abstract class Scope
  * @return void
  */
  abstract public function apply($query, $values);
+
+ /**
+ * Return the query builders that this scope supports.
+ *
+ * @return \Illuminate\Support\Collection
+ */
+ public static function builders()
+ {
+ return collect(static::$builders)->map(function ($builder) {
+ return get_class(Statamic::query($builder));
+ });
+ }
 }

src/Query/Scopes/ScopeRepository.php

@@ -13,8 +13,14 @@ public function all()
 
  public function find($key, $context = [])
  {
- if ($scope = app('statamic.scopes')->get($key)) {
- return app($scope)->context($context);
+ if ($class = app('statamic.scopes')->get($key)) {
+ $scope = app($class);
+
+ if ($scope instanceof Filter) {
+ $scope->context($context);
+ }
+
+ return $scope;
  }
  }
 

src/Tags/Concerns/QueriesScopes.php

@@ -8,15 +8,9 @@ trait QueriesScopes
 {
  public function queryScopes($query)
  {
- $this->parseQueryScopes()
- ->map(function ($handle) {
- return app('statamic.scopes')->get($handle);
- })
- ->filter()
- ->each(function ($class) use ($query) {
- $scope = app($class);
- $scope->apply($query, $this->params);
- });
+ $this->parseQueryScopes()->each(function ($handle) use ($query) {
+ $query->appplyScope($handle, $this->params);
+ });
  }
 
  protected function parseQueryScopes()