Data Class Reference

Inheritance diagram for Data:

Public Member Functions
	__construct ( $componentName, ReaderFactory $readerFactory, CacheInterface $cache, SerializerInterface $serializer, InterpreterInterface $argumentInterpreter)
	merge (array $config)
	get ($path=null, $default=null)

Data Fields
const	CACHE_ID = 'ui_component_configuration_data'
const	SEARCH_PATTERN = '%s.xml'

Detailed Description

UI Component configuration data

Definition at line 16 of file Data.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$componentName,
		ReaderFactory	$readerFactory,
		CacheInterface	$cache,
		SerializerInterface	$serializer,
		InterpreterInterface	$argumentInterpreter
	)

Parameters

string	$componentName
ReaderFactory	$readerFactory
CacheInterface	$cache
SerializerInterface	$serializer
InterpreterInterface	$argumentInterpreter

Definition at line 74 of file Data.php.

      {
        $this->readerFactory = $readerFactory;
        $this->cache = $cache;
        $this->serializer = $serializer;
        $this->componentName = $componentName;
        $this->argumentInterpreter = $argumentInterpreter;
        $this->cacheId = static::CACHE_ID . '_' . $componentName;
    }

Member Function Documentation

get()

get	(		$path = null,
			$default = null
	)

Get config value by key

Parameters

string	$path
mixed	$default

Returns

mixed

Implements DataInterface.

Definition at line 133 of file Data.php.

    {
        if (empty($this->data)) {
            $this->initData();
        }
        if ($path === null) {
            return $this->data;
        }
        $keys = explode('/', $path);
        $data = $this->data;
        foreach ($keys as $key) {
            if (is_array($data) && array_key_exists($key, $data)) {
                $data = $data[$key];
            } else {
                return $default;
            }
        }
        return $data;
    }

merge()

merge

(

array

$config

)

Merge config data to the object

Parameters

array

$config

Returns

void

Implements DataInterface.

Definition at line 121 of file Data.php.

    {
        $this->data = array_replace_recursive($this->get(), $config);
    }

Field Documentation

CACHE_ID

const CACHE_ID = 'ui_component_configuration_data'

ID in the storage cache

Definition at line 21 of file Data.php.

SEARCH_PATTERN

const SEARCH_PATTERN = '%s.xml'

Search pattern

Definition at line 26 of file Data.php.

---

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

• vendor/magento/module-ui/Config/Data.php