Carts

Type: Class
Namespace: craft\commerce\services
Inherits: craft\commerce\services\Carts » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
Implements: yii\base\Configurable (opens new window)
Since: 2.0

Cart service.

# Public Properties

Property	Description
activeCartEdgeDuration	string (opens new window)
behaviors (opens new window)	yii\base\Behavior (opens new window) – List of behaviors attached to this component
cart	craft\commerce\elements\Order
hasSessionCartNumber	boolean (opens new window)
mergedCart	craft\commerce\elements\Order

# `activeCartEdgeDuration`

Type: string (opens new window)
Access: Read-only
Since: 2.2

View source (opens new window)

# `cart`

Type: craft\commerce\elements\Order
Access: Read-only

View source (opens new window)

# `hasSessionCartNumber`

Type: boolean (opens new window)
Access: Read-only
Since: 2.1.11

View source (opens new window)

# `mergedCart`

Type: craft\commerce\elements\Order
Access: Read-only

View source (opens new window)

# Protected Properties

Property	Description
cartName	string (opens new window) – Session key for storing the cart number

# `cartName`

Type: string (opens new window)

Session key for storing the cart number

View source (opens new window)

# Public Methods

Method	Description
__call() (opens new window)	Calls the named method which is not a class method.
__clone() (opens new window)	This method is called after the object is created by cloning an existing one.
__construct() (opens new window)	Constructor.
__get() (opens new window)	Returns the value of an object property.
__isset() (opens new window)	Checks if a property is set, i.e. defined and not null.
__set() (opens new window)	Sets value of an object property.
__unset() (opens new window)	Sets an object property to null.
attachBehavior() (opens new window)	Attaches a behavior to this component.
attachBehaviors() (opens new window)	Attaches a list of behaviors to the component.
behaviors() (opens new window)	Returns a list of behaviors that this component should behave as.
canGetProperty() (opens new window)	Returns a value indicating whether a property can be read.
canSetProperty() (opens new window)	Returns a value indicating whether a property can be set.
className() (opens new window)	Returns the fully qualified name of this class.
detachBehavior() (opens new window)	Detaches a behavior from the component.
detachBehaviors() (opens new window)	Detaches all behaviors from the component.
ensureBehaviors() (opens new window)	Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component.
forgetCart()	Forgets a Cart
generateCartNumber()	Generate a cart number and return it.
getActiveCartEdgeDuration()
getBehavior() (opens new window)	Returns the named behavior object.
getBehaviors() (opens new window)	Returns all behaviors attached to this component.
getCart()	Get the current cart for this session.
getHasSessionCartNumber()	Returns whether there is a cart number in the session.
getMergedCart()	Returns the current cart with the contents of any previous carts for the current user merged in.
hasEventHandlers() (opens new window)	Returns a value indicating whether there is any handler attached to the named event.
hasMethod() (opens new window)	Returns a value indicating whether a method is defined.
hasProperty() (opens new window)	Returns a value indicating whether a property is defined.
init() (opens new window)	Initializes the object.
off() (opens new window)	Detaches an existing event handler from this component.
on() (opens new window)	Attaches an event handler to an event.
purgeIncompleteCarts()	Removes all carts that are incomplete and older than the config setting.
trigger() (opens new window)	Triggers an event.