Validator.php

Go to the documentation of this file.

<?php
namespace Magento\Theme\Model\Design\Config;

use \Magento\Framework\Exception\LocalizedException;
use \Magento\Theme\Api\Data\DesignConfigInterface;
use \Magento\Theme\Api\Data\DesignConfigDataInterface;
use \Magento\Framework\Mail\TemplateInterfaceFactory as TemplateFactory;
use \Magento\Framework\Filter\Template;
use \Magento\Framework\Filter\Template\Tokenizer\Parameter as ParameterTokenizer;

class Validator
{
    private $fields = [];

    private $templateFactory;

    public function __construct(TemplateFactory $templateFactory, $fields = [])
    {
        $this->templateFactory = $templateFactory;
        $this->fields = $fields;
    }

    public function validate(DesignConfigInterface $designConfig)
    {
        $designConfigData = $designConfig->getExtensionAttributes()->getDesignConfigData();
        $elements = [];
        foreach ($designConfigData as $designElement) {
            if (!in_array($designElement->getFieldConfig()['field'], $this->fields)) {
                continue;
            }
            /* Save mapping between field names and config paths */
            $elements[$designElement->getFieldConfig()['field']] = [
                'config_path' => $designElement->getPath(),
                'value' => $designElement->getValue()
            ];
        }

        foreach ($elements as $name => $data) {
            $templateId = $data['value'];
            $text = $this->getTemplateText($templateId, $designConfig);
            // Check if template body has a reference to the same config path
            if (preg_match_all(Template::CONSTRUCTION_TEMPLATE_PATTERN, $text, $constructions, PREG_SET_ORDER)) {
                foreach ($constructions as $construction) {
                    $configPath = isset($construction[2]) ? $construction[2] : '';
                    $params = $this->getParameters($configPath);
                    if (isset($params['config_path']) && $params['config_path'] == $data['config_path']) {
                        throw new LocalizedException(
                            __(
                                'The "%templateName" template contains an incorrect configuration, with a reference '
                                . 'to itself. Remove or change the reference, then try again.',
                                ["templateName" => $name]
                            )
                        );
                    };
                }
            }
        }
    }

    private function getScopeId(DesignConfigInterface $designConfig)
    {
        if ($designConfig->getScope() == 'stores') {
            return $designConfig->getScopeId();
        }
        return false;
    }
    private function getTemplateText($templateId, DesignConfigInterface $designConfig)
    {
        // Load template object by configured template id
        $template = $this->templateFactory->create();
        $template->emulateDesign($this->getScopeId($designConfig));
        if (is_numeric($templateId)) {
            $template->load($templateId);
        } else {
            $template->setForcedArea($templateId);
            $template->loadDefault($templateId);
        }
        $text = $template->getTemplateText();
        $template->revertDesign();
        return $text;
    }

    private function getParameters($value)
    {
        $tokenizer = new ParameterTokenizer();
        $tokenizer->setString($value);
        $params = $tokenizer->tokenize();
        return $params;
    }
}