Admin Class Reference

Inheritance diagram for Admin:

Public Member Functions
	__construct (\Magento\Framework\App\Helper\Context $context, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Sales\Model\Config $salesConfig, \Magento\Framework\Pricing\PriceCurrencyInterface $priceCurrency, \Magento\Framework\Escaper $escaper)
	displayPriceAttribute ($dataObject, $code, $strong=false, $separator='< br/>')
	displayPrices ($dataObject, $basePrice, $price, $strong=false, $separator='< br/>')
	applySalableProductTypesFilter ($collection)
	escapeHtmlWithLinks ($data, $allowedTags=null)
Public Member Functions inherited from AbstractHelper
	__construct (Context $context)
	isModuleOutputEnabled ($moduleName=null)

Protected Attributes
	$_salesConfig
	$_storeManager
	$priceCurrency
	$escaper
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

Sales admin helper.

Definition at line 13 of file Admin.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\App\Helper\Context	$context,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Sales\Model\Config	$salesConfig,
		\Magento\Framework\Pricing\PriceCurrencyInterface	$priceCurrency,
		\Magento\Framework\Escaper	$escaper
	)

Parameters

\Magento\Framework\App\Helper\Context	$context
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Sales\Model\Config	$salesConfig
\Magento\Framework\Pricing\PriceCurrencyInterface	$priceCurrency
\Magento\Framework\Escaper	$escaper

Definition at line 42 of file Admin.php.

      {
        $this->priceCurrency = $priceCurrency;
        $this->_storeManager = $storeManager;
        $this->_salesConfig = $salesConfig;
        $this->escaper = $escaper;
        parent::__construct($context);
    }

Member Function Documentation

applySalableProductTypesFilter()

applySalableProductTypesFilter

(

$collection

)

Filter collection by removing not available product types

Parameters

\Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection

$collection

Returns

\Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection

Definition at line 123 of file Admin.php.

    {
        $productTypes = $this->_salesConfig->getAvailableProductTypes();
        foreach ($collection->getItems() as $key => $item) {
            if ($item instanceof \Magento\Catalog\Model\Product) {
                $type = $item->getTypeId();
            } elseif ($item instanceof \Magento\Sales\Model\Order\Item) {
                $type = $item->getProductType();
            } elseif ($item instanceof \Magento\Quote\Model\Quote\Item) {
                $type = $item->getProductType();
            } else {
                $type = '';
            }
            if (!in_array($type, $productTypes)) {
                $collection->removeItemByKey($key);
            }
        }
        return $collection;
    }

displayPriceAttribute()

displayPriceAttribute	(		$dataObject,
			$code,
			$strong = false,
			$separator = '<br/>'
	)

Display price attribute value in base order currency and in place order currency

Parameters

\Magento\Framework\DataObject	$dataObject
string	$code
bool	$strong
string	$separator

Returns

string

Definition at line 65 of file Admin.php.

    {
        // Fix for 'bs_customer_bal_total_refunded' attribute
        $baseValue = $dataObject->hasData('bs_' . $code)
            ? $dataObject->getData('bs_' . $code)
            : $dataObject->getData('base_' . $code);
        return $this->displayPrices(
            $dataObject,
            $baseValue,
            $dataObject->getData($code),
            $strong,
            $separator
        );
    }

displayPrices()

displayPrices	(		$dataObject,
			$basePrice,
			$price,
			$strong = false,
			$separator = '<br/>'
	)

Get "double" prices html (block with base and place currency)

Parameters

\Magento\Framework\DataObject	$dataObject
float	$basePrice
float	$price
bool	$strong
string	$separator

Returns

string

Definition at line 90 of file Admin.php.

    {
        if ($dataObject instanceof \Magento\Sales\Model\Order) {
            $order = $dataObject;
        } else {
            $order = $dataObject->getOrder();
        }

        if ($order && $order->isCurrencyDifferent()) {
            $res = '<strong>';
            $res .= $order->formatBasePrice($basePrice);
            $res .= '</strong>' . $separator;
            $res .= '[' . $order->formatPrice($price) . ']';
        } elseif ($order) {
            $res = $order->formatPrice($price);
            if ($strong) {
                $res = '<strong>' . $res . '</strong>';
            }
        } else {
            $res = $this->priceCurrency->format($price);
            if ($strong) {
                $res = '<strong>' . $res . '</strong>';
            }
        }
        return $res;
    }

escapeHtmlWithLinks()

escapeHtmlWithLinks	(		$data,
			$allowedTags = null
	)

Escape string preserving links

Parameters

string	$data
null | array	$allowedTags

Returns

string

Definition at line 150 of file Admin.php.

    {
        if (!empty($data) && is_array($allowedTags) && in_array('a', $allowedTags)) {
            $links = [];
            $i = 1;
            $data = str_replace('%', '%%', $data);
            $regexp = "#(?J)<a"
                ."(?:(?:\s+(?:(?:href\s*=\s*(['\"])(?<link>.*?)\\1\s*)|(?:\S+\s*=\s*(['\"])(.*?)\\3)\s*)*)|>)"
                .">?(?:(?:(?<text>.*?)(?:<\/a\s*>?|(?=<\w))|(?<text>.*)))#si";
            while (preg_match($regexp, $data, $matches)) {
                $text = '';
                if (!empty($matches['text'])) {
                    $text = str_replace('%%', '%', $matches['text']);
                }
                $url = $this->filterUrl($matches['link'] ?? '');
                //Recreate a minimalistic secure a tag
                $links[] = sprintf(
                    '<a href="%s">%s</a>',
                    htmlspecialchars($url, ENT_QUOTES, 'UTF-8', false),
                    $this->escaper->escapeHtml($text)
                );
                $data = str_replace($matches[0], '%' . $i . '$s', $data);
                ++$i;
            }
            $data = $this->escaper->escapeHtml($data, $allowedTags);
            return vsprintf($data, $links);
        }
        return $this->escaper->escapeHtml($data, $allowedTags);
    }

Field Documentation

$_salesConfig

$_salesConfig

protected

Definition at line 18 of file Admin.php.

$_storeManager

$_storeManager

protected

Definition at line 23 of file Admin.php.

$escaper

$escaper

protected

Definition at line 33 of file Admin.php.

$priceCurrency

$priceCurrency

protected

Definition at line 28 of file Admin.php.

---

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

• vendor/magento/module-sales/Helper/Admin.php