Inheritance diagram for Template:

Public Member Functions
	__construct (Template\Context $context, array $data=[])

	setTemplateContext ($templateContext)

	getTemplate ()

	setTemplate ($template)

	getTemplateFile ($template=null)

	getArea ()

	assign ($key, $value=null)

	fetchView ($fileName)

	getBaseUrl ()

	getObjectData (\Magento\Framework\DataObject $object, $key)

	getCacheKeyInfo ()

Public Member Functions inherited from AbstractBlock
	__construct (\Magento\Framework\View\Element\Context $context, array $data=[])

	getJsLayout ()

	getRequest ()

	getParentBlock ()

	setLayout (\Magento\Framework\View\LayoutInterface $layout)

	getLayout ()

	setNameInLayout ($name)

	getChildNames ()

	setAttribute ($name, $value=null)

	setChild ($alias, $block)

	addChild ($alias, $block, $data=[])

	unsetChild ($alias)

	unsetCallChild ($alias, $callback, $result, $params)

	unsetChildren ()

	getChildBlock ($alias)

	getChildHtml ($alias='', $useCache=true)

	getChildChildHtml ($alias, $childChildAlias='', $useCache=true)

	getBlockHtml ($name)

	insert ($element, $siblingName=0, $after=true, $alias='')

	append ($element, $alias='')

	getGroupChildNames ($groupName)

	getChildData ($alias, $key='')

	getUiId ($arg1=null, $arg2=null, $arg3=null, $arg4=null, $arg5=null)

	getJsId ($arg1=null, $arg2=null, $arg3=null, $arg4=null, $arg5=null)

	getUrl ($route='', $params=[])

	getViewFileUrl ($fileId, array $params=[])

	formatDate ( $date=null, $format=\IntlDateFormatter::SHORT, $showTime=false, $timezone=null)

	formatTime ( $time=null, $format=\IntlDateFormatter::SHORT, $showDate=false)

	getModuleName ()

	escapeHtml ($data, $allowedTags=null)

	escapeJs ($string)

	escapeHtmlAttr ($string, $escapeSingleQuote=true)

	escapeCss ($string)

	stripTags ($data, $allowableTags=null, $allowHtmlEntities=false)

	escapeUrl ($string)

	escapeXssInUrl ($data)

	escapeQuote ($data, $addSlashes=false)

	escapeJsQuote ($data, $quote='\'')

	getNameInLayout ()

	getCacheKeyInfo ()

	getCacheKey ()

	getVar ($name, $module=null)

	isScopePrivate ()

Public Member Functions inherited from DataObject
	__construct (array $data=[])

	addData (array $arr)

	setData ($key, $value=null)

	unsetData ($key=null)

	getData ($key='', $index=null)

	getDataByPath ($path)

	getDataByKey ($key)

	setDataUsingMethod ($key, $args=[])

	getDataUsingMethod ($key, $args=null)

	hasData ($key='')

	toArray (array $keys=[])

	convertToArray (array $keys=[])

	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	toJson (array $keys=[])

	convertToJson (array $keys=[])

	toString ($format='')

	__call ($method, $args)

	isEmpty ()

	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')

	debug ($data=null, &$objects=[])

	offsetSet ($offset, $value)

	offsetExists ($offset)

	offsetUnset ($offset)

	offsetGet ($offset)

Public Member Functions inherited from BlockInterface
	toHtml ()

Data Fields
const	XML_PATH_TEMPLATE_ALLOW_SYMLINK = 'dev/template/allow_symlink'

Data Fields inherited from AbstractBlock
const	CACHE_GROUP = \Magento\Framework\App\Cache\Type\Block::TYPE_IDENTIFIER

const	CACHE_KEY_PREFIX = 'BLOCK_'

Protected Member Functions
	_construct ()

	_toHtml ()

	getRootDirectory ()

	getMediaDirectory ()

Protected Member Functions inherited from AbstractBlock
	_construct ()

	_prepareLayout ()

	_beforeToHtml ()

	_afterToHtml ($html)

	_toHtml ()

	_getNotFoundUrl ($route='', $params=['_direct'=> 'core/index/notFound'])

	getCacheTags ()

	getCacheLifetime ()

	_loadCache ()

	_saveCache ($data)

	_getSidPlaceholder ($cacheKey=null)

Protected Member Functions inherited from DataObject
	_getData ($key)

	_underscore ($name)

Protected Attributes
	$_viewVars = []

	$_baseUrl

	$_jsUrl

	$_allowSymlinks

	$_filesystem

	$_template

	$templateEnginePool

	$_storeManager

	$_appState

	$directory

	$templateContext

	$pageConfig

	$resolver

	$validator

Protected Attributes inherited from AbstractBlock
	$_design

	$_session

	$_sidResolver

	$_nameInLayout

	$_layout

	$jsLayout = []

	$_request

	$_urlBuilder

	$_eventManager

	$_frontController

	$_assetRepo

	$_viewConfig

	$_cacheState

	$_logger

	$_escaper

	$filterManager

	$_localeDate

	$inlineTranslation

	$_isScopePrivate = false

	$_scopeConfig

	$_cache

Protected Attributes inherited from DataObject
	$_data = []

Additional Inherited Members
Static Public Member Functions inherited from AbstractBlock
static	extractModuleName ($className)

Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Standard Magento block. Should be used when you declare a block in frontend area layout handle.

Avoid extending this class.

If you need custom presentation logic in your blocks, use this class as block, and declare custom view models in block arguments in layout handle file.

Example: <block name="my.block" class="Magento\Backend\Block\Template" template="My_Module::template.phtml"> <arguments> <argument name="viewModel" xsi:type="object">My\Module\ViewModel\Custom</argument> </arguments> </block>

@api @SuppressWarnings(PHPMD.NumberOfChildren) @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Since: 100.0.2

Definition at line 32 of file Template.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	Template\Context	$context,
		array	$data = `[]`
	)

Constructor

Parameters

Template\Context	$context
array	$data

Definition at line 144 of file Template.php.

     {
         $this->validator = $context->getValidator();
         $this->resolver = $context->getResolver();
         $this->_filesystem = $context->getFilesystem();
         $this->templateEnginePool = $context->getEnginePool();
         $this->_storeManager = $context->getStoreManager();
         $this->_appState = $context->getAppState();
         $this->templateContext = $this;
         $this->pageConfig = $context->getPageConfig();
         parent::__construct($context, $data);
     }

Member Function Documentation

◆ _construct()

_construct ( )

protected

Internal constructor, that is called from real constructor

Returns: void

Definition at line 172 of file Template.php.

     {
         parent::_construct();
 
         /*
          * In case template was passed through constructor
          * we assign it to block's property _template
          * Mainly for those cases when block created
          * not via \Magento\Framework\View\Model\LayoutInterface::addBlock()
          */
         if ($this->hasData('template')) {
             $this->setTemplate($this->getData('template'));
         }
     }

◆ _toHtml()

_toHtml ( )

protected

Render block HTML

Returns: string

Definition at line 296 of file Template.php.

     {
         if (!$this->getTemplate()) {
             return '';
         }
         return $this->fetchView($this->getTemplateFile());
     }

◆ assign()

assign	(	$key,
		$value = `null`
	)

Assign variable

Parameters

string \| array	$key
mixed	$value

Returns: $this

Definition at line 242 of file Template.php.

     {
         if (is_array($key)) {
             foreach ($key as $subKey => $subValue) {
                 $this->assign($subKey, $subValue);
             }
         } else {
             $this->_viewVars[$key] = $value;
         }
         return $this;
     }

◆ fetchView()

fetchView ( $fileName )

Retrieve block view from file (template)

Parameters

string $fileName

Returns: string

Definition at line 260 of file Template.php.

     {
         $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();
             $errorMessage = "Invalid template file: '{$templatePath}' in module: '{$this->getModuleName()}'"
                 . " block's name: '{$this->getNameInLayout()}'";
             if ($this->_appState->getMode() === \Magento\Framework\App\State::MODE_DEVELOPER) {
                 throw new \Magento\Framework\Exception\ValidatorException(
                     new \Magento\Framework\Phrase(
                         $errorMessage
                     )
                 );
             }
             $this->_logger->critical($errorMessage);
         }
 
         \Magento\Framework\Profiler::stop('TEMPLATE:' . $fileName);
         return $html;
     }

◆ getArea()

getArea ( )

Get design area

Returns: string

Definition at line 230 of file Template.php.

     {
         return $this->_getData('area') ? $this->_getData('area') : $this->_appState->getAreaCode();
     }

◆ getBaseUrl()

getBaseUrl ( )

Get base url of the application

Returns: string

Definition at line 309 of file Template.php.

     {
         if (!$this->_baseUrl) {
             $this->_baseUrl = $this->_urlBuilder->getBaseUrl();
         }
         return $this->_baseUrl;
     }

◆ getCacheKeyInfo()

getCacheKeyInfo ( )

Get cache key informative items

Returns: array

Definition at line 334 of file Template.php.

     {
         return [
             'BLOCK_TPL',
             $this->_storeManager->getStore()->getCode(),
             $this->getTemplateFile(),
             'base_url' => $this->getBaseUrl(),
             'template' => $this->getTemplate()
         ];
     }

◆ getMediaDirectory()

getMediaDirectory ( )

protected

Get media directory

Returns: \Magento\Framework\Filesystem\Directory\Read

Definition at line 364 of file Template.php.

     {
         if (!$this->mediaDirectory) {
             $this->mediaDirectory = $this->_filesystem->getDirectoryRead(DirectoryList::MEDIA);
         }
         return $this->mediaDirectory;
     }

◆ getObjectData()

getObjectData	(	\Magento\Framework\DataObject	$object,
			$key
	)

Get data from specified object

Parameters

\Magento\Framework\DataObject	$object
string	$key

Returns: mixed

Definition at line 324 of file Template.php.

     {
         return $object->getDataUsingMethod((string)$key);
     }

◆ getRootDirectory()

getRootDirectory ( )

protected

Instantiates filesystem directory

Returns: \Magento\Framework\Filesystem\Directory\ReadInterface

Definition at line 350 of file Template.php.

     {
         if (null === $this->directory) {
             $this->directory = $this->_filesystem->getDirectoryRead(DirectoryList::ROOT);
         }
 
         return $this->directory;
     }

◆ getTemplate()

getTemplate ( )

Get relevant path to template

Returns: string

Definition at line 192 of file Template.php.

     {
         return $this->_template;
     }

◆ getTemplateFile()

getTemplateFile ( $template = null )

Get absolute path to template

Parameters

string | null $template

Returns: string|bool

Definition at line 215 of file Template.php.

     {
         $params = ['module' => $this->getModuleName()];
         $area = $this->getArea();
         if ($area) {
             $params['area'] = $area;
         }
         return $this->resolver->getTemplateFileName($template ?: $this->getTemplate(), $params);
     }

◆ setTemplate()

setTemplate ( $template )

Set path to template used for generating block's output.

Parameters

string $template

Returns: $this

Definition at line 203 of file Template.php.

     {
         $this->_template = $template;
         return $this;
     }

◆ setTemplateContext()

setTemplateContext ( $templateContext )

Set template context. Sets the object that should represent $block in template

Parameters

\Magento\Framework\View\Element\BlockInterface $templateContext

Returns: void

Definition at line 163 of file Template.php.

     {
         $this->templateContext = $templateContext;
     }

Field Documentation

◆ $_allowSymlinks

$_allowSymlinks

protected

Definition at line 65 of file Template.php.

◆ $_appState

$_appState

protected

Definition at line 100 of file Template.php.

◆ $_baseUrl

$_baseUrl

protected

Definition at line 51 of file Template.php.

◆ $_filesystem

$_filesystem

protected

Definition at line 72 of file Template.php.

◆ $_jsUrl

$_jsUrl

protected

Definition at line 58 of file Template.php.

◆ $_storeManager

$_storeManager

protected

Definition at line 93 of file Template.php.

◆ $_template

$_template

protected

Definition at line 79 of file Template.php.

◆ $_viewVars

$_viewVars = []

protected

Definition at line 44 of file Template.php.

◆ $directory

$directory

protected

Definition at line 107 of file Template.php.

◆ $pageConfig

$pageConfig

protected

Definition at line 126 of file Template.php.

◆ $resolver

$resolver

protected

Definition at line 131 of file Template.php.

◆ $templateContext

$templateContext

protected

Definition at line 121 of file Template.php.

◆ $templateEnginePool

$templateEnginePool

protected

Definition at line 86 of file Template.php.

◆ $validator

$validator

protected

Definition at line 136 of file Template.php.

◆ XML_PATH_TEMPLATE_ALLOW_SYMLINK

const XML_PATH_TEMPLATE_ALLOW_SYMLINK = 'dev/template/allow_symlink'

Config path to 'Allow Symlinks' template settings

Definition at line 37 of file Template.php.

The documentation for this class was generated from the following file:

vendor/magento/framework/View/Element/Template.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _construct()

◆ _toHtml()

◆ assign()

◆ fetchView()

◆ getArea()

◆ getBaseUrl()

◆ getCacheKeyInfo()

◆ getMediaDirectory()

◆ getObjectData()

◆ getRootDirectory()

◆ getTemplate()

◆ getTemplateFile()

◆ setTemplate()

◆ setTemplateContext()

Field Documentation

◆ $_allowSymlinks

◆ $_appState

◆ $_baseUrl

◆ $_filesystem

◆ $_jsUrl

◆ $_storeManager

◆ $_template

◆ $_viewVars

◆ $directory

◆ $pageConfig

◆ $resolver

◆ $templateContext

◆ $templateEnginePool

◆ $validator

◆ XML_PATH_TEMPLATE_ALLOW_SYMLINK