Skip to content

Eager loading in ActiveRecord::refresh() (without breaking BC) #20290

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 10 commits into from
+14 −2
Closed

Eager loading in ActiveRecord::refresh() (without breaking BC) #20290

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
dd9a6c4
Optimise ArrayHelper::map
chriscpty Oct 17, 2024
ca4bae9
Optimise ArrayHelper::map
chriscpty Oct 17, 2024
facef5a
improve ArrayHelper::map tests
chriscpty Oct 17, 2024
1fcadcd
fix ArrayHelper::map() for path strings
chriscpty Oct 18, 2024
7538551
fix ArrayHelper::map() for path strings
chriscpty Oct 18, 2024
4ed589f
use strpos rather than polyfill
chriscpty Oct 22, 2024
2c6f34d
refresh relations with BC break
chriscpty Dec 6, 2024
0058f0e
refresh relations without BC break
chriscpty Dec 6, 2024
a92c9b3
refresh relations with BC break
chriscpty Dec 6, 2024
c887d4e
Merge branch 'master' into without-bc-break
chriscpty Dec 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions framework/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ Yii Framework 2 Change Log
- Enh #20279: Add to the `\yii\web\Request` `csrfHeader` property to configure a custom HTTP header for CSRF validation (olegbaturin)
- Enh #20279: Add to the `\yii\web\Request` `csrfTokenSafeMethods` property to configure a custom safe HTTP methods list (olegbaturin)
- Bug #20140: Fix compatibility with PHP 8.4: calling `session_set_save_handler()` (Izumi-kun)
- Enh #20277: Eager loading in `\yii\db\ActiveRecord::refresh` (chriscpty)

2.0.51 July 18, 2024
--------------------
Expand Down
7 changes: 7 additions & 0 deletions framework/db/ActiveRecord.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -280,6 +280,9 @@ protected static function filterValidColumnNames($db, array $aliases)

/**
* {@inheritdoc}
*
* @param array $with If an array is passed to this function,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you can't be declared it as required parameter $with

* it will be interpreted as an array of relations to eagerly load for the refreshed record.
*/
public function refresh()
{
Expand All @@ -290,6 +293,10 @@ public function refresh()
foreach ($this->getPrimaryKey(true) as $key => $value) {
$pk[$tableName . '.' . $key] = $value;
}
$args = func_get_args();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think passed arguments must be compatible with with():

$args = func_get_args();
if ($args) {
    $query->with(...$args);
}

if (array_key_exists(0, $args) && is_array($args[0])) {
$query->with(...$args[0]);
}
$query->where($pk);

/* @var $record BaseActiveRecord */
Expand Down
4 changes: 2 additions & 2 deletions framework/db/BaseActiveRecord.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1082,8 +1082,8 @@ protected function refreshInternal($record)
$this->_attributes[$name] = isset($record->_attributes[$name]) ? $record->_attributes[$name] : null;
}
$this->_oldAttributes = $record->_oldAttributes;
$this->_related = [];
$this->_relationsDependencies = [];
$this->_related = $record->_related;
$this->_relationsDependencies = $record->_relationsDependencies;
$this->afterRefresh();

return true;
Expand Down
4 changes: 4 additions & 0 deletions tests/framework/ar/ActiveRecordTestTrait.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -288,6 +288,10 @@ public function testRefresh()
$customer->name = 'to be refreshed';
$this->assertTrue($customer->refresh());
$this->assertEquals('user1', $customer->name);
$this->assertFalse($customer->isRelationPopulated('profile'));

$this->assertTrue($customer->refresh(['profile']));
$this->assertTrue($customer->isRelationPopulated('profile'));
}

public function testEquals()
Expand Down
Loading