Widget Class Reference

Public Member Functions
	__construct (\Magento\Framework\Escaper $escaper, \Magento\Widget\Model\Config\Data $dataStorage, \Magento\Framework\View\Asset\Repository $assetRepo, \Magento\Framework\View\Asset\Source $assetSource, \Magento\Framework\View\FileSystem $viewFileSystem, \Magento\Widget\Helper\Conditions $conditionsHelper)
	getConfigAsXml ($type)
	getConfigAsObject ($type)
	getWidgets ($filters=[])
	getWidgetsArray ($filters=[])
	getWidgetDeclaration ($type, $params=[], $asIs=true)
	getPlaceholderImageUrl ($type)

Protected Member Functions
	prepareWidgetParameters (\Magento\Framework\DataObject $object)
	prepareDropDownValues (array $data, $key, $sortOrder)
	prepareHelperBlock (array $data)
	getAsCanonicalArray ($inputArray)
	idEncode ($string)
	sortWidgets ($firstElement, $secondElement)
	sortParameters ($firstElement, $secondElement)

Protected Attributes
	$dataStorage
	$configCacheType
	$assetRepo
	$assetSource
	$viewFileSystem
	$escaper
	$widgetsArray = []
	$conditionsHelper

Detailed Description

Widget model for different purposes @SuppressWarnings(PHPMD.CouplingBetweenObjects)

@api

Since

100.0.2

Definition at line 15 of file Widget.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\Escaper	$escaper,
		\Magento\Widget\Model\Config\Data	$dataStorage,
		\Magento\Framework\View\Asset\Repository	$assetRepo,
		\Magento\Framework\View\Asset\Source	$assetSource,
		\Magento\Framework\View\FileSystem	$viewFileSystem,
		\Magento\Widget\Helper\Conditions	$conditionsHelper
	)

Parameters

\Magento\Framework\Escaper	$escaper
\Magento\Widget\Model\Config\Data	$dataStorage
\Magento\Framework\View\Asset\Repository	$assetRepo
\Magento\Framework\View\Asset\Source	$assetSource
\Magento\Framework\View\FileSystem	$viewFileSystem
\Magento\Widget\Helper\Conditions	$conditionsHelper

Definition at line 70 of file Widget.php.

      {
        $this->escaper = $escaper;
        $this->dataStorage = $dataStorage;
        $this->assetRepo = $assetRepo;
        $this->assetSource = $assetSource;
        $this->viewFileSystem = $viewFileSystem;
        $this->conditionsHelper = $conditionsHelper;
    }

Member Function Documentation

getAsCanonicalArray()

getAsCanonicalArray (   $inputArray )

protected

Remove attributes from widget array and emulate work of \Magento\Framework\Simplexml\Element::asCanonicalArray

Parameters

array

$inputArray

Returns

array

Definition at line 411 of file Widget.php.

    {
        if (array_key_exists('@', $inputArray)) {
            unset($inputArray['@']);
        }
        foreach ($inputArray as $key => $value) {
            if (!is_array($value)) {
                continue;
            }
            $inputArray[$key] = $this->getAsCanonicalArray($value);
        }
        return $inputArray;
    }

getConfigAsObject()

getConfigAsObject

(

$type

)

Return widget XML configuration as \Magento\Framework\DataObject and makes some data preparations

Parameters

string

$type

Widget type

Returns

\Magento\Framework\DataObject

Definition at line 141 of file Widget.php.

    {
        $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->setType($type);
        $object->setData($widget);

        // Correct widget parameters and convert its data to objects
        $newParams = $this->prepareWidgetParameters($object);
        $object->setData('parameters', $newParams);

        return $object;
    }

getConfigAsXml()

getConfigAsXml

(

$type

)

Return widget XML configuration as \Magento\Framework\DataObject and makes some data preparations

Parameters

string

$type

Widget type

Returns

null|\Magento\Framework\Simplexml\Element

Deprecated:

101.0.0

Definition at line 130 of file Widget.php.

    {
        return $this->getXmlElementByType($type);
    }

getPlaceholderImageUrl()

getPlaceholderImageUrl

(

$type

)

Get image URL of WYSIWYG placeholder image

Parameters

string

$type

Returns

string

Definition at line 365 of file Widget.php.

    {
        $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');
    }

getWidgetDeclaration()

getWidgetDeclaration	(		$type,
			$params = [],
			$asIs = true
	)

Return widget presentation code in WYSIWYG editor

Parameters

string	$type	Widget Type
array	$params	Pre-configured Widget Params
bool	$asIs	Return result as widget directive(true) or as placeholder image(false)

Returns

string Widget directive ready to parse

Definition at line 299 of file Widget.php.

    {
        $directive = '{{widget type="' . $type . '"';
        $widget = $this->getConfigAsObject($type);

        foreach ($params as $name => $value) {
            // Retrieve default option value if pre-configured
            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();
                }
            }
            if (isset($value)) {
                $directive .= sprintf(' %s="%s"', $name, $this->escaper->escapeQuote($value));
            }
        }

        $directive .= $this->getWidgetPageVarName($params);

        $directive .= sprintf(' type_name="%s"', $widget['name']);

        $directive .= '}}';

        if ($asIs) {
            return $directive;
        }

        $html = sprintf(
            '<img id="%s" src="%s" title="%s">',
            $this->idEncode($directive),
            $this->getPlaceholderImageUrl($type),
            $this->escaper->escapeUrl($directive)
        );
        return $html;
    }

getWidgets()

getWidgets

(

$filters = []

)

Return filtered list of widgets

Parameters

array

$filters

Key-value array of filters for widget node properties

Returns

array

Definition at line 243 of file Widget.php.

    {
        $widgets = $this->dataStorage->get();
        $result = $widgets;

        // filter widgets by params
        if (is_array($filters) && count($filters) > 0) {
            foreach ($widgets as $code => $widget) {
                try {
                    foreach ($filters as $field => $value) {
                        if (!isset($widget[$field]) || (string)$widget[$field] != $value) {
                            throw new \Exception();
                        }
                    }
                } catch (\Exception $e) {
                    unset($result[$code]);
                    continue;
                }
            }
        }

        return $result;
    }

getWidgetsArray()

getWidgetsArray

(

$filters = []

)

Return list of widgets as array

Parameters

array

$filters

Key-value array of filters for widget node properties

Returns

array

Definition at line 273 of file Widget.php.

    {
        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;
    }

idEncode()

idEncode (   $string )

protected

Encode string to valid HTML id element, based on base64 encoding

Parameters

string

$string

Returns

string

Definition at line 431 of file Widget.php.

    {
        return strtr(base64_encode($string), '+/=', ':_-');
    }

prepareDropDownValues()

prepareDropDownValues ( array  $data,   $key,   $sortOrder  )

protected

Prepare drop-down values

Parameters

array	$data
string	$key
int	$sortOrder

Returns

array

Definition at line 197 of file Widget.php.

    {
        $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;
    }

prepareHelperBlock()

prepareHelperBlock ( array  $data )

protected

Prepare helper block

Parameters

array

$data

Returns

array

Definition at line 221 of file Widget.php.

    {
        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;
    }

prepareWidgetParameters()

prepareWidgetParameters ( \Magento\Framework\DataObject  $object )

protected

Prepare widget parameters

Parameters

\Magento\Framework\DataObject

$object

Returns

array

Definition at line 168 of file Widget.php.

    {
        $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;
    }

sortParameters()

sortParameters (   $firstElement,   $secondElement  )

protected

Widget parameters sort callback

Parameters

\Magento\Framework\DataObject	$firstElement
\Magento\Framework\DataObject	$secondElement

Returns

int

Definition at line 455 of file Widget.php.

    {
        $aOrder = (int)$firstElement->getData('sort_order');
        $bOrder = (int)$secondElement->getData('sort_order');
        return $aOrder < $bOrder ? -1 : ($aOrder > $bOrder ? 1 : 0);
    }

sortWidgets()

sortWidgets (   $firstElement,   $secondElement  )

protected

User-defined widgets sorting by Name

Parameters

array	$firstElement
array	$secondElement

Returns

bool

Definition at line 443 of file Widget.php.

    {
        return strcmp($firstElement["name"], $secondElement["name"]);
    }

Field Documentation

$assetRepo

$assetRepo

protected

Definition at line 30 of file Widget.php.

$assetSource

$assetSource

protected

Definition at line 35 of file Widget.php.

$conditionsHelper

$conditionsHelper

protected

Definition at line 55 of file Widget.php.

$configCacheType

$configCacheType

protected

Definition at line 25 of file Widget.php.

$dataStorage

$dataStorage

protected

Definition at line 20 of file Widget.php.

$escaper

$escaper

protected

Definition at line 45 of file Widget.php.

$viewFileSystem

$viewFileSystem

protected

Definition at line 40 of file Widget.php.

$widgetsArray

$widgetsArray = []

protected

Definition at line 50 of file Widget.php.

---

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

• vendor/magento/module-widget/Model/Widget.php