How is Magento\Framework\View\Element\Template\File\Validator::isValid() implemented and used?

dmitry_fedyuk · May 6, 2017, 11:20am

Context: How are the «*.phtml» templates rendered?

Implementation

magento/magento2/blob/2.1.6/lib/internal/Magento/Framework/View/Element/Template/File/Validator.php#L93-L116


/**
 * Checks whether the provided file can be rendered.
 *
 * Available directories which are allowed to be rendered
 * (the template file should be located under these directories):
 *  - app
 *  - design
 *
 * @param string $filename
 * @return bool
 */
public function isValid($filename)
{
    $filename = str_replace('\\', '/', $filename);
    if (!isset($this->_templatesValidationResults[$filename])) {
        $this->_templatesValidationResults[$filename] =
            ($this->isPathInDirectories($filename, $this->_compiledDir)
                || $this->isPathInDirectories($filename, $this->moduleDirs)
                || $this->isPathInDirectories($filename, $this->_themesDir)
                || $this->_isAllowSymlinks)
            && $this->getRootDirectory()->isFile($this->getRootDirectory()->getRelativePath($filename));
    }
    return $this->_templatesValidationResults[$filename];
}

An example of the argument

Usages

Magento\Framework\View\Element\Template::fetchView()

github.com

magento/magento2/blob/2.1.6/lib/internal/Magento/Framework/View/Element/Template.php#L238-L267


/**
 * Retrieve block view from file (template)
 *
 * @param string $fileName
 * @return string
 */
public function fetchView($fileName)
{
    $relativeFilePath = $this->getRootDirectory()->getRelativePath($fileName);
    \Magento\Framework\Profiler::start(
        'TEMPLATE:' . $fileName,
        ['group' => 'TEMPLATE', 'file_name' => $relativeFilePath]
    );


    if ($this->validator->isValid($fileName)) {
        $extension = pathinfo($fileName, PATHINFO_EXTENSION);
        $templateEngine = $this->templateEnginePool->get($extension);
        $html = $templateEngine->render($this->templateContext, $fileName, $this->_viewVars);
    } else {
        $html = '';
        $templatePath = $fileName ?: $this->getTemplate();
        $this->_logger->critical(
            "Invalid template file: '{$templatePath}' in module: '{$this->getModuleName()}'"
            . " block's name: '{$this->getNameInLayout()}'"
        );
    }


    \Magento\Framework\Profiler::stop('TEMPLATE:' . $fileName);
    return $html;
}