PHP Класс Isswp101\Persimmon\QueryBuilder\QueryBuilder

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство	Тип	Описание
$query	array	Query.

Открытые методы

Метод	Описание
__construct ( array $body = [] )	Constructor.
__toString ( ) : string
aggregation ( Aggregation $aggregation )
between ( $field, $start, $end )
betweenOrEquals ( $field, $start, $end )
build ( ) : array	Build query.
fields ( mixed $fields = false )	Set _source to search query.
filter ( Filter \| array $filter = [], string $mode = Filter::MODE_INCLUDE )
from ( integer $from )
getOnlyIds ( )	Return only _id.
greaterThan ( $field, $start )
greaterThanOrEquals ( $field, $start )
gt ( $field, $start )
gte ( $field, $start )
hasSort ( ) : boolean
lessThan ( $field, $end )
lessThanOrEquals ( $field, $end )
lt ( $field, $start )
lte ( $field, $start )
match ( $field, $value )
notMatch ( $field, $value )
notWhere ( $field, $value )
orMatch ( $field, $value )
orWhere ( $field, $value )
range ( $field, $start, $end )
size ( integer $size )
sort ( array \| string $sort )
toJson ( integer $options ) : string
where ( $field, $value )

Защищенные методы

Метод	Описание
getQuery ( ) : array	Return query.
merge ( array $query, $mode = 'must' )

Описание методов

__construct() публичный Метод

Constructor.

public __construct ( array $body = [] )
$body	array

__toString() публичный Метод

public __toString ( ) : string
Результат	string

aggregation() публичный Метод

public aggregation ( Aggregation $aggregation )
$aggregation	Isswp101\Persimmon\QueryBuilder\Aggregations\Aggregation

between() публичный Метод

public between ( $field, $start, $end )

betweenOrEquals() публичный Метод

public betweenOrEquals ( $field, $start, $end )

build() публичный Метод

Build query.

public build ( ) : array
Результат	array

fields() публичный Метод

Set _source to search query.

public fields ( mixed $fields = false )
$fields	mixed

filter() публичный Метод

public filter ( Filter \| array $filter = [], string $mode = Filter::MODE_INCLUDE )
$filter	Isswp101\Persimmon\QueryBuilder\Filters\Filter \| array
$mode	string

from() публичный Метод

public from ( integer $from )
$from	integer

getOnlyIds() публичный Метод

Return only _id.

public getOnlyIds ( )

getQuery() защищенный Метод

Return query.

protected getQuery ( ) : array
Результат	array

greaterThan() публичный Метод

public greaterThan ( $field, $start )

greaterThanOrEquals() публичный Метод

public greaterThanOrEquals ( $field, $start )

gt() публичный Метод

public gt ( $field, $start )

gte() публичный Метод

public gte ( $field, $start )

hasSort() публичный Метод

public hasSort ( ) : boolean
Результат	boolean

lessThan() публичный Метод

public lessThan ( $field, $end )

lessThanOrEquals() публичный Метод

public lessThanOrEquals ( $field, $end )

lt() публичный Метод

public lt ( $field, $start )

lte() публичный Метод

public lte ( $field, $start )

match() публичный Метод

public match ( $field, $value )

merge() защищенный Метод

protected merge ( array $query, $mode = 'must' )
$query	array

notMatch() публичный Метод

public notMatch ( $field, $value )

notWhere() публичный Метод

public notWhere ( $field, $value )

orMatch() публичный Метод

public orMatch ( $field, $value )

orWhere() публичный Метод

public orWhere ( $field, $value )

range() публичный Метод

public range ( $field, $start, $end )

size() публичный Метод

public size ( integer $size )
$size	integer

sort() публичный Метод

public sort ( array \| string $sort )
$sort	array \| string

toJson() публичный Метод

public toJson ( integer $options ) : string
$options	integer
Результат	string

where() публичный Метод

public where ( $field, $value )

Описание свойств

$query защищенное свойство

Query.

protected array $query
Результат	array