Skip to content

Commit d6c1315

Browse files
committed
cms@287a7b2
Finish 4.15.1
1 parent 062a480 commit d6c1315

File tree

8 files changed

+684
-112
lines changed

8 files changed

+684
-112
lines changed

docs/.artifacts/cms/4.x/addresses.md

+66-14
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@
99
| Param | Description
1010
| ----------------------------------------- | -----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
1111
| [administrativeArea](#administrativearea) | Narrows the query results based on the administrative area the assets belong to.
12-
| [afterPopulate](#afterpopulate) | Performs any post-population processing on elements.
1312
| [andRelatedTo](#andrelatedto) | Narrows the query results to only addresses that are related to certain other elements.
13+
| [andWith](#andwith) | Causes the query to return matching addresses eager-loaded with related elements, in addition to the elements that were already specified by [with](#with).
1414
| [asArray](#asarray) | Causes the query to return matching addresses as arrays of data, rather than [Address](craft4:craft\elements\Address) objects.
1515
| [cache](#cache) | Enables query cache for this Query.
1616
| [clearCachedResult](#clearcachedresult) | Clears the [cached result](https://craftcms.com/docs/4.x/element-queries.html#cache).
@@ -43,6 +43,7 @@
4343

4444
#### `administrativeArea`
4545

46+
4647
Narrows the query results based on the administrative area the assets belong to.
4748

4849
Possible values include:
@@ -73,21 +74,10 @@ $addresses = \craft\elements\Address::find()
7374
:::
7475

7576

76-
#### `afterPopulate`
77-
78-
Performs any post-population processing on elements.
79-
80-
81-
82-
83-
84-
85-
86-
87-
88-
8977
#### `andRelatedTo`
9078

79+
<a class="ref-defined-by" href="https://docs.craftcms.com/api/v4/craft-elements-db-elementquery.html#method-andrelatedto" target="_blank" rel="noopener noreferer">Defined by <code>craft\elements\db\ElementQuery</code></a>
80+
9181
Narrows the query results to only addresses that are related to certain other elements.
9282

9383

@@ -115,8 +105,25 @@ $addresses = \craft\elements\Address::find()
115105
:::
116106

117107

108+
#### `andWith`
109+
110+
<a class="ref-defined-by" href="https://docs.craftcms.com/api/v4/craft-elements-db-elementquery.html#method-andwith" target="_blank" rel="noopener noreferer">Defined by <code>craft\elements\db\ElementQuery</code></a>
111+
112+
Causes the query to return matching addresses eager-loaded with related elements, in addition to the elements that were already specified by [with](#with).
113+
114+
115+
116+
.
117+
118+
119+
120+
121+
122+
118123
#### `asArray`
119124

125+
<a class="ref-defined-by" href="https://docs.craftcms.com/api/v4/craft-elements-db-elementquery.html#method-asarray" target="_blank" rel="noopener noreferer">Defined by <code>craft\elements\db\ElementQuery</code></a>
126+
120127
Causes the query to return matching addresses as arrays of data, rather than [Address](craft4:craft\elements\Address) objects.
121128

122129

@@ -142,6 +149,8 @@ $addresses = \craft\elements\Address::find()
142149

143150
#### `cache`
144151

152+
<a class="ref-defined-by" href="https://docs.craftcms.com/api/v4/craft-elements-db-elementquery.html#method-cache" target="_blank" rel="noopener noreferer">Defined by <code>craft\elements\db\ElementQuery</code></a>
153+
145154
Enables query cache for this Query.
146155

147156

@@ -155,6 +164,8 @@ Enables query cache for this Query.
155164

156165
#### `clearCachedResult`
157166

167+
<a class="ref-defined-by" href="https://docs.craftcms.com/api/v4/craft-elements-db-elementquery.html#method-clearcachedresult" target="_blank" rel="noopener noreferer">Defined by <code>craft\elements\db\ElementQuery</code></a>
168+
158169
Clears the [cached result](https://craftcms.com/docs/4.x/element-queries.html#cache).
159170

160171

@@ -164,6 +175,7 @@ Clears the [cached result](https://craftcms.com/docs/4.x/element-queries.html#ca
164175

165176
#### `countryCode`
166177

178+
167179
Narrows the query results based on the country the assets belong to.
168180

169181
Possible values include:
@@ -196,6 +208,8 @@ $addresses = \craft\elements\Address::find()
196208

197209
#### `dateCreated`
198210

211+
<a class="ref-defined-by" href="https://docs.craftcms.com/api/v4/craft-elements-db-elementquery.html#method-datecreated" target="_blank" rel="noopener noreferer">Defined by <code>craft\elements\db\ElementQuery</code></a>
212+
199213
Narrows the query results based on the addresses’ creation dates.
200214

201215

@@ -236,6 +250,8 @@ $addresses = \craft\elements\Address::find()
236250

237251
#### `dateUpdated`
238252

253+
<a class="ref-defined-by" href="https://docs.craftcms.com/api/v4/craft-elements-db-elementquery.html#method-dateupdated" target="_blank" rel="noopener noreferer">Defined by <code>craft\elements\db\ElementQuery</code></a>
254+
239255
Narrows the query results based on the addresses’ last-updated dates.
240256

241257

@@ -274,6 +290,8 @@ $addresses = \craft\elements\Address::find()
274290

275291
#### `fixedOrder`
276292

293+
<a class="ref-defined-by" href="https://docs.craftcms.com/api/v4/craft-elements-db-elementquery.html#method-fixedorder" target="_blank" rel="noopener noreferer">Defined by <code>craft\elements\db\ElementQuery</code></a>
294+
277295
Causes the query results to be returned in the order specified by [id](#id).
278296

279297

@@ -305,6 +323,8 @@ $addresses = \craft\elements\Address::find()
305323

306324
#### `id`
307325

326+
<a class="ref-defined-by" href="https://docs.craftcms.com/api/v4/craft-elements-db-elementquery.html#method-id" target="_blank" rel="noopener noreferer">Defined by <code>craft\elements\db\ElementQuery</code></a>
327+
308328
Narrows the query results based on the addresses’ IDs.
309329

310330

@@ -345,6 +365,8 @@ This can be combined with [fixedOrder](#fixedorder) if you want the results to b
345365

346366
#### `ignorePlaceholders`
347367

368+
<a class="ref-defined-by" href="https://docs.craftcms.com/api/v4/craft-elements-db-elementquery.html#method-ignoreplaceholders" target="_blank" rel="noopener noreferer">Defined by <code>craft\elements\db\ElementQuery</code></a>
369+
348370
Causes the query to return matching addresses as they are stored in the database, ignoring matching placeholder
349371
elements that were set by [craft\services\Elements::setPlaceholderElement()](https://docs.craftcms.com/api/v4/craft-services-elements.html#method-setplaceholderelement).
350372

@@ -359,6 +381,8 @@ elements that were set by [craft\services\Elements::setPlaceholderElement()](htt
359381

360382
#### `inReverse`
361383

384+
<a class="ref-defined-by" href="https://docs.craftcms.com/api/v4/craft-elements-db-elementquery.html#method-inreverse" target="_blank" rel="noopener noreferer">Defined by <code>craft\elements\db\ElementQuery</code></a>
385+
362386
Causes the query results to be returned in reverse order.
363387

364388

@@ -384,6 +408,8 @@ $addresses = \craft\elements\Address::find()
384408

385409
#### `language`
386410

411+
<a class="ref-defined-by" href="https://docs.craftcms.com/api/v4/craft-elements-db-elementquery.html#method-language" target="_blank" rel="noopener noreferer">Defined by <code>craft\elements\db\ElementQuery</code></a>
412+
387413
Determines which site(s) the addresses should be queried in, based on their language.
388414

389415

@@ -422,6 +448,8 @@ $addresses = \craft\elements\Address::find()
422448

423449
#### `limit`
424450

451+
<a class="ref-defined-by" href="https://www.yiiframework.com/doc/api/2.0/yii-db-querytrait#limit()-detail" target="_blank" rel="noopener noreferer">Defined by <code>yii\db\QueryTrait</code></a>
452+
425453
Determines the number of addresses that should be returned.
426454

427455

@@ -445,6 +473,8 @@ $addresses = \craft\elements\Address::find()
445473

446474
#### `offset`
447475

476+
<a class="ref-defined-by" href="https://www.yiiframework.com/doc/api/2.0/yii-db-querytrait#offset()-detail" target="_blank" rel="noopener noreferer">Defined by <code>yii\db\QueryTrait</code></a>
477+
448478
Determines how many addresses should be skipped in the results.
449479

450480

@@ -468,6 +498,8 @@ $addresses = \craft\elements\Address::find()
468498

469499
#### `orderBy`
470500

501+
<a class="ref-defined-by" href="https://docs.craftcms.com/api/v4/craft-elements-db-elementquery.html#method-orderby" target="_blank" rel="noopener noreferer">Defined by <code>craft\elements\db\ElementQuery</code></a>
502+
471503
Determines the order that the addresses should be returned in. (If empty, defaults to `dateCreated DESC,
472504
elements.id`.)
473505

@@ -492,6 +524,7 @@ $addresses = \craft\elements\Address::find()
492524

493525
#### `owner`
494526

527+
495528
Sets the [ownerId](#ownerid) parameter based on a given owner element.
496529

497530

@@ -515,6 +548,7 @@ $addresses = \craft\elements\Address::find()
515548

516549
#### `ownerId`
517550

551+
518552
Narrows the query results based on the addresses’ owner elements, per their IDs.
519553

520554
Possible values include:
@@ -545,6 +579,8 @@ $addresses = \craft\elements\Address::find()
545579

546580
#### `preferSites`
547581

582+
<a class="ref-defined-by" href="https://docs.craftcms.com/api/v4/craft-elements-db-elementquery.html#method-prefersites" target="_blank" rel="noopener noreferer">Defined by <code>craft\elements\db\ElementQuery</code></a>
583+
548584
If [unique()](https://docs.craftcms.com/api/v4/craft-elements-db-elementquery.html#method-unique) is set, this determines which site should be selected when querying multi-site elements.
549585

550586

@@ -580,6 +616,8 @@ $addresses = \craft\elements\Address::find()
580616

581617
#### `prepareSubquery`
582618

619+
<a class="ref-defined-by" href="https://docs.craftcms.com/api/v4/craft-elements-db-elementquery.html#method-preparesubquery" target="_blank" rel="noopener noreferer">Defined by <code>craft\elements\db\ElementQuery</code></a>
620+
583621
Prepares the element query and returns its subquery (which determines what elements will be returned).
584622

585623

@@ -589,6 +627,8 @@ Prepares the element query and returns its subquery (which determines what eleme
589627

590628
#### `relatedTo`
591629

630+
<a class="ref-defined-by" href="https://docs.craftcms.com/api/v4/craft-elements-db-elementquery.html#method-relatedto" target="_blank" rel="noopener noreferer">Defined by <code>craft\elements\db\ElementQuery</code></a>
631+
592632
Narrows the query results to only addresses that are related to certain other elements.
593633

594634

@@ -616,6 +656,8 @@ $addresses = \craft\elements\Address::find()
616656

617657
#### `search`
618658

659+
<a class="ref-defined-by" href="https://docs.craftcms.com/api/v4/craft-elements-db-elementquery.html#method-search" target="_blank" rel="noopener noreferer">Defined by <code>craft\elements\db\ElementQuery</code></a>
660+
619661
Narrows the query results to only addresses that match a search query.
620662

621663

@@ -649,6 +691,8 @@ $addresses = \craft\elements\Address::find()
649691

650692
#### `siteSettingsId`
651693

694+
<a class="ref-defined-by" href="https://docs.craftcms.com/api/v4/craft-elements-db-elementquery.html#method-sitesettingsid" target="_blank" rel="noopener noreferer">Defined by <code>craft\elements\db\ElementQuery</code></a>
695+
652696
Narrows the query results based on the addresses’ IDs in the `elements_sites` table.
653697

654698

@@ -683,6 +727,8 @@ $address = \craft\elements\Address::find()
683727

684728
#### `trashed`
685729

730+
<a class="ref-defined-by" href="https://docs.craftcms.com/api/v4/craft-elements-db-elementquery.html#method-trashed" target="_blank" rel="noopener noreferer">Defined by <code>craft\elements\db\ElementQuery</code></a>
731+
686732
Narrows the query results to only addresses that have been soft-deleted.
687733

688734

@@ -708,6 +754,8 @@ $addresses = \craft\elements\Address::find()
708754

709755
#### `uid`
710756

757+
<a class="ref-defined-by" href="https://docs.craftcms.com/api/v4/craft-elements-db-elementquery.html#method-uid" target="_blank" rel="noopener noreferer">Defined by <code>craft\elements\db\ElementQuery</code></a>
758+
711759
Narrows the query results based on the addresses’ UIDs.
712760

713761

@@ -733,6 +781,8 @@ $address = \craft\elements\Address::find()
733781

734782
#### `with`
735783

784+
<a class="ref-defined-by" href="https://docs.craftcms.com/api/v4/craft-elements-db-elementquery.html#method-with" target="_blank" rel="noopener noreferer">Defined by <code>craft\elements\db\ElementQuery</code></a>
785+
736786
Causes the query to return matching addresses eager-loaded with related elements.
737787

738788

@@ -760,6 +810,8 @@ $addresses = \craft\elements\Address::find()
760810

761811
#### `withCustomFields`
762812

813+
<a class="ref-defined-by" href="https://docs.craftcms.com/api/v4/craft-elements-db-elementquery.html#method-withcustomfields" target="_blank" rel="noopener noreferer">Defined by <code>craft\elements\db\ElementQuery</code></a>
814+
763815
Sets whether custom fields should be factored into the query.
764816

765817

0 commit comments

Comments
 (0)