Bulk actions checkbox column
Installation
The preferred way to install this extension is through composer., (*1)
Either run, (*2)
composer require --prefer-dist integready/yii2-bulkactionscheckboxcolumn "~1.0"
or add, (*3)
"integready/yii2-bulkactionscheckboxcolumn": "~1.0"
to the require section of your composer.json
file., (*4)
Usage example:
GridView id must be set.
- index.php
(View)
:
> Only one button is type to BulkCheckboxColumn::BUTTON_TYPE_CUSTOM_JS
!
= GridView::widget([
'id' => 'books-grid',
'dataProvider' => $dataProvider,
'filterModel' => $searchModel,
'layout' => '{toolbar}\n{summary}\n{items}\n{pager}', // {toolbar} must be included in 'layout' section
'columns' => [
[
'class' => BulkCheckboxColumn::className(),
'elements' => [
[
'label' => 'Change Availability',
'field' => 'available',
'buttonClass' => 'btn btn-primary',
'buttonOptions' => [
'data' => [
'button' => 'change',
],
],
'items' => [
1 => 'Yes',
0 => 'No',
],
'visible' => false,
],
[
'label' => 'Change International Shipping',
'field' => 'intl_shipping',
'buttonClass' => 'btn btn-success',
'items' => [
1 => 'Yes',
0 => 'No',
],
],
[
'label' => 'Change Author',
'field' => 'author_book',
'buttonClass' => 'btn btn-info',
'buttonType' => BulkCheckboxColumn::BUTTON_TYPE_CUSTOM_JS,
'customJs' => 'function(event, gridId, ids) { /* ... */ }',
]
// ...Other elements
],
],
// Other columns
],
]); ?>
- BookController.php
(Controller)
:
<?php
namespace app\controllers;
use Yii;
use yii\web\Controller;
use backend\models\Book;
use yii\helpers\ArrayHelper;
use backend\models\BookSearch;
/**
* BookController implements the CRUD actions for Site model.
*/
class BookController extends Controller
{
/**
* @inheritdoc
*/
public function actions()
{
return ArrayHelper::merge(parent::actions(), [
'bulk_available' => [
'class' => BulkCheckboxAction::className(),
'modelClass' => Book::className(),
'gridId' => 'books-grid',
'statusField' => 'available',
'updateType' => BulkCheckboxAction::UPDATE_TYPE_ONEBYONE,
],
// ...Many actions
'bulk_intl_shipping' => [
'class' => BulkCheckboxAction::className(),
'modelClass' => Book::className(),
'gridId' => 'books-grid',
'statusField' => 'intl_shipping',
],
]);
}
/**
* Index page
*
* @return mixed
*/
public function actionIndex()
{
$this->runAction('bulk_available');
// ...Many actions with run
$this->runAction('bulk_intl_shipping');
$searchModel = new BookSearch();
$dataProvider = $searchModel->search(Yii::$app->request->queryParams);
return $this->render('index', [
'searchModel' => $searchModel,
'dataProvider' => $dataProvider,
]);
}
// Other actions and methods
}