Skip to content

Commit

Permalink
commerce@fdaf2a3
Browse files Browse the repository at this point in the history
Finish 5.0.16
  • Loading branch information
shinybrad committed Aug 14, 2024
1 parent cba1744 commit 354c40d
Show file tree
Hide file tree
Showing 3 changed files with 0 additions and 162 deletions.
54 changes: 0 additions & 54 deletions docs/.artifacts/commerce/5.x/orders-carts.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@

| Param | Description
| --------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
| [addOrderBy](#addorderby) | Adds additional ORDER BY columns to the query.
| [afterPopulate](#afterpopulate) | Performs any post-population processing on elements.
| [andRelatedTo](#andrelatedto) | Narrows the query results to only orders that are related to certain other elements.
| [asArray](#asarray) | Causes the query to return matching orders as arrays of data, rather than [Order](commerce5:craft\commerce\elements\Order) objects.
Expand All @@ -24,7 +23,6 @@
| [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.
| [email](#email) | Narrows the query results based on the customers’ email addresses.
| [expiryDate](#expirydate) | Narrows the query results based on the orders’ expiry dates.
| [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.
| [fixedOrder](#fixedorder) | Causes the query results to be returned in the order specified by [id](#id).
| [gateway](#gateway) | Narrows the query results based on the gateway.
| [gatewayId](#gatewayid) | Narrows the query results based on the gateway, per its ID.
Expand Down Expand Up @@ -85,19 +83,6 @@
<!-- textlint-enable -->


#### `addOrderBy`

Adds additional ORDER BY columns to the query.










#### `afterPopulate`

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


#### `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.

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).
This method should return an array of field names or field definitions.
If the former, the field name will be treated as an object property name whose value will be used
as the field value. If the latter, the array key should be the field name while the array value should be
the corresponding field definition which can be either an object property name or a PHP callable
returning the corresponding field value. The signature of the callable should be:

```php
function ($model, $field) {
// return field value
}
```

For example, the following code declares four fields:

- `email`: the field name is the same as the property name `email`;
- `firstName` and `lastName`: the field names are `firstName` and `lastName`, and their
values are obtained from the `first_name` and `last_name` properties;
- `fullName`: the field name is `fullName`. Its value is obtained by concatenating `first_name`
and `last_name`.

```php
return [
'email',
'firstName' => 'first_name',
'lastName' => 'last_name',
'fullName' => function ($model) {
return $model->first_name . ' ' . $model->last_name;
},
];
```




#### `fixedOrder`

Causes the query results to be returned in the order specified by [id](#id).
Expand Down
54 changes: 0 additions & 54 deletions docs/.artifacts/commerce/5.x/products-variants.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ Product queries support the following parameters:

| Param | Description
| --------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
| [addOrderBy](#product-addorderby) | Adds additional ORDER BY columns to the query.
| [after](#product-after) | Narrows the query results to only products that were posted on or after a certain date.
| [afterPopulate](#product-afterpopulate) | Performs any post-population processing on elements.
| [andRelatedTo](#product-andrelatedto) | Narrows the query results to only products that are related to certain other elements.
Expand All @@ -30,7 +29,6 @@ Product queries support the following parameters:
| [defaultWidth](#product-defaultwidth) | Narrows the query results based on the products’ default variant width dimension IDs.
| [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.
| [expiryDate](#product-expirydate) | Narrows the query results based on the products’ expiry dates.
| [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.
| [fixedOrder](#product-fixedorder) | Causes the query results to be returned in the order specified by [id](#product-id).
| [hasVariant](#product-hasvariant) | Narrows the query results to only products that have certain variants.
| [id](#product-id) | Narrows the query results based on the products’ IDs.
Expand Down Expand Up @@ -69,19 +67,6 @@ Product queries support the following parameters:
<!-- textlint-enable -->


<h4 id="product-addorderby"><a href="#product-addorderby" class="header-anchor">#</a> <code>addOrderBy</code></h4>

Adds additional ORDER BY columns to the query.










<h4 id="product-after"><a href="#product-after" class="header-anchor">#</a> <code>after</code></h4>

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


<h4 id="product-fields"><a href="#product-fields" class="header-anchor">#</a> <code>fields</code></h4>

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.

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).
This method should return an array of field names or field definitions.
If the former, the field name will be treated as an object property name whose value will be used
as the field value. If the latter, the array key should be the field name while the array value should be
the corresponding field definition which can be either an object property name or a PHP callable
returning the corresponding field value. The signature of the callable should be:

```php
function ($model, $field) {
// return field value
}
```

For example, the following code declares four fields:

- `email`: the field name is the same as the property name `email`;
- `firstName` and `lastName`: the field names are `firstName` and `lastName`, and their
values are obtained from the `first_name` and `last_name` properties;
- `fullName`: the field name is `fullName`. Its value is obtained by concatenating `first_name`
and `last_name`.

```php
return [
'email',
'firstName' => 'first_name',
'lastName' => 'last_name',
'fullName' => function ($model) {
return $model->first_name . ' ' . $model->last_name;
},
];
```




<h4 id="product-fixedorder"><a href="#product-fixedorder" class="header-anchor">#</a> <code>fixedOrder</code></h4>

Causes the query results to be returned in the order specified by [id](#product-id).
Expand Down
54 changes: 0 additions & 54 deletions docs/.artifacts/commerce/5.x/subscriptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@

| Param | Description
| ------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
| [addOrderBy](#addorderby) | Adds additional ORDER BY columns to the query.
| [afterPopulate](#afterpopulate) | Performs any post-population processing on elements.
| [andRelatedTo](#andrelatedto) | Narrows the query results to only subscriptions that are related to certain other elements.
| [asArray](#asarray) | Causes the query to return matching subscriptions as arrays of data, rather than [Subscription](commerce5:craft\commerce\elements\Subscription) objects.
Expand All @@ -20,7 +19,6 @@
| [dateSuspended](#datesuspended) | Narrows the query results based on the subscriptions’ suspension date.
| [dateUpdated](#dateupdated) | Narrows the query results based on the subscriptions’ last-updated dates.
| [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.
| [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.
| [fixedOrder](#fixedorder) | Causes the query results to be returned in the order specified by [id](#id).
| [gatewayId](#gatewayid) | Narrows the query results based on the gateway, per its ID.
| [hasStarted](#hasstarted) | Narrows the query results to only subscriptions that have started.
Expand Down Expand Up @@ -63,19 +61,6 @@
<!-- textlint-enable -->


#### `addOrderBy`

Adds additional ORDER BY columns to the query.










#### `afterPopulate`

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



#### `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.

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).
This method should return an array of field names or field definitions.
If the former, the field name will be treated as an object property name whose value will be used
as the field value. If the latter, the array key should be the field name while the array value should be
the corresponding field definition which can be either an object property name or a PHP callable
returning the corresponding field value. The signature of the callable should be:

```php
function ($model, $field) {
// return field value
}
```

For example, the following code declares four fields:

- `email`: the field name is the same as the property name `email`;
- `firstName` and `lastName`: the field names are `firstName` and `lastName`, and their
values are obtained from the `first_name` and `last_name` properties;
- `fullName`: the field name is `fullName`. Its value is obtained by concatenating `first_name`
and `last_name`.

```php
return [
'email',
'firstName' => 'first_name',
'lastName' => 'last_name',
'fullName' => function ($model) {
return $model->first_name . ' ' . $model->last_name;
},
];
```




#### `fixedOrder`

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

0 comments on commit 354c40d

Please sign in to comment.