How is Magento\Framework\View\TemplateEngine\Php::render() implemented and used?

dmitry_fedyuk · May 6, 2017, 12:03pm

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

Implementation

magento/magento2/blob/2.1.6/lib/internal/Magento/Framework/View/TemplateEngine/Php.php#L40-L68


/**
 * Render output
 *
 * Include the named PHTML template using the given block as the $this
 * reference, though only public methods will be accessible.
 *
 * @param BlockInterface           $block
 * @param string                   $fileName
 * @param array                    $dictionary
 * @return string
 * @throws \Exception
 */
public function render(BlockInterface $block, $fileName, array $dictionary = [])
{
    ob_start();
    try {
        $tmpBlock = $this->_currentBlock;
        $this->_currentBlock = $block;
        extract($dictionary, EXTR_SKIP);
        include $fileName;
        $this->_currentBlock = $tmpBlock;
    } catch (\Exception $exception) {
        ob_end_clean();
        throw $exception;
    }
    /** Get output buffer. */
    $output = ob_get_clean();
    return $output;
}

An example of arguments

This example uses the standard «Contact Us» frontend form:

The single usage: 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;
}

dmitry_fedyuk · May 6, 2017, 12:06pm