Класс yii\sphinx\ActiveDataProvider

ActiveDataProvider — это расширенная версия yii\data\ActiveDataProvider, специфичная для Sphinx.

Она позволяет получать не только строки и общее количество строк, но также метаинформацию и результаты фасетной обработки.

Ниже приведен пример использования ActiveDataProvider для получения результатов фасетной обработки:

$provider = new ActiveDataProvider([
    'query' => Post::find()->facets(['author_id', 'category_id']),
    'pagination' => [
        'pageSize' => 20,
    ],
]);

// get the posts in the current page
$posts = $provider->getModels();

// get all facets
$facets = $provider->getFacets();

// get particular facet
$authorFacet = $provider->getFacet('author_id');

В случае, если свойство yii\sphinx\Query::showMeta() установлено, ActiveDataProvider будет получать значение общего количества из метаинформации запроса, избегая дополнительного запроса для подсчета:

$provider = new ActiveDataProvider([
    'query' => Post::find()->showMeta(true),
    'pagination' => [
        'pageSize' => 20,
    ],
]);

$totalCount = $provider->getTotalCount(); // fetched from meta information

Примечание: при использовании метаинформации общее количество результатов будет получено после применения ограничения пагинации, что исключает возможность проверки существования запрошенной страницы. В этом случае провайдер данных автоматически отключает yii\data\Pagination::validatePage.

Примечание: так как смещение и ограничение пагинации могут превысить предел `max_matches` Sphinx, провайдер данных автоматически установит значение `max_matches` на основе этих значений. Однако, если свойство yii\sphinx\Query::showMeta() установлено, такая настройка не выполняется, так как это нарушит вычисление общего количества, поэтому вам необходимо самостоятельно обрабатывать пределы `max_matches`.

Публичные свойства

Публичные методы

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

Подробное описание свойств

$facets общественное свойство

Результаты фасетного запроса.

public array getFacets ( )
public void setFacets ( $facets )

$meta общественное свойство

Метаинформация запроса поиска

public array getMeta ( )
public void setMeta ( $meta )

Подробное описание методов