Renderer Class Reference

Inheritance diagram for Renderer:

Public Member Functions
	__construct (\Magento\Framework\View\Element\Template\Context $context, \Magento\Tax\Helper\Data $taxHelper, PriceCurrencyInterface $priceCurrency, \Magento\Weee\Helper\Data $weeeHelper, array $data=[])
	displayPriceWithWeeeDetails ()
	getIncludeWeeeFlag ()
	getUnitDisplayPriceInclTax ()
	getBaseUnitDisplayPriceInclTax ()
	getRowDisplayPriceInclTax ()
	getBaseRowDisplayPriceInclTax ()
	getUnitDisplayPriceExclTax ()
	getBaseUnitDisplayPriceExclTax ()
	getRowDisplayPriceExclTax ()
	getBaseRowDisplayPriceExclTax ()
	getFinalUnitDisplayPriceInclTax ()
	getBaseFinalUnitDisplayPriceInclTax ()
	getFinalRowDisplayPriceInclTax ()
	getBaseFinalRowDisplayPriceInclTax ()
	getFinalUnitDisplayPriceExclTax ()
	getBaseFinalUnitDisplayPriceExclTax ()
	getFinalRowDisplayPriceExclTax ()
	getBaseFinalRowDisplayPriceExclTax ()
	displayFinalPrice ()
	getTotalAmount ($item)
	getBaseTotalAmount ($item)
Public Member Functions inherited from Renderer
	__construct (Context $context, TaxHelper $taxHelper, PriceCurrencyInterface $priceCurrency, array $data=[])
	setItem ($item)
	getZone ()
	setZone ($zone)
	getStoreId ()
	getItem ()
	displayPriceInclTax ()
	displayPriceExclTax ()
	displayBothPrices ()
	formatPrice ($price)
	getItemDisplayPriceExclTax ()
	getTotalAmount ($item)
	getBaseTotalAmount ($item)
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 Attributes
	$weeeHelper
Protected Attributes inherited from Renderer
	$taxHelper
	$item
	$storeId = null
	$zone = null
	$priceCurrency
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 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_'
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)
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Item price render block

@api

Author

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

Since

100.0.2

Definition at line 21 of file Renderer.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\View\Element\Template\Context	$context,
		\Magento\Tax\Helper\Data	$taxHelper,
		PriceCurrencyInterface	$priceCurrency,
		\Magento\Weee\Helper\Data	$weeeHelper,
		array	$data = []
	)

Parameters

\Magento\Framework\View\Element\Template\Context	$context
\Magento\Tax\Helper\Data	$taxHelper
PriceCurrencyInterface	$priceCurrency
\Magento\Weee\Helper\Data	$weeeHelper
array	$data

Definition at line 35 of file Renderer.php.

      {
        $this->weeeHelper = $weeeHelper;
        parent::__construct($context, $taxHelper, $priceCurrency, $data);
        $this->_isScopePrivate = true;
    }

Member Function Documentation

displayFinalPrice()

displayFinalPrice

(

)

Whether to display final price that include Weee amounts

Returns

bool

Definition at line 401 of file Renderer.php.

    {
        $flag = $this->weeeHelper->typeOfDisplay(
            WeeeDisplayConfig::DISPLAY_EXCL_DESCR_INCL,
            $this->getZone(),
            $this->getStoreId()
        );

        if (!$flag) {
            return false;
        }

        if ($this->weeeHelper->getWeeeTaxAppliedAmount($this->getItem()) <= 0) {
            return false;
        }
        return true;
    }

displayPriceWithWeeeDetails()

displayPriceWithWeeeDetails

(

)

Whether to display weee details together with price

Returns

bool

Definition at line 52 of file Renderer.php.

    {
        if (!$this->weeeHelper->isEnabled($this->getStoreId())) {
            return false;
        }

        $displayWeeeDetails = $this->weeeHelper->typeOfDisplay(
            [WeeeDisplayConfig::DISPLAY_INCL_DESCR, WeeeDisplayConfig::DISPLAY_EXCL_DESCR_INCL],
            $this->getZone(),
            $this->getStoreId()
        );
        if (!$displayWeeeDetails) {
            return false;
        }
        if ($this->weeeHelper->getWeeeTaxAppliedAmount($this->getItem()) <= 0) {
            return false;
        }

        return true;
    }

getBaseFinalRowDisplayPriceExclTax()

getBaseFinalRowDisplayPriceExclTax

(

)

Get base final row display price excluding tax, this will add Weee amount to rowTotal

Returns

float

Definition at line 385 of file Renderer.php.

    {
        $baseRowTotalExclTax = $this->getItem()->getBaseRowTotal();

        if (!$this->weeeHelper->isEnabled($this->getStoreId())) {
            return $baseRowTotalExclTax;
        }

        return $baseRowTotalExclTax + $this->getItem()->getBaseWeeeTaxAppliedRowAmnt();
    }

getBaseFinalRowDisplayPriceInclTax()

getBaseFinalRowDisplayPriceInclTax

(

)

Get base final row display price including tax, this will add weee amount to rowTotalInclTax

Returns

float

Definition at line 315 of file Renderer.php.

    {
        $baseRowTotalInclTax = $this->getItem()->getBaseRowTotalInclTax();

        if (!$this->weeeHelper->isEnabled($this->getStoreId())) {
            return $baseRowTotalInclTax;
        }

        return $baseRowTotalInclTax + $this->weeeHelper->getBaseRowWeeeTaxInclTax($this->getItem());
    }

getBaseFinalUnitDisplayPriceExclTax()

getBaseFinalUnitDisplayPriceExclTax

(

)

Get base final unit display price excluding tax

Returns

float

Definition at line 347 of file Renderer.php.

    {
        $orderItem = $this->getItem();
        if ($orderItem instanceof InvoiceItem || $orderItem instanceof CreditMemoItem) {
            $orderItem = $orderItem->getOrderItem();
        }

        $qty = $orderItem->getQtyOrdered();
        $basePriceExclTax = $orderItem->getBaseRowTotal() / $qty;

        if (!$this->weeeHelper->isEnabled($this->getStoreId())) {
            return $basePriceExclTax;
        }

        return $basePriceExclTax + $this->getItem()->getBaseWeeeTaxAppliedAmount();
    }

getBaseFinalUnitDisplayPriceInclTax()

getBaseFinalUnitDisplayPriceInclTax

(

)

Get base final unit display price including tax, this will add Weee amount to unit price include tax

Returns

float

Definition at line 283 of file Renderer.php.

    {
        $basePriceInclTax = $this->getItem()->getBasePriceInclTax();

        if (!$this->weeeHelper->isEnabled($this->getStoreId())) {
            return $basePriceInclTax;
        }

        return $basePriceInclTax + $this->weeeHelper->getBaseWeeeTaxInclTax($this->getItem());
    }

getBaseRowDisplayPriceExclTax()

getBaseRowDisplayPriceExclTax

(

)

Get base price for row total excluding tax. The Weee amount will be added to row total depending on Weee display setting

Returns

float

Definition at line 247 of file Renderer.php.

    {
        $baseRowTotalExclTax = $this->getItem()->getBaseRowTotal();

        if (!$this->weeeHelper->isEnabled($this->getStoreId())) {
            return $baseRowTotalExclTax;
        }

        if ($this->getIncludeWeeeFlag()) {
            return $baseRowTotalExclTax + $this->getItem()->getBaseWeeeTaxAppliedRowAmnt();
        }

        return $baseRowTotalExclTax;
    }

getBaseRowDisplayPriceInclTax()

getBaseRowDisplayPriceInclTax

(

)

Get base price for row total including tax. The Weee amount will be added to row total including tax depending on Weee display setting

Returns

float

Definition at line 157 of file Renderer.php.

    {
        $baseRowTotalInclTax = $this->getItem()->getBaseRowTotalInclTax();

        if (!$this->weeeHelper->isEnabled($this->getStoreId())) {
            return $baseRowTotalInclTax;
        }

        if ($this->getIncludeWeeeFlag()) {
            return $baseRowTotalInclTax + $this->weeeHelper->getBaseRowWeeeTaxInclTax($this->getItem());
        }

        return $baseRowTotalInclTax;
    }

getBaseTotalAmount()

getBaseTotalAmount

(

$item

)

Return the total amount minus discount

Parameters

OrderItem | InvoiceItem | CreditMemoItem

$item

Returns

mixed

Definition at line 442 of file Renderer.php.

    {
        $totalAmount = $item->getBaseRowTotal()
            - $item->getBaseDiscountAmount()
            + $item->getBaseTaxAmount()
            + $item->getBaseDiscountTaxCompensationAmount()
            + $this->weeeHelper->getBaseRowWeeeTaxInclTax($item);

        return $totalAmount;
    }

getBaseUnitDisplayPriceExclTax()

getBaseUnitDisplayPriceExclTax

(

)

Get base price for unit price excluding tax. The Weee amount will be added to unit price depending on Weee display setting

Returns

float

Definition at line 199 of file Renderer.php.

    {
        $orderItem = $this->getItem();
        if ($orderItem instanceof InvoiceItem || $orderItem instanceof CreditMemoItem) {
            $orderItem = $orderItem->getOrderItem();
        }

        $qty = $orderItem->getQtyOrdered();
        $basePriceExclTax = $orderItem->getBaseRowTotal() / $qty;

        if (!$this->weeeHelper->isEnabled($this->getStoreId())) {
            return $basePriceExclTax;
        }

        if ($this->getIncludeWeeeFlag()) {
            return $basePriceExclTax + $this->getItem()->getBaseWeeeTaxAppliedAmount();
        }

        return $basePriceExclTax;
    }

getBaseUnitDisplayPriceInclTax()

getBaseUnitDisplayPriceInclTax

(

)

Get base price for unit price including tax. The Weee amount will be added to unit price including tax depending on Weee display setting

Returns

float

Definition at line 115 of file Renderer.php.

    {
        $basePriceInclTax = $this->getItem()->getBasePriceInclTax();

        if (!$this->weeeHelper->isEnabled($this->getStoreId())) {
            return $basePriceInclTax;
        }

        if ($this->getIncludeWeeeFlag()) {
            return $basePriceInclTax + $this->weeeHelper->getBaseWeeeTaxInclTax($this->getItem());
        }

        return $basePriceInclTax;
    }

getFinalRowDisplayPriceExclTax()

getFinalRowDisplayPriceExclTax

(

)

Get final row display price excluding tax, this will add Weee amount to rowTotal

Returns

float

Definition at line 369 of file Renderer.php.

    {
        $rowTotalExclTax = $this->getItem()->getRowTotal();

        if (!$this->weeeHelper->isEnabled($this->getStoreId())) {
            return $rowTotalExclTax;
        }

        return $rowTotalExclTax + $this->weeeHelper->getWeeeTaxAppliedRowAmount($this->getItem());
    }

getFinalRowDisplayPriceInclTax()

getFinalRowDisplayPriceInclTax

(

)

Get final row display price including tax, this will add weee amount to rowTotalInclTax

Returns

float

Definition at line 299 of file Renderer.php.

    {
        $rowTotalInclTax = $this->getItem()->getRowTotalInclTax();

        if (!$this->weeeHelper->isEnabled($this->getStoreId())) {
            return $rowTotalInclTax;
        }

        return $rowTotalInclTax + $this->weeeHelper->getRowWeeeTaxInclTax($this->getItem());
    }

getFinalUnitDisplayPriceExclTax()

getFinalUnitDisplayPriceExclTax

(

)

Get final unit display price excluding tax

Returns

float

Definition at line 331 of file Renderer.php.

    {
        $priceExclTax = $this->getItemDisplayPriceExclTax();

        if (!$this->weeeHelper->isEnabled($this->getStoreId())) {
            return $priceExclTax;
        }

        return $priceExclTax + $this->weeeHelper->getWeeeTaxAppliedAmount($this->getItem());
    }

getFinalUnitDisplayPriceInclTax()

getFinalUnitDisplayPriceInclTax

(

)

Get final unit display price including tax, this will add Weee amount to unit price include tax

Returns

float

Definition at line 267 of file Renderer.php.

    {
        $priceInclTax = $this->getItem()->getPriceInclTax();

        if (!$this->weeeHelper->isEnabled($this->getStoreId())) {
            return $priceInclTax;
        }

        return $priceInclTax + $this->weeeHelper->getWeeeTaxInclTax($this->getItem());
    }

getIncludeWeeeFlag()

getIncludeWeeeFlag

(

)

Return the flag whether to include weee in the price

Returns

bool|int

Definition at line 78 of file Renderer.php.

    {
        $includeWeee = $this->weeeHelper->typeOfDisplay(
            [WeeeDisplayConfig::DISPLAY_INCL_DESCR, WeeeDisplayConfig::DISPLAY_INCL],
            $this->getZone(),
            $this->getStoreId()
        );
        return $includeWeee;
    }

getRowDisplayPriceExclTax()

getRowDisplayPriceExclTax

(

)

Get display price for row total excluding tax. The Weee amount will be added to row total depending on Weee display setting

Returns

float

Definition at line 226 of file Renderer.php.

    {
        $rowTotalExclTax = $this->getItem()->getRowTotal();

        if (!$this->weeeHelper->isEnabled($this->getStoreId())) {
            return $rowTotalExclTax;
        }

        if ($this->getIncludeWeeeFlag()) {
            return $rowTotalExclTax + $this->weeeHelper->getWeeeTaxAppliedRowAmount($this->getItem());
        }

        return $rowTotalExclTax;
    }

getRowDisplayPriceInclTax()

getRowDisplayPriceInclTax

(

)

Get display price for row total including tax. The Weee amount will be added to row total including tax depending on Weee display setting

Returns

float

Definition at line 136 of file Renderer.php.

    {
        $rowTotalInclTax = $this->getItem()->getRowTotalInclTax();

        if (!$this->weeeHelper->isEnabled($this->getStoreId())) {
            return $rowTotalInclTax;
        }

        if ($this->getIncludeWeeeFlag()) {
            return $rowTotalInclTax + $this->weeeHelper->getRowWeeeTaxInclTax($this->getItem());
        }

        return $rowTotalInclTax;
    }

getTotalAmount()

getTotalAmount

(

$item

)

Return the total amount minus discount

Parameters

OrderItem | InvoiceItem | CreditMemoItem

$item

Returns

mixed

Definition at line 425 of file Renderer.php.

    {
        $totalAmount = $item->getRowTotal()
            - $item->getDiscountAmount()
            + $item->getTaxAmount()
            + $item->getDiscountTaxCompensationAmount()
            + $this->weeeHelper->getRowWeeeTaxInclTax($item);

        return $totalAmount;
    }

getUnitDisplayPriceExclTax()

getUnitDisplayPriceExclTax

(

)

Get display price for unit price excluding tax. The Weee amount will be added to unit price depending on Weee display setting

Returns

float

Definition at line 178 of file Renderer.php.

    {
        $priceExclTax = $this->getItemDisplayPriceExclTax();

        if (!$this->weeeHelper->isEnabled($this->getStoreId())) {
            return $priceExclTax;
        }

        if ($this->getIncludeWeeeFlag()) {
            return $priceExclTax + $this->weeeHelper->getWeeeTaxAppliedAmount($this->getItem());
        }

        return $priceExclTax;
    }

getUnitDisplayPriceInclTax()

getUnitDisplayPriceInclTax

(

)

Get display price for unit price including tax. The Weee amount will be added to unit price including tax depending on Weee display setting

Returns

float

Definition at line 94 of file Renderer.php.

    {
        $priceInclTax = $this->getItem()->getPriceInclTax();

        if (!$this->weeeHelper->isEnabled($this->getStoreId())) {
            return $priceInclTax;
        }

        if ($this->getIncludeWeeeFlag()) {
            return $priceInclTax + $this->weeeHelper->getWeeeTaxInclTax($this->getItem());
        }

        return $priceInclTax;
    }

Field Documentation

$weeeHelper

$weeeHelper

protected

Definition at line 26 of file Renderer.php.

---

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

• vendor/magento/module-weee/Block/Item/Price/Renderer.php