/
SearchCriteria.php
59 lines (52 loc) · 1.39 KB
/
SearchCriteria.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
<?php
/*
* This file is part of Flarum.
*
* (c) Toby Zerner <toby.zerner@gmail.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Flarum\Search;
use Flarum\User\User;
/**
* Represents the criteria that will determine the entire result set of a
* search. The limit and offset are not included because they only determine
* which part of the entire result set will be returned.
*/
class SearchCriteria
{
/**
* The user performing the search.
*
* @var User
*/
public $actor;
/**
* The search query.
*
* @var string
*/
public $query;
/**
* 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.
*
* @var array
*/
public $sort;
/**
* @param User $actor The user performing the search.
* @param string $query The search query.
* @param array $sort 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.
*/
public function __construct(User $actor, $query, array $sort = null)
{
$this->actor = $actor;
$this->query = $query;
$this->sort = $sort;
}
}