View Class Reference

Inheritance diagram for View:

Public Member Functions
	__construct (FileResolverInterface $fileResolver, ConverterInterface $converter, SchemaLocatorInterface $schemaLocator, ValidationStateInterface $validationState, $fileName, $idAttributes=[], $domDocumentClass=\Magento\Framework\Config\Dom::class, $defaultScope='global', $xpath=[])
	getVars ($module)
	getVarValue ($module, $var)
	getMediaEntities ($module, $mediaType)
	getMediaAttributes ($module, $mediaType, $mediaId)
	getExcludedFiles ()
	getExcludedDir ()
	read ($scope=null)
Public Member Functions inherited from Filesystem
	__construct (\Magento\Framework\Config\FileResolverInterface $fileResolver, \Magento\Framework\Config\ConverterInterface $converter, \Magento\Framework\Config\SchemaLocatorInterface $schemaLocator, \Magento\Framework\Config\ValidationStateInterface $validationState, $fileName, $idAttributes=[], $domDocumentClass=\Magento\Framework\Config\Dom::class, $defaultScope='global')
	read ($scope=null)

Protected Member Functions
	getIdAttributes ()
	getItems ()
	initData ()
Protected Member Functions inherited from Filesystem
	_createConfigMerger ($mergerClass, $initialContents)

Protected Attributes
	$xpath
	$data
Protected Attributes inherited from Filesystem
	$_fileResolver
	$_converter
	$_fileName
	$_schema
	$_perFileSchema
	$_idAttributes = []
	$_domDocumentClass
	$validationState
	$_defaultScope
	$_schemaFile

Detailed Description

View configuration files handler

@api

Since

100.0.2

Definition at line 14 of file View.php.

Constructor & Destructor Documentation

__construct()

__construct	(	FileResolverInterface	$fileResolver,
		ConverterInterface	$converter,
		SchemaLocatorInterface	$schemaLocator,
		ValidationStateInterface	$validationState,
			$fileName,
			$idAttributes = [],
			$domDocumentClass = \Magento\Framework\Config\Dom::class,
			$defaultScope = 'global',
			$xpath = []
	)

Parameters

FileResolverInterface	$fileResolver
ConverterInterface	$converter
SchemaLocatorInterface	$schemaLocator
ValidationStateInterface	$validationState
string	$fileName
array	$idAttributes
string	$domDocumentClass
string	$defaultScope
array	$xpath

Definition at line 39 of file View.php.

      {
        $this->xpath = $xpath;
        $idAttributes = $this->getIdAttributes();
        parent::__construct(
            $fileResolver,
            $converter,
            $schemaLocator,
            $validationState,
            $fileName,
            $idAttributes,
            $domDocumentClass,
            $defaultScope
        );
    }

Member Function Documentation

getExcludedDir()

getExcludedDir

(

)

Get excluded directory list

Returns

array

Definition at line 173 of file View.php.

    {
        $items = $this->getItems();
        return $items['directory'] ?? [];
    }

getExcludedFiles()

getExcludedFiles

(

)

Get excluded file list

Returns

array

Definition at line 162 of file View.php.

    {
        $items = $this->getItems();
        return $items['file'] ?? [];
    }

getIdAttributes()

getIdAttributes ( )

protected

Variables are identified by module and name

Returns

array

Definition at line 136 of file View.php.

    {
        $idAttributes = [
            '/view/vars' => 'module',
            '/view/vars/(var/)*var' => 'name',
            '/view/exclude/item' => ['type', 'item'],
        ];
        foreach ($this->xpath as $attribute) {
            if (is_array($attribute)) {
                foreach ($attribute as $key => $id) {
                    if (count($id) > 1) {
                        $idAttributes[$key] = array_values($id);
                    } else {
                        $idAttributes[$key] = array_shift($id);
                    }
                }
            }
        }
        return $idAttributes;
    }

getItems()

getItems ( )

protected

Get a list of excludes

Returns

array

Definition at line 184 of file View.php.

    {
        $this->initData();
        return $this->data['exclude'] ?? [];
    }

getMediaAttributes()

getMediaAttributes	(		$module,
			$mediaType,
			$mediaId
	)

Retrieve array of media attributes

Parameters

string	$module
string	$mediaType
string	$mediaId

Returns

array

Definition at line 125 of file View.php.

    {
        $this->initData();
        return $this->data['media'][$module][$mediaType][$mediaId] ?? [];
    }

getMediaEntities()

getMediaEntities	(		$module,
			$mediaType
	)

Retrieve a list media attributes in scope of specified module

Parameters

string	$module
string	$mediaType

Returns

array

Definition at line 111 of file View.php.

    {
        $this->initData();
        return $this->data['media'][$module][$mediaType] ?? [];
    }

getVars()

getVars

(

$module

)

Get a list of variables in scope of specified module

Returns array(<var_name> => <var_value>)

Parameters

string

$module

Returns

array

Definition at line 72 of file View.php.

    {
        $this->initData();
        return $this->data['vars'][$module] ?? [];
    }

getVarValue()

getVarValue	(		$module,
			$var
	)

Get value of a configuration option variable

Parameters

string	$module
string	$var

Returns

string|false|array

Definition at line 85 of file View.php.

    {
        $this->initData();
        if (!isset($this->data['vars'][$module])) {
            return false;
        }

        $value = $this->data['vars'][$module];
        foreach (explode('/', $var) as $node) {
            if (is_array($value) && isset($value[$node])) {
                $value = $value[$node];
            } else {
                return false;
            }
        }

        return $value;
    }

initData()

initData ( )

protected

Initialize data array

Returns

void

Definition at line 195 of file View.php.

    {
        if ($this->data === null) {
            $this->data = $this->read();
        }
    }

read()

read

(

$scope = null

)

{Read configuration scope

Parameters

string | null

$scope

Returns

array

}

Since

100.1.0

Implements ReaderInterface.

Definition at line 206 of file View.php.

    {
        $scope = $scope ?: $this->_defaultScope;
        $result = [];

        $parents = (array)$this->_fileResolver->getParents($this->_fileName, $scope);
        // Sort parents desc
        krsort($parents);

        foreach ($parents as $parent) {
            $result = array_replace_recursive($result, $this->_readFiles([$parent]));
        }

        return array_replace_recursive($result, parent::read($scope));
    }

Field Documentation

$data

$data

protected

Definition at line 26 of file View.php.

$xpath

$xpath

protected

Definition at line 19 of file View.php.

---

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

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