php/yii2
1
0
Fork 0
mirror of https://github.com/yiisoft/yii2.git synced 2025-11-03 22:12:37 +08:00
Code Issues Packages Projects Releases Wiki Activity

Added support for using callables as "ActiveQuery::indexBy".

Browse Source
This commit is contained in:
Qiang Xue
2013-07-08 21:25:00 -04:00
parent 23deeab4be
commit aa568aacb5
2 changed files with 37 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
framework/yii/db/ActiveQuery.php
View File

@ -55,8 +55,9 @@ class ActiveQuery extends Query
*/
public $with;
/**
* @var string the name of the column by which query results should be indexed by.
* This is only used when the query result is returned as an array when calling [[all()]].
* @var string|callable $column the name of the column by which the query results should be indexed by.
* This can also be a callable (e.g. anonymous function) that returns the index value based on the given
* row or model data. For more details, see [[indexBy()]].
*/
public $indexBy;
/**
@ -288,7 +289,19 @@ class ActiveQuery extends Query
/**
* Sets the [[indexBy]] property.
* @param string $column the name of the column by which the query results should be indexed by.
* @param string|callable $column the name of the column by which the query results should be indexed by.
* This can also be a callable (e.g. anonymous function) that returns the index value based on the given
* row or model data. The signature of the callable should be:
*
* ~~~
* // $model is an AR instance when `asArray` is false,
* // or an array of column values when `asArray` is true.
* function ($model)
* {
* // return the index value corresponding to $model
* }
* ~~~
*
* @return ActiveQuery the query object itself
*/
public function indexBy($column)
@ -305,7 +318,12 @@ class ActiveQuery extends Query
return $rows;
}
foreach ($rows as $row) {
$models[$row[$this->indexBy]] = $row;
if (is_string($this->indexBy)) {
$key = $row[$this->indexBy];
} else {
$key = call_user_func($this->indexBy, $row);
}
$models[$key] = $row;
}
} else {
/** @var $class ActiveRecord */
@ -317,7 +335,12 @@ class ActiveQuery extends Query
} else {
foreach ($rows as $row) {
$model = $class::create($row);
$models[$model->{$this->indexBy}] = $model;
if (is_string($this->indexBy)) {
$key = $model->{$this->indexBy};
} else {
$key = call_user_func($this->indexBy, $model);
}
$models[$key] = $model;
}
}
}

9
tests/unit/framework/db/ActiveRecordTest.php
View File

@ -84,6 +84,15 @@ class ActiveRecordTest extends DatabaseTestCase
$this->assertTrue($customers['user1'] instanceof Customer);
$this->assertTrue($customers['user2'] instanceof Customer);
$this->assertTrue($customers['user3'] instanceof Customer);
// indexBy callable
$customers = Customer::find()->indexBy(function($customer) {
return $customer->id . '-' . $customer->name;
})->orderBy('id')->all();
$this->assertEquals(3, count($customers));
$this->assertTrue($customers['1-user1'] instanceof Customer);
$this->assertTrue($customers['2-user2'] instanceof Customer);
$this->assertTrue($customers['3-user3'] instanceof Customer);
}
public function testFindBySql()