Inheritance diagram for Cart:

Public Member Functions
	__construct (\Magento\Framework\View\Element\Template\Context $context, \Magento\Customer\Model\Session $customerSession, \Magento\Checkout\Model\Session $checkoutSession, \Magento\Catalog\Model\ResourceModel\Url $catalogUrlBuilder, \Magento\Checkout\Helper\Cart $cartHelper, \Magento\Framework\App\Http\Context $httpContext, array $data=[])

	prepareItemUrls ()

	hasError ()

	getItemsSummaryQty ()

	isWishlistActive ()

	getCheckoutUrl ()

	getContinueShoppingUrl ()

	getIsVirtual ()

	getMethods ($alias)

	getMethodHtml ($name)

	getItems ()

	getItemsCount ()

	getPagerHtml ()

Public Member Functions inherited from AbstractCart
	__construct (\Magento\Framework\View\Element\Template\Context $context, \Magento\Customer\Model\Session $customerSession, \Magento\Checkout\Model\Session $checkoutSession, array $data=[])

	getItemRenderer ($type=null)

	getQuote ()

	getItems ()

	getItemHtml (\Magento\Quote\Model\Quote\Item $item)

	getTotals ()

	getTotalsCache ()

Public Member Functions inherited from Template
	__construct (Template\Context $context, array $data=[])

	setTemplateContext ($templateContext)

	getTemplate ()

	setTemplate ($template)

	getTemplateFile ($template=null)

	getArea ()

	assign ($key, $value=null)

	fetchView ($fileName)

	getBaseUrl ()

	getObjectData (\Magento\Framework\DataObject $object, $key)

	getCacheKeyInfo ()

Public Member Functions inherited from AbstractBlock
	__construct (\Magento\Framework\View\Element\Context $context, array $data=[])

	getJsLayout ()

	getRequest ()

	getParentBlock ()

	setLayout (\Magento\Framework\View\LayoutInterface $layout)

	getLayout ()

	setNameInLayout ($name)

	getChildNames ()

	setAttribute ($name, $value=null)

	setChild ($alias, $block)

	addChild ($alias, $block, $data=[])

	unsetChild ($alias)

	unsetCallChild ($alias, $callback, $result, $params)

	unsetChildren ()

	getChildBlock ($alias)

	getChildHtml ($alias='', $useCache=true)

	getChildChildHtml ($alias, $childChildAlias='', $useCache=true)

	getBlockHtml ($name)

	insert ($element, $siblingName=0, $after=true, $alias='')

	append ($element, $alias='')

	getGroupChildNames ($groupName)

	getChildData ($alias, $key='')

	getUiId ($arg1=null, $arg2=null, $arg3=null, $arg4=null, $arg5=null)

	getJsId ($arg1=null, $arg2=null, $arg3=null, $arg4=null, $arg5=null)

	getUrl ($route='', $params=[])

	getViewFileUrl ($fileId, array $params=[])

	formatDate ( $date=null, $format=\IntlDateFormatter::SHORT, $showTime=false, $timezone=null)

	formatTime ( $time=null, $format=\IntlDateFormatter::SHORT, $showDate=false)

	getModuleName ()

	escapeHtml ($data, $allowedTags=null)

	escapeJs ($string)

	escapeHtmlAttr ($string, $escapeSingleQuote=true)

	escapeCss ($string)

	stripTags ($data, $allowableTags=null, $allowHtmlEntities=false)

	escapeUrl ($string)

	escapeXssInUrl ($data)

	escapeQuote ($data, $addSlashes=false)

	escapeJsQuote ($data, $quote='\'')

	getNameInLayout ()

	getCacheKeyInfo ()

	getCacheKey ()

	getVar ($name, $module=null)

	isScopePrivate ()

Public Member Functions inherited from DataObject
	__construct (array $data=[])

	addData (array $arr)

	setData ($key, $value=null)

	unsetData ($key=null)

	getData ($key='', $index=null)

	getDataByPath ($path)

	getDataByKey ($key)

	setDataUsingMethod ($key, $args=[])

	getDataUsingMethod ($key, $args=null)

	hasData ($key='')

	toArray (array $keys=[])

	convertToArray (array $keys=[])

	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	toJson (array $keys=[])

	convertToJson (array $keys=[])

	toString ($format='')

	__call ($method, $args)

	isEmpty ()

	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')

	debug ($data=null, &$objects=[])

	offsetSet ($offset, $value)

	offsetExists ($offset)

	offsetUnset ($offset)

	offsetGet ($offset)

Public Member Functions inherited from BlockInterface
	toHtml ()

Protected Member Functions
	_construct ()

Protected Member Functions inherited from AbstractCart
	_getRendererList ()

Protected Member Functions inherited from Template
	_construct ()

	_toHtml ()

	getRootDirectory ()

	getMediaDirectory ()

Protected Member Functions inherited from AbstractBlock
	_construct ()

	_prepareLayout ()

	_beforeToHtml ()

	_afterToHtml ($html)

	_toHtml ()

	_getNotFoundUrl ($route='', $params=['_direct'=> 'core/index/notFound'])

	getCacheTags ()

	getCacheLifetime ()

	_loadCache ()

	_saveCache ($data)

	_getSidPlaceholder ($cacheKey=null)

Protected Member Functions inherited from DataObject
	_getData ($key)

	_underscore ($name)

Protected Attributes
	$_catalogUrlBuilder

	$httpContext

	$_cartHelper

Protected Attributes inherited from AbstractCart
	$_quote = null

	$_totals

	$_itemRenders = []

	$_customerSession

	$_checkoutSession

Protected Attributes inherited from Template
	$_viewVars = []

	$_baseUrl

	$_jsUrl

	$_allowSymlinks

	$_filesystem

	$_template

	$templateEnginePool

	$_storeManager

	$_appState

	$directory

	$templateContext

	$pageConfig

	$resolver

	$validator

Protected Attributes inherited from AbstractBlock
	$_design

	$_session

	$_sidResolver

	$_nameInLayout

	$_layout

	$jsLayout = []

	$_request

	$_urlBuilder

	$_eventManager

	$_frontController

	$_assetRepo

	$_viewConfig

	$_cacheState

	$_logger

	$_escaper

	$filterManager

	$_localeDate

	$inlineTranslation

	$_isScopePrivate = false

	$_scopeConfig

	$_cache

Protected Attributes inherited from DataObject
	$_data = []

Additional Inherited Members
Static Public Member Functions inherited from AbstractBlock
static	extractModuleName ($className)

Data Fields inherited from AbstractCart
const	DEFAULT_TYPE = 'default'

Data Fields inherited from Template
const	XML_PATH_TEMPLATE_ALLOW_SYMLINK = 'dev/template/allow_symlink'

Data Fields inherited from AbstractBlock
const	CACHE_GROUP = \Magento\Framework\App\Cache\Type\Block::TYPE_IDENTIFIER

const	CACHE_KEY_PREFIX = 'BLOCK_'

Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Shopping cart block

@api

Since: 100.0.2

Definition at line 16 of file Cart.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\View\Element\Template\Context	$context,
		\Magento\Customer\Model\Session	$customerSession,
		\Magento\Checkout\Model\Session	$checkoutSession,
		\Magento\Catalog\Model\ResourceModel\Url	$catalogUrlBuilder,
		\Magento\Checkout\Helper\Cart	$cartHelper,
		\Magento\Framework\App\Http\Context	$httpContext,
		array	$data = `[]`
	)

Parameters

\Magento\Framework\View\Element\Template\Context	$context
\Magento\Customer\Model\Session	$customerSession
\Magento\Checkout\Model\Session	$checkoutSession
\Magento\Catalog\Model\ResourceModel\Url	$catalogUrlBuilder
\Magento\Checkout\Helper\Cart	$cartHelper
\Magento\Framework\App\Http\Context	$httpContext
array	$data	@codeCoverageIgnore

Definition at line 43 of file Cart.php.

       {
         $this->_cartHelper = $cartHelper;
         $this->_catalogUrlBuilder = $catalogUrlBuilder;
         parent::__construct($context, $customerSession, $checkoutSession, $data);
         $this->_isScopePrivate = true;
         $this->httpContext = $httpContext;
     }

Member Function Documentation

◆ _construct()

_construct ( )

protected

Prepare Quote Item Product URLs

@codeCoverageIgnore

Returns: void

Definition at line 65 of file Cart.php.

     {
         parent::_construct();
         $this->prepareItemUrls();
     }

◆ getCheckoutUrl()

getCheckoutUrl ( )

@codeCoverageIgnore

Returns: string

Definition at line 154 of file Cart.php.

     {
         return $this->getUrl('checkout', ['_secure' => true]);
     }

◆ getContinueShoppingUrl()

getContinueShoppingUrl ( )

Returns: string

Definition at line 162 of file Cart.php.

     {
         $url = $this->getData('continue_shopping_url');
         if ($url === null) {
             $url = $this->_checkoutSession->getContinueShoppingUrl(true);
             if (!$url) {
                 $url = $this->_urlBuilder->getUrl();
             }
             $this->setData('continue_shopping_url', $url);
         }
         return $url;
     }

◆ getIsVirtual()

getIsVirtual ( )

Returns: bool @codeCoverageIgnore @SuppressWarnings(PHPMD.BooleanGetMethodName)

Definition at line 180 of file Cart.php.

     {
         return $this->_cartHelper->getIsVirtualQuote();
     }

◆ getItems()

getItems ( )

Return customer quote items

Returns: array

Definition at line 221 of file Cart.php.

     {
         if ($this->getCustomItems()) {
             return $this->getCustomItems();
         }
 
         return parent::getItems();
     }

◆ getItemsCount()

getItemsCount ( )

@codeCoverageIgnore

Returns: int

Definition at line 234 of file Cart.php.

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

◆ getItemsSummaryQty()

getItemsSummaryQty ( )

@codeCoverageIgnore

Returns: int

Definition at line 126 of file Cart.php.

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

◆ getMethodHtml()

getMethodHtml ( $name )

Return HTML of checkout method (link, button etc.)

Parameters

string $name Block name in layout

Returns: string

Exceptions

Definition at line 207 of file Cart.php.

     {
         $block = $this->getLayout()->getBlock($name);
         if (!$block) {
             throw new \Magento\Framework\Exception\LocalizedException(__('Invalid method: %1', $name));
         }
         return $block->toHtml();
     }

◆ getMethods()

getMethods ( $alias )

Return list of available checkout methods

Parameters

string $alias Container block alias in layout

Returns: array

Definition at line 191 of file Cart.php.

     {
         $childName = $this->getLayout()->getChildName($this->getNameInLayout(), $alias);
         if ($childName) {
             return $this->getLayout()->getChildNames($childName);
         }
         return [];
     }

◆ getPagerHtml()

getPagerHtml ( )

Render pagination HTML

Returns: string

Since: 100.1.7

Definition at line 245 of file Cart.php.

     {
         return $this->getChildHtml('pager');
     }

◆ hasError()

hasError ( )

@codeCoverageIgnore

Returns: bool

Definition at line 117 of file Cart.php.

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

◆ isWishlistActive()

isWishlistActive ( )

@codeCoverageIgnore

Returns: bool

Definition at line 135 of file Cart.php.

     {
         $isActive = $this->_getData('is_wishlist_active');
         if ($isActive === null) {
             $isActive = $this->_scopeConfig->getValue(
                 'wishlist/general/active',
                 \Magento\Store\Model\ScopeInterface::SCOPE_STORE
             ) && $this->httpContext->getValue(
                 Context::CONTEXT_AUTH
             );
             $this->setIsWishlistActive($isActive);
         }
         return $isActive;
     }

◆ prepareItemUrls()

prepareItemUrls ( )

prepare cart items URLs

Returns: void @SuppressWarnings(PHPMD.CyclomaticComplexity)

Definition at line 77 of file Cart.php.

     {
         $products = [];
         /* @var $item \Magento\Quote\Model\Quote\Item */
         foreach ($this->getItems() as $item) {
             $product = $item->getProduct();
             $option = $item->getOptionByCode('product_type');
             if ($option) {
                 $product = $option->getProduct();
             }
 
             if ($item->getStoreId() != $this->_storeManager->getStore()->getId() &&
                 !$item->getRedirectUrl() &&
                 !$product->isVisibleInSiteVisibility()
             ) {
                 $products[$product->getId()] = $item->getStoreId();
             }
         }
 
         if ($products) {
             $products = $this->_catalogUrlBuilder->getRewriteByProductStore($products);
             foreach ($this->getItems() as $item) {
                 $product = $item->getProduct();
                 $option = $item->getOptionByCode('product_type');
                 if ($option) {
                     $product = $option->getProduct();
                 }
 
                 if (isset($products[$product->getId()])) {
                     $object = new \Magento\Framework\DataObject($products[$product->getId()]);
                     $item->getProduct()->setUrlDataObject($object);
                 }
             }
         }
     }

Field Documentation

◆ $_cartHelper

$_cartHelper

protected

Definition at line 31 of file Cart.php.

◆ $_catalogUrlBuilder

$_catalogUrlBuilder

protected

Definition at line 21 of file Cart.php.

◆ $httpContext

$httpContext

protected

Definition at line 26 of file Cart.php.

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

vendor/magento/module-checkout/Block/Cart.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _construct()

◆ getCheckoutUrl()

◆ getContinueShoppingUrl()

◆ getIsVirtual()

◆ getItems()

◆ getItemsCount()

◆ getItemsSummaryQty()

◆ getMethodHtml()

◆ getMethods()

◆ getPagerHtml()

◆ hasError()

◆ isWishlistActive()

◆ prepareItemUrls()

Field Documentation

◆ $_cartHelper

◆ $_catalogUrlBuilder

◆ $httpContext