How to use data providers and data widgets in Yii

Use ActiveDataProvider to process ActiveRecord data, and implement data management through configuring query, pagination and sort; 2. Pass the data provider to the view, and combine it with GridView to realize table display, automatically support paging, sorting and operating columns; 3. When using ListView to match custom layouts (such as cards), specify a single template through itemView, and use options and itemOptions to control structure styles; 4. Use closures or formatters (such as datetime) to process field display; 5. Always create a data provider in the controller and pass it into the view, and render it by the data widget to achieve efficient and maintainable data display.

In Yii 2, data providers and data widgets work together to display data efficiently in your views. They help you manage, filter, paginate, and render large datasets without writing boilerplate code. Here's how to use them effectively.

What Are Data Providers?

Data providers are classes that supply data to widgets like grids or lists. They handle tasks like sorting, pagination, and filtering. Yii 2 offers several built-in data providers:

• ActiveDataProvider – for working with ActiveRecord models.
• ArrayDataProvider – for plain PHP arrays.
• SqlDataProvider – for raw SQL queries.

Using ActiveDataProvider (Most Common)

Suppose you have a Post model and want to display posts in a grid.

 use yii\data\ActiveDataProvider;

$dataProvider = new ActiveDataProvider([
    'query' => \app\models\Post::find(),
    'pagination' => [
        'pageSize' => 10,
    ],
    'sort' => [
        'defaultOrder' => [
            'created_at' => SORT_DESC,
        ]
    ],
]);

Now pass $dataProvider to your view.

What Are Data Widgets?

Data widgets render data provided by a data provider. The most commonly used ones are:

• GridView – displays data in a table with sorting and pagination.
• ListView – renders data using customized item views.
• DetailView – shows a single model's data in a key-value format.

Using GridView with Data Provider

In your view file (eg, index.php ):

 use yii\grid\GridView;

echo GridView::widget([
    'dataProvider' => $dataProvider,
    'columns' => [
        'id',
        'title',
        'author.name', // relation
        [
            'attribute' => 'status',
            'value' => function ($model) {
                return $model->status == 1 ? 'Published' : 'Draft';
            }
        ],
        'created_at:datetime',
        ['class' => 'yii\grid\ActionColumn'],
    ],
]);

This automatically includes:

• Pagination (based on data provider settings)
• Sorting on clickable column headers
• Action buttons (view/update/delete)

Using ListView for Custom Layouts

If you want more control over layout (eg, blog posts in cards):

 use yii\widgets\ListView;

echo ListView::widget([
    'dataProvider' => $dataProvider,
    'itemView' => '_post', // a partial view file for each item
    'layout' => "{items}\n{pager}",
    'itemOptions' => [
        'tag' => 'div',
        'class' => 'col-md-6 col-lg-4 mb-4'
    ],
    'options' => [
        'tag' => 'div',
        'class' => 'row'
    ],
]);

Create _post.php in the same view directory:

 <div class="card">
    <div class="card-body">
        <h5 class="card-title"><?= $model->title ?></h5>
        <p class="card-text"><?= Yii::$app->formatter->asSummary($model->content) ?></p>
        <small>By <?= $model->author->name ?></small>
    </div>
</div>

This gives you a responsive, card-based layout powered by the same data provider.

Key Tips

• Always use data providers when displaying lists – they handle performance aspects like LIMIT/OFFSET automatically.
• Use ActionColumn in GridView to quickly add view/update/delete links.
• Customize columns with closings or widgets:

 [
    'label' => 'Category',
    'value' => function ($model) {
        return $model->category ? $model->category->name : 'Uncategorized';
    }
]

• Format dates, numbers, and other fields using Yii's Formatter (eg, 'created_at:datetime' ).

Summary

• Data providers prepare and manage your data.
• Data widgets render it in a user-friendly way.
• Combine ActiveDataProvider GridView for admin grids.
• Use ListView when you need flexible layouts.
• Leverage sorting, pagination, and formatting features built into Yii.

Basically, set up the provider in the controller, pass it to the view, and plug it into a widget. The rest is handled for you.

The above is the detailed content of How to use data providers and data widgets in Yii. For more information, please follow other related articles on the PHP Chinese website!