HtmlContent Class Reference

Inheritance diagram for HtmlContent:

Public Member Functions
	__construct (ContextInterface $context, BlockInterface $block, array $components=[], array $data=[])
	getBlock ()
	getComponentName ()
	render ()
	getConfiguration ()
Public Member Functions inherited from AbstractComponent
	__construct (ContextInterface $context, array $components=[], array $data=[])
	getContext ()
	getName ()
	prepare ()
	toHtml ()
	render ()
	addComponent ($name, UiComponentInterface $component)
	getComponent ($name)
	getChildComponents ()
	renderChildComponent ($name)
	getTemplate ()
	getConfiguration ()
	getJsConfig (UiComponentInterface $component)
	setData ($key, $value=null)
	getData ($key='', $index=null)
	prepareDataSource (array $dataSource)
	getDataSourceData ()
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)

Data Fields
const	NAME = 'html_content'

Protected Attributes
	$block
Protected Attributes inherited from AbstractComponent
	$context
	$components
	$componentData = []
	$dataSources = []
Protected Attributes inherited from DataObject
	$_data = []

Additional Inherited Members
Protected Member Functions inherited from AbstractComponent
	prepareChildComponent (UiComponentInterface $component)
	initObservers (array & $data=[])
Protected Member Functions inherited from DataObject
	_getData ($key)
	_underscore ($name)
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Definition at line 12 of file HtmlContent.php.

Constructor & Destructor Documentation

__construct()

__construct	(	ContextInterface	$context,
		BlockInterface	$block,
		array	$components = [],
		array	$data = []
	)

Parameters

ContextInterface	$context
BlockInterface	$block
array	$components
array	$data

Definition at line 27 of file HtmlContent.php.

      {
        parent::__construct($context, $components, $data);
        $this->block = $block;
    }

Member Function Documentation

getBlock()

getBlock

(

)

Get wrapped block

Returns

BlockInterface

Implements BlockWrapperInterface.

Definition at line 42 of file HtmlContent.php.

    {
        return $this->block;
    }

getComponentName()

getComponentName

(

)

Get component name

Returns

string

Implements UiComponentInterface.

Definition at line 52 of file HtmlContent.php.

    {
        return static::NAME;
    }

getConfiguration()

getConfiguration

(

)

@inheritDoc

Implements UiComponentInterface.

Definition at line 68 of file HtmlContent.php.

    {
        $configuration = parent::getConfiguration();
        if ($this->getData('wrapper/canShow') !== false) {
            if ($this->getData('isAjaxLoaded')) {
                $configuration['url'] = $this->getData('url');
            } else {
                if (!$this->getData('config/content')) { //add html block cony into cache
                    $content = $this->block->toHtml();
                    $this->addData(['config' => ['content' => $content]]);
                }

                $configuration['content'] = $this->getData('config/content');
            }
            if ($this->getData('wrapper')) {
                $configuration = array_merge($this->getData(), $this->getData('wrapper'));
            }
        }
        return $configuration;
    }

render()

render

(

)

@inheritDoc

Implements UiComponentInterface.

Definition at line 60 of file HtmlContent.php.

    {
        return $this->getData('config/content') ?: $this->block->toHtml();
    }

Field Documentation

$block

$block

protected

Definition at line 19 of file HtmlContent.php.

NAME

const NAME = 'html_content'

Definition at line 14 of file HtmlContent.php.

---

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

• vendor/magento/module-ui/Component/HtmlContent.php