你一定对yii2的ActiveDataProvider很熟悉,黄金组合ActiveDataProvider + GridView帮助无数的yii2开发者快速构造出功能强大的表格。
你可知yii2的世界里还有SqlDataProvider和ArrayDataProvider两位大兄弟?接下来我们把这同家三兄弟的用法做一个小教程。
本文并非配置篇,对于三兄弟的配置大全阿北会在《yii2配置词典》专栏中进行介绍
ActiveDataProvider
最常用的一个,使用ActiveDataProvider将返回一个对象集合,里面包含了查询的对象群、分页信息等等,一般我们是这样用的
$query = User::find();
$dataProvider = new ActiveDataProvider([
'query'=>$query,
'pagination'=>[
'pageSize'=>20
]
]);
在ActiveDataProvider中除了query参数都是可选的,比如pagination、sort等。
当你得到了$dataProvider后,可以将其传给视图和GridView进行无敌组合,当然也可以使用自身的一些方法,比如
获得当前页的所有users
$dataProvider->getModels();//这是一个内含对象的一维数组
获得页码信息
$dataProvider->getTotalCount();// 获得总页数
$dataProvider->getCount();// 当前页码
$dataProvider->getPagination(); // 内含的Pagination对象
上面是最常用的,除此之外还提供了比如refresh等方法。
当然我们最常用的还是将ActiveDataProvider传递给GridView然后渲染出表格。
use yii\grid\GridView;
= GridView::widget([
'dataProvider' => $dataProvider,
]);?>
小结 ActiveDataProvider返回的是对象的集合,确切的说是每一个模型(AR),因此模型的关联特性可以使用,这让我们可以构造出复杂完整的表格。
SqlDataProvider
和名字一样,SqlDataProvider接收一个原生的SQL语句并且能生成一个带有参数的dataProvider,一个月你总会碰到几次是用QueryBuilder构造不出来的复杂SQL。
用法如下
$totalCount = Yii::$app->db->createCommand('SELECT COUNT(*) FROM user WHERE sex=:sex', ['sex:' => 1])
->queryScalar();
$dataProvider = new SqlDataProvider([
'sql' => 'SELECT * FROM user WHERE sex=:sex',
'params' => [':sex' => 1],
'totalCount' => $totalCount,
//'sort' =>false,//如果为假则删除排序
'sort' => [
'attributes' => [
'username' => [
'asc' => ['username' => SORT_ASC],
'desc' => ['username' => SORT_DESC],
'default' => SORT_DESC,
'label' => '用户名',
],
'sex' => [
'asc' => ['sex' => SORT_ASC],
'desc' => ['sex' => SORT_DESC],
'default' => SORT_DESC,
'label' => '性别',
],
'created_on'
],
],
'pagination' => [
'pageSize' => 10,
],
]);
return $dataProvider;
不要被上面一大堆代码吓到,我只是装个逼而已,其实SqlDataProvider必填的参数只有一项,就是sql。比如我下面的这段代码
$dataProvider = new SqlDataProvider([
'sql' => 'SELECT * FROM `blog`'
]);
当然SqlDataProvider也有一些方法,比如getModels、getTotalCount等方法,不同的是这里面没有对象了,这里面是数组。这很正常,你不在操作AR了,你现在直接在操作数据库。
而我们在 小谈Yii Framework 2.0(yii2)的数据库层 提到过,AR才是数据表面向对象的归宿。
所以当你搭配GridView的时候,就要如下写代码了
GridView::widget([
'dataProvider' => $dataProvider,
'columns' => [
['class' => 'yii\grid\SerialColumn'],
[
'label' =>"昵称",
'attribute' => 'nickname',
'value'=>function($data){
return $data["nickname"];
}
],
'username',
'sex',
'created_on',
['class' => 'yii\grid\ActionColumn'],
],
]);
此刻的$data就是我们sql语句查出的一行。
小结 替补ActiveDataProvider,同时也提供给一些喜欢数组作为结果的小盆友们,无法使用关联属性。当然如果你是一个SQL迷,这种方法也许更直接更快速。
ArrayDataProvider
之所以出现了三种数据提供者(DataProvider)主要是因为我们要面对不同的数据来源、一个Query、一条SQL语句,你看,现在使用ArrayDataProvider你可以将一个数组作为数据来源还。
比如下面的代码
$dataProvider = new ArrayDataProvider([
'allModels' => Blog::find()->asArray()->all(),// 或Blog::find()->all()
'pagination' => [
'pageSize' => 1,
],
]);
allModels 是一个必填项,代表数据来源,allModels是一个数组,但是allModels里面的元素并不限制,可以数组或对象,甚至是简单的数据类型,比如数字和字符串。
当然ArrayDataProvider一样可以和GridView组合,比如
GridView::widget([
'dataProvider' => $dataProvider
]);
对于GridView而言,这三种DataProvider没有区别
小结 给你一堆数据,然后用ArrayDataProvider进行分页、排序、构造表格!也许有其使用的场景吧,不过我现在还没遇到。
小结
这篇文章的初衷是为了让大家知道yii2中一共提供了几种数据提供者以及其使用方法,具体配置等我们会在其他专栏介绍。
在本文也使用了一些文章
- 就写SQL咋的了~在Yii2中使用SqlDataProvider的方法
- 小谈Yii Framework 2.0(yii2)的数据库层
原文链接 https://nai8.me/site/index.html