Skip to content

Allow filter directive processors to be used with the Widget template filter #28723

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
theCapypara wants to merge 4 commits into from
Closed

Allow filter directive processors to be used with the Widget template filter #28723

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4cd8f37
Allow directiveProcessors to be used with Widget template filter
theCapypara Jun 15, 2020
734afa9
Added phpcs ignore for an old method
theCapypara Sep 2, 2020
65ab5ff
Merge branch '2.4-develop' into feature/widget-allow-directive-proces…
engcom-Charlie Sep 2, 2020
248ab28
Int. test for custom directives in CMS Widget Filter Model
theCapypara Oct 1, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 22 additions & 16 deletions app/code/Magento/Widget/Model/Template/Filter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,21 +22,22 @@ class Filter extends \Magento\Cms\Model\Template\Filter
protected $_widget;

/**
* @param \Magento\Framework\Stdlib\StringUtils $string
* @param \Psr\Log\LoggerInterface $logger
* @param \Magento\Framework\Escaper $escaper
* @param \Magento\Framework\View\Asset\Repository $assetRepo
* @param \Magento\Framework\Stdlib\StringUtils $string
* @param \Psr\Log\LoggerInterface $logger
* @param \Magento\Framework\Escaper $escaper
* @param \Magento\Framework\View\Asset\Repository $assetRepo
* @param \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig
* @param \Magento\Variable\Model\VariableFactory $coreVariableFactory
* @param \Magento\Store\Model\StoreManagerInterface $storeManager
* @param \Magento\Framework\View\LayoutInterface $layout
* @param \Magento\Framework\View\LayoutFactory $layoutFactory
* @param \Magento\Framework\App\State $appState
* @param \Magento\Framework\UrlInterface $urlModel
* @param \Pelago\Emogrifier $emogrifier
* @param \Magento\Variable\Model\Source\Variables $configVariables
* @param \Magento\Widget\Model\ResourceModel\Widget $widgetResource
* @param \Magento\Widget\Model\Widget $widget
* @param \Magento\Variable\Model\VariableFactory $coreVariableFactory
* @param \Magento\Store\Model\StoreManagerInterface $storeManager
* @param \Magento\Framework\View\LayoutInterface $layout
* @param \Magento\Framework\View\LayoutFactory $layoutFactory
* @param \Magento\Framework\App\State $appState
* @param \Magento\Framework\UrlInterface $urlModel
* @param \Pelago\Emogrifier $emogrifier
* @param \Magento\Variable\Model\Source\Variables $configVariables
* @param \Magento\Widget\Model\ResourceModel\Widget $widgetResource
* @param \Magento\Widget\Model\Widget $widget
* @param array $directiveProcessors
* @SuppressWarnings(PHPMD.ExcessiveParameterList)
*/
public function __construct(
Expand All @@ -54,7 +55,8 @@ public function __construct(
\Pelago\Emogrifier $emogrifier,
\Magento\Variable\Model\Source\Variables $configVariables,
\Magento\Widget\Model\ResourceModel\Widget $widgetResource,
\Magento\Widget\Model\Widget $widget
\Magento\Widget\Model\Widget $widget,
array $directiveProcessors = []
) {
$this->_widgetResource = $widgetResource;
$this->_widget = $widget;
Expand All @@ -71,7 +73,10 @@ public function __construct(
$appState,
$urlModel,
$emogrifier,
$configVariables
$configVariables,
[],
null,
$directiveProcessors
);
}

Expand Down Expand Up @@ -140,6 +145,7 @@ public function widgetDirective($construction)
*/
public function mediaDirective($construction)
{
// phpcs:ignore Magento2.Functions.DiscouragedFunction
$params = $this->getParameters(html_entity_decode($construction[2], ENT_QUOTES));
return $this->_storeManager->getStore()
->getBaseUrl(\Magento\Framework\UrlInterface::URL_TYPE_MEDIA) . $params['url'];
Expand Down
14 changes: 14 additions & 0 deletions dev/tests/integration/testsuite/Magento/Widget/Model/Template/FilterTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,18 @@ public function testMediaDirectiveWithEncodedQuotes()
$result = $filter->mediaDirective($construction);
$this->assertEquals($baseUrl . $image, $result);
}

public function testCustomDirective()
{
// via TestModuleSimpleTemplateDirective
$template = '{{mydir "somevalue" param1=yes}}';
$expected = 'SEYEULAVEMOS';

/** @var \Magento\Widget\Model\Template\Filter $filter */
$filter = \Magento\TestFramework\Helper\Bootstrap::getObjectManager()->create(
\Magento\Widget\Model\Template\Filter::class
);
$result = $filter->filter($template);
$this->assertEquals($expected, $result);
}
}