You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/.artifacts/commerce/5.x/orders-carts.md
+19Lines changed: 19 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,6 +13,7 @@
13
13
| [andWith](#andwith) | Causes the query to return matching orders eager-loaded with related elements, in addition to the elements that were already specified by [with](#with).
14
14
| [asArray](#asarray) | Causes the query to return matching orders as arrays of data, rather than [Order](commerce5:craft\commerce\elements\Order) objects.
15
15
| [cache](#cache) | Enables query cache for this Query.
16
+
| [canonicalsOnly](#canonicalsonly) | Narrows the query results to only canonical elements, including elements that reference another canonical element via `canonicalId` so long as they aren’t a draft.
16
17
| [clearCachedResult](#clearcachedresult) | Clears the [cached result](https://craftcms.com/docs/5.x/development/element-queries.html#cache).
17
18
| [couponCode](#couponcode) | Narrows the query results based on the order's coupon code.
18
19
| [customer](#customer) | Narrows the query results based on the customer’s user account.
@@ -207,6 +208,24 @@ Enables query cache for this Query.
207
208
208
209
209
210
211
+
#### `canonicalsOnly`
212
+
213
+
<aclass="ref-defined-by"href="https://docs.craftcms.com/api/v5/craft-elements-db-elementquery.html#method-canonicalsonly"target="_blank"rel="noopener noreferer">Defined by <code>craft\elements\db\ElementQuery</code></a>
214
+
215
+
Narrows the query results to only canonical elements, including elements
216
+
that reference another canonical element via `canonicalId` so long as they
217
+
aren’t a draft.
218
+
219
+
220
+
221
+
Unpublished drafts can be included as well if `drafts(null)` and
222
+
`draftOf(false)` are also passed.
223
+
224
+
225
+
226
+
227
+
228
+
210
229
#### `clearCachedResult`
211
230
212
231
<aclass="ref-defined-by"href="https://docs.craftcms.com/api/v5/craft-elements-db-elementquery.html#method-clearcachedresult"target="_blank"rel="noopener noreferer">Defined by <code>craft\elements\db\ElementQuery</code></a>
Copy file name to clipboardExpand all lines: docs/.artifacts/commerce/5.x/subscriptions.md
+19Lines changed: 19 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,6 +13,7 @@
13
13
| [andWith](#andwith) | Causes the query to return matching subscriptions eager-loaded with related elements, in addition to the elements that were already specified by [with](#with).
14
14
| [asArray](#asarray) | Causes the query to return matching subscriptions as arrays of data, rather than [Subscription](commerce5:craft\commerce\elements\Subscription) objects.
15
15
| [cache](#cache) | Enables query cache for this Query.
16
+
| [canonicalsOnly](#canonicalsonly) | Narrows the query results to only canonical elements, including elements that reference another canonical element via `canonicalId` so long as they aren’t a draft.
16
17
| [clearCachedResult](#clearcachedresult) | Clears the [cached result](https://craftcms.com/docs/5.x/development/element-queries.html#cache).
17
18
| [dateCanceled](#datecanceled) | Narrows the query results based on the subscriptions’ cancellation date.
18
19
| [dateCreated](#datecreated) | Narrows the query results based on the subscriptions’ creation dates.
@@ -184,6 +185,24 @@ Enables query cache for this Query.
184
185
185
186
186
187
188
+
#### `canonicalsOnly`
189
+
190
+
<aclass="ref-defined-by"href="https://docs.craftcms.com/api/v5/craft-elements-db-elementquery.html#method-canonicalsonly"target="_blank"rel="noopener noreferer">Defined by <code>craft\elements\db\ElementQuery</code></a>
191
+
192
+
Narrows the query results to only canonical elements, including elements
193
+
that reference another canonical element via `canonicalId` so long as they
194
+
aren’t a draft.
195
+
196
+
197
+
198
+
Unpublished drafts can be included as well if `drafts(null)` and
199
+
`draftOf(false)` are also passed.
200
+
201
+
202
+
203
+
204
+
205
+
187
206
#### `clearCachedResult`
188
207
189
208
<aclass="ref-defined-by"href="https://docs.craftcms.com/api/v5/craft-elements-db-elementquery.html#method-clearcachedresult"target="_blank"rel="noopener noreferer">Defined by <code>craft\elements\db\ElementQuery</code></a>
0 commit comments