OperationDom.php

Go to the documentation of this file.

<?php
namespace Magento\FunctionalTestingFramework\DataGenerator\Config;

use Magento\FunctionalTestingFramework\Config\Dom\NodeMergingConfig;
use Magento\FunctionalTestingFramework\Config\Dom\NodePathMatcher;
use Magento\FunctionalTestingFramework\Exceptions\Collector\ExceptionCollector;
use Magento\FunctionalTestingFramework\Util\Validation\DuplicateNodeValidationUtil;

class OperationDom extends \Magento\FunctionalTestingFramework\Config\MftfDom
{
    const METADATA_FILE_NAME_ENDING = "meta";
    const METADATA_META_FILENAME_ATTRIBUTE = "filename";
    const METADATA_META_NAME_ATTRIBUTE = "name";

    private $validationUtil;

    public function __construct(
        $xml,
        $filename,
        $exceptionCollector,
        array $idAttributes = [],
        $typeAttributeName = null,
        $schemaFile = null,
        $errorFormat = self::ERROR_FORMAT_DEFAULT
    ) {
        $this->validationUtil = new DuplicateNodeValidationUtil('key', $exceptionCollector);
        parent::__construct(
            $xml,
            $filename,
            $exceptionCollector,
            $idAttributes,
            $typeAttributeName,
            $schemaFile,
            $errorFormat
        );
    }

    public function initDom($xml, $filename = null)
    {
        $dom = parent::initDom($xml, $filename);

        if (strpos($filename, self::METADATA_FILE_NAME_ENDING)) {
            $operationNodes = $dom->getElementsByTagName('operation');
            foreach ($operationNodes as $operationNode) {
                $operationNode->setAttribute(self::METADATA_META_FILENAME_ATTRIBUTE, $filename);
                $this->validateOperationElements(
                    $operationNode,
                    $filename,
                    $operationNode->getAttribute(self::METADATA_META_NAME_ATTRIBUTE)
                );
            }
        }

        return $dom;
    }

    public function validateOperationElements(\DOMElement $parentNode, $filename, $topParent)
    {
        $this->validationUtil->validateChildUniqueness(
            $parentNode,
            $filename,
            $topParent
        );
        $childNodes = $parentNode->childNodes;

        for ($i = 0; $i < $childNodes->length; $i++) {
            $currentNode = $childNodes->item($i);
            if (!is_a($currentNode, \DOMElement::class)) {
                continue;
            }
            $this->validateOperationElements(
                $currentNode,
                $filename,
                $topParent
            );
        }
    }
}