Carts

Type
Class
Namespace
craft\commerce\services
Inherits
craft\commerce\services\Carts » yii\base\Component » yii\base\BaseObject
Implements
yii\base\Configurable
Since
2.0

Cart service.

View source

Public Properties

PropertyDescription
$behaviorsyii\base\Behavior – List of behaviors attached to this component
$cartcraft\commerce\elements\Order

$cart

Signature

public craft\commerce\elements\Order getCart ( $forceSave = false )

Protected Properties

PropertyDescription
$cartNamestring – Session key for storing the cart number

$cartName

Type
string

Session key for storing the cart number

View source

Signature

protected string $cartName = 'commerce_cart'

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.
forgetCart()Forgets a Cart
generateCartNumber()Generate a cart number and return it.
getBehavior()Returns the named behavior object.
getBehaviors()Returns all behaviors attached to this component.
getCart()Get the current cart for this session.
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.
purgeIncompleteCarts()Removes all carts that are incomplete and older than the config setting.
trigger()Triggers an event.

forgetCart()

Forgets a Cart

View source

Returns

void

Signature

public void forgetCart ( )

generateCartNumber()

Generate a cart number and return it.

View source

Returns

string

Signature

public string generateCartNumber ( )

getCart()

Get the current cart for this session.

View source

Arguments

  • $forceSave (boolean) – Force the cart to save when requesting it.

Returns

craft\commerce\elements\Order

Throws

Signature

public craft\commerce\elements\Order getCart ( $forceSave = false )

purgeIncompleteCarts()

Removes all carts that are incomplete and older than the config setting.

View source

Returns

integer – The number of carts purged from the database

Throws

Signature

public integer purgeIncompleteCarts ( )