OldTown\Workflow\Loader\XmlUtil

Complexity

Total Complexity

19

Size/Duplication

Total Lines	158
Duplicated Lines	9.49 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes	3
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getChildElement()	6	14	4
A	getRequiredChildElement()	0	13	2
A	getChildElements()	9	21	4
A	getChildText()	0	10	2
A	getText()	0	16	4
A	getRequiredAttributeValue()	0	17	2
A	encode()	0	4	1

<?php
/**
 * @link https://github.com/old-town/old-town-workflow
 * @author  Malofeykin Andrey  <and-rey2@yandex.ru>
 */
namespace OldTown\Workflow\Loader;

use DOMElement;
use OldTown\Workflow\Exception\NotExistsRequiredAttributeException;
use OldTown\Workflow\Exception\NotExistsRequiredElementException;

/**
 * Class XmlUtil
 *
 * @package OldTown\Workflow\Loader
 */
abstract class XmlUtil
{
    /**
     * Ищет среди потомков элемента $parent, первый элемент с именем тега $childName
     *
     * @param DOMElement $parent
     * @param string $childName
     *
     * @return DOMElement|null
     */
    public static function getChildElement(DOMElement $parent, $childName)
    {
        $listElements = $parent->getElementsByTagName($childName);
        if ($listElements->length > 0) {
            for ($i = 0; $i < $listElements->length; $i++) {

This code seems to be duplicated across your project.

                $currentItem = $listElements->item($i);
                if ($parent->isSameNode($currentItem->parentNode)) {
                    return $currentItem;
                }
            }
        }

        return null;
    }

    /**
     * Ищет среди потомков элемента $parent, первый элемент с именем тега $childName. В случае если элемент не найден,
     * бросается исключение
     *
     * @param DOMElement $parent
     * @param string $childName
     *
     * @return DOMElement
     */
    public static function getRequiredChildElement(DOMElement $parent, $childName)
    {
        $element = static::getChildElement($parent, $childName);

        if (!$element instanceof DOMElement) {
            $errMsg = sprintf('Отсутствует элемен %s', $childName);
            $exception =  new NotExistsRequiredElementException($errMsg);

            throw $exception;
        }

        return $element;
    }



    /**
     * Ищет среди потомков элемента $parent,  элементы с именем тега $childName
     *
     * @param DOMElement $parent
     * @param string $childName
     *
     * @return DOMElement[]|null
     */
    public static function getChildElements(DOMElement $parent, $childName)
    {
        $listElements = $parent->getElementsByTagName($childName);
        if ($listElements->length > 0) {
            $list = [];

            for ($i = 0; $i < $listElements->length; $i++) {

This code seems to be duplicated across your project.

                $currentItem = $listElements->item($i);

                if (!$parent->isSameNode($currentItem->parentNode)) {
                    continue;
                }

                $list[] = $currentItem;
            }

            return $list;
        }

        return [];
    }

    /**
     * Ищет среди потомков элемента $parent, первый элемент с именем тега $childName и возвращает его текст
     *
     * @param DOMElement $parent
     * @param string $childName
     *
     * @return null
     */
    public static function getChildText(DOMElement $parent, $childName)
    {
        $child = self::getChildElement($parent, $childName);

        if (null === $child) {
            return null;
        }

        return self::getText($child);
    }

    /**
     * Получает текст из нод потомков
     *
     * @param DOMElement $node
     * @return string
     */
    public static function getText(DOMElement $node)
    {
        $s = '';
        for ($i = 0; $i < $node->childNodes->length; $i++) {
            $child = $node->childNodes->item($i);

            switch ($child->nodeType) {
                case XML_CDATA_SECTION_NODE:
                case XML_TEXT_NODE: {
                    $s .= $child->nodeValue;
                }
            }
        }

        return $s;
    }

    /**
     * @param DOMElement $node
     * @param string     $attributeName
     *
     * @return string
     */
    public static function getRequiredAttributeValue(DOMElement $node, $attributeName)
    {
        $attributeName = (string)$attributeName;

        $attribute = $node->attributes->getNamedItem($attributeName);
        if (!$attribute) {
            $errMsg = "Отсутствует атрибут {$attributeName} у тега {$node->nodeName}";
            $exception =  new NotExistsRequiredAttributeException($errMsg);
            $exception->setRequiredAttributeName($attributeName);

            throw $exception;
        }

        $value = $attribute->nodeValue;

        return $value;
    }


    /**
     * @fixme Реализовать методу \OldTown\Workflow\Loader\XmlUtil::encode
     *
     * @param string $string
     * @return string
     */
    public static function encode($string)
    {
        return $string;
    }
}