Sidebar Class Reference

Public Member Functions
	__construct (Cart $cart, HelperData $helperData, ResolverInterface $resolver)
	getResponseData ($error='')
	checkQuoteItem ($itemId)
	removeQuoteItem ($itemId)
	updateQuoteItem ($itemId, $itemQty)

Protected Member Functions
	normalize ($itemQty)
	getSummaryQty ()
	getSummaryText ()
	getSubtotalHtml ()

Protected Attributes
	$cart
	$helperData
	$resolver
	$summaryQty

Detailed Description

Deprecated:

100.1.0

Definition at line 18 of file Sidebar.php.

Constructor & Destructor Documentation

__construct()

__construct	(	Cart	$cart,
		HelperData	$helperData,
		ResolverInterface	$resolver
	)

Parameters

Cart	$cart
HelperData	$helperData
ResolverInterface	$resolver	@codeCoverageIgnore

Definition at line 46 of file Sidebar.php.

      {
        $this->cart = $cart;
        $this->helperData = $helperData;
        $this->resolver = $resolver;
    }

Member Function Documentation

checkQuoteItem()

checkQuoteItem

(

$itemId

)

Check if required quote item exist

Parameters

int

$itemId

Exceptions

LocalizedException

Returns

$this

Definition at line 84 of file Sidebar.php.

    {
        $item = $this->cart->getQuote()->getItemById($itemId);
        if (!$item instanceof CartItemInterface) {
            throw new LocalizedException(__("The quote item isn't found. Verify the item and try again."));
        }
        return $this;
    }

getResponseData()

getResponseData

(

$error = ''

)

Compile response data

Parameters

string

$error

Returns

array

Definition at line 62 of file Sidebar.php.

    {
        if (empty($error)) {
            $response = [
                'success' => true,
            ];
        } else {
            $response = [
                'success' => false,
                'error_message' => $error,
            ];
        }
        return $response;
    }

getSubtotalHtml()

getSubtotalHtml ( )

protected

Retrieve subtotal block html

Returns

string

Definition at line 166 of file Sidebar.php.

    {
        $totals = $this->cart->getQuote()->getTotals();
        $subtotal = isset($totals['subtotal']) && $totals['subtotal'] instanceof Total
            ? $totals['subtotal']->getValue()
            : 0;
        return $this->helperData->formatPrice($subtotal);
    }

getSummaryQty()

getSummaryQty ( )

protected

Retrieve summary qty

Returns

int

Definition at line 143 of file Sidebar.php.

    {
        if (!$this->summaryQty) {
            $this->summaryQty = $this->cart->getSummaryQty();
        }
        return $this->summaryQty;
    }

getSummaryText()

getSummaryText ( )

protected

Retrieve summary qty text

Returns

string

Definition at line 156 of file Sidebar.php.

    {
        return ($this->getSummaryQty() == 1) ? __(' item') : __(' items');
    }

normalize()

normalize (   $itemQty )

protected

Apply normalization filter to item qty value

Parameters

int

$itemQty

Returns

int|array

Definition at line 127 of file Sidebar.php.

    {
        if ($itemQty) {
            $filter = new \Zend_Filter_LocalizedToNormalized(
                ['locale' => $this->resolver->getLocale()]
            );
            return $filter->filter($itemQty);
        }
        return $itemQty;
    }

removeQuoteItem()

removeQuoteItem

(

$itemId

)

Remove quote item

Parameters

int

$itemId

Returns

$this

Definition at line 99 of file Sidebar.php.

    {
        $this->cart->removeItem($itemId);
        $this->cart->save();
        return $this;
    }

updateQuoteItem()

updateQuoteItem	(		$itemId,
			$itemQty
	)

Update quote item

Parameters

int	$itemId
int	$itemQty

Exceptions

LocalizedException

Returns

$this

Definition at line 114 of file Sidebar.php.

    {
        $itemData = [$itemId => ['qty' => $this->normalize($itemQty)]];
        $this->cart->updateItems($itemData)->save();
        return $this;
    }

Field Documentation

$cart

$cart

protected

Definition at line 23 of file Sidebar.php.

$helperData

$helperData

protected

Definition at line 28 of file Sidebar.php.

$resolver

$resolver

protected

Definition at line 33 of file Sidebar.php.

$summaryQty

$summaryQty

protected

Definition at line 38 of file Sidebar.php.

---

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

• vendor/magento/module-checkout/Model/Sidebar.php