Magento 2 Documentation  2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
Public Member Functions | Data Fields
Converter Class Reference
Inheritance diagram for Converter:
ConverterInterface

Public Member Functions

 __construct (Parser $argumentParser, ParserInterface $parser, ReaderInterface $reader, ConverterUtils $converterUtils)
 
 convert ($source)
 

Data Fields

const DATA_ATTRIBUTES_KEY = 'attributes'
 
const DATA_ARGUMENTS_KEY = 'arguments'
 
const DATA_COMPONENTS_KEY = 'children'
 
const ARGUMENT_KEY = 'argument'
 
const SETTINGS_KEY = 'settings'
 
const NAME_ATTRIBUTE_KEY = 'name'
 
const CLASS_ATTRIBUTE_KEY = 'class'
 

Detailed Description

Converter for UI Component instances configuration files

Definition at line 16 of file Converter.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( Parser  $argumentParser,
ParserInterface  $parser,
ReaderInterface  $reader,
ConverterUtils  $converterUtils 
)
Parameters
Parser$argumentParser
ParserInterface$parser
ReaderInterface$reader
ConverterUtils$converterUtils

Definition at line 84 of file Converter.php.

89  {
90  $this->argumentParser = $argumentParser;
91  $this->reader = $reader;
92  $this->parser = $parser;
93  $this->converterUtils = $converterUtils;
94  }

Member Function Documentation

◆ convert()

convert (   $source)

Convert configuration to array

Parameters
\DOMDocument | null$source
Returns
array

Convert dom node tree to array

Parameters
\DOMDocument$source
Returns
array

Convert config

Parameters
\DOMDocument$source
Returns
array

Convert dom node tree to array

Parameters
\DOMDocument$source
Returns
array
Exceptions

Implements ConverterInterface.

Definition at line 152 of file Converter.php.

153  {
154  if ($source === null) {
155  return [];
156  }
157 
158  if (!$this->schemaMap) {
159  $this->schemaMap = $this->reader->read();
160  }
161  $result = $this->toArray($source);
162  return empty($result) ? $result : reset($result);
163  }
$source
Definition: source.php:23

Field Documentation

◆ ARGUMENT_KEY

const ARGUMENT_KEY = 'argument'

The key of the arguments node

Definition at line 36 of file Converter.php.

◆ CLASS_ATTRIBUTE_KEY

const CLASS_ATTRIBUTE_KEY = 'class'

Key class attribute value

Definition at line 51 of file Converter.php.

◆ DATA_ARGUMENTS_KEY

const DATA_ARGUMENTS_KEY = 'arguments'

The key for the data arguments

Definition at line 26 of file Converter.php.

◆ DATA_ATTRIBUTES_KEY

const DATA_ATTRIBUTES_KEY = 'attributes'

The key attributes of a node

Definition at line 21 of file Converter.php.

◆ DATA_COMPONENTS_KEY

const DATA_COMPONENTS_KEY = 'children'

The key of sub components

Definition at line 31 of file Converter.php.

◆ NAME_ATTRIBUTE_KEY

const NAME_ATTRIBUTE_KEY = 'name'

Key name attribute value

Definition at line 46 of file Converter.php.

◆ SETTINGS_KEY

const SETTINGS_KEY = 'settings'

The key of the settings component

Definition at line 41 of file Converter.php.


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