tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-07-03 01:49:37 +02:00
Code Issues Projects Releases Wiki Activity

DOC Update eagerLoad() docblock

Browse Source
This commit is contained in:
Steve Boyd 2023-06-21 14:12:55 +12:00
parent 11ab07a056
commit e9358c88af
1 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/ORM/DataList.php
View File

@ -1209,7 +1209,19 @@ class DataList extends ViewableData implements SS_List, Filterable, Sortable, Li
}
/**
* $myDataList->eagerLoad('Some.Nested.Relation', 'Another.Relation')
* Eager load relations for DataObjects in this DataList including nested relations
*
* Eager loading alleviates the N + 1 problem by querying the nested relationship tables before they are
* needed using a single large `WHERE ID in ($ids)` SQL query instead of many `WHERE RelationID = $id` queries.
*
* You can speicify nested relations by using dot notation, and you can also pass in multiple relations.
* When speicifying nested relations there is a maximum of 3 levels of relations allowed i.e. 2 dots
*
* Example:
* $myDataList->eagerLoad('MyRelation.NestedRelation.EvenMoreNestedRelation', 'DifferentRelation')
*
* IMPORTANT: Calling eagerLoad() will cause any relations on DataObjects to be returned as an ArrayList
* instead of a subclass of DataList such as HasManyList i.e. MyDataObject->MyHasManyRelation() returns an ArrayList
*/
public function eagerLoad(...$relations): static
{