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.

View source

Public Properties

PropertyDescription
$behaviorsyii\base\Behavior – List of behaviors attached to this component

Public Methods

MethodDescription
__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 an object property.
__isset()Checks if a property is set, i.e. defined and not null.
__set()Sets value of an object property.
__unset()Sets an object property to 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.
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.
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.

View source

Arguments

  • $productId (integer) – Product ID
  • $siteId (integer, null) – Site ID for which to return the variants. Defaults to null which is current site.

Returns

craft\commerce\elements\Variant[]

Signature

public craft\commerce\elements\Variant[] getAllVariantsByProductId ( \craft\commerce\services\int $productId, \craft\commerce\services\int $siteId = null )

getVariantById()

Returns a variant by its ID.

View source

Arguments

  • $variantId (integer) – The variant’s ID.
  • $siteId (integer, null) – The site ID for which to fetch the variant. Defaults to null which is current site.

Returns

craft\base\ElementInterface, null

Signature

public craft\base\ElementInterface, null getVariantById ( \craft\commerce\services\int $variantId, \craft\commerce\services\int $siteId = null )