Converter Class Reference

Inheritance diagram for Converter:

Public Member Functions
	__construct (ArgumentParser $argumentParser, InterpreterInterface $argumentInterpreter, $argumentNodeName, array $idAttributes=[])
	convert ($source)

Data Fields
const	NAME_ATTRIBUTE = 'name'

Protected Member Functions
	convertXml ($elements)
	getElementKey (\DOMElement $element)
	isKeyAttribute (\DOMElement $element, \DOMAttr $attribute)
	getChildNodes (\DOMElement $element)
	castNumeric ($nodeValue)

Protected Attributes
	$argumentParser
	$argumentInterpreter
	$argumentNodeName
	$idAttributes

Detailed Description

Converter for configuration data.

Definition at line 14 of file Converter.php.

Constructor & Destructor Documentation

__construct()

__construct	(	ArgumentParser	$argumentParser,
		InterpreterInterface	$argumentInterpreter,
			$argumentNodeName,
		array	$idAttributes = []
	)

Constructor for Converter object.

Parameters

ArgumentParser	$argumentParser
InterpreterInterface	$argumentInterpreter
string	$argumentNodeName
array	$idAttributes

Definition at line 57 of file Converter.php.

      {
        $this->argumentParser = $argumentParser;
        $this->argumentInterpreter = $argumentInterpreter;
        $this->argumentNodeName = $argumentNodeName;
        $this->idAttributes = $idAttributes;
    }

Member Function Documentation

castNumeric()

castNumeric (   $nodeValue )

protected

Cast nodeValue to int or double.

Parameters

string

$nodeValue

Returns

float|integer

Definition at line 205 of file Converter.php.

    {
        if (is_numeric($nodeValue)) {
            if (preg_match('/^\d+$/', $nodeValue)) {
                $nodeValue = (int) $nodeValue;
            } else {
                $nodeValue = (double) $nodeValue;
            }
        }

        return $nodeValue;
    }

convert()

convert

(

$source

)

Convert XML to array.

Parameters

\DOMDocument

$source

Returns

array

Implements ConverterInterface.

Definition at line 75 of file Converter.php.

    {
        return $this->convertXml($source->documentElement->childNodes);
    }

convertXml()

convertXml (   $elements )

protected

Convert XML node to array or string recursive.

Parameters

\DOMNodeList | array

$elements

Returns

array @SuppressWarnings(PHPMD.CyclomaticComplexity)

Definition at line 87 of file Converter.php.

    {
        $result = [];

        foreach ($elements as $element) {
            if ($element instanceof \DOMElement) {
                if ($element->getAttribute('remove') == 'true') {
                    // Remove element
                    continue;
                }
                if ($element->hasAttribute('xsi:type')) {
                    if ($element->hasAttribute('path')) {
                        $elementData = $this->getAttributes($element);
                        $elementData['value'] = $this->argumentInterpreter->evaluate(
                            $this->argumentParser->parse($element)
                        );
                        unset($elementData['xsi:type'], $elementData['item']);
                    } else {
                        $elementData = $this->argumentInterpreter->evaluate(
                            $this->argumentParser->parse($element)
                        );
                    }
                } else {
                    $elementData = array_merge(
                        $this->getAttributes($element),
                        $this->getChildNodes($element)
                    );
                }
                $key = $this->getElementKey($element);
                if ($key) {
                    $result[$element->nodeName][$key] = $elementData;
                } elseif (!empty($elementData)) {
                    $result[$element->nodeName][] = $elementData;
                }
            } elseif ($element->nodeType == XML_TEXT_NODE && trim($element->nodeValue) != '') {
                return ['value' => $element->nodeValue];
            }
        }

        return $result;
    }

getChildNodes()

getChildNodes ( \DOMElement  $element )

protected

Get child nodes data.

Parameters

\DOMElement

$element

Returns

array

Definition at line 190 of file Converter.php.

    {
        $children = [];
        if ($element->hasChildNodes()) {
            $children = $this->convertXml($element->childNodes);
        }
        return $children;
    }

getElementKey()

getElementKey ( \DOMElement  $element )

protected

Get key for DOM element

Parameters

\DOMElement

$element

Returns

boolean|string

Definition at line 135 of file Converter.php.

    {
        if (isset($this->idAttributes[$element->nodeName])) {
            if ($element->hasAttribute($this->idAttributes[$element->nodeName])) {
                return $element->getAttribute($this->idAttributes[$element->nodeName]);
            }
        }
        if ($element->hasAttribute(self::NAME_ATTRIBUTE)) {
            return $element->getAttribute(self::NAME_ATTRIBUTE);
        }
        return false;
    }

isKeyAttribute()

isKeyAttribute ( \DOMElement  $element, \DOMAttr  $attribute  )

protected

Verify attribute is main key for element.

Parameters

\DOMElement	$element
\DOMAttr	$attribute

Returns

boolean

Definition at line 155 of file Converter.php.

    {
        if (isset($this->idAttributes[$element->nodeName])) {
            return $attribute->name == $this->idAttributes[$element->nodeName];
        } else {
            return $attribute->name == self::NAME_ATTRIBUTE;
        }
    }

Field Documentation

$argumentInterpreter

$argumentInterpreter

protected

Definition at line 33 of file Converter.php.

$argumentNodeName

$argumentNodeName

protected

Definition at line 40 of file Converter.php.

$argumentParser

$argumentParser

protected

Definition at line 26 of file Converter.php.

$idAttributes

$idAttributes

protected

Definition at line 47 of file Converter.php.

NAME_ATTRIBUTE

const NAME_ATTRIBUTE = 'name'

Unique identifier of node.

Definition at line 19 of file Converter.php.

---

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

• vendor/magento/magento2-functional-testing-framework/src/Magento/FunctionalTestingFramework/Config/Converter.php