Magento 2 Documentation  2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
Public Member Functions
Reader Class Reference
Inheritance diagram for Reader:
ReaderInterface

Public Member Functions

 __construct ( $fileName, FileResolverInterface $fileResolver, ConfigConverter $converter, Reader\Definition $definitionReader, ReaderFactory $readerFactory, Reader\DomFactory $readerDomFactory, array $idAttributes=[])
 
 read ($scope=null)
 

Detailed Description

UI Component configuration reader

Definition at line 19 of file Reader.php.

Constructor & Destructor Documentation

◆ __construct()

__construct (   $fileName,
FileResolverInterface  $fileResolver,
ConfigConverter  $converter,
Reader\Definition  $definitionReader,
ReaderFactory  $readerFactory,
Reader\DomFactory  $readerDomFactory,
array  $idAttributes = [] 
)

Reader constructor.

Parameters
string$fileName
FileResolverInterface$fileResolver
ConfigConverter$converter
Reader\Definition$definitionReader
ReaderFactory$readerFactory
Reader\DomFactory$readerDomFactory
array$idAttributes

Definition at line 71 of file Reader.php.

79  {
80  $this->fileName = $fileName;
81  $this->fileResolver = $fileResolver;
82  $this->converter = $converter;
83  $this->definitionReader = $definitionReader;
84  $this->readerFactory = $readerFactory;
85  $this->readerDomFactory = $readerDomFactory;
86  $this->idAttributes = array_replace($this->idAttributes, $idAttributes);
87  }
$fileName
Definition: translate.phtml:15

Member Function Documentation

◆ read()

read (   $scope = null)

Load configuration scope

Parameters
string | null$scope
Returns
array

Implements ReaderInterface.

Definition at line 95 of file Reader.php.

96  {
97  $scope = $scope ?: 'global';
98  $fileList = $this->fileResolver->get($this->fileName, $scope);
99  if (!count($fileList)) {
100  return [];
101  }
102  $output = $this->readFiles($fileList);
103 
104  return $output;
105  }
$fileList
Definition: export.php:13

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