Inheritance diagram for AbstractBlock:

Public Member Functions
	__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 ()

Static Public Member Functions
static	extractModuleName ($className)

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

const	CACHE_KEY_PREFIX = 'BLOCK_'

Protected Member Functions
	_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
	$_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 Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Base class for all blocks.

Avoid inheriting from this class. Will be deprecated.

Marked as public API because it is actively used now.

@api @SuppressWarnings(PHPMD.ExcessivePublicCount) @SuppressWarnings(PHPMD.ExcessiveClassComplexity) @SuppressWarnings(PHPMD.CouplingBetweenObjects) @SuppressWarnings(PHPMD.TooManyFields) @SuppressWarnings(PHPMD.NumberOfChildren)

Since: 100.0.2

Definition at line 25 of file AbstractBlock.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\View\Element\Context	$context,
		array	$data = `[]`
	)

Constructor

Parameters

\Magento\Framework\View\Element\Context	$context
array	$data

Definition at line 185 of file AbstractBlock.php.

     {
         $this->_request = $context->getRequest();
         $this->_layout = $context->getLayout();
         $this->_eventManager = $context->getEventManager();
         $this->_urlBuilder = $context->getUrlBuilder();
         $this->_cache = $context->getCache();
         $this->_design = $context->getDesignPackage();
         $this->_session = $context->getSession();
         $this->_sidResolver = $context->getSidResolver();
         $this->_scopeConfig = $context->getScopeConfig();
         $this->_assetRepo = $context->getAssetRepository();
         $this->_viewConfig = $context->getViewConfig();
         $this->_cacheState = $context->getCacheState();
         $this->_logger = $context->getLogger();
         $this->_escaper = $context->getEscaper();
         $this->filterManager = $context->getFilterManager();
         $this->_localeDate = $context->getLocaleDate();
         $this->inlineTranslation = $context->getInlineTranslation();
         if (isset($data['jsLayout'])) {
             $this->jsLayout = $data['jsLayout'];
             unset($data['jsLayout']);
         }
         parent::__construct($data);
         $this->_construct();
     }

Member Function Documentation

◆ _afterToHtml()

_afterToHtml ( $html )

protected

Processing block html after rendering

Parameters

string $html

Returns: string

Definition at line 698 of file AbstractBlock.php.

     {
         return $html;
     }

◆ _beforeToHtml()

_beforeToHtml ( )

protected

Before rendering html, but after trying to load cache

Returns: $this

Definition at line 639 of file AbstractBlock.php.

     {
         return $this;
     }

◆ _construct()

_construct ( )

protected

Internal constructor, that is called from real constructor

Please override this one instead of overriding real __construct constructor

Returns: void

Please override this one instead of overriding real __construct constructor

Definition at line 239 of file AbstractBlock.php.

240 {

244 }

◆ _getNotFoundUrl()

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

protected

Get 404 file not found url

Parameters

string	$route
array	$params

Returns: string

Definition at line 803 of file AbstractBlock.php.

     {
         return $this->getUrl($route, $params);
     }

◆ _getSidPlaceholder()

_getSidPlaceholder ( $cacheKey = null )

protected

Get SID placeholder for cache

Parameters

null | string $cacheKey

Returns: string

Definition at line 1134 of file AbstractBlock.php.

     {
         if ($cacheKey === null) {
             $cacheKey = $this->getCacheKey();
         }
 
         return '<!--SID=' . $cacheKey . '-->';
     }

◆ _loadCache()

_loadCache ( )

protected

Load block html from cache storage

Returns: string|false

Definition at line 1089 of file AbstractBlock.php.

     {
         if ($this->getCacheLifetime() === null || !$this->_cacheState->isEnabled(self::CACHE_GROUP)) {
             return false;
         }
         $cacheKey = $this->getCacheKey();
         $cacheData = $this->_cache->load($cacheKey);
         if ($cacheData) {
             $cacheData = str_replace(
                 $this->_getSidPlaceholder($cacheKey),
                 $this->_sidResolver->getSessionIdQueryParam($this->_session) . '=' . $this->_session->getSessionId(),
                 $cacheData
             );
         }
         return $cacheData;
     }

◆ _prepareLayout()

_prepareLayout ( )

protected

Preparing global layout

You can redefine this method in child classes for changing layout

Returns: $this

Definition at line 284 of file AbstractBlock.php.

     {
         return $this;
     }

◆ _saveCache()

_saveCache ( $data )

protected

Save block content to cache storage

Parameters

string $data

Returns: $this

Definition at line 1112 of file AbstractBlock.php.

     {
         if (!$this->getCacheLifetime() || !$this->_cacheState->isEnabled(self::CACHE_GROUP)) {
             return false;
         }
         $cacheKey = $this->getCacheKey();
         $data = str_replace(
             $this->_sidResolver->getSessionIdQueryParam($this->_session) . '=' . $this->_session->getSessionId(),
             $this->_getSidPlaceholder($cacheKey),
             $data
         );
 
         $this->_cache->save($data, $cacheKey, array_unique($this->getCacheTags()), $this->getCacheLifetime());
         return $this;
     }

◆ _toHtml()

_toHtml ( )

protected

Override this method in descendants to produce html

Returns: string

Definition at line 708 of file AbstractBlock.php.

     {
         return '';
     }

◆ addChild()

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

Create block with name: {parent}.{alias} and set as child

Parameters

string	$alias
string	$block
array	$data

Returns: $this new block

Definition at line 385 of file AbstractBlock.php.

     {
         $block = $this->getLayout()->createBlock(
             $block,
             $this->getNameInLayout() . '.' . $alias,
             ['data' => $data]
         );
         $this->setChild($alias, $block);
         return $block;
     }

◆ append()

append	(	$element,
		$alias = `''`
	)

Append element to the end of children list

Parameters

\Magento\Framework\View\Element\AbstractBlock \| string	$element
string	$alias

Returns: $this

Definition at line 598 of file AbstractBlock.php.

     {
         return $this->insert($element, null, true, $alias);
     }

◆ escapeCss()

escapeCss ( $string )

Escape string for the CSS context

Parameters

string $string

Returns: string

Since: 101.0.0

Definition at line 927 of file AbstractBlock.php.

     {
         return $this->_escaper->escapeCss($string);
     }

◆ escapeHtml()

escapeHtml	(	$data,
		$allowedTags = `null`
	)

Escape HTML entities

Parameters

string \| array	$data
array \| null	$allowedTags

Returns: string

Definition at line 890 of file AbstractBlock.php.

     {
         return $this->_escaper->escapeHtml($data, $allowedTags);
     }

◆ escapeHtmlAttr()

escapeHtmlAttr	(	$string,
		$escapeSingleQuote = `true`
	)

Escape a string for the HTML attribute context

Parameters

string	$string
boolean	$escapeSingleQuote

Returns: string

Since: 101.0.0

Definition at line 915 of file AbstractBlock.php.

     {
         return $this->_escaper->escapeHtmlAttr($string, $escapeSingleQuote);
     }

◆ escapeJs()

escapeJs ( $string )

Escape string for the JavaScript context

Parameters

string $string

Returns: string

Since: 101.0.0

Definition at line 902 of file AbstractBlock.php.

     {
         return $this->_escaper->escapeJs($string);
     }

◆ escapeJsQuote()

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

Escape quotes in java scripts

Parameters

string \| array	$data
string	$quote

Returns: string|array

Deprecated:: 101.0.0

Definition at line 994 of file AbstractBlock.php.

     {
         return $this->_escaper->escapeJsQuote($data, $quote);
     }

◆ escapeQuote()

escapeQuote	(	$data,
		$addSlashes = `false`
	)

Escape quotes inside html attributes

Use $addSlashes = false for escaping js that inside html attribute (onClick, onSubmit etc)

Parameters

string	$data
bool	$addSlashes

Returns: string

Deprecated:: 101.0.0

Definition at line 981 of file AbstractBlock.php.

     {
         return $this->_escaper->escapeQuote($data, $addSlashes);
     }

◆ escapeUrl()

escapeUrl ( $string )

Escape URL

Parameters

string $string

Returns: string

Definition at line 954 of file AbstractBlock.php.

     {
         return $this->_escaper->escapeUrl((string)$string);
     }

◆ escapeXssInUrl()

escapeXssInUrl ( $data )

Escape xss in urls

Parameters

string $data

Returns: string

Deprecated:: 101.0.0

Definition at line 966 of file AbstractBlock.php.

     {
         return $this->_escaper->escapeXssInUrl($data);
     }

◆ extractModuleName()

static extractModuleName ( $className )

static

Extract module name from specified block class name

Parameters

string $className

Returns: string

Definition at line 873 of file AbstractBlock.php.

     {
         $namespace = substr(
             $className,
             0,
             strpos($className, '\\' . 'Block')
         );
         return str_replace('\\', '_', $namespace);
     }

◆ formatDate()

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

Retrieve formatting date

Parameters

null \| string \| \DateTimeInterface	$date
int	$format
bool	$showTime
null \| string	$timezone

Returns: string

Definition at line 817 of file AbstractBlock.php.

       {
         $date = $date instanceof \DateTimeInterface ? $date : new \DateTime($date);
         return $this->_localeDate->formatDateTime(
             $date,
             $format,
             $showTime ? $format : \IntlDateFormatter::NONE,
             null,
             $timezone
         );
     }

◆ formatTime()

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

Retrieve formatting time

Parameters

\DateTime \| string \| null	$time
int	$format
bool	$showDate

Returns: string

Definition at line 841 of file AbstractBlock.php.

       {
         $time = $time instanceof \DateTimeInterface ? $time : new \DateTime($time);
         return $this->_localeDate->formatDateTime(
             $time,
             $showDate ? $format : \IntlDateFormatter::NONE,
             $format
         );
     }

◆ getBlockHtml()

getBlockHtml ( $name )

Retrieve block html

Parameters

string $name

Returns: string

Definition at line 555 of file AbstractBlock.php.

     {
         $block = $this->_layout->getBlock($name);
         if ($block) {
             return $block->toHtml();
         }
         return '';
     }

◆ getCacheKey()

getCacheKey ( )

Get Key for caching block content

Returns: string

don't prevent recalculation by saving generated cache key because of ability to render single block instance with different data

Definition at line 1026 of file AbstractBlock.php.

     {
         if ($this->hasData('cache_key')) {
             return static::CACHE_KEY_PREFIX . $this->getData('cache_key');
         }
 
         $key = $this->getCacheKeyInfo();
 
         $key = array_values($key);  // ignore array keys
 
         $key = implode('|', $key);
         $key = sha1($key); // use hashing to hide potentially private data
         return static::CACHE_KEY_PREFIX . $key;
     }

◆ getCacheKeyInfo()

getCacheKeyInfo ( )

Get cache key informative items

Provide string array key to share specific info item with FPC placeholder

Returns: string[]

Definition at line 1016 of file AbstractBlock.php.

     {
         return [$this->getNameInLayout()];
     }

◆ getCacheLifetime()

getCacheLifetime ( )

protected

Get block cache life time

Returns: int|bool|null

Definition at line 1070 of file AbstractBlock.php.

     {
         if (!$this->hasData('cache_lifetime')) {
             return null;
         }
 
         $cacheLifetime = $this->getData('cache_lifetime');
         if (false === $cacheLifetime || null === $cacheLifetime) {
             return null;
         }
 
         return (int)$cacheLifetime;
     }

◆ getCacheTags()

getCacheTags ( )

protected

Get tags array for saving cache

Returns: array

Definition at line 1050 of file AbstractBlock.php.

     {
         if (!$this->hasData('cache_tags')) {
             $tags = [];
         } else {
             $tags = $this->getData('cache_tags');
         }
         $tags[] = self::CACHE_GROUP;
 
         if ($this instanceof IdentityInterface) {
             $tags = array_merge($tags, $this->getIdentities());
         }
         return $tags;
     }

◆ getChildBlock()

getChildBlock ( $alias )

Retrieve child block by name

Parameters

string $alias

Returns: \Magento\Framework\View\Element\AbstractBlock|bool

Definition at line 477 of file AbstractBlock.php.

     {
         $layout = $this->getLayout();
         if (!$layout) {
             return false;
         }
         $name = $layout->getChildName($this->getNameInLayout(), $alias);
         if ($name) {
             return $layout->getBlock($name);
         }
         return false;
     }

◆ getChildChildHtml()

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

Render output of child child element

Parameters

string	$alias
string	$childChildAlias
bool	$useCache

Returns: string

Definition at line 527 of file AbstractBlock.php.

     {
         $layout = $this->getLayout();
         if (!$layout) {
             return '';
         }
         $childName = $layout->getChildName($this->getNameInLayout(), $alias);
         if (!$childName) {
             return '';
         }
         $out = '';
         if ($childChildAlias) {
             $childChildName = $layout->getChildName($childName, $childChildAlias);
             $out = $layout->renderElement($childChildName, $useCache);
         } else {
             foreach ($layout->getChildNames($childName) as $childChild) {
                 $out .= $layout->renderElement($childChild, $useCache);
             }
         }
         return $out;
     }

◆ getChildData()

getChildData	(	$alias,
		$key = `''`
	)

Get a value from child block by specified key

Parameters

string	$alias
string	$key

Returns: mixed

Definition at line 625 of file AbstractBlock.php.

     {
         $child = $this->getChildBlock($alias);
         if ($child) {
             return $child->getData($key);
         }
         return null;
     }

◆ getChildHtml()

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

Retrieve child block HTML

Parameters

string	$alias
boolean	$useCache

Returns: string

Definition at line 497 of file AbstractBlock.php.

     {
         $layout = $this->getLayout();
         if (!$layout) {
             return '';
         }
         $name = $this->getNameInLayout();
         $out = '';
         if ($alias) {
             $childName = $layout->getChildName($name, $alias);
             if ($childName) {
                 $out = $layout->renderElement($childName, $useCache);
             }
         } else {
             foreach ($layout->getChildNames($name) as $child) {
                 $out .= $layout->renderElement($child, $useCache);
             }
         }
 
         return $out;
     }

◆ getChildNames()

getChildNames ( )

Retrieves sorted list of child names

Returns: array

Definition at line 328 of file AbstractBlock.php.

     {
         $layout = $this->getLayout();
         if (!$layout) {
             return [];
         }
         return $layout->getChildNames($this->getNameInLayout());
     }

◆ getGroupChildNames()

getGroupChildNames ( $groupName )

Get a group of child blocks

Returns an array of <alias> => <block> or an array of <alias> => <callback_result> The callback currently supports only $this methods and passes the alias as parameter

Parameters

string $groupName

Returns: array

Definition at line 613 of file AbstractBlock.php.

     {
         return $this->getLayout()->getGroupChildNames($this->getNameInLayout(), $groupName);
     }

◆ getJsId()

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

Generate id for using in JavaScript UI

Function takes an arbitrary amount of parameters

Parameters

string \| null	$arg1
string \| null	$arg2
string \| null	$arg3
string \| null	$arg4
string \| null	$arg5

Returns: string

Definition at line 744 of file AbstractBlock.php.

     {
         $args = [];
         if ($arg1 !== null) {
             $args[] = $arg1;
         }
         if ($arg2 !== null) {
             $args[] = $arg2;
         }
         if ($arg3 !== null) {
             $args[] = $arg3;
         }
         if ($arg4 !== null) {
             $args[] = $arg4;
         }
         if ($arg5 !== null) {
             $args[] = $arg5;
         }
         $rawId = $this->_nameInLayout . '-' . implode('-', $args);
         return trim(preg_replace('/[^a-z0-9]+/', '-', strtolower($rawId)), '-');
     }

◆ getJsLayout()

getJsLayout ( )

Retrieve serialized JS layout configuration ready to use in template

Returns: string

Definition at line 217 of file AbstractBlock.php.

     {
         return json_encode($this->jsLayout);
     }

◆ getLayout()

getLayout ( )

Retrieve layout object

Returns: \Magento\Framework\View\LayoutInterface

Exceptions

Definition at line 295 of file AbstractBlock.php.

     {
         if (!$this->_layout) {
             throw new \Magento\Framework\Exception\LocalizedException(
                 new \Magento\Framework\Phrase('Layout must be initialized')
             );
         }
         return $this->_layout;
     }

◆ getModuleName()

getModuleName ( )

Retrieve module name of block

Returns: string

Definition at line 859 of file AbstractBlock.php.

     {
         if (!$this->_getData('module_name')) {
             $this->setData('module_name', self::extractModuleName(get_class($this)));
         }
         return $this->_getData('module_name');
     }

◆ getNameInLayout()

getNameInLayout ( )

Get block name

Returns: string

Definition at line 1004 of file AbstractBlock.php.

     {
         return $this->_nameInLayout;
     }

◆ getParentBlock()

getParentBlock ( )

Retrieve parent block

Returns: \Magento\Framework\View\Element\AbstractBlock|bool

Definition at line 251 of file AbstractBlock.php.

     {
         $layout = $this->getLayout();
         if (!$layout) {
             return false;
         }
         $parentName = $layout->getParentName($this->getNameInLayout());
         if ($parentName) {
             return $layout->getBlock($parentName);
         }
         return false;
     }

◆ getRequest()

getRequest ( )

Get request

Returns: \Magento\Framework\App\RequestInterface

Definition at line 227 of file AbstractBlock.php.

     {
         return $this->_request;
     }

◆ getUiId()

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

Retrieve data-ui-id attribute

Retrieve data-ui-id attribute which will distinguish link/input/container/anything else in template among others. Function takes an arbitrary amount of parameters.

Parameters

string \| null	$arg1
string \| null	$arg2
string \| null	$arg3
string \| null	$arg4
string \| null	$arg5

Returns: string

Definition at line 727 of file AbstractBlock.php.

     {
         return ' data-ui-id="' . $this->getJsId($arg1, $arg2, $arg3, $arg4, $arg5) . '" ';
     }

◆ getUrl()

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

Generate url by route and parameters

Parameters

string	$route
array	$params

Returns: string

Definition at line 773 of file AbstractBlock.php.

     {
         return $this->_urlBuilder->getUrl($route, $params);
     }

◆ getVar()

getVar	(	$name,
		$module = `null`
	)

Get variable value from view configuration

Module name can be omitted. If omitted, it will be determined automatically.

Parameters

string	$name	variable name
string \| null	$module	optional module name

Returns: string|false

Definition at line 1152 of file AbstractBlock.php.

     {
         $module = $module ?: $this->getModuleName();
         return $this->_viewConfig->getViewConfig()->getVarValue($module, $name);
     }

◆ getViewFileUrl()

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

Retrieve url of a view file

Parameters

string	$fileId
array	$params

Returns: string

Definition at line 785 of file AbstractBlock.php.

     {
         try {
             $params = array_merge(['_secure' => $this->getRequest()->isSecure()], $params);
             return $this->_assetRepo->getUrlWithParams($fileId, $params);
         } catch (\Magento\Framework\Exception\LocalizedException $e) {
             $this->_logger->critical($e);
             return $this->_getNotFoundUrl();
         }
     }

◆ insert()

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

Insert child element into specified position

By default inserts as first element into children list

Parameters

\Magento\Framework\View\Element\AbstractBlock \| string	$element
string \| int \| null	$siblingName
bool	$after
string	$alias

Returns: $this|bool

Definition at line 575 of file AbstractBlock.php.

     {
         $layout = $this->getLayout();
         if (!$layout) {
             return false;
         }
         if ($element instanceof \Magento\Framework\View\Element\AbstractBlock) {
             $elementName = $element->getNameInLayout();
         } else {
             $elementName = $element;
         }
         $layout->setChild($this->_nameInLayout, $elementName, $alias);
         $layout->reorderChild($this->_nameInLayout, $elementName, $siblingName, $after);
         return $this;
     }

◆ isScopePrivate()

isScopePrivate ( )

Determine if the block scope is private or public.

Returns true if scope is private, false otherwise

Returns: bool

Definition at line 1165 of file AbstractBlock.php.

     {
         return $this->_isScopePrivate;
     }

◆ setAttribute()

setAttribute	(	$name,
		$value = `null`
	)

Set block attribute value

Wrapper for method "setData"

Parameters

string	$name
mixed	$value

Returns: $this

Definition at line 346 of file AbstractBlock.php.

     {
         return $this->setData($name, $value);
     }

◆ setChild()

setChild	(	$alias,
		$block
	)

Set child block

Parameters

string	$alias
\Magento\Framework\View\Element\AbstractBlock \| string	$block

Returns: $this

Definition at line 358 of file AbstractBlock.php.

     {
         $layout = $this->getLayout();
         if (!$layout) {
             return $this;
         }
         $thisName = $this->getNameInLayout();
         if ($layout->getChildName($thisName, $alias)) {
             $this->unsetChild($alias);
         }
         if ($block instanceof self) {
             $block = $block->getNameInLayout();
         }
 
         $layout->setChild($thisName, $block, $alias);
 
         return $this;
     }

◆ setLayout()

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

Set layout object

Parameters

\Magento\Framework\View\LayoutInterface $layout

Returns: $this

Definition at line 270 of file AbstractBlock.php.

     {
         $this->_layout = $layout;
         $this->_prepareLayout();
         return $this;
     }

◆ setNameInLayout()

setNameInLayout ( $name )

Sets/changes name of a block in layout

Parameters

string $name

Returns: $this

Definition at line 311 of file AbstractBlock.php.

     {
         if (!empty($this->_nameInLayout) && $this->_layout) {
             if ($name === $this->_nameInLayout) {
                 return $this;
             }
             $this->_layout->renameElement($this->_nameInLayout, $name);
         }
         $this->_nameInLayout = $name;
         return $this;
     }

◆ stripTags()

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

Wrapper for standard strip_tags() function with extra functionality for html entities

Parameters

string	$data
string \| null	$allowableTags
bool	$allowHtmlEntities

Returns: string

Definition at line 940 of file AbstractBlock.php.

     {
         return $this->filterManager->stripTags(
             $data,
             ['allowableTags' => $allowableTags, 'escape' => $allowHtmlEntities]
         );
     }

◆ unsetCallChild()

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

Call a child and unset it, if callback matched result

Variable $params will pass to child callback $params may be array, if called from layout with elements with same name, for example: ...<foo>value_1</foo><foo>value_2</foo><foo>value_3</foo>

Or, if called like this: ...<foo>value_1</foo><bar>value_2</bar><baz>value_3</baz>

then it will be $params1, $params2, $params3

It is no difference anyway, because they will be transformed in appropriate way.

Parameters

string	$alias
string	$callback
mixed	$result
array	$params

Returns: $this

Definition at line 431 of file AbstractBlock.php.

     {
         $child = $this->getChildBlock($alias);
         if ($child) {
             $args = func_get_args();
             $alias = array_shift($args);
             $callback = array_shift($args);
             $result = (string)array_shift($args);
             if (!is_array($params)) {
                 $params = $args;
             }
 
             // @codingStandardsIgnoreStart
             if ($result == call_user_func_array([&$child, $callback], $params)) {
                 $this->unsetChild($alias);
             }
             // @codingStandardsIgnoreEnd
         }
         return $this;
     }

◆ unsetChild()

unsetChild ( $alias )

Unset child block

Parameters

string $alias

Returns: $this

Definition at line 402 of file AbstractBlock.php.

     {
         $layout = $this->getLayout();
         if (!$layout) {
             return $this;
         }
         $layout->unsetChild($this->getNameInLayout(), $alias);
         return $this;
     }

◆ unsetChildren()

unsetChildren ( )

Unset all children blocks

Returns: $this

Definition at line 457 of file AbstractBlock.php.

     {
         $layout = $this->getLayout();
         if (!$layout) {
             return $this;
         }
         $name = $this->getNameInLayout();
         $children = $layout->getChildNames($name);
         foreach ($children as $childName) {
             $layout->unsetChild($name, $childName);
         }
         return $this;
     }

Field Documentation

◆ $_assetRepo

$_assetRepo

protected

Definition at line 113 of file AbstractBlock.php.

◆ $_cache

$_cache

protected

Definition at line 177 of file AbstractBlock.php.

◆ $_cacheState

$_cacheState

protected

Definition at line 127 of file AbstractBlock.php.

◆ $_design

$_design

protected

Definition at line 42 of file AbstractBlock.php.

◆ $_escaper

$_escaper

protected

Definition at line 141 of file AbstractBlock.php.

◆ $_eventManager

$_eventManager

protected

Definition at line 99 of file AbstractBlock.php.

◆ $_frontController

$_frontController

protected

Definition at line 106 of file AbstractBlock.php.

◆ $_isScopePrivate

$_isScopePrivate = false

protected

Definition at line 166 of file AbstractBlock.php.

◆ $_layout

$_layout

protected

Definition at line 70 of file AbstractBlock.php.

◆ $_localeDate

$_localeDate

protected

Definition at line 153 of file AbstractBlock.php.

◆ $_logger

$_logger

protected

Definition at line 134 of file AbstractBlock.php.

◆ $_nameInLayout

$_nameInLayout

protected

Definition at line 63 of file AbstractBlock.php.

◆ $_request

$_request

protected

Definition at line 84 of file AbstractBlock.php.

◆ $_scopeConfig

$_scopeConfig

protected

Definition at line 171 of file AbstractBlock.php.

◆ $_session

$_session

protected

Definition at line 49 of file AbstractBlock.php.

◆ $_sidResolver

$_sidResolver

protected

Definition at line 56 of file AbstractBlock.php.

◆ $_urlBuilder

$_urlBuilder

protected

Definition at line 91 of file AbstractBlock.php.

◆ $_viewConfig

$_viewConfig

protected

Definition at line 120 of file AbstractBlock.php.

◆ $filterManager

$filterManager

protected

Definition at line 148 of file AbstractBlock.php.

◆ $inlineTranslation

$inlineTranslation

protected

Definition at line 158 of file AbstractBlock.php.

◆ $jsLayout

$jsLayout = []

protected

Definition at line 77 of file AbstractBlock.php.

◆ CACHE_GROUP

const CACHE_GROUP = \Magento\Framework\App\Cache\Type\Block::TYPE_IDENTIFIER

Cache group Tag

Definition at line 30 of file AbstractBlock.php.

◆ CACHE_KEY_PREFIX

const CACHE_KEY_PREFIX = 'BLOCK_'

Prefix for cache key of block

Definition at line 35 of file AbstractBlock.php.

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

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

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _afterToHtml()

◆ _beforeToHtml()

◆ _construct()

◆ _getNotFoundUrl()

◆ _getSidPlaceholder()

◆ _loadCache()

◆ _prepareLayout()

◆ _saveCache()

◆ _toHtml()

◆ addChild()

◆ append()

◆ escapeCss()

◆ escapeHtml()

◆ escapeHtmlAttr()

◆ escapeJs()

◆ escapeJsQuote()

◆ escapeQuote()

◆ escapeUrl()

◆ escapeXssInUrl()

◆ extractModuleName()

◆ formatDate()

◆ formatTime()

◆ getBlockHtml()

◆ getCacheKey()

◆ getCacheKeyInfo()

◆ getCacheLifetime()

◆ getCacheTags()

◆ getChildBlock()

◆ getChildChildHtml()

◆ getChildData()

◆ getChildHtml()

◆ getChildNames()

◆ getGroupChildNames()

◆ getJsId()

◆ getJsLayout()

◆ getLayout()

◆ getModuleName()

◆ getNameInLayout()

◆ getParentBlock()

◆ getRequest()

◆ getUiId()

◆ getUrl()

◆ getVar()

◆ getViewFileUrl()

◆ insert()

◆ isScopePrivate()

◆ setAttribute()

◆ setChild()

◆ setLayout()

◆ setNameInLayout()

◆ stripTags()

◆ unsetCallChild()

◆ unsetChild()

◆ unsetChildren()

Field Documentation

◆ $_assetRepo

◆ $_cache

◆ $_cacheState

◆ $_design

◆ $_escaper

◆ $_eventManager

◆ $_frontController

◆ $_isScopePrivate

◆ $_layout

◆ $_localeDate

◆ $_logger

◆ $_nameInLayout

◆ $_request

◆ $_scopeConfig

◆ $_session