Skip to content

Commit 354c40d

Browse files
shinybradshinybrad
committed
commerce@fdaf2a3
Finish 5.0.16
1 parent cba1744 commit 354c40d

File tree

3 files changed

+0
-162
lines changed

3 files changed

+0
-162
lines changed

‎docs/.artifacts/commerce/5.x/orders-carts.md‎

Lines changed: 0 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@
88

99
| Param | Description
1010
| --------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
11-
| [addOrderBy](#addorderby) | Adds additional ORDER BY columns to the query.
1211
| [afterPopulate](#afterpopulate) | Performs any post-population processing on elements.
1312
| [andRelatedTo](#andrelatedto) | Narrows the query results to only orders that are related to certain other elements.
1413
| [asArray](#asarray) | Causes the query to return matching orders as arrays of data, rather than [Order](commerce5:craft\commerce\elements\Order) objects.
@@ -24,7 +23,6 @@
2423
| [eagerly](#eagerly) | Causes the query to be used to eager-load results for the query’s source element and any other elements in its collection.
2524
| [email](#email) | Narrows the query results based on the customers’ email addresses.
2625
| [expiryDate](#expirydate) | Narrows the query results based on the orders’ expiry dates.
27-
| [fields](#fields) | Returns the list of fields that should be returned by default by [toArray()](https://www.yiiframework.com/doc/api/2.0/yii-base-arrayabletrait#toArray()-detail) when no specific fields are specified.
2826
| [fixedOrder](#fixedorder) | Causes the query results to be returned in the order specified by [id](#id).
2927
| [gateway](#gateway) | Narrows the query results based on the gateway.
3028
| [gatewayId](#gatewayid) | Narrows the query results based on the gateway, per its ID.
@@ -85,19 +83,6 @@
8583
<!-- textlint-enable -->
8684

8785

88-
#### `addOrderBy`
89-
90-
Adds additional ORDER BY columns to the query.
91-
92-
93-
94-
95-
96-
97-
98-
99-
100-
10186
#### `afterPopulate`
10287

10388
Performs any post-population processing on elements.
@@ -517,45 +502,6 @@ $orders = \craft\commerce\elements\Order::find()
517502
:::
518503

519504

520-
#### `fields`
521-
522-
Returns the list of fields that should be returned by default by [toArray()](https://www.yiiframework.com/doc/api/2.0/yii-base-arrayabletrait#toArray()-detail) when no specific fields are specified.
523-
524-
A field is a named element in the returned array by [toArray()](https://www.yiiframework.com/doc/api/2.0/yii-base-arrayabletrait#toArray()-detail).
525-
This method should return an array of field names or field definitions.
526-
If the former, the field name will be treated as an object property name whose value will be used
527-
as the field value. If the latter, the array key should be the field name while the array value should be
528-
the corresponding field definition which can be either an object property name or a PHP callable
529-
returning the corresponding field value. The signature of the callable should be:
530-
531-
```php
532-
function ($model, $field) {
533-
// return field value
534-
}
535-
```
536-
537-
For example, the following code declares four fields:
538-
539-
- `email`: the field name is the same as the property name `email`;
540-
- `firstName` and `lastName`: the field names are `firstName` and `lastName`, and their
541-
values are obtained from the `first_name` and `last_name` properties;
542-
- `fullName`: the field name is `fullName`. Its value is obtained by concatenating `first_name`
543-
and `last_name`.
544-
545-
```php
546-
return [
547-
'email',
548-
'firstName' => 'first_name',
549-
'lastName' => 'last_name',
550-
'fullName' => function ($model) {
551-
return $model->first_name . ' ' . $model->last_name;
552-
},
553-
];
554-
```
555-
556-
557-
558-
559505
#### `fixedOrder`
560506

561507
Causes the query results to be returned in the order specified by [id](#id).

‎docs/.artifacts/commerce/5.x/products-variants.md‎

Lines changed: 0 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ Product queries support the following parameters:
1212

1313
| Param | Description
1414
| --------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
15-
| [addOrderBy](#product-addorderby) | Adds additional ORDER BY columns to the query.
1615
| [after](#product-after) | Narrows the query results to only products that were posted on or after a certain date.
1716
| [afterPopulate](#product-afterpopulate) | Performs any post-population processing on elements.
1817
| [andRelatedTo](#product-andrelatedto) | Narrows the query results to only products that are related to certain other elements.
@@ -30,7 +29,6 @@ Product queries support the following parameters:
3029
| [defaultWidth](#product-defaultwidth) | Narrows the query results based on the products’ default variant width dimension IDs.
3130
| [eagerly](#product-eagerly) | Causes the query to be used to eager-load results for the query’s source element and any other elements in its collection.
3231
| [expiryDate](#product-expirydate) | Narrows the query results based on the products’ expiry dates.
33-
| [fields](#product-fields) | Returns the list of fields that should be returned by default by [toArray()](https://www.yiiframework.com/doc/api/2.0/yii-base-arrayabletrait#toArray()-detail) when no specific fields are specified.
3432
| [fixedOrder](#product-fixedorder) | Causes the query results to be returned in the order specified by [id](#product-id).
3533
| [hasVariant](#product-hasvariant) | Narrows the query results to only products that have certain variants.
3634
| [id](#product-id) | Narrows the query results based on the products’ IDs.
@@ -69,19 +67,6 @@ Product queries support the following parameters:
6967
<!-- textlint-enable -->
7068

7169

72-
<h4 id="product-addorderby"><a href="#product-addorderby" class="header-anchor">#</a> <code>addOrderBy</code></h4>
73-
74-
Adds additional ORDER BY columns to the query.
75-
76-
77-
78-
79-
80-
81-
82-
83-
84-
8570
<h4 id="product-after"><a href="#product-after" class="header-anchor">#</a> <code>after</code></h4>
8671

8772
Narrows the query results to only products that were posted on or after a certain date.
@@ -556,45 +541,6 @@ $products = \craft\commerce\elements\Product::find()
556541
:::
557542

558543

559-
<h4 id="product-fields"><a href="#product-fields" class="header-anchor">#</a> <code>fields</code></h4>
560-
561-
Returns the list of fields that should be returned by default by [toArray()](https://www.yiiframework.com/doc/api/2.0/yii-base-arrayabletrait#toArray()-detail) when no specific fields are specified.
562-
563-
A field is a named element in the returned array by [toArray()](https://www.yiiframework.com/doc/api/2.0/yii-base-arrayabletrait#toArray()-detail).
564-
This method should return an array of field names or field definitions.
565-
If the former, the field name will be treated as an object property name whose value will be used
566-
as the field value. If the latter, the array key should be the field name while the array value should be
567-
the corresponding field definition which can be either an object property name or a PHP callable
568-
returning the corresponding field value. The signature of the callable should be:
569-
570-
```php
571-
function ($model, $field) {
572-
// return field value
573-
}
574-
```
575-
576-
For example, the following code declares four fields:
577-
578-
- `email`: the field name is the same as the property name `email`;
579-
- `firstName` and `lastName`: the field names are `firstName` and `lastName`, and their
580-
values are obtained from the `first_name` and `last_name` properties;
581-
- `fullName`: the field name is `fullName`. Its value is obtained by concatenating `first_name`
582-
and `last_name`.
583-
584-
```php
585-
return [
586-
'email',
587-
'firstName' => 'first_name',
588-
'lastName' => 'last_name',
589-
'fullName' => function ($model) {
590-
return $model->first_name . ' ' . $model->last_name;
591-
},
592-
];
593-
```
594-
595-
596-
597-
598544
<h4 id="product-fixedorder"><a href="#product-fixedorder" class="header-anchor">#</a> <code>fixedOrder</code></h4>
599545

600546
Causes the query results to be returned in the order specified by [id](#product-id).

‎docs/.artifacts/commerce/5.x/subscriptions.md‎

Lines changed: 0 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@
88

99
| Param | Description
1010
| ------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
11-
| [addOrderBy](#addorderby) | Adds additional ORDER BY columns to the query.
1211
| [afterPopulate](#afterpopulate) | Performs any post-population processing on elements.
1312
| [andRelatedTo](#andrelatedto) | Narrows the query results to only subscriptions that are related to certain other elements.
1413
| [asArray](#asarray) | Causes the query to return matching subscriptions as arrays of data, rather than [Subscription](commerce5:craft\commerce\elements\Subscription) objects.
@@ -20,7 +19,6 @@
2019
| [dateSuspended](#datesuspended) | Narrows the query results based on the subscriptions’ suspension date.
2120
| [dateUpdated](#dateupdated) | Narrows the query results based on the subscriptions’ last-updated dates.
2221
| [eagerly](#eagerly) | Causes the query to be used to eager-load results for the query’s source element and any other elements in its collection.
23-
| [fields](#fields) | Returns the list of fields that should be returned by default by [toArray()](https://www.yiiframework.com/doc/api/2.0/yii-base-arrayabletrait#toArray()-detail) when no specific fields are specified.
2422
| [fixedOrder](#fixedorder) | Causes the query results to be returned in the order specified by [id](#id).
2523
| [gatewayId](#gatewayid) | Narrows the query results based on the gateway, per its ID.
2624
| [hasStarted](#hasstarted) | Narrows the query results to only subscriptions that have started.
@@ -63,19 +61,6 @@
6361
<!-- textlint-enable -->
6462

6563

66-
#### `addOrderBy`
67-
68-
Adds additional ORDER BY columns to the query.
69-
70-
71-
72-
73-
74-
75-
76-
77-
78-
7964
#### `afterPopulate`
8065

8166
Performs any post-population processing on elements.
@@ -361,45 +346,6 @@ and any other elements in its collection.
361346

362347

363348

364-
#### `fields`
365-
366-
Returns the list of fields that should be returned by default by [toArray()](https://www.yiiframework.com/doc/api/2.0/yii-base-arrayabletrait#toArray()-detail) when no specific fields are specified.
367-
368-
A field is a named element in the returned array by [toArray()](https://www.yiiframework.com/doc/api/2.0/yii-base-arrayabletrait#toArray()-detail).
369-
This method should return an array of field names or field definitions.
370-
If the former, the field name will be treated as an object property name whose value will be used
371-
as the field value. If the latter, the array key should be the field name while the array value should be
372-
the corresponding field definition which can be either an object property name or a PHP callable
373-
returning the corresponding field value. The signature of the callable should be:
374-
375-
```php
376-
function ($model, $field) {
377-
// return field value
378-
}
379-
```
380-
381-
For example, the following code declares four fields:
382-
383-
- `email`: the field name is the same as the property name `email`;
384-
- `firstName` and `lastName`: the field names are `firstName` and `lastName`, and their
385-
values are obtained from the `first_name` and `last_name` properties;
386-
- `fullName`: the field name is `fullName`. Its value is obtained by concatenating `first_name`
387-
and `last_name`.
388-
389-
```php
390-
return [
391-
'email',
392-
'firstName' => 'first_name',
393-
'lastName' => 'last_name',
394-
'fullName' => function ($model) {
395-
return $model->first_name . ' ' . $model->last_name;
396-
},
397-
];
398-
```
399-
400-
401-
402-
403349
#### `fixedOrder`
404350

405351
Causes the query results to be returned in the order specified by [id](#id).

0 commit comments

Comments
 (0)