Query Namespace

src/Api/Controller/ListDiscussionsController.php

@@ -14,7 +14,7 @@
 use Flarum\Discussion\Filter\DiscussionFilterer;
 use Flarum\Discussion\Search\DiscussionSearcher;
 use Flarum\Http\UrlGenerator;
-use Flarum\Search\SearchCriteria;
+use Flarum\Query\QueryCriteria;
 use Psr\Http\Message\ServerRequestInterface;
 use Tobscure\JsonApi\Document;
 
@@ -93,7 +93,7 @@ protected function data(ServerRequestInterface $request, Document $document)
         $offset = $this->extractOffset($request);
         $include = array_merge($this->extractInclude($request), ['state']);
 
-        $criteria = new SearchCriteria($actor, $filters, $sort);
+        $criteria = new QueryCriteria($actor, $filters, $sort);
         if (array_key_exists('q', $filters)) {
             $results = $this->searcher->search($criteria, $limit, $offset);
         } else {

src/Api/Controller/ListPostsController.php

@@ -13,7 +13,7 @@
 use Flarum\Http\UrlGenerator;
 use Flarum\Post\Filter\PostFilterer;
 use Flarum\Post\PostRepository;
-use Flarum\Search\SearchCriteria;
+use Flarum\Query\QueryCriteria;
 use Illuminate\Support\Arr;
 use Psr\Http\Message\ServerRequestInterface;
 use Tobscure\JsonApi\Document;
@@ -83,7 +83,7 @@ protected function data(ServerRequestInterface $request, Document $document)
         $offset = $this->extractOffset($request);
         $include = $this->extractInclude($request);
 
-        $results = $this->filterer->filter(new SearchCriteria($actor, $filters, $sort), $limit, $offset);
+        $results = $this->filterer->filter(new QueryCriteria($actor, $filters, $sort), $limit, $offset);
 
         $document->addPaginationLinks(
             $this->url->to('api')->route('posts.index'),

src/Api/Controller/ListUsersController.php

@@ -11,7 +11,7 @@
 
 use Flarum\Api\Serializer\UserSerializer;
 use Flarum\Http\UrlGenerator;
-use Flarum\Search\SearchCriteria;
+use Flarum\Query\QueryCriteria;
 use Flarum\User\Filter\UserFilterer;
 use Flarum\User\Search\UserSearcher;
 use Psr\Http\Message\ServerRequestInterface;
@@ -83,7 +83,7 @@ protected function data(ServerRequestInterface $request, Document $document)
         $offset = $this->extractOffset($request);
         $include = $this->extractInclude($request);
 
-        $criteria = new SearchCriteria($actor, $filters, $sort);
+        $criteria = new QueryCriteria($actor, $filters, $sort);
         if (array_key_exists('q', $filters)) {
             $results = $this->searcher->search($criteria, $limit, $offset);
         } else {

src/Discussion/Event/Searching.php

@@ -9,7 +9,7 @@
 
 namespace Flarum\Discussion\Event;
 
-use Flarum\Search\SearchCriteria;
+use Flarum\Query\QueryCriteria;
 use Flarum\Search\SearchState;
 
 /**
@@ -23,15 +23,15 @@ class Searching
     public $search;
 
     /**
-     * @var \Flarum\Search\SearchCriteria
+     * @var \Flarum\Query\QueryCriteria
      */
     public $criteria;
 
     /**
      * @param SearchState $search
-     * @param \Flarum\Search\SearchCriteria $criteria
+     * @param \Flarum\Query\QueryCriteria $criteria
      */
-    public function __construct(SearchState $search, SearchCriteria $criteria)
+    public function __construct(SearchState $search, QueryCriteria $criteria)
     {
         $this->search = $search;
         $this->criteria = $criteria;

src/Discussion/Filter/AuthorFilterGambit.php → src/Discussion/Query/AuthorFilterGambit.php

@@ -7,7 +7,7 @@
  * LICENSE file that was distributed with this source code.
  */
 
-namespace Flarum\Discussion\Filter;
+namespace Flarum\Discussion\Query;
 
 use Flarum\Filter\FilterInterface;
 use Flarum\Filter\FilterState;

src/Discussion/Filter/CreatedFilterGambit.php → src/Discussion/Query/CreatedFilterGambit.php

@@ -7,7 +7,7 @@
  * LICENSE file that was distributed with this source code.
  */
 
-namespace Flarum\Discussion\Filter;
+namespace Flarum\Discussion\Query;
 
 use Flarum\Filter\FilterInterface;
 use Flarum\Filter\FilterState;

src/Discussion/Filter/HiddenFilterGambit.php → src/Discussion/Query/HiddenFilterGambit.php

@@ -7,7 +7,7 @@
  * LICENSE file that was distributed with this source code.
  */
 
-namespace Flarum\Discussion\Filter;
+namespace Flarum\Discussion\Query;
 
 use Flarum\Filter\FilterInterface;
 use Flarum\Filter\FilterState;

src/Discussion/Filter/UnreadFilterGambit.php → src/Discussion/Query/UnreadFilterGambit.php

@@ -7,7 +7,7 @@
  * LICENSE file that was distributed with this source code.
  */
 
-namespace Flarum\Discussion\Filter;
+namespace Flarum\Discussion\Query;
 
 use Flarum\Discussion\DiscussionRepository;
 use Flarum\Filter\FilterInterface;

src/Discussion/Search/DiscussionSearcher.php

@@ -11,9 +11,9 @@
 
 use Flarum\Discussion\DiscussionRepository;
 use Flarum\Discussion\Event\Searching;
+use Flarum\Query\QueryCriteria;
 use Flarum\Search\AbstractSearcher;
 use Flarum\Search\GambitManager;
-use Flarum\Search\SearchCriteria;
 use Flarum\Search\SearchState;
 use Flarum\User\User;
 use Illuminate\Contracts\Events\Dispatcher;
@@ -53,7 +53,7 @@ protected function getQuery(User $actor): Builder
     /**
      * @deprecated along with the Searching event, remove in Beta 17.
      */
-    protected function mutateSearch(SearchState $search, SearchCriteria $criteria)
+    protected function mutateSearch(SearchState $search, QueryCriteria $criteria)
     {
         parent::mutateSearch($search, $criteria);
 

src/Extend/Filter.php

@@ -45,7 +45,7 @@ public function addFilter(string $filterClass)
      *
      * The callback can be a closure or an invokable class, and should accept:
      * - Flarum\Filter\FilterState $filter
-     * - Flarum\Search\SearchCriteria $criteria
+     * - Flarum\Query\QueryCriteria $criteria
      */
     public function addFilterMutator($callback)
     {

src/Extend/SimpleFlarumSearch.php

@@ -61,7 +61,7 @@ public function setFullTextGambit($gambitClass)
      *
      * The callback can be a closure or an invokable class, and should accept:
      * - Flarum\Search\SearchState $search
-     * - Flarum\Search\SearchCriteria $criteria
+     * - Flarum\Query\QueryCriteria $criteria
      */
     public function addSearchMutator($callback)
     {

src/Filter/AbstractFilterer.php

@@ -11,17 +11,17 @@
 
 use Flarum\Event\ConfigurePostsQuery;
 use Flarum\Post\Filter\PostFilterer;
-use Flarum\Search\ApplySearchParametersTrait;
-use Flarum\Search\SearchCriteria;
-use Flarum\Search\SearchResults;
+use Flarum\Query\ApplyQueryParametersTrait;
+use Flarum\Query\QueryCriteria;
+use Flarum\Query\QueryResults;
 use Flarum\User\User;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Support\Arr;
 use InvalidArgumentException;
 
 abstract class AbstractFilterer
 {
-    use ApplySearchParametersTrait;
+    use ApplyQueryParametersTrait;
 
     protected $filters;
 
@@ -40,14 +40,14 @@ public function __construct(array $filters, array $filterMutators)
     abstract protected function getQuery(User $actor): Builder;
 
     /**
-     * @param SearchCriteria $criteria
+     * @param QueryCriteria $criteria
      * @param mixed|null $limit
      * @param int $offset
      *
-     * @return SearchResults
+     * @return QueryResults
      * @throws InvalidArgumentException
      */
-    public function filter(SearchCriteria $criteria, int $limit = null, int $offset = 0): SearchResults
+    public function filter(QueryCriteria $criteria, int $limit = null, int $offset = 0): QueryResults
     {
         $actor = $criteria->actor;
 
@@ -89,6 +89,6 @@ public function filter(SearchCriteria $criteria, int $limit = null, int $offset
             $results->pop();
         }
 
-        return new SearchResults($results, $areMoreResults);
+        return new QueryResults($results, $areMoreResults);
     }
 }

src/Filter/FilterServiceProvider.php

@@ -9,14 +9,14 @@
 
 namespace Flarum\Filter;
 
-use Flarum\Discussion\Filter as DiscussionFilter;
 use Flarum\Discussion\Filter\DiscussionFilterer;
+use Flarum\Discussion\Query as DiscussionQuery;
 use Flarum\Foundation\AbstractServiceProvider;
 use Flarum\Foundation\ContainerUtil;
 use Flarum\Post\Filter as PostFilter;
 use Flarum\Post\Filter\PostFilterer;
-use Flarum\User\Filter as UserFilter;
 use Flarum\User\Filter\UserFilterer;
+use Flarum\User\Query as UserQuery;
 use Illuminate\Support\Arr;
 
 class FilterServiceProvider extends AbstractServiceProvider
@@ -31,14 +31,14 @@ public function register()
         $this->app->singleton('flarum.filter.filters', function () {
             return [
                 DiscussionFilterer::class => [
-                    DiscussionFilter\AuthorFilterGambit::class,
-                    DiscussionFilter\CreatedFilterGambit::class,
-                    DiscussionFilter\HiddenFilterGambit::class,
-                    DiscussionFilter\UnreadFilterGambit::class,
+                    DiscussionQuery\AuthorFilterGambit::class,
+                    DiscussionQuery\CreatedFilterGambit::class,
+                    DiscussionQuery\HiddenFilterGambit::class,
+                    DiscussionQuery\UnreadFilterGambit::class,
                 ],
                 UserFilterer::class => [
-                    UserFilter\EmailFilterGambit::class,
-                    UserFilter\GroupFilterGambit::class,
+                    UserQuery\EmailFilterGambit::class,
+                    UserQuery\GroupFilterGambit::class,
                 ],
                 PostFilterer::class => [
                     PostFilter\AuthorFilter::class,

src/Filter/FilterState.php

@@ -9,79 +9,8 @@
 
 namespace Flarum\Filter;
 
-use Flarum\User\User;
-use Illuminate\Database\Query\Builder;
+use Flarum\Query\AbstractQueryState;
 
-class FilterState
+class FilterState extends AbstractQueryState
 {
-    /**
-     * @var Builder
-     */
-    protected $query;
-
-    /**
-     * @var User
-     */
-    protected $actor;
-
-    /**
-     * @var mixed
-     */
-    protected $defaultSort = [];
-
-    /**
-     * @param Builder $query
-     * @param User $actor
-     */
-    public function __construct(Builder $query, User $actor, $defaultSort = [])
-    {
-        $this->query = $query;
-        $this->actor = $actor;
-        $this->defaultSort = $defaultSort;
-    }
-
-    /**
-     * Get the query builder for the search results query.
-     *
-     * @return Builder
-     */
-    public function getQuery()
-    {
-        return $this->query;
-    }
-
-    /**
-     * Get the user who is performing the search.
-     *
-     * @return User
-     */
-    public function getActor()
-    {
-        return $this->actor;
-    }
-
-    /**
-     * Get the default sort order for the search.
-     *
-     * @return array
-     */
-    public function getDefaultSort()
-    {
-        return $this->defaultSort;
-    }
-
-    /**
-     * Set the default sort order for the search. This will only be applied if
-     * a sort order has not been specified in the search criteria.
-     *
-     * @param mixed $defaultSort An array of sort-order pairs, where the column
-     *     is the key, and the order is the value. The order may be 'asc',
-     *     'desc', or an array of IDs to order by.
-     *     Alternatively, a callable may be used.
-     * @return mixed
-     */
-    public function setDefaultSort($defaultSort)
-    {
-        $this->defaultSort = $defaultSort;
-    }
 }