php/yii2
1
0
Fork 0
mirror of https://github.com/yiisoft/yii2.git synced 2025-10-27 20:06:19 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fix #20505: ArrayDataProvider key handling with flexible path support

Browse Source
This commit is contained in:
AIZAWA Hina
2025-08-30 20:02:12 +09:00
committed by GitHub
parent c4e920f054
commit 9b417e5f6d
3 changed files with 24 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
framework/CHANGELOG.md
View File

@ -22,6 +22,7 @@ Yii Framework 2 Change Log
- Bug #20489: Replace deprecated `strftime` with `date` in `YiiRequirementChecker` (max-s-lab)
- Bug #20494: Fix `PHPdoc`, add `PHPStan/Psalm` annotations for `authMethods` property in `CompositeAuth` class (terabytesoftw)
- Bug #20485: Fix error `Cannot unset string offsets` in `yii\di\Instance:ensure(['__class' => ...], 'some\class\name')` (max-s-lab)
- Enh #20505: `ArrayDataProvider` key handling with flexible path support (fetus-hina)
2.0.53 June 27, 2025
--------------------

16
framework/data/ArrayDataProvider.php
View File

@ -53,8 +53,9 @@ use yii\helpers\ArrayHelper;
class ArrayDataProvider extends BaseDataProvider
{
/**
* @var string|callable|null the column that is used as the key of the data models.
* This can be either a column name, or a callable that returns the key value of a given data model.
* @var string|array|callable|null the column that is used as the key of the data models.
* This can be either a column name, a dot-separated path, an array of keys, or a callable
* that returns the key value of a given data model.
* If this is not set, the index of the [[models]] array will be used.
* @see getKeys()
*/
@ -103,16 +104,7 @@ class ArrayDataProvider extends BaseDataProvider
protected function prepareKeys($models)
{
if ($this->key !== null) {
$keys = [];
foreach ($models as $model) {
if (is_string($this->key)) {
$keys[] = $model[$this->key];
} else {
$keys[] = call_user_func($this->key, $model);
}
}
return $keys;
return ArrayHelper::getColumn($models, $this->key, false);
}
return array_keys($models);

19
tests/framework/data/ArrayDataProviderTest.php
View File

@ -183,6 +183,25 @@ class ArrayDataProviderTest extends TestCase
];
$dataProvider = new ArrayDataProvider(['allModels' => $mixedArray, 'pagination' => $pagination]);
$this->assertEquals(['key1', 9], $dataProvider->getKeys());
$nestedArray = [
['foo' => ['bar' => 'key1']],
['foo' => ['bar' => 'key2']],
['foo' => ['bar' => 'key3']],
];
$dataProvider = new ArrayDataProvider([
'allModels' => $nestedArray,
'key' => ['foo', 'bar'],
'pagination' => $pagination,
]);
$this->assertEquals(['key1', 'key2'], $dataProvider->getKeys());
$dataProvider = new ArrayDataProvider([
'allModels' => $nestedArray,
'key' => 'foo.bar',
'pagination' => $pagination,
]);
$this->assertEquals(['key1', 'key2'], $dataProvider->getKeys());
}
public function testSortFlags()