AbstractComponent Class Reference

Inheritance diagram for AbstractComponent:

Public Member Functions
	__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)
Public Member Functions inherited from UiComponentInterface
	getComponentName ()

Protected Member Functions
	prepareChildComponent (UiComponentInterface $component)
	initObservers (array & $data=[])
Protected Member Functions inherited from DataObject
	_getData ($key)
	_underscore ($name)

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

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

Detailed Description

Abstract class AbstractComponent

@api @SuppressWarnings(PHPMD.NumberOfChildren)

Since

100.0.2

Definition at line 24 of file AbstractComponent.php.

Constructor & Destructor Documentation

__construct()

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

Constructor

Parameters

ContextInterface	$context
	UiComponentInterface[]	$components
array	$data

Definition at line 55 of file AbstractComponent.php.

      {
        $this->context = $context;
        $this->components = $components;
        $this->_data = array_replace_recursive($this->_data, $data);
        $this->initObservers($this->_data);
    }

Member Function Documentation

addComponent()

addComponent	(		$name,
		UiComponentInterface	$component
	)

Add component

Parameters

string	$name
UiComponentInterface	$component

Returns

void

Implements UiComponentInterface.

Definition at line 170 of file AbstractComponent.php.

    {
        $this->components[$name] = $component;
    }

getChildComponents()

getChildComponents

(

)

Get components

Returns

UiComponentInterface[]

Implements UiComponentInterface.

Definition at line 189 of file AbstractComponent.php.

    {
        return $this->components;
    }

getComponent()

getComponent

(

$name

)

Parameters

string

$name

Returns

UiComponentInterface

Implements UiComponentInterface.

Definition at line 179 of file AbstractComponent.php.

    {
        return isset($this->components[$name]) ? $this->components[$name] : null;
    }

getConfiguration()

getConfiguration

(

)

Get component configuration

Returns

array

Implements UiComponentInterface.

Definition at line 224 of file AbstractComponent.php.

    {
        return (array)$this->getData('config');
    }

getContext()

getContext

(

)

Get component context

Returns

ContextInterface

Implements UiComponentInterface.

Definition at line 71 of file AbstractComponent.php.

    {
        return $this->context;
    }

getData()

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

Component data getter

Parameters

string	$key
string | int	$index

Returns

mixed

Implements UiComponentInterface.

Definition at line 264 of file AbstractComponent.php.

    {
        return parent::getData($key, $index);
    }

getDataSourceData()

getDataSourceData

(

)

{Get Data Source data

Returns

array

}

Implements UiComponentInterface.

Definition at line 283 of file AbstractComponent.php.

    {
        return [];
    }

getJsConfig()

getJsConfig

(

UiComponentInterface

$component

)

Get configuration of related JavaScript Component (force extending the root component if component does not extend other component)

Parameters

UiComponentInterface

$component

Returns

array

Definition at line 236 of file AbstractComponent.php.

    {
        $jsConfig = (array)$component->getData('js_config');
        if (!isset($jsConfig['extends'])) {
            $jsConfig['extends'] = $component->getContext()->getNamespace();
        }
        return $jsConfig;
    }

getName()

getName

(

)

Get component name

Returns

string

Implements UiComponentInterface.

Definition at line 81 of file AbstractComponent.php.

    {
        return $this->getData('name');
    }

getTemplate()

getTemplate

(

)

Get template

Returns

string

Implements UiComponentInterface.

Definition at line 214 of file AbstractComponent.php.

    {
        return $this->getData('template') . '.xhtml';
    }

initObservers()

initObservers ( array &  $data = [] )

protected

Initiate observers

Parameters

array

$data

Returns

void

Definition at line 294 of file AbstractComponent.php.

    {
        if (isset($data['observers']) && is_array($data['observers'])) {
            foreach ($data['observers'] as $observerType => $observer) {
                if (!is_object($observer)) {
                    $observer = $this;
                }
                if ($observer instanceof ObserverInterface) {
                    $this->getContext()->getProcessor()->attach($observerType, $observer);
                }
                unset($data['observers']);
            }
        }
    }

prepare()

prepare

(

)

Prepare component configuration

Returns

void

Implements UiComponentInterface.

Definition at line 91 of file AbstractComponent.php.

    {
        $config = $this->getData('config');
        if (isset($config['value']) && $config['value'] instanceof ValueSourceInterface) {
            $config['value'] = $config['value']->getValue($this->getName());
        }
        $this->setData('config', (array)$config);

        $jsConfig = $this->getJsConfig($this);
        if (isset($jsConfig['provider'])) {
            unset($jsConfig['extends']);
            $this->getContext()->addComponentDefinition($this->getName(), $jsConfig);
        } else {
            $this->getContext()->addComponentDefinition($this->getComponentName(), $jsConfig);
        }

        if ($this->hasData('actions')) {
            $this->getContext()->addActions($this->getData('actions'), $this);
        }

        if ($this->hasData('html_blocks')) {
            $this->getContext()->addHtmlBlocks($this->getData('html_blocks'), $this);
        }

        if ($this->hasData('buttons')) {
            $this->getContext()->addButtons($this->getData('buttons'), $this);
        }
        $this->context->getProcessor()->register($this);
        $this->getContext()->getProcessor()->notify($this->getComponentName());
    }

prepareChildComponent()

prepareChildComponent ( UiComponentInterface  $component )

protected

Call prepare method in the component UI

Parameters

UiComponentInterface

$component

Returns

$this

Since

100.1.0

Definition at line 129 of file AbstractComponent.php.

    {
        $childComponents = $component->getChildComponents();
        if (!empty($childComponents)) {
            foreach ($childComponents as $child) {
                $this->prepareChildComponent($child);
            }
        }
        $component->prepare();

        return $this;
    }

prepareDataSource()

prepareDataSource

(

array

$dataSource

)

Prepare Data Source

Parameters

array

$dataSource

Returns

array

Implements UiComponentInterface.

Definition at line 275 of file AbstractComponent.php.

    {
        return $dataSource;
    }

render()

render

(

)

Render component

Returns

string

Implements UiComponentInterface.

Definition at line 157 of file AbstractComponent.php.

    {
        $result = $this->getContext()->getRenderEngine()->render($this, $this->getTemplate());
        return $result;
    }

renderChildComponent()

renderChildComponent

(

$name

)

Render child component

Parameters

string

$name

Returns

string

Implements UiComponentInterface.

Definition at line 200 of file AbstractComponent.php.

    {
        $result = null;
        if (isset($this->components[$name])) {
            $result = $this->components[$name]->render();
        }
        return $result;
    }

setData()

setData	(		$key,
			$value = null
	)

Component data setter

Parameters

string | array	$key
mixed	$value

Returns

void

Implements UiComponentInterface.

Definition at line 252 of file AbstractComponent.php.

    {
        parent::setData($key, $value);
    }

toHtml()

toHtml

(

)

Produce and return block's html output

Returns

string

Implements BlockInterface.

Definition at line 147 of file AbstractComponent.php.

    {
        $this->render();
    }

Field Documentation

$componentData

$componentData = []

protected

Definition at line 41 of file AbstractComponent.php.

$components

$components

protected

Definition at line 36 of file AbstractComponent.php.

$context

$context

protected

Definition at line 31 of file AbstractComponent.php.

$dataSources

$dataSources = []

protected

Definition at line 46 of file AbstractComponent.php.

---

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

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