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. This manages the cart currently in the session, this service should mainly be used by web controller actions.
View source (opens new window)
# 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 |
| cartCookie | array (opens new window) – The configuration of the cart cookie. |
| cartCookieDuration | integer (opens new window) – The expiration duration of the cart cookie, in seconds. |
| cartName | |
| hasSessionCartNumber | boolean (opens new window) |
| sessionCartNumber | string (opens new window), mixed |
# activeCartEdgeDuration
- Type
- string (opens new window)
- Default value
null
View source (opens new window)
# cart
- Type
- craft\commerce\elements\Order
- Default value
null
View source (opens new window)
# cartCookie
- Type
- array (opens new window)
- Default value
[]- Since
- 4.0.0
The configuration of the cart cookie.
See also setSessionCartNumber()
View source (opens new window)
# cartCookieDuration
- Type
- integer (opens new window)
- Default value
31536000- Since
- 4.0.0
The expiration duration of the cart cookie, in seconds. (Defaults to one year.)
See also setSessionCartNumber()
View source (opens new window)
# cartName
- Default value
null- Access
- Read-only
- Since
- 3.1
View source (opens new window)
# hasSessionCartNumber
- Type
- boolean (opens new window)
- Default value
null
View source (opens new window)
# sessionCartNumber
- Type
- string (opens new window),
mixed - Default value
null
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 a component property. |
| __isset() (opens new window) | Checks if a property is set, i.e. defined and not null. |
| __set() (opens new window) | Sets the value of a component property. |
| __unset() (opens new window) | Sets a component property to be 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 the cart in the current session. |
| generateCartNumber() | Generates a new random cart number and returns it. |
| getActiveCartEdgeDuration() | Calculates the date of the active cart duration edge. |
| 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. |
| getCartName() | |
| getHasSessionCartNumber() | Returns whether there is a cart number in the session. |
| 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 for this component. |
| init() | Initializes the cart service |
| 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. |
| restorePreviousCartForCurrentUser() | Restores previous cart for the current user if their current cart is empty. |
| setSessionCartNumber() | Set the session cart number. |
| trigger() (opens new window) | Triggers an event. |
# forgetCart()
Forgets the cart in the current session.
View source (opens new window)
# generateCartNumber()
- Since
- 2.0
Generates a new random cart number and returns it.
View source (opens new window)
# getActiveCartEdgeDuration()
- Since
- 2.2
Calculates the date of the active cart duration edge.
View source (opens new window)
Throws
# getCart()
Get the current cart for this session.
View source (opens new window)
Arguments
$forceSave(boolean (opens new window)) – Force the cart to save when requesting it.
Throws
- craft\errors\ElementNotFoundException (opens new window)
- yii\base\Exception (opens new window)
- Throwable (opens new window)
# getCartName()
DEPRECATED
Deprecated in 4.0.0. The cookie name is available via cartCookie ['name'].
- Since
- 3.1
View source (opens new window)
# getHasSessionCartNumber()
- Since
- 2.1.11
Returns whether there is a cart number in the session.
View source (opens new window)
Throws
# init()
Initializes the cart service
View source (opens new window)
Returns
void
Throws
# purgeIncompleteCarts()
Removes all carts that are incomplete and older than the config setting.
View source (opens new window)
Returns
integer (opens new window) – The number of carts purged from the database
Throws
# restorePreviousCartForCurrentUser()
Restores previous cart for the current user if their current cart is empty.
Ideally this is only used when a user logs in.
View source (opens new window)
Throws
- craft\errors\ElementNotFoundException (opens new window)
- yii\base\Exception (opens new window)
- craft\errors\MissingComponentException (opens new window)
- Throwable (opens new window)
# setSessionCartNumber()
Set the session cart number.
View source (opens new window)
Arguments
$cartNumber
# Protected Methods
| Method | Description |
|---|---|
| getSessionCartNumber() | Get the session cart number or generates one if none exists. |
# getSessionCartNumber()
Get the session cart number or generates one if none exists.