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/old/vendor/magento/module-widget/Model/ |
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Widget\Model;
use Magento\Framework\App\Cache\Type\Config;
use Magento\Framework\DataObject;
use Magento\Framework\Escaper;
use Magento\Framework\Math\Random;
use Magento\Framework\View\Asset\Repository;
use Magento\Framework\View\Asset\Source;
use Magento\Framework\View\FileSystem;
use Magento\Widget\Helper\Conditions;
use Magento\Widget\Model\Config\Data;
/**
* Widget model for different purposes
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
*
* @api
* @since 100.0.2
*/
class Widget
{
/**
* @var Data
*/
protected $dataStorage;
/**
* @var Config
*/
protected $configCacheType;
/**
* @var Repository
*/
protected $assetRepo;
/**
* @var Source
*/
protected $assetSource;
/**
* @var FileSystem
*/
protected $viewFileSystem;
/**
* @var Escaper
*/
protected $escaper;
/**
* @var array
*/
protected $widgetsArray = [];
/**
* @var Conditions
*/
protected $conditionsHelper;
/**
* @var Random
*/
private $mathRandom;
/**
* @var string[]
*/
private $reservedChars = ['}', '{'];
/**
* @param Escaper $escaper
* @param Data $dataStorage
* @param Repository $assetRepo
* @param Source $assetSource
* @param FileSystem $viewFileSystem
* @param Conditions $conditionsHelper
*/
public function __construct(
Escaper $escaper,
Data $dataStorage,
Repository $assetRepo,
Source $assetSource,
FileSystem $viewFileSystem,
Conditions $conditionsHelper
) {
$this->escaper = $escaper;
$this->dataStorage = $dataStorage;
$this->assetRepo = $assetRepo;
$this->assetSource = $assetSource;
$this->viewFileSystem = $viewFileSystem;
$this->conditionsHelper = $conditionsHelper;
}
/**
* Get math random
*
* @return \Magento\Framework\Math\Random
*
* @deprecated 100.0.10
*/
private function getMathRandom()
{
if ($this->mathRandom === null) {
$this->mathRandom = \Magento\Framework\App\ObjectManager::getInstance()
->get(\Magento\Framework\Math\Random::class);
}
return $this->mathRandom;
}
/**
* Return widget config based on its class type
*
* @param string $type Widget type
* @return null|array
*/
public function getWidgetByClassType($type)
{
$widgets = $this->getWidgets();
/** @var array $widget */
foreach ($widgets as $widget) {
if (isset($widget['@']['type']) && $type === $widget['@']['type']) {
return $widget;
}
}
return null;
}
/**
* Return widget XML configuration as \Magento\Framework\DataObject and makes some data preparations
*
* @param string $type Widget type
* @return null|\Magento\Framework\Simplexml\Element
*
* @deprecated 101.0.0
*/
public function getConfigAsXml($type)
{
// phpstan:ignore
return $this->getXmlElementByType($type);
}
/**
* Return widget XML configuration as \Magento\Framework\DataObject and makes some data preparations
*
* @param string $type Widget type
* @return \Magento\Framework\DataObject
*/
public function getConfigAsObject($type)
{
$widget = $this->getWidgetByClassType($type);
$object = new \Magento\Framework\DataObject();
if ($widget === null) {
return $object;
}
$widget = $this->getAsCanonicalArray($widget);
// Save all nodes to object data
$object->setData($widget);
$object->setType($type);
// Correct widget parameters and convert its data to objects
$newParams = $this->prepareWidgetParameters($object);
$object->setData('parameters', $newParams);
return $object;
}
/**
* Prepare widget parameters
*
* @param \Magento\Framework\DataObject $object
* @return array
*/
protected function prepareWidgetParameters(\Magento\Framework\DataObject $object)
{
$params = $object->getData('parameters');
$newParams = [];
if (is_array($params)) {
$sortOrder = 0;
foreach ($params as $key => $data) {
if (is_array($data)) {
$data = $this->prepareDropDownValues($data, $key, $sortOrder);
$data = $this->prepareHelperBlock($data);
$newParams[$key] = new \Magento\Framework\DataObject($data);
$sortOrder++;
}
}
}
uasort($newParams, [$this, 'sortParameters']);
return $newParams;
}
/**
* Prepare drop-down values
*
* @param array $data
* @param string $key
* @param int $sortOrder
* @return array
*/
protected function prepareDropDownValues(array $data, $key, $sortOrder)
{
$data['key'] = $key;
$data['sort_order'] = isset($data['sort_order']) ? (int)$data['sort_order'] : $sortOrder;
$values = [];
if (isset($data['values']) && is_array($data['values'])) {
foreach ($data['values'] as $value) {
if (isset($value['label']) && isset($value['value'])) {
$values[] = $value;
}
}
}
$data['values'] = $values;
return $data;
}
/**
* Prepare helper block
*
* @param array $data
* @return array
*/
protected function prepareHelperBlock(array $data)
{
if (isset($data['helper_block'])) {
$helper = new \Magento\Framework\DataObject();
if (isset($data['helper_block']['data']) && is_array($data['helper_block']['data'])) {
$helper->addData($data['helper_block']['data']);
}
if (isset($data['helper_block']['type'])) {
$helper->setType($data['helper_block']['type']);
}
$data['helper_block'] = $helper;
}
return $data;
}
/**
* Return filtered list of widgets
*
* @param array $filters Key-value array of filters for widget node properties
* @return array
*/
public function getWidgets($filters = [])
{
$widgets = $this->dataStorage->get();
$result = $widgets;
// filter widgets by params
if (is_array($filters) && !empty($filters)) {
foreach ($widgets as $code => $widget) {
foreach ($filters as $field => $value) {
if (!isset($widget[$field]) || (string)$widget[$field] != $value) {
unset($result[$code]);
break;
}
}
}
}
return $result;
}
/**
* Return list of widgets as array
*
* @param array $filters Key-value array of filters for widget node properties
* @return array
*/
public function getWidgetsArray($filters = [])
{
if (empty($this->widgetsArray)) {
$result = [];
foreach ($this->getWidgets($filters) as $code => $widget) {
$result[$widget['name']] = [
'name' => __((string)$widget['name']),
'code' => $code,
'type' => $widget['@']['type'],
'description' => __((string)$widget['description']),
];
}
usort($result, [$this, "sortWidgets"]);
$this->widgetsArray = $result;
}
return $this->widgetsArray;
}
/**
* Return widget presentation code in WYSIWYG editor
*
* @param string $type Widget Type
* @param array $params Pre-configured Widget Params
* @param bool $asIs Return result as widget directive(true) or as placeholder image(false)
* @return string Widget directive ready to parse
*/
public function getWidgetDeclaration($type, $params = [], $asIs = true)
{
$widget = $this->getConfigAsObject($type);
$params = array_filter($params, function ($value) {
return $value !== null && $value !== '';
});
$directiveParams = '';
foreach ($params as $name => $value) {
// Retrieve default option value if pre-configured
$directiveParams .= $this->getDirectiveParam($widget, $name, $value);
}
$directive = sprintf('{{widget type="%s"%s%s}}', $type, $directiveParams, $this->getWidgetPageVarName($params));
if ($asIs) {
return $directive;
}
return sprintf(
'<img id="%s" src="%s" title="%s">',
$this->idEncode($directive),
$this->getPlaceholderImageUrl($type),
$this->escaper->escapeUrl($directive)
);
}
/**
* Returns directive param with prepared value
*
* @param DataObject $widget
* @param string $name
* @param string|array $value
* @return string
*/
private function getDirectiveParam(DataObject $widget, string $name, $value): string
{
if ($name === 'conditions') {
$name = 'conditions_encoded';
$value = $this->conditionsHelper->encode($value);
} elseif (is_array($value)) {
$value = implode(',', $value);
} elseif (trim($value) === '') {
$parameters = $widget->getParameters();
if (isset($parameters[$name]) && is_object($parameters[$name])) {
$value = $parameters[$name]->getValue();
}
} else {
$value = $this->getPreparedValue($value);
}
return sprintf(' %s="%s"', $name, $this->escaper->escapeHtmlAttr($value, false));
}
/**
* Returns encoded value if it contains reserved chars
*
* @param string $value
* @return string
*/
private function getPreparedValue(string $value): string
{
$pattern = sprintf('/%s/', implode('|', $this->reservedChars));
return preg_match($pattern, $value) ? rawurlencode($value) : $value;
}
/**
* Get widget page varname
*
* @param array $params
* @return string
* @throws \Magento\Framework\Exception\LocalizedException
*/
private function getWidgetPageVarName($params = [])
{
$pageVarName = '';
if (array_key_exists('show_pager', $params) && (bool)$params['show_pager']) {
$pageVarName = sprintf(
' %s="%s"',
'page_var_name',
'p' . $this->getMathRandom()->getRandomString(5, \Magento\Framework\Math\Random::CHARS_LOWERS)
);
}
return $pageVarName;
}
/**
* Get image URL of WYSIWYG placeholder image
*
* @param string $type
* @return string
*/
public function getPlaceholderImageUrl($type)
{
$placeholder = false;
$widget = $this->getWidgetByClassType($type);
if (is_array($widget) && isset($widget['placeholder_image'])) {
$placeholder = (string)$widget['placeholder_image'];
}
if ($placeholder) {
$asset = $this->assetRepo->createAsset($placeholder);
$placeholder = $this->assetSource->getFile($asset);
if ($placeholder) {
return $asset->getUrl();
}
}
return $this->assetRepo->getUrl('Magento_Widget::placeholder.png');
}
/**
* Get a list of URLs of WYSIWYG placeholder images
*
* Returns array(<type> => <url>)
*
* @return array
*/
public function getPlaceholderImageUrls()
{
$result = [];
$widgets = $this->getWidgets();
/** @var array $widget */
foreach ($widgets as $widget) {
if (isset($widget['@'])) {
if (isset($widget['@']['type'])) {
$type = $widget['@']['type'];
$result[$type] = $this->getPlaceholderImageUrl($type);
}
}
}
return $result;
}
/**
* Remove attributes from widget array and emulate work of \Magento\Framework\Simplexml\Element::asCanonicalArray
*
* @param array $inputArray
* @return array
*/
protected function getAsCanonicalArray($inputArray)
{
if (array_key_exists('@', $inputArray)) {
unset($inputArray['@']);
}
foreach ($inputArray as $key => $value) {
if (!is_array($value)) {
continue;
}
$inputArray[$key] = $this->getAsCanonicalArray($value);
}
return $inputArray;
}
/**
* Encode string to valid HTML id element, based on base64 encoding
*
* @param string $string
* @return string
*/
protected function idEncode($string)
{
return strtr(base64_encode($string), '+/=', ':_-');
}
/**
* User-defined widgets sorting by Name
*
* @param array $firstElement
* @param array $secondElement
* @return bool
*/
protected function sortWidgets($firstElement, $secondElement)
{
return strcmp($firstElement["name"], $secondElement["name"]);
}
/**
* Widget parameters sort callback
*
* @param \Magento\Framework\DataObject $firstElement
* @param \Magento\Framework\DataObject $secondElement
* @return int
*/
protected function sortParameters($firstElement, $secondElement)
{
$aOrder = (int)$firstElement->getData('sort_order');
$bOrder = (int)$secondElement->getData('sort_order');
return $aOrder < $bOrder ? -1 : ($aOrder > $bOrder ? 1 : 0);
}
}