EagerLoadPlan ​
- Type
- Class
- Namespace
- craft\elements\db
- Inherits
- craft\elements\db\EagerLoadPlan » yii\base\BaseObject
- Implements
- yii\base\Configurable
- Since
- 3.5.0
Class EagerLoadPlan
Public Properties ​
| Property | Description |
|---|---|
| alias | string – The eager-loading alias |
| all | boolean – Whether to eager-load the matching elements |
| count | boolean – Whether to eager-load the count of the matching elements |
| criteria | array – The criteria that should be applied when eager-loading these elements |
| handle | string – The eager-loading handle |
| nested | craft\elements\db\EagerLoadPlan[] – Nested eager-loading plans to apply to the eager-loaded elements. |
| when | callable, null – A PHP callable whose return value determines whether to apply eager-loaded elements to the given element. |
alias ​
- Type
- string
- Default value
null
The eager-loading alias
all ​
- Type
- boolean
- Default value
false- Since
- 3.5.12
Whether to eager-load the matching elements
count ​
- Type
- boolean
- Default value
false
Whether to eager-load the count of the matching elements
criteria ​
- Type
- array
- Default value
[]
The criteria that should be applied when eager-loading these elements
handle ​
- Type
- string
- Default value
null
The eager-loading handle
nested ​
- Type
- craft\elements\db\EagerLoadPlan[]
- Default value
[]
Nested eager-loading plans to apply to the eager-loaded elements.
when ​
A PHP callable whose return value determines whether to apply eager-loaded elements to the given element.
The signature of the callable should be function (\craft\base\ElementInterface $element): bool, where $element refers to the element the eager-loaded elements are about to be applied to. The callable should return a boolean value.
Public Methods ​
| Method | Description |
|---|---|
| __call() | Calls the named method which is not a class method. |
| __construct() | Constructor. |
| __get() | Returns the value of an object property. |
| __isset() | Checks if a property is set, i.e. defined and not null. |
| __set() | Sets value of an object property. |
| __unset() | Sets an object property to null. |
| canGetProperty() | Returns a value indicating whether a property can be read. |
| canSetProperty() | Returns a value indicating whether a property can be set. |
| className() | Returns the fully qualified name of this class. |
| hasMethod() | Returns a value indicating whether a method is defined. |
| hasProperty() | Returns a value indicating whether a property is defined. |
| init() | Initializes the object. |