Класс yii\data\SqlDataProvider

SqlDataProvider реализует поставщик данных, основанный на простом SQL-запросе.

SqlDataProvider предоставляет данные в виде массивов, каждый из которых представляет строку результата запроса.

Как и другие поставщики данных, SqlDataProvider также поддерживает сортировку и постраничный вывод. Для этого он изменяет предоставленный $sql запрос с добавлением клаузов "ORDER BY" и "LIMIT". Вы можете настроить свойства $sort и $pagination для настройки поведения сортировки и постраничного вывода.

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

$count = Yii::$app->db->createCommand('
    SELECT COUNT(*) FROM user WHERE status=:status
', [':status' => 1])->queryScalar();

$dataProvider = new SqlDataProvider([
    'sql' => 'SELECT * FROM user WHERE status=:status',
    'params' => [':status' => 1],
    'totalCount' => $count,
    'sort' => [
        'attributes' => [
            'age',
            'name' => [
                'asc' => ['first_name' => SORT_ASC, 'last_name' => SORT_ASC],
                'desc' => ['first_name' => SORT_DESC, 'last_name' => SORT_DESC],
                'default' => SORT_DESC,
                'label' => 'Name',
            ],
        ],
    ],
    'pagination' => [
        'pageSize' => 20,
    ],
]);

// get the user records in the current page
$models = $dataProvider->getModels();

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

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

Открытые свойства

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

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

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

$db публичное свойство

Объект подключения к БД или идентификатор компонента приложения для подключения к БД. Начиная с версии 2.0.2, это также может быть массив конфигурации для создания объекта.

public yii\db\Connection|array|string $db = 'db'

$key публичное свойство

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

Если это не задано, будут использованы ключи массива $models.

public string|callable $key = null

$params публичное свойство

Параметры (имя=>значение), которые будут связаны с SQL-запросом.

public array $params = []

$sql публичное свойство

SQL-запрос, используемый для извлечения строк данных.

public string $sql = null

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