Variants ​
- Type
- Class
- Namespace
- craft\commerce\services
- Inherits
- craft\commerce\services\Variants » yii\base\Component » yii\base\BaseObject
- Implements
- yii\base\Configurable
- Since
- 2.0
Variant service.
Public Properties ​
| Property | Description |
|---|---|
| behaviors | yii\base\Behavior – List of behaviors attached to this component. |
| variantGqlContentArguments |
variantGqlContentArguments ​
- Default value
null- Access
- Read-only
- Since
- 3.1.4
Public Methods ​
| Method | Description |
|---|---|
| __call() | Calls the named method which is not a class method. |
| __clone() | This method is called after the object is created by cloning an existing one. |
| __construct() | Constructor. |
| __get() | Returns the value of a component property. |
| __isset() | Checks if a property is set, i.e. defined and not null. |
| __set() | Sets the value of a component property. |
| __unset() | Sets a component property to be null. |
| attachBehavior() | Attaches a behavior to this component. |
| attachBehaviors() | Attaches a list of behaviors to the component. |
| behaviors() | Returns a list of behaviors that this component should behave as. |
| 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. |
| detachBehavior() | Detaches a behavior from the component. |
| detachBehaviors() | Detaches all behaviors from the component. |
| ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. |
| getAllVariantsByProductId() | Returns a product's variants, per the product's ID. |
| getBehavior() | Returns the named behavior object. |
| getBehaviors() | Returns all behaviors attached to this component. |
| getVariantById() | Returns a variant by its ID. |
| getVariantGqlContentArguments() | |
| hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. |
| hasMethod() | Returns a value indicating whether a method is defined. |
| hasProperty() | Returns a value indicating whether a property is defined for this component. |
| init() | Initializes the object. |
| off() | Detaches an existing event handler from this component. |
| on() | Attaches an event handler to an event. |
| trigger() | Triggers an event. |
getAllVariantsByProductId() ​
Returns a product's variants, per the product's ID.
Arguments ​
$productId(integer) – Product ID$siteId(integer, null) – Site ID for which to return the variants. Defaults tonullwhich is current site.$includeDisabled
Returns ​
craft\commerce\elements\Variant[]
getVariantById() ​
Returns a variant by its ID.
Arguments ​
$variantId(integer) – The variant’s ID.$siteId(integer, null) – The site ID for which to fetch the variant. Defaults tonullwhich is current site.
getVariantGqlContentArguments() ​
- Since
- 3.1.4