本文档介绍了如何在 Yii2 框架中，通过修改关联模型中的 ActiveQuery，实现对 API 返回的关联数据进行升序排序。主要针对通过 `expand` 参数获取关联数据，并需要对这些关联数据进行排序的场景。 通过修改关联模型的 `getPermissions` 方法，添加 `orderBy` 子句，可以轻松实现关联数据的排序需求。
在 Yii2 框架中，当通过 API 获取数据，并且使用了 expand 参数来获取关联数据时，有时需要对这些关联数据进行排序。本文将介绍如何通过修改关联模型的 ActiveQuery 来实现这一目标。
实现方法
假设我们有两个模型：PermissionGroup 和 Permission，它们之间存在关联关系，PermissionGroup 模型通过 getPermissions() 方法关联到 Permission 模型。我们需要对 Permission 模型的数据按照 name 字段进行升序排序。
实现步骤如下：
找到关联模型中的关联方法： 在 PermissionGroup 模型中找到 getPermissions() 方法。这个方法定义了 PermissionGroup 和 Permission 之间的关联关系。
修改 ActiveQuery： 在 getPermissions() 方法中，使用 orderBy() 方法对 Permission 模型的数据进行排序。
public function getPermissions()
{
return $this->hasMany(Permission::className(), ['group_id' => 'id'])->orderBy('name ASC');
}在上面的代码中，orderBy('name ASC') 指定了按照 name 字段进行升序排序。 ASC 表示升序，如果需要降序排列，可以使用 DESC。
- 确保 extraFields() 方法包含关联关系： 为了在 API 响应中包含 permissions 关联数据，需要在 PermissionGroup 模型中定义 extraFields() 方法，并确保其中包含 permissions 字段。
public function extraFields() {
return ['permissions'];
}示例
假设我们有以下数据：
PermissionGroup 表:
| id | name |
|---|---|
| 8 | group_a |
| 3 | group_b |
Permission 表:
| id | name | group_id |
|---|---|---|
| 34 | z | 8 |
| 35 | x | 8 |
| 36 | y | 8 |
| 22 | b | 3 |
| 23 | d | 3 |
| 24 | a | 3 |
修改 PermissionGroup 模型后，通过 API 请求 http://localhost/yii2/backend/web/index.php?r=configuration/permissiongroup&expand=permissions&sort=name，返回的数据将会是：
[
{
"id": 8,
"name": "group_a",
"permissions": [
{
"id": "35",
"name": "x",
"group_id": 8
},
{
"id": "36",
"name": "y",
"group_id": 8
},
{
"id": "34",
"name": "z",
"group_id": 8
}
]
},
{
"id": 3,
"name": "group_b",
"permissions": [
{
"id": "24",
"name": "a",
"group_id": 3
},
{
"id": "22",
"name": "b",
"group_id": 3
},
{
"id": "23",
"name": "d",
"group_id": 3
}
]
}
]可以看到，permissions 数组中的数据已经按照 name 字段进行了升序排序。
注意事项
- 确保 orderBy() 方法中使用的字段是数据库中存在的字段。
- orderBy() 方法可以接受多个字段，用于多重排序。 例如：orderBy(['name' => SORT_ASC, 'id' => SORT_DESC])。
- 这种方法适用于通过 hasMany() 关联关系获取的数据排序。
总结
通过修改关联模型的 ActiveQuery，可以轻松实现对 API 返回的关联数据进行排序的需求。 只需要在关联方法中添加 orderBy() 子句，并指定排序的字段和排序方式即可。 这种方法简单易懂，适用于大多数场景。
