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

dmitry_fedyuk · May 6, 2017, 11:01am

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

Implementation

magento/magento2/blob/2.1.6/lib/internal/Magento/Framework/View/Element/Template/File/Resolver.php#L38-L52


/**
 * Get template filename
 *
 * @param string $template
 * @param [] $params
 * @return string|bool
 */
public function getTemplateFileName($template, $params = [])
{
    $key = $template . '_' . serialize($params);
    if (!isset($this->_templateFilesMap[$key])) {
        $this->_templateFilesMap[$key] = $this->_viewFileSystem->getTemplateFileName($template, $params);
    }
    return $this->_templateFilesMap[$key];
}

An example of result

An example of arguments

An example of the method’s arguments (for the standard «Contact Us» frontend form):

Usages

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

2. Magento\Customer\Block\Adminhtml\Edit\Tab\Cart::getGridParentHtml()

github.com

magento/magento2/blob/2.1.6/app/code/Magento/Customer/Block/Adminhtml/Edit/Tab/Cart.php#L208-L217


/**
 * Gets grid parent html
 *
 * @return string
 */
public function getGridParentHtml()
{
    $templateName = $this->resolver->getTemplateFileName($this->_parentTemplate, ['_relative' => true]);
    return $this->fetchView($templateName);
}

3. Magento\Paypal\Block\Iframe::_construct()

github.com

magento/magento2/blob/2.1.6/app/code/Magento/Paypal/Block/Iframe.php#L98-L119


/**
 * Internal constructor
 *
 * @return void
 */
protected function _construct()
{
    parent::_construct();
    $paymentCode = $this->_getCheckout()->getQuote()->getPayment()->getMethod();
    if (in_array($paymentCode, $this->_hssHelper->getHssMethods())) {
        $this->_paymentMethodCode = $paymentCode;
        $templatePath = str_replace('_', '', $paymentCode);
        $templateFile = "{$templatePath}/iframe.phtml";
        $directory = $this->readFactory->create($this->reader->getModuleDir('', 'Magento_Paypal'));
        $file = $this->resolver->getTemplateFileName($templateFile, ['module' => 'Magento_Paypal']);
        if ($file && $directory->isExist($directory->getRelativePath($file))) {
            $this->setTemplate($templateFile);
        } else {
            $this->setTemplate('hss/iframe.phtml');
        }
    }
}