PHP Class JamesMoss\Flywheel\Query

Builds an executes a query whichs searches and sorts documents from a repository.

Protected Properties

Method	Description
__construct ( Repository $repository )	Constructor
andWhere ( string \| Closure $field, string $operator = null, string $value = null ) : Query	Adds a boolean AND predicate for this query,
execute ( ) : Result	Runs the query.
limit ( integer $count, integer $offset ) : Query	Set a limit on the number of documents returned. An offset from 0 can also be specified.
orWhere ( string \| Closure $field, string $operator = null, string $value = null ) : Query	Adds a boolean OR predicate for this query,
orderBy ( mixed $fields ) : Query	Sets the fields to order the results by. They should be in the the format 'fieldname ASC\|DESC'. e.g 'dateAdded DESC'.
where ( $field, $operator = null, $value = null ) : Query

Constructor

public __construct ( Repository $repository )
$repository	Repository	The repo this query will run against.

Adds a boolean AND predicate for this query,

public andWhere ( string \| Closure $field, string $operator = null, string $value = null ) : Query
$field	string \| Closure	The name of the field to match or an anonymous function that will define sub predicates.
$operator	string	An operator from the allowed list.
$value	string	The value to compare against.
return	Query	The same instance of this class.

Runs the query.

public execute ( ) : Result
return	Result	The documents returned from this query.

Set a limit on the number of documents returned. An offset from 0 can also be specified.

public limit ( integer $count, integer $offset ) : Query
$count	integer	The number of documents to return.
$offset	integer	The offset from which to return.
return	Query	The same instance of this class.

Adds a boolean OR predicate for this query,

public orWhere ( string \| Closure $field, string $operator = null, string $value = null ) : Query
$field	string \| Closure	The name of the field to match or an anonymous function that will define sub predicates.
$operator	string	An operator from the allowed list.
$value	string	The value to compare against.
return	Query	The same instance of this class.

Sets the fields to order the results by. They should be in the the format 'fieldname ASC|DESC'. e.g 'dateAdded DESC'.

public orderBy ( mixed $fields ) : Query
$fields	mixed	An array comprising strings in the above format (or a single string)
return	Query	The same instance of this class.

protected $limit

protected $orderBy

protected $predicate

protected $repo

public where ( $field, $operator = null, $value = null ) : Query
return	Query	The same instance of this class.