Data Class Reference

Inheritance diagram for Data:

Public Member Functions
	__construct (ReaderInterface $reader, CacheInterface $cache, $cacheId, SerializerInterface $serializer=null)
	merge (array $config)
	get ($path=null, $default=null)
	reset ()

Protected Member Functions
	initData ()

Protected Attributes
	$_reader
	$_cache
	$_cacheId
	$cacheTags = []
	$_data = []

Detailed Description

Represents loaded and cached configuration data, should be used to gain access to different types

@SuppressWarnings(PHPMD.NumberOfChildren) @api

Since

100.0.2

Definition at line 18 of file Data.php.

Constructor & Destructor Documentation

__construct()

__construct	(	ReaderInterface	$reader,
		CacheInterface	$cache,
			$cacheId,
		SerializerInterface	$serializer = null
	)

Constructor

Parameters

ReaderInterface	$reader
CacheInterface	$cache
string	$cacheId
SerializerInterface | null	$serializer

Definition at line 83 of file Data.php.

      {
        $this->reader = $reader;
        $this->cache = $cache;
        $this->cacheId = $cacheId;
        $this->serializer = $serializer ?: ObjectManager::getInstance()->get(SerializerInterface::class);
        $this->initData();
    }

Member Function Documentation

get()

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

Get config value by key

Parameters

string	$path
mixed	$default

Returns

array|mixed|null

Implements DataInterface.

Definition at line 132 of file Data.php.

    {
        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;
    }

initData()

initData ( )

protected

Initialise data for configuration

Returns

void

Definition at line 101 of file Data.php.

    {
        $data = $this->cache->load($this->cacheId);
        if (false === $data) {
            $data = $this->reader->read();
            $this->cache->save($this->serializer->serialize($data), $this->cacheId, $this->cacheTags);
        } else {
            $data = $this->serializer->unserialize($data);
        }

        $this->merge($data);
    }

merge()

merge

(

array

$config

)

Merge config data to the object

Parameters

array

$config

Returns

void

Implements DataInterface.

Definition at line 120 of file Data.php.

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

reset()

reset

(

)

Clear cache data

Returns

void

Definition at line 154 of file Data.php.

    {
        $this->cache->remove($this->cacheId);
    }

Field Documentation

$_cache

$_cache

protected

Definition at line 32 of file Data.php.

$_cacheId

$_cacheId

protected

Definition at line 39 of file Data.php.

$_data

$_data = []

protected

Definition at line 53 of file Data.php.

$_reader

$_reader

protected

Definition at line 25 of file Data.php.

$cacheTags

$cacheTags = []

protected

Definition at line 46 of file Data.php.

---

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

• vendor/magento/framework/Config/Data.php