Класс yii\elasticsearch\ActiveDataProvider
| Наследование | yii\elasticsearch\ActiveDataProvider » yii\data\ActiveDataProvider » yii\data\BaseDataProvider » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable, yii\data\DataProviderInterface |
| Доступно с версии | 2.0.5 |
| Исходный код | https://github.com/yiisoft/yii2-elasticsearch/blob/master/ActiveDataProvider.php |
ActiveDataProvider — это улучшенная версия yii\data\ActiveDataProvider, специализированная для ElasticSearch.
Она позволяет извлекать не только строки и общее количество строк, но и полные результаты запроса, включая агрегации и т.д.
Примечание: этот поставщик данных извлекает модели результатов и общее количество с помощью одного запроса к ElasticSearch, поэтому общее количество результатов будет извлечено после применения ограничений пагинации, что исключает возможность проверки, существует ли запрошенная страница. Поставщик данных автоматически отключает \yii\elasticsearch\yii\data\Pagination::validatePage из-за этого.
Публичные свойства
| Свойство | Тип | Описание | Определено |
|---|---|---|---|
| $aggregations | массив | Все результаты агрегаций | yii\elasticsearch\ActiveDataProvider |
| $behaviors | yii\base\Behavior[] | Список прикреплённых к этому компоненту поведений | yii\base\Component |
| $count | целое число | Количество моделей данных на текущей странице. | yii\data\BaseDataProvider |
| $db | yii\db\Connection|массив|строка | Объект подключения к базе данных или идентификатор компонента приложения для подключения к базе данных. | yii\data\ActiveDataProvider |
| $id | строка | Идентификатор, уникально определяющий поставщик данных среди всех поставщиков данных. | yii\data\BaseDataProvider |
| $key | строка|вызов | Столбец, используемый в качестве ключа моделей данных. | yii\data\ActiveDataProvider |
| $keys | массив | Список значений ключей, соответствующих $models. | yii\data\BaseDataProvider |
| $models | массив | Список моделей данных на текущей странице. | yii\data\BaseDataProvider |
| $pagination | yii\data\Pagination|false | Объект пагинации. | yii\data\BaseDataProvider |
| $query | yii\db\QueryInterface | Запрос, используемый для извлечения моделей данных и $totalCount, если он не задан явно. | yii\data\ActiveDataProvider |
| $queryResults | массив | Полные результаты запроса | yii\elasticsearch\ActiveDataProvider |
| $sort | yii\data\Sort|boolean | Объект сортировки. | yii\data\BaseDataProvider |
| $totalCount | целое число | Общее количество возможных моделей данных. | yii\data\BaseDataProvider |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает именованный метод, который не является методом класса. | yii\base\Object |
| __clone() | Этот метод вызывается после создания объекта путём клонирования существующего. | yii\base\Component |
| __construct() | Конструктор. | yii\base\Object |
| __get() | Возвращает значение свойства объекта. | yii\base\Object |
| __isset() | Проверяет, установлено ли свойство, т.е. определено и не равно null. | yii\base\Object |
| __set() | Устанавливает значение свойства объекта. | yii\base\Object |
| __unset() | Устанавливает свойство объекта в значение null. | yii\base\Object |
| attachBehavior() | Прикрепляет поведение к этому компоненту. | yii\base\Component |
| attachBehaviors() | Прикрепляет список поведений к компоненту. | yii\base\Component |
| behaviors() | Возвращает список поведений, по которым должен действовать этот компонент. | yii\base\Component |
| canGetProperty() | Возвращает значение, указывающее, можно ли считать свойство. | yii\base\Object |
| canSetProperty() | Возвращает значение, указывающее, можно ли установить свойство. | yii\base\Object |
| className() | Возвращает полное квалифицированное имя этого класса. | yii\base\Object |
| detachBehavior() | Открепляет поведение от компонента. | yii\base\Component |
| detachBehaviors() | Открепляет все поведения от компонента. | yii\base\Component |
| ensureBehaviors() | Убеждается, что поведения, объявленные в behaviors(), прикреплены к этому компоненту. | yii\base\Component |
| getAggregation() | Возвращает результаты указанной агрегации. | yii\elasticsearch\ActiveDataProvider |
| getAggregations() | yii\elasticsearch\ActiveDataProvider | |
| getBehavior() | Возвращает объект именованного поведения. | yii\base\Component |
| getBehaviors() | Возвращает все прикреплённые к этому компоненту поведения. | yii\base\Component |
| getCount() | Возвращает количество моделей данных на текущей странице. | yii\data\BaseDataProvider |
| getKeys() | Возвращает значения ключей, связанные с моделями данных. | yii\data\BaseDataProvider |
| getModels() | Возвращает модели данных на текущей странице. | yii\data\BaseDataProvider |
| getPagination() | Возвращает объект постраничной навигации, используемый этим поставщиком данных. | yii\data\BaseDataProvider |
| getQueryResults() | yii\elasticsearch\ActiveDataProvider | |
| getSort() | Возвращает объект сортировки, используемый этим поставщиком данных. | yii\data\BaseDataProvider |
| getTotalCount() | Возвращает общее количество моделей данных. | yii\data\BaseDataProvider |
| hasEventHandlers() | Возвращает значение, указывающее, есть ли обработчики событий, прикреплённые к указанному событию. | yii\base\Component |
| hasMethod() | Возвращает значение, указывающее, определён ли метод. | yii\base\Object |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство. | yii\base\Object |
| init() | Инициализирует компонент соединения с базой данных. | yii\data\ActiveDataProvider |
| off() | Открепляет существующий обработчик событий от этого компонента. | yii\base\Component |
| on() | Прикрепляет обработчик событий к событию. | yii\base\Component |
| prepare() | Подготавливает модели данных и ключи. | yii\data\BaseDataProvider |
| refresh() | Обновляет поставщик данных. | yii\data\BaseDataProvider |
| setKeys() | Устанавливает значения ключей, связанные с моделями данных. | yii\data\BaseDataProvider |
| setModels() | Устанавливает модели данных на текущей странице. | yii\data\BaseDataProvider |
| setPagination() | Устанавливает постраничную навигацию для этого поставщика данных. | yii\data\BaseDataProvider |
| setQueryResults() | yii\elasticsearch\ActiveDataProvider | |
| setSort() | Устанавливает определение сортировки для этого поставщика данных. | yii\data\ActiveDataProvider |
| setTotalCount() | Устанавливает общее количество моделей данных. | yii\data\BaseDataProvider |
| trigger() | Вызывает событие. | yii\base\Component |
Защищённые методы
| Метод | Описание | Определено в |
|---|---|---|
| prepareKeys() | Подготавливает ключи, связанные с текущими доступными моделями данных. | yii\elasticsearch\ActiveDataProvider |
| prepareModels() | Подготавливает модели данных, которые будут доступны на текущей странице. | yii\elasticsearch\ActiveDataProvider |
| prepareTotalCount() | Возвращает значение, указывающее общее количество моделей данных в этом поставщике данных. | yii\elasticsearch\ActiveDataProvider |
Подробное описание свойств
$aggregations общедоступное только для чтения свойство
Все результаты агрегаций
public array getAggregations ( )
$queryResults общедоступное свойство
Полные результаты запроса
public array getQueryResults ( )
public void setQueryResults ( $results )
Подробное описание методов
getAggregation() public method
Возвращает результаты указанной агрегации.
| public array getAggregation ( $name ) | ||
|---|---|---|
| $name | string |
Имя агрегации. |
| return | array |
Результаты агрегации. |
| throws | yii\base\InvalidCallException |
если запрошенная агрегация отсутствует в результатах запроса. |
getAggregations() public method
| public array getAggregations ( ) | ||
|---|---|---|
| return | array |
Все результаты агрегации |
getQueryResults() public method
| public array getQueryResults ( ) | ||
|---|---|---|
| return | array |
Полные результаты запроса |
prepareKeys() protected method
Подготавливает ключи, связанные с доступными в данный момент моделями данных.
| protected array prepareKeys ( $models ) | ||
|---|---|---|
| $models | array |
Доступные модели данных |
| return | array |
Ключи |
prepareModels() protected method
Подготавливает модели данных, которые будут доступны на текущей странице.
| protected array prepareModels ( ) | ||
|---|---|---|
| return | array |
Доступные модели данных |
prepareTotalCount() protected method
Возвращает значение, указывающее общее количество моделей данных в этом поставщике данных.
| protected integer prepareTotalCount ( ) | ||
|---|---|---|
| return | integer |
Общее количество моделей данных в этом поставщике данных. |
setQueryResults() public method
| public void setQueryResults ( $results ) | ||
|---|---|---|
| $results | array |
Полные результаты запроса |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-elasticsearch-activedataprovider.html
