Класс yii\elasticsearch\QueryBuilder
| Наследование | yii\elasticsearch\QueryBuilder » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Доступно с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2-elasticsearch/blob/master/QueryBuilder.php |
QueryBuilder создаёт запрос Elasticsearch на основе спецификации, заданной объектом yii\elasticsearch\Query.
Публичные свойства
| Свойство | Тип | Описание | Определено |
|---|---|---|---|
| $db | yii\elasticsearch\Connection | Подключение к базе данных. | yii\elasticsearch\QueryBuilder |
Публичные методы
| Метод | Описание | Определено |
|---|---|---|
| __call() | Вызывает именованный метод, который не является методом класса. | yii\base\Object |
| __construct() | Конструктор. | yii\elasticsearch\QueryBuilder |
| __get() | Возвращает значение свойства объекта. | yii\base\Object |
| __isset() | Проверяет, задано ли свойство, т.е. определено и не равно null. | yii\base\Object |
| __set() | Устанавливает значение свойства объекта. | yii\base\Object |
| __unset() | Устанавливает свойство объекта в null. | yii\base\Object |
| build() | Генерирует запрос из объекта yii\elasticsearch\Query. | yii\elasticsearch\QueryBuilder |
| buildCondition() | Разбирает спецификацию условия и генерирует соответствующее выражение SQL. | yii\elasticsearch\QueryBuilder |
| buildOrderBy() | Добавляет условие ORDER BY в запрос | yii\elasticsearch\QueryBuilder |
| canGetProperty() | Возвращает значение, указывающее, можно ли прочитать свойство. | yii\base\Object |
| canSetProperty() | Возвращает значение, указывающее, можно ли установить свойство. | yii\base\Object |
| className() | Возвращает полное имя этого класса. | yii\base\Object |
| hasMethod() | Возвращает значение, указывающее, определён ли метод. | yii\base\Object |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство. | yii\base\Object |
| init() | Инициализирует объект. | yii\base\Object |
Защищённые методы
| Метод | Описание | Определено |
|---|---|---|
| buildCompositeInCondition() | yii\elasticsearch\QueryBuilder |
Подробности свойств
$db публичное свойство
Подключение к базе данных.
public yii\elasticsearch\Connection $db = null
Подробности методов
__construct() публичный метод
Конструктор.
| public void __construct ( $connection, $config = [] ) | ||
|---|---|---|
| $connection | yii\elasticsearch\Connection |
Подключение к базе данных. |
| $config | array |
Пары имя-значение, которые будут использоваться для инициализации свойств объекта |
build() публичный метод
Генерирует запрос из объекта yii\elasticsearch\Query.
| public array build ( $query ) | ||
|---|---|---|
| $query | yii\elasticsearch\Query |
Объект yii\elasticsearch\Query, из которого будет сгенерирован запрос |
| return | array |
Сгенерированное выражение SQL (первый элемент массива) и соответствующие параметры, которые будут привязаны к выражению SQL (второй элемент массива). |
buildCompositeInCondition() защищённый метод
| protected void buildCompositeInCondition ( $operator, $columns, $values ) | ||
|---|---|---|
| $operator | ||
| $columns | ||
| $values | ||
buildCondition() публичный метод
Разбирает спецификацию условия и генерирует соответствующее выражение SQL.
| public string buildCondition ( $condition ) | ||
|---|---|---|
| $condition | string|array |
Спецификация условия. См. yii\elasticsearch\Query::where(), как указать условие. |
| return | string |
Сгенерированное выражение SQL |
| throws | yii\base\InvalidParamException |
если используется неизвестный оператор в запросе |
| throws | yii\base\NotSupportedException |
если строковые условия используются в where |
buildOrderBy() публичный метод
Добавляет условие ORDER BY в запрос
| public void buildOrderBy ( $columns ) | ||
|---|---|---|
| $columns | ||
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-elasticsearch-querybuilder.html
