Server : Apache System : Linux server2.corals.io 4.18.0-348.2.1.el8_5.x86_64 #1 SMP Mon Nov 15 09:17:08 EST 2021 x86_64 User : corals ( 1002) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system Directory : /home/corals/cartforge.co/vendor/magento/module-sales/Helper/ |
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);
namespace Magento\Sales\Helper;
use Magento\Framework\App\ObjectManager;
/**
* Sales admin helper.
*/
class Admin extends \Magento\Framework\App\Helper\AbstractHelper
{
/**
* @var \Magento\Sales\Model\Config
*/
protected $_salesConfig;
/**
* @var \Magento\Store\Model\StoreManagerInterface
*/
protected $_storeManager;
/**
* @var \Magento\Framework\Pricing\PriceCurrencyInterface
*/
protected $priceCurrency;
/**
* @var \Magento\Framework\Escaper
*/
protected $escaper;
/**
* @var \DOMDocumentFactory
*/
private $domDocumentFactory;
/**
* @param \Magento\Framework\App\Helper\Context $context
* @param \Magento\Store\Model\StoreManagerInterface $storeManager
* @param \Magento\Sales\Model\Config $salesConfig
* @param \Magento\Framework\Pricing\PriceCurrencyInterface $priceCurrency
* @param \Magento\Framework\Escaper $escaper
* @param \DOMDocumentFactory|null $domDocumentFactory
*/
public function __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,
\DOMDocumentFactory $domDocumentFactory = null
) {
$this->priceCurrency = $priceCurrency;
$this->_storeManager = $storeManager;
$this->_salesConfig = $salesConfig;
$this->escaper = $escaper;
$this->domDocumentFactory = $domDocumentFactory
?: ObjectManager::getInstance()->get(\DOMDocumentFactory::class);
parent::__construct($context);
}
/**
* Display price attribute value in base order currency and in place order currency
*
* @param \Magento\Framework\DataObject $dataObject
* @param string $code
* @param bool $strong
* @param string $separator
* @return string
*/
public function displayPriceAttribute($dataObject, $code, $strong = false, $separator = '<br/>')
{
// 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
);
}
/**
* Get "double" prices html (block with base and place currency)
*
* @param \Magento\Framework\DataObject $dataObject
* @param float $basePrice
* @param float $price
* @param bool $strong
* @param string $separator
* @return string
*/
public function displayPrices($dataObject, $basePrice, $price, $strong = false, $separator = '<br/>')
{
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;
}
/**
* Filter collection by removing not available product types
*
* @param \Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection $collection
* @return \Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection
*/
public function applySalableProductTypesFilter($collection)
{
$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;
}
/**
* Escape string preserving links
*
* @param string $data
* @param null|array $allowedTags
* @return string
*/
public function escapeHtmlWithLinks($data, $allowedTags = null)
{
if (!empty($data) && is_array($allowedTags) && in_array('a', $allowedTags)) {
$wrapperElementId = uniqid();
$domDocument = $this->domDocumentFactory->create();
$internalErrors = libxml_use_internal_errors(true);
$convmap = [0x80, 0x10FFFF, 0, 0x1FFFFF];
$data = mb_encode_numericentity(
$data,
$convmap,
'UTF-8'
);
$domDocument->loadHTML(
'<html><body id="' . $wrapperElementId . '">' . $data . '</body></html>'
);
libxml_use_internal_errors($internalErrors);
$linkTags = $domDocument->getElementsByTagName('a');
foreach ($linkTags as $linkNode) {
$linkAttributes = [];
foreach ($linkNode->attributes as $attribute) {
$linkAttributes[$attribute->name] = $attribute->value;
}
foreach ($linkAttributes as $attributeName => $attributeValue) {
if ($attributeName === 'href') {
$url = $this->filterUrl($attributeValue ?? '');
$url = $this->escaper->escapeUrl($url);
$linkNode->setAttribute('href', $url);
} else {
$linkNode->removeAttribute($attributeName);
}
}
}
$result = mb_decode_numericentity(
// phpcs:ignore Magento2.Functions.DiscouragedFunction
html_entity_decode(
$domDocument->saveHTML(),
ENT_QUOTES|ENT_SUBSTITUTE,
'UTF-8'
),
$convmap,
'UTF-8'
);
preg_match('/<body id="' . $wrapperElementId . '">(.+)<\/body><\/html>$/si', $result, $matches);
$data = !empty($matches) ? $matches[1] : '';
}
return $this->escaper->escapeHtml($data, $allowedTags);
}
/**
* Filter the URL for allowed protocols.
*
* @param string $url
* @return string
*/
private function filterUrl(string $url): string
{
if ($url) {
//Revert the sprintf escaping
// phpcs:ignore Magento2.Functions.DiscouragedFunction
$urlScheme = parse_url($url, PHP_URL_SCHEME);
$urlScheme = $urlScheme ? strtolower($urlScheme) : '';
if ($urlScheme !== 'http' && $urlScheme !== 'https') {
$url = null;
}
}
if (!$url) {
$url = '#';
}
return $url;
}
}