Cart Class Reference

Inheritance diagram for Cart:

Public Member Functions
	__construct (\Magento\Framework\App\Helper\Context $context, \Magento\Checkout\Model\Cart $checkoutCart, \Magento\Checkout\Model\Session $checkoutSession)
	getCart ()
	getAddUrl ($product, $additional=[])
	getRemoveUrl ($item)
	getDeletePostJson ($item)
	getCartUrl ()
	getQuote ()
	getItemsCount ()
	getItemsQty ()
	getSummaryCount ()
	getIsVirtualQuote ()
	getShouldRedirectToCart ($store=null)
Public Member Functions inherited from Data
	getCurrentBase64Url ()
	getEncodedUrl ($url=null)
	addRequestParam ($url, $param)
	removeRequestParam ($url, $paramKey, $caseSensitive=false)
Public Member Functions inherited from AbstractHelper
	__construct (Context $context)
	isModuleOutputEnabled ($moduleName=null)

Data Fields
const	DELETE_URL = 'checkout/cart/delete'
const	XML_PATH_REDIRECT_TO_CART = 'checkout/cart/redirect_to_cart'
const	COUPON_CODE_MAX_LENGTH = 255

Protected Attributes
	$_checkoutCart
	$_checkoutSession
Protected Attributes inherited from AbstractHelper
	$_moduleName
	$_request
	$_moduleManager
	$_logger
	$_urlBuilder
	$_httpHeader
	$_eventManager
	$_remoteAddress
	$urlEncoder
	$urlDecoder
	$scopeConfig
	$_cacheConfig

Additional Inherited Members
Protected Member Functions inherited from AbstractHelper
	_getRequest ()
	_getModuleName ()
	_getUrl ($route, $params=[])

Detailed Description

Shopping cart helper

Author

Magento Core Team core@.nosp@m.mage.nosp@m.ntoco.nosp@m.mmer.nosp@m.ce.co.nosp@m.m

Definition at line 13 of file Cart.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\App\Helper\Context	$context,
		\Magento\Checkout\Model\Cart	$checkoutCart,
		\Magento\Checkout\Model\Session	$checkoutSession
	)

Parameters

\Magento\Framework\App\Helper\Context	$context
\Magento\Checkout\Model\Cart	$checkoutCart
\Magento\Checkout\Model\Session	$checkoutSession	@codeCoverageIgnore

Definition at line 46 of file Cart.php.

      {
        $this->_checkoutCart = $checkoutCart;
        $this->_checkoutSession = $checkoutSession;
        parent::__construct($context);
    }

Member Function Documentation

getAddUrl()

getAddUrl	(		$product,
			$additional = []
	)

Retrieve url for add product to cart

Parameters

\Magento\Catalog\Model\Product	$product
array	$additional

Returns

string

Definition at line 74 of file Cart.php.

    {
        if (isset($additional['useUencPlaceholder'])) {
            $uenc = "%uenc%";
            unset($additional['useUencPlaceholder']);
        } else {
            $uenc = $this->urlEncoder->encode($this->_urlBuilder->getCurrentUrl());
        }

        $urlParamName = \Magento\Framework\App\ActionInterface::PARAM_NAME_URL_ENCODED;

        $routeParams = [
            $urlParamName => $uenc,
            'product' => $product->getEntityId(),
            '_secure' => $this->_getRequest()->isSecure()
        ];

        if (!empty($additional)) {
            $routeParams = array_merge($routeParams, $additional);
        }

        if ($product->hasUrlDataObject()) {
            $routeParams['_scope'] = $product->getUrlDataObject()->getStoreId();
            $routeParams['_scope_to_url'] = true;
        }

        if ($this->_getRequest()->getRouteName() == 'checkout'
            && $this->_getRequest()->getControllerName() == 'cart'
        ) {
            $routeParams['in_cart'] = 1;
        }

        return $this->_getUrl('checkout/cart/add', $routeParams);
    }

getCart()

getCart

(

)

Retrieve cart instance

Returns

\Magento\Checkout\Model\Cart @codeCoverageIgnore

Definition at line 62 of file Cart.php.

    {
        return $this->_checkoutCart;
    }

getCartUrl()

getCartUrl

(

)

Retrieve shopping cart url

Returns

string @codeCoverageIgnore

Definition at line 147 of file Cart.php.

    {
        return $this->_getUrl('checkout/cart');
    }

getDeletePostJson()

getDeletePostJson

(

$item

)

Get post parameters for delete from cart

Parameters

\Magento\Quote\Model\Quote\Item\AbstractItem

$item

Returns

string

Definition at line 130 of file Cart.php.

    {
        $url = $this->_getUrl(self::DELETE_URL);

        $data = ['id' => $item->getId()];
        if (!$this->_request->isAjax()) {
            $data[\Magento\Framework\App\ActionInterface::PARAM_NAME_URL_ENCODED] = $this->getCurrentBase64Url();
        }
        return json_encode(['action' => $url, 'data' => $data]);
    }

getIsVirtualQuote()

getIsVirtualQuote

(

)

Check quote for virtual products only

Returns

bool @SuppressWarnings(PHPMD.BooleanGetMethodName) @codeCoverageIgnore

Definition at line 203 of file Cart.php.

    {
        return $this->getQuote()->isVirtual();
    }

getItemsCount()

getItemsCount

(

)

Get shopping cart items count

Returns

int @codeCoverageIgnore

Definition at line 169 of file Cart.php.

    {
        return $this->getCart()->getItemsCount();
    }

getItemsQty()

getItemsQty

(

)

Get shopping cart summary qty

Returns

int|float @codeCoverageIgnore

Definition at line 180 of file Cart.php.

    {
        return $this->getCart()->getItemsQty();
    }

getQuote()

getQuote

(

)

Retrieve current quote instance

Returns

\Magento\Quote\Model\Quote @codeCoverageIgnore

Definition at line 158 of file Cart.php.

    {
        return $this->_checkoutSession->getQuote();
    }

getRemoveUrl()

getRemoveUrl

(

$item

)

Retrieve url for remove product from cart

Parameters

\Magento\Quote\Model\Quote\Item\AbstractItem

$item

Returns

string

Definition at line 115 of file Cart.php.

    {
        $params = [
            'id' => $item->getId(),
            \Magento\Framework\App\ActionInterface::PARAM_NAME_BASE64_URL => $this->getCurrentBase64Url(),
        ];
        return $this->_getUrl(self::DELETE_URL, $params);
    }

getShouldRedirectToCart()

getShouldRedirectToCart

(

$store = null

)

Checks if customer should be redirected to shopping cart after adding a product

Parameters

int | string | \Magento\Store\Model\Store

$store

Returns

bool @SuppressWarnings(PHPMD.BooleanGetMethodName) @codeCoverageIgnore

Definition at line 216 of file Cart.php.

    {
        return $this->scopeConfig->isSetFlag(
            self::XML_PATH_REDIRECT_TO_CART,
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
            $store
        );
    }

getSummaryCount()

getSummaryCount

(

)

Get shopping cart items summary (include config settings)

Returns

int|float @codeCoverageIgnore

Definition at line 191 of file Cart.php.

    {
        return $this->getCart()->getSummaryQty();
    }

Field Documentation

$_checkoutCart

$_checkoutCart

protected

Definition at line 33 of file Cart.php.

$_checkoutSession

$_checkoutSession

protected

Definition at line 38 of file Cart.php.

COUPON_CODE_MAX_LENGTH

const COUPON_CODE_MAX_LENGTH = 255

Maximal coupon code length according to database table definitions (longer codes are truncated)

Definition at line 28 of file Cart.php.

DELETE_URL

const DELETE_URL = 'checkout/cart/delete'

Path to controller to delete item from cart

Definition at line 18 of file Cart.php.

XML_PATH_REDIRECT_TO_CART

const XML_PATH_REDIRECT_TO_CART = 'checkout/cart/redirect_to_cart'

Path for redirect to cart

Definition at line 23 of file Cart.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/module-checkout/Helper/Cart.php