Класс yii\data\ArrayDataProvider

ArrayDataProvider реализует поставщик данных на основе массива данных.

Свойство $allModels содержит все модели данных, которые могут быть отсортированы и/или постраничены. ArrayDataProvider предоставит данные после сортировки и/или постраничной навигации. Вы можете настроить свойства $sort и $pagination для настройки поведения сортировки и постраничной навигации.

Элементы в массиве $allModels могут быть либо объектами (например, объектами модели), либо ассоциативными массивами (например, результатами запроса DAO). Убедитесь, что вы установили свойство $key в имя поля, которое однозначно идентифицирует запись данных, или в false, если у вас нет такого поля.

По сравнению с yii\data\ActiveDataProvider, ArrayDataProvider может быть менее эффективным, потому что ему необходимо иметь $allModels готовым.

ArrayDataProvider может использоваться следующим образом:

$query = new Query;
$provider = new ArrayDataProvider([
    'allModels' => $query->from('post')->all(),
    'sort' => [
        'attributes' => ['id', 'username', 'email'],
    ],
    'pagination' => [
        'pageSize' => 10,
    ],
]);
// get the posts in the current page
$posts = $provider->getModels();

Примечание: если вы хотите использовать функцию сортировки, вы должны настроить свойство $sort таким образом, чтобы поставщик знал, какие столбцы можно сортировать.

Дополнительную информацию и примеры использования ArrayDataProvider см. в статье руководства о поставщиках данных.

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

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

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

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

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

Данные, которые не постраничены и не отсортированы. При включении постраничной навигации это свойство обычно содержит больше элементов, чем $models. Элементы массива должны использовать целочисленные ключи, начинающиеся с нуля.

public array $allModels = null

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

Столбец, используемый в качестве ключа моделей данных. Это может быть имя столбца или вызываемый объект, возвращающий значение ключа заданной модели данных. Если это не установлено, используется индекс массива $models.

См. также getKeys().

public string|callable $key = null

$modelClass общественное свойство (доступно начиная с версии 2.0.9)

Имя класса Model, который будет представлен. Это свойство используется для получения имён столбцов.

public string $modelClass = null

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