DuplicateNodeValidationUtil.php

Go to the documentation of this file.

<?php
namespace Magento\FunctionalTestingFramework\Util\Validation;

use Magento\FunctionalTestingFramework\Exceptions\Collector\ExceptionCollector;
use Magento\FunctionalTestingFramework\Exceptions\XmlException;

class DuplicateNodeValidationUtil
{
    private $uniqueKey;

    private $exceptionCollector;

    public function __construct($uniqueKey, $exceptionCollector)
    {
        $this->uniqueKey = $uniqueKey;
        $this->exceptionCollector = $exceptionCollector;
    }

    public function validateChildUniqueness(\DOMElement $parentNode, $filename, $parentKey)
    {
        $childNodes = $parentNode->childNodes;
        $type = ucfirst($parentNode->tagName);

        $keyValues = [];
        for ($i = 0; $i < $childNodes->length; $i++) {
            $currentNode = $childNodes->item($i);

            if (!is_a($currentNode, \DOMElement::class)) {
                continue;
            }

            if ($currentNode->hasAttribute($this->uniqueKey)) {
                $keyValues[] = $currentNode->getAttribute($this->uniqueKey);
            }
        }

        $withoutDuplicates = array_unique($keyValues);

        if (count($withoutDuplicates) != count($keyValues)) {
            $duplicates = array_diff_assoc($keyValues, $withoutDuplicates);
            $keyError = "";
            foreach ($duplicates as $duplicateKey => $duplicateValue) {
                $keyError .= "\t{$this->uniqueKey}: {$duplicateValue} is used more than once.";
                if ($parentKey !== null) {
                    $keyError .=" (Parent: {$parentKey})";
                }
                $keyError .= "\n";
            }

            $errorMsg = "{$type} cannot use {$this->uniqueKey}s more than once.\t\n{$keyError}\tin file: {$filename}";
            $this->exceptionCollector->addError($filename, $errorMsg);
        }
    }
}