Magento 2 Documentation
2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
|
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 | |
Widget model for different purposes @SuppressWarnings(PHPMD.CouplingBetweenObjects)
@api
Definition at line 15 of file Widget.php.
__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 | ||
) |
\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.
|
protected |
Remove attributes from widget array and emulate work of \Magento\Framework\Simplexml\Element::asCanonicalArray
array | $inputArray |
Definition at line 411 of file Widget.php.
getConfigAsObject | ( | $type | ) |
Return widget XML configuration as \Magento\Framework\DataObject and makes some data preparations
string | $type | Widget type |
Definition at line 141 of file Widget.php.
getConfigAsXml | ( | $type | ) |
Return widget XML configuration as \Magento\Framework\DataObject and makes some data preparations
string | $type | Widget type |
Definition at line 130 of file Widget.php.
getPlaceholderImageUrl | ( | $type | ) |
Get image URL of WYSIWYG placeholder image
string | $type |
Definition at line 365 of file Widget.php.
getWidgetDeclaration | ( | $type, | |
$params = [] , |
|||
$asIs = true |
|||
) |
Return widget presentation code in WYSIWYG editor
string | $type | Widget Type |
array | $params | Pre-configured Widget Params |
bool | $asIs | Return result as widget directive(true) or as placeholder image(false) |
Definition at line 299 of file Widget.php.
getWidgets | ( | $filters = [] | ) |
Return filtered list of widgets
array | $filters | Key-value array of filters for widget node properties |
Definition at line 243 of file Widget.php.
getWidgetsArray | ( | $filters = [] | ) |
Return list of widgets as array
array | $filters | Key-value array of filters for widget node properties |
Definition at line 273 of file Widget.php.
|
protected |
Encode string to valid HTML id element, based on base64 encoding
string | $string |
Definition at line 431 of file Widget.php.
|
protected |
Prepare drop-down values
array | $data | |
string | $key | |
int | $sortOrder |
Definition at line 197 of file Widget.php.
|
protected |
|
protected |
Prepare widget parameters
\Magento\Framework\DataObject | $object |
Definition at line 168 of file Widget.php.
|
protected |
Widget parameters sort callback
\Magento\Framework\DataObject | $firstElement | |
\Magento\Framework\DataObject | $secondElement |
Definition at line 455 of file Widget.php.
|
protected |
User-defined widgets sorting by Name
array | $firstElement | |
array | $secondElement |
Definition at line 443 of file Widget.php.
|
protected |
Definition at line 30 of file Widget.php.
|
protected |
Definition at line 35 of file Widget.php.
|
protected |
Definition at line 55 of file Widget.php.
|
protected |
Definition at line 25 of file Widget.php.
|
protected |
Definition at line 20 of file Widget.php.
|
protected |
Definition at line 45 of file Widget.php.
|
protected |
Definition at line 40 of file Widget.php.
|
protected |
Definition at line 50 of file Widget.php.