Inheritance diagram for Filter:

Public Member Functions
	__construct (\Magento\Framework\Stdlib\StringUtils $string, \Psr\Log\LoggerInterface $logger, \Magento\Framework\Escaper $escaper, \Magento\Framework\View\Asset\Repository $assetRepo, \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, \Magento\Variable\Model\VariableFactory $coreVariableFactory, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Framework\View\LayoutInterface $layout, \Magento\Framework\View\LayoutFactory $layoutFactory, \Magento\Framework\App\State $appState, \Magento\Framework\UrlInterface $urlModel, \Pelago\Emogrifier $emogrifier, \Magento\Variable\Model\Source\Variables $configVariables, \Magento\Widget\Model\ResourceModel\Widget $widgetResource, \Magento\Widget\Model\Widget $widget)

	generateWidget ($construction)

	widgetDirective ($construction)

	mediaDirective ($construction)

Public Member Functions inherited from Filter
	setUseSessionInUrl ($flag)

	mediaDirective ($construction)

Public Member Functions inherited from Filter
	__construct (\Magento\Framework\Stdlib\StringUtils $string, \Psr\Log\LoggerInterface $logger, \Magento\Framework\Escaper $escaper, \Magento\Framework\View\Asset\Repository $assetRepo, \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, \Magento\Variable\Model\VariableFactory $coreVariableFactory, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Framework\View\LayoutInterface $layout, \Magento\Framework\View\LayoutFactory $layoutFactory, \Magento\Framework\App\State $appState, \Magento\Framework\UrlInterface $urlModel, \Pelago\Emogrifier $emogrifier, \Magento\Variable\Model\Source\Variables $configVariables, $variables=[], \Magento\Framework\Css\PreProcessor\Adapter\CssInliner $cssInliner=null)

	setUseAbsoluteLinks ($flag)

	setUseSessionInUrl ($flag)

	setPlainTemplateMode ($plainTemplateMode)

	isPlainTemplateMode ()

	setIsChildTemplate ($isChildTemplate)

	isChildTemplate ()

	setStoreId ($storeId)

	setDesignParams (array $designParams)

	getDesignParams ()

	getStoreId ()

	blockDirective ($construction)

	layoutDirective ($construction)

	viewDirective ($construction)

	mediaDirective ($construction)

	storeDirective ($construction)

	setUrlModel (\Magento\Framework\UrlInterface $urlModel)

	transDirective ($construction)

	varDirective ($construction)

	modifierEscape ($value, $type='html')

	protocolDirective ($construction)

	configDirective ($construction)

	customvarDirective ($construction)

	cssDirective ($construction)

	inlinecssDirective ($construction)

	getCssFilesContent (array $files)

	applyInlineCss ($html)

	filter ($value)

Public Member Functions inherited from Template
	__construct (\Magento\Framework\Stdlib\StringUtils $string, $variables=[])

	setVariables (array $variables)

	setTemplateProcessor (callable $callback)

	getTemplateProcessor ()

	filter ($value)

	addAfterFilterCallback (callable $afterFilterCallback)

	varDirective ($construction)

	templateDirective ($construction)

	dependDirective ($construction)

	ifDirective ($construction)

Protected Attributes
	$_widgetResource

	$_widget

Protected Attributes inherited from Filter
	$_useSessionInUrl

Protected Attributes inherited from Filter
	$_useAbsoluteLinks = false

	$_useSessionInUrl = false

	$_modifiers = ['nl2br' => '']

	$_storeId

	$_assetRepo

	$_logger

	$_escaper

	$_variableFactory

	$_storeManager

	$_layout

	$_layoutFactory

	$_scopeConfig

	$_directiveParams

	$_appState

	$urlModel

	$emogrifier

	$configVariables

Protected Attributes inherited from Template
	$templateVars = []

	$templateProcessor = null

	$string

Additional Inherited Members
Data Fields inherited from Filter
const	TRANS_DIRECTIVE_NAME = 'trans'

const	TRANS_DIRECTIVE_REGEX = '/^\s([\'"])([^\1]?)(?<!\\\)\1(\s.*)?$/si'

Data Fields inherited from Template
const	CONSTRUCTION_PATTERN = '/{{([a-z]{0,10})(.*?)}}/si'

const	CONSTRUCTION_DEPEND_PATTERN = '/{{depend\s(.?)}}(.?){{\\/depend\s}}/si'

const	CONSTRUCTION_IF_PATTERN = '/{{if\s(.?)}}(.?)({{else}}(.?))?{{\\/if\s*}}/si'

const	CONSTRUCTION_TEMPLATE_PATTERN = '/{{(template)(.*?)}}/si'

const	LOOP_PATTERN = '/{{for(?P<loopItem>.? )(in)(?P<loopData>.?)}}(?P<loopBody>.*?){{\/for}}/si'

Protected Member Functions inherited from Filter
	_getBlockParameters ($value)

	getTransParameters ($value)

	explodeModifiers ($value, $default=null)

	applyModifiers ($value, $modifiers)

	addInlineCssFile ($file)

	getInlineCssFiles ()

Protected Member Functions inherited from Template
	afterFilter ($value)

	resetAfterFilterCallbacks ()

	getParameters ($value)

	getVariable ($value, $default='{no_value_defined}')

	getStackArgs ($stack)

Detailed Description

Template Filter Model @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 12 of file Filter.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\Stdlib\StringUtils	$string,
		\Psr\Log\LoggerInterface	$logger,
		\Magento\Framework\Escaper	$escaper,
		\Magento\Framework\View\Asset\Repository	$assetRepo,
		\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig,
		\Magento\Variable\Model\VariableFactory	$coreVariableFactory,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Framework\View\LayoutInterface	$layout,
		\Magento\Framework\View\LayoutFactory	$layoutFactory,
		\Magento\Framework\App\State	$appState,
		\Magento\Framework\UrlInterface	$urlModel,
		\Pelago\Emogrifier	$emogrifier,
		\Magento\Variable\Model\Source\Variables	$configVariables,
		\Magento\Widget\Model\ResourceModel\Widget	$widgetResource,
		\Magento\Widget\Model\Widget	$widget
	)

Parameters

\Magento\Framework\Stdlib\StringUtils	$string
\Psr\Log\LoggerInterface	$logger
\Magento\Framework\Escaper	$escaper
\Magento\Framework\View\Asset\Repository	$assetRepo
\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig
\Magento\Variable\Model\VariableFactory	$coreVariableFactory
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Framework\View\LayoutInterface	$layout
\Magento\Framework\View\LayoutFactory	$layoutFactory
\Magento\Framework\App\State	$appState
\Magento\Framework\UrlInterface	$urlModel
\Pelago\Emogrifier	$emogrifier
\Magento\Variable\Model\Source\Variables	$configVariables
\Magento\Widget\Model\ResourceModel\Widget	$widgetResource
\Magento\Widget\Model\Widget	$widget	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 42 of file Filter.php.

       {
         $this->_widgetResource = $widgetResource;
         $this->_widget = $widget;
         parent::__construct(
             $string,
             $logger,
             $escaper,
             $assetRepo,
             $scopeConfig,
             $coreVariableFactory,
             $storeManager,
             $layout,
             $layoutFactory,
             $appState,
             $urlModel,
             $emogrifier,
             $configVariables
         );
     }

Member Function Documentation

◆ generateWidget()

generateWidget ( $construction )

General method for generate widget

Parameters

string[] $construction

Returns: string

Definition at line 84 of file Filter.php.

     {
         $params = $this->getParameters($construction[2]);
 
         // Determine what name block should have in layout
         $name = null;
         if (isset($params['name'])) {
             $name = $params['name'];
         }
 
         // validate required parameter type or id
         if (!empty($params['type'])) {
             $type = $params['type'];
         } elseif (!empty($params['id'])) {
             $preConfigured = $this->_widgetResource->loadPreconfiguredWidget($params['id']);
             $type = $preConfigured['widget_type'];
             $params = $preConfigured['parameters'];
         } else {
             return '';
         }
 
         // we have no other way to avoid fatal errors for type like 'cms/widget__link', '_cms/widget_link' etc.
         $xml = $this->_widget->getWidgetByClassType($type);
         if ($xml === null) {
             return '';
         }
 
         // define widget block and check the type is instance of Widget Interface
         $widget = $this->_layout->createBlock($type, $name, ['data' => $params]);
         if (!$widget instanceof \Magento\Widget\Block\BlockInterface) {
             return '';
         }
 
         return $widget->toHtml();
     }

◆ mediaDirective()

mediaDirective ( $construction )

Retrieve media file URL directive

Parameters

string[] $construction

Returns: string

Definition at line 137 of file Filter.php.

     {
         $params = $this->getParameters(html_entity_decode($construction[2], ENT_QUOTES));
         return $this->_storeManager->getStore()
             ->getBaseUrl(\Magento\Framework\UrlInterface::URL_TYPE_MEDIA) . $params['url'];
     }

◆ widgetDirective()

widgetDirective ( $construction )

Generate widget

Parameters

string[] $construction

Returns: string

Definition at line 126 of file Filter.php.

     {
         return $this->generateWidget($construction);
     }

Field Documentation

◆ $_widget

$_widget

protected

Definition at line 22 of file Filter.php.

◆ $_widgetResource

$_widgetResource

protected

Definition at line 17 of file Filter.php.

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

vendor/magento/module-widget/Model/Template/Filter.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ generateWidget()

◆ mediaDirective()

◆ widgetDirective()

Field Documentation

◆ $_widget

◆ $_widgetResource