How is Magento\Framework\View\Element\Template::getTemplateFile() implemented and used?

dmitry_fedyuk · May 6, 2017, 10:41am

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

Implementation

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


/**
 * Get absolute path to template
 *
 * @param string|null $template
 * @return string
 */
public function getTemplateFile($template = null)
{
    $params = ['module' => $this->getModuleName()];
    $area = $this->getArea();
    if ($area) {
        $params['area'] = $area;
    }
    return $this->resolver->getTemplateFileName($template ?: $this->getTemplate(), $params);
}

Details: How is Magento\Framework\View\Element\Template\File\Resolver::getTemplateFileName() implemented and used?

Usages

1. Magento\Framework\View\Element\Template::_toHtml()

github.com

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


/**
 * Render block HTML
 *
 * @return string
 */
protected function _toHtml()
{
    if (!$this->getTemplate()) {
        return '';
    }
    return $this->fetchView($this->getTemplateFile());
}

2. Magento\Framework\View\Element\Template::getCacheKeyInfo()

github.com

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


/**
 * Get cache key informative items
 *
 * @return array
 */
public function getCacheKeyInfo()
{
    return [
        'BLOCK_TPL',
        $this->_storeManager->getStore()->getCode(),
        $this->getTemplateFile(),
        'base_url' => $this->getBaseUrl(),
        'template' => $this->getTemplate()
    ];
}

3. Magento\Bundle\Block\Adminhtml\Catalog\Product\Edit\Tab\Attributes\Extend::getElementHtml()

github.com

magento/magento2/blob/2.1.6/app/code/Magento/Bundle/Block/Adminhtml/Catalog/Product/Edit/Tab/Attributes/Extend.php#L66-L75


/**
 * Get Element Html
 *
 * @return string
 */
public function getElementHtml()
{
    $templateFile = $this->getTemplateFile($this->template);
    return $this->fetchView($templateFile);
}

4. Magento_Catalog/view/frontend/templates/product/list/toolbar.phtml

github.com

magento/magento2/blob/2.1.6/app/code/Magento/Catalog/view/frontend/templates/product/list/toolbar.phtml#L19-L33


<div class="toolbar toolbar-products" data-mage-init='<?php /* @escapeNotVerified */ echo $block->getWidgetOptionsJson(); ?>'>
    <?php if ($block->isExpanded()): ?>
        <?php include ($block->getTemplateFile('Magento_Catalog::product/list/toolbar/viewmode.phtml')) ?>
    <?php endif; ?>


    <?php include ($block->getTemplateFile('Magento_Catalog::product/list/toolbar/amount.phtml')) ?>


    <?php echo $block->getPagerHtml() ?>


    <?php include ($block->getTemplateFile('Magento_Catalog::product/list/toolbar/limiter.phtml')) ?>


    <?php if ($block->isExpanded()): ?>
        <?php include ($block->getTemplateFile('Magento_Catalog::product/list/toolbar/sorter.phtml')) ?>
    <?php endif; ?>
</div>

5. Magento_Shipping/view/adminhtml/templates/order/packaging/popup.phtml

github.com

magento/magento2/blob/2.1.6/app/code/Magento/Shipping/view/adminhtml/templates/order/packaging/popup.phtml#L81-L81


<?php include ($block->getTemplateFile('Magento_Shipping::order/packaging/popup_content.phtml')) ?>

6. Magento\Theme\Block\Html\Footer::getCacheKeyInfo()

github.com

magento/magento2/blob/2.1.6/app/code/Magento/Theme/Block/Html/Footer.php#L63-L79


/**
 * Get cache key informative items
 *
 * @return array
 */
public function getCacheKeyInfo()
{
    return [
        'PAGE_FOOTER',
        $this->_storeManager->getStore()->getId(),
        (int)$this->_storeManager->getStore()->isCurrentlySecure(),
        $this->_design->getDesignTheme()->getId(),
        $this->httpContext->getValue(Context::CONTEXT_AUTH),
        $this->getTemplateFile(),
        'template' => $this->getTemplate()
    ];
}