OldTown\Workflow\Loader\WorkflowDescriptor

Complexity

Total Complexity

110

Size/Duplication

Total Lines	980
Duplicated Lines	11.33 %

Coupling/Cohesion

Components	1
Dependencies	16

Test Coverage

Coverage

100%

Importance

Changes	3
Bugs	0	Features	0

34 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	15	2
A	getName()	0	4	1
A	setName()	0	6	1
C	validate()	0	70	9
B	validateDtd()	0	37	3
F	init()	49	122	17
A	getGlobalConditions()	0	4	1
A	addCommonAction()	0	8	1
A	addAction()	0	17	4
A	getStep()	0	15	4
C	getAction()	0	25	7
A	getGlobalActions()	0	4	1
A	getSteps()	0	4	1
A	getInitialActions()	0	4	1
A	getCommonActions()	0	4	1
A	getCommonAction()	0	8	2
A	getInitialAction()	17	17	4
A	getJoins()	0	4	1
A	getJoin()	17	17	4
A	getMetaAttributes()	0	4	1
A	getRegisters()	0	4	1
A	getSplits()	0	4	1
A	getSplit()	17	17	4
A	setTriggerFunction()	0	11	2
A	getTriggerFunction()	0	17	3
A	getTriggerFunctions()	0	4	1
A	addGlobalAction()	0	5	1
A	addInitialAction()	0	5	1
A	addJoin()	0	11	2
A	addSplit()	0	11	2
A	addStep()	0	11	2
A	removeActionActionById()	0	6	1
B	removeAction()	0	27	5
F	writeXml()	11	137	18

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

use OldTown\Workflow\Exception\ArgumentNotNumericException;
use OldTown\Workflow\Exception\InternalWorkflowException;
use OldTown\Workflow\Exception\InvalidArgumentException;
use OldTown\Workflow\Exception\InvalidDescriptorException;
use OldTown\Workflow\Exception\InvalidDtdSchemaException;
use OldTown\Workflow\Exception\InvalidWorkflowDescriptorException;
use DOMElement;
use OldTown\Workflow\Exception\InvalidWriteWorkflowException;
use OldTown\Workflow\Exception\RuntimeException;
use SplObjectStorage;
use DOMDocument;
use DOMImplementation;
use \LibXMLError;

/**
 * Interface WorkflowDescriptor
 *
 * @package OldTown\Workflow\Loader
 */
class WorkflowDescriptor extends AbstractDescriptor implements WriteXmlInterface
{
    /**
     *
     *
     * @var string
     */
    const DOCUMENT_TYPE_QUALIFIED_NAME = 'workflow';

    /**
     *
     *
     * @var string
     */
    const DOCUMENT_TYPE_PUBLIC_ID = '-//OpenSymphony Group//DTD OSWorkflow 2.8//EN';

    /**
     *
     *
     * @var string
     */
    const DOCUMENT_TYPE_SYSTEM_ID = 'http://www.opensymphony.com/osworkflow/workflow_2_8.dtd';



    /**
     * @var ConditionsDescriptor|null
     */
    protected $globalConditions;

    /**
     * @var ActionDescriptor[]|SplObjectStorage
     */
    protected $globalActions;

    /**
     * @var SplObjectStorage|ActionDescriptor[]
     */
    protected $initialActions;

    /**
     * @var JoinDescriptor[]|SplObjectStorage
     */
    protected $joins;

    /**
     * @var RegisterDescriptor[]|SplObjectStorage
     */
    protected $registers;

    /**
     * @var SplitDescriptor[]|SplObjectStorage
     */
    protected $splits = [];

    /**
     * @var StepDescriptor[]|SplObjectStorage
     */
    protected $steps;

    /**
     * @var ActionDescriptor[]
     */
    protected $commonActions = [];

    /**
     * @var ActionDescriptor[]|SplObjectStorage
     */
    protected $commonActionsList = [];

    /**
     * @var array
     */
    protected $metaAttributes = [];

    /**
     * @var array
     */
    protected $timerFunctions = [];

    /**
     * Имя workflow
     *
     * @var string|null
     */
    protected $workflowName;

    /**
     * @param DOMElement $element
     * @throws InvalidArgumentException
     * @throws RuntimeException
     * @throws InternalWorkflowException
     * @throws \OldTown\Workflow\Exception\ArgumentNotNumericException
     */
    public function __construct(DOMElement $element = null)
    {
        $this->registers = new SplObjectStorage();
        $this->initialActions = new SplObjectStorage();
        $this->globalActions = new SplObjectStorage();
        $this->steps = new SplObjectStorage();
        $this->joins = new SplObjectStorage();
        $this->splits = new SplObjectStorage();

        parent::__construct($element);

        if (null !== $element) {
            $this->init($element);
        }
    }

    /**
     * Возвращает имя workflow
     *
     * @return null|string
     */
    public function getName()
    {
        return $this->workflowName;
    }


    /**
     * Устанавливает имя workflow
     *
     * @param string $workflowName
     *
     * @return $this
     */
    public function setName($workflowName)
    {
        $this->workflowName = (string)$workflowName;

        return $this;
    }

    /**
     * Валидация workflow
     *
     * @throws InvalidWorkflowDescriptorException
     * @throws InternalWorkflowException
     * @throws InvalidDescriptorException
     * @throws InvalidWriteWorkflowException
     * @throws  \OldTown\Workflow\Exception\InvalidDtdSchemaException
     * @return void
     */
    public function validate()
    {
        $registers = $this->getRegisters();
        $triggerFunctions = $this->getTriggerFunctions();
        $globalActions = $this->getGlobalActions();
        $initialActions = $this->getInitialActions();
        $commonActions = $this->getCommonActions();
        $steps = $this->getSteps();
        $splits = $this->getSplits();
        $joins = $this->getJoins();


        ValidationHelper::validate($registers);
        ValidationHelper::validate($triggerFunctions);
        ValidationHelper::validate($globalActions);
        ValidationHelper::validate($initialActions);
        ValidationHelper::validate($commonActions);
        ValidationHelper::validate($steps);
        ValidationHelper::validate($splits);
        ValidationHelper::validate($joins);


        $actions = [];

        foreach ($globalActions as $action) {
            $actionId = $action->getId();
            if (array_key_exists($actionId, $actions)) {
                $errMsg = sprintf(
                    'Ошибка валидация. Действие с id %s уже существует',
                    $actionId
                );
                throw new InvalidWorkflowDescriptorException($errMsg);
            }
            $actions[$actionId] = $actionId;
        }

        foreach ($steps as $step) {
            $j = $step->getActions();

            foreach ($j as $action) {
                if (!$action->isCommon()) {
                    $actionId = $action->getId();
                    if (array_key_exists($actionId, $actions)) {
                        $errMsg = sprintf(
                            'Действие с id %s найденное у шага %s является дубликатом',
                            $actionId,
                            $step->getId()
                        );
                        throw new InvalidWorkflowDescriptorException($errMsg);
                    }
                    $actions[$actionId] = $actionId;
                }
            }
        }


        foreach ($commonActions as $action) {
            $actionId = $action->getId();
            if (array_key_exists($actionId, $actions)) {
                $errMsg = sprintf(
                    'common-action  с id %s является дубликатом',
                    $actionId
                );
                throw new InvalidWorkflowDescriptorException($errMsg);
            }
        }


        $this->validateDtd();
    }

    /**
     * Валидация схемы документа
     *
     * @return void
     * @throws InternalWorkflowException
     * @throws InvalidDescriptorException
     * @throws InvalidWriteWorkflowException
     * @throws  \OldTown\Workflow\Exception\InvalidDtdSchemaException
     */
    private function validateDtd()
    {
        $libxmlUseInternalErrors = libxml_use_internal_errors(true);
        $dom = $this->writeXml();

        $secureDtdEntityResolver = new SecureDtdEntityResolver();
        $dtd = $secureDtdEntityResolver->resolveEntity($dom->doctype);


        $systemId = 'data://text/plain;base64,'.base64_encode($dtd);

        $creator = new DOMImplementation;
        $doctype = $creator->createDocumentType(
            static::DOCUMENT_TYPE_QUALIFIED_NAME,
            static::DOCUMENT_TYPE_PUBLIC_ID,
            $systemId
        );
        $new = $creator->createDocument('', '', $doctype);

        $oldNode = $dom->getElementsByTagName(static::DOCUMENT_TYPE_QUALIFIED_NAME)->item(0);
        $newNode = $new->importNode($oldNode, true);
        $new->appendChild($newNode);

        if (!$new->validate()) {
            /** @var LibXMLError[] $errors */
            $errors = libxml_get_errors();
            $errMsgStack = [];
            foreach ($errors as $error) {
                $errMsgStack[] = $error->message;
            }
            $errMsg = implode(" \n", $errMsgStack);

            libxml_use_internal_errors($libxmlUseInternalErrors);
            throw new InvalidDtdSchemaException($errMsg);
        }
        libxml_use_internal_errors($libxmlUseInternalErrors);
    }

    /**
     * @param DOMElement $root
     * @throws InvalidArgumentException
     * @throws RuntimeException
     * @throws InternalWorkflowException
     * @throws \OldTown\Workflow\Exception\ArgumentNotNumericException
     */
    protected function init(DOMElement $root)
    {
        $metaElements = XmlUtil::getChildElements($root, 'meta');
        foreach ($metaElements as $meta) {

This code seems to be duplicated across your project.

            $value = XmlUtil::getText($meta);
            $name = XmlUtil::getRequiredAttributeValue($meta, 'name');

            $this->metaAttributes[$name] = $value;
        }

        // handle registers - OPTIONAL
        $r = XmlUtil::getChildElement($root, 'registers');
        if (null !== $r) {

This code seems to be duplicated across your project.

            $registers = XMLUtil::getChildElements($r, 'register');

            foreach ($registers as $register) {
                $registerDescriptor = DescriptorFactory::getFactory()->createRegisterDescriptor($register);
                $registerDescriptor->setParent($this);
                $this->registers->attach($registerDescriptor);
            }
        }

        // handle global-conditions - OPTIONAL
        $globalConditionsElement = XMLUtil::getChildElement($root, 'global-conditions');
        if ($globalConditionsElement !== null) {
            $globalConditions = XMLUtil::getChildElement($globalConditionsElement, 'conditions');

            $conditionsDescriptor = DescriptorFactory::getFactory()->createConditionsDescriptor($globalConditions);
            $conditionsDescriptor->setParent($this);
            $this->globalConditions = $conditionsDescriptor;
        }

        // handle initial-steps - REQUIRED
        $initialActionsElement = XMLUtil::getChildElement($root, 'initial-actions');
        $initialActions = XMLUtil::getChildElements($initialActionsElement, 'action');

It seems like $initialActionsElement defined by \OldTown\Workflow\Loader\XMLUtil::getChildElement($root, 'initial-actions') on line 330 can be null; however, OldTown\Workflow\Loader\XmlUtil::getChildElements() does not accept null, maybe add an additional type check?

        foreach ($initialActions as $initialAction) {
            $actionDescriptor = DescriptorFactory::getFactory()->createActionDescriptor($initialAction);
            $actionDescriptor->setParent($this);
            $this->addInitialAction($actionDescriptor);
        }

        // handle global-actions - OPTIONAL
        $globalActionsElement = XMLUtil::getChildElement($root, 'global-actions');

        if (null !== $globalActionsElement) {

This code seems to be duplicated across your project.

            $globalActions = XMLUtil::getChildElements($globalActionsElement, 'action');

            foreach ($globalActions as $globalAction) {
                $actionDescriptor = DescriptorFactory::getFactory()->createActionDescriptor($globalAction);
                $actionDescriptor->setParent($this);
                $this->addGlobalAction($actionDescriptor);
            }
        }


        // handle common-actions - OPTIONAL
        //   - Store actions in HashMap for now. When parsing Steps, we'll resolve
        //      any common actions into local references.
        $commonActionsElement = XMLUtil::getChildElement($root, 'common-actions');

        if (null !== $commonActionsElement) {

This code seems to be duplicated across your project.

            $commonActions = XMLUtil::getChildElements($commonActionsElement, 'action');

            foreach ($commonActions as $commonAction) {
                $actionDescriptor = DescriptorFactory::getFactory()->createActionDescriptor($commonAction);
                $actionDescriptor->setParent($this);
                $this->addCommonAction($actionDescriptor);
            }
        }


        // handle timer-functions - OPTIONAL
        $timerFunctionsElement = XMLUtil::getChildElement($root, 'trigger-functions');

        if (null !== $timerFunctionsElement) {
            $timerFunctions = XMLUtil::getChildElements($timerFunctionsElement, 'trigger-function');

            foreach ($timerFunctions as $timerFunction) {
                $functionElement = XmlUtil::getRequiredChildElement($timerFunction, 'function');
                $id = XmlUtil::getRequiredAttributeValue($timerFunction, 'id');

                $function = DescriptorFactory::getFactory()->createFunctionDescriptor($functionElement);
                $function->setParent($this);

                $this->setTriggerFunction($id, $function);
            }
        }

        // handle steps - REQUIRED
        $stepsElement = XMLUtil::getChildElement($root, 'steps');
        $steps = XMLUtil::getChildElements($stepsElement, 'step');

It seems like $stepsElement defined by \OldTown\Workflow\Loader\XMLUtil::getChildElement($root, 'steps') on line 387 can be null; however, OldTown\Workflow\Loader\XmlUtil::getChildElements() does not accept null, maybe add an additional type check?

        foreach ($steps as $step) {
            $stepDescriptor = DescriptorFactory::getFactory()->createStepDescriptor($step, $this);
            $this->addStep($stepDescriptor);
        }


        // handle splits - OPTIONAL:
        $splitsElement = XMLUtil::getChildElement($root, 'splits');
        if (null !== $splitsElement) {

This code seems to be duplicated across your project.

            $split = XMLUtil::getChildElements($splitsElement, 'split');
            foreach ($split as $s) {
                $splitDescriptor = DescriptorFactory::getFactory()->createSplitDescriptor($s);
                $splitDescriptor->setParent($this);
                $this->addSplit($splitDescriptor);
            }
        }


        // handle joins - OPTIONAL:
        $joinsElement = XMLUtil::getChildElement($root, 'joins');
        if (null !== $joinsElement) {

This code seems to be duplicated across your project.

            $join = XMLUtil::getChildElements($joinsElement, 'join');
            foreach ($join as $s) {
                $joinDescriptor = DescriptorFactory::getFactory()->createJoinDescriptor($s);
                $joinDescriptor->setParent($this);
                $this->addJoin($joinDescriptor);
            }
        }
    }

    /**
     * @return null|ConditionsDescriptor
     */
    public function getGlobalConditions()
    {
        return $this->globalConditions;
    }


    /**
     * Добавляет новый переход между действиями
     *
     * @param ActionDescriptor $descriptor
     * @return $this
     *
     * @throws InvalidArgumentException
     * @throws RuntimeException
     */
    public function addCommonAction(ActionDescriptor $descriptor)
    {
        $descriptor->setCommon(true);
        $this->addAction($this->commonActions, $descriptor);
        $this->addAction($this->commonActionsList, $descriptor);

        return $this;
    }

    /**
     * @param                  $actionsCollectionOrMap
     * @param ActionDescriptor $descriptor
     *
     * @return $this
     * @throws InvalidArgumentException
     * @throws RuntimeException
     */
    private function addAction(&$actionsCollectionOrMap, ActionDescriptor $descriptor)
    {
        $descriptorId = $descriptor->getId();
        $action = $this->getAction($descriptorId);
        if (null !== $action) {
            $errMsg = sprintf('Действие с id %s уже существует', $descriptorId);
            throw new InvalidArgumentException($errMsg);
        }

        if ($actionsCollectionOrMap instanceof SplObjectStorage) {
            $actionsCollectionOrMap->attach($descriptor);
        } elseif (is_array($actionsCollectionOrMap)) {
            $actionsCollectionOrMap[$descriptorId] = $descriptor;
        }

        return $this;
    }

    /**
     * Возвращает шаг по его id
     *
     * @param integer $id
     * @return StepDescriptor|null
     * @throws \OldTown\Workflow\Exception\ArgumentNotNumericException
     */
    public function getStep($id)
    {
        if (!is_numeric($id)) {
            $errMsg = 'Аргумент должен быть числом';
            throw new ArgumentNotNumericException($errMsg);
        }
        $id = (integer)$id;

        foreach ($this->getSteps() as $step) {
            if ($id === $step->getId()) {
                return $step;
            }
        }
        return null;
    }

    /**
     * @param integer $id
     * @return ActionDescriptor|null
     */
    public function getAction($id)
    {
        $id = (integer)$id;

        foreach ($this->getGlobalActions() as $actionDescriptor) {
            if ($id === $actionDescriptor->getId()) {
                return $actionDescriptor;
            }
        }

        foreach ($this->getSteps() as $stepDescriptor) {
            $actionDescriptor = $stepDescriptor->getAction($id);
            if (null !== $actionDescriptor) {
                return $actionDescriptor;
            }
        }

        foreach ($this->getInitialActions() as $actionDescriptor) {
            if ($id === $actionDescriptor->getId()) {
                return $actionDescriptor;
            }
        }

        return null;
    }

    /**
     * @return ActionDescriptor[]|SplObjectStorage
     */
    public function getGlobalActions()
    {
        return $this->globalActions;
    }

    /**
     * @return StepDescriptor[]|SplObjectStorage
     */
    public function getSteps()
    {
        return $this->steps;
    }

    /**
     * @return ActionDescriptor[]|SplObjectStorage
     */
    public function getInitialActions()
    {
        return $this->initialActions;
    }

    /**
     * @return ActionDescriptor[]
     */
    public function getCommonActions()
    {
        return $this->commonActions;
    }

    /**
     * @param $id
     *
     * @return ActionDescriptor|null
     */
    public function getCommonAction($id)
    {
        $id = (integer)$id;
        if (array_key_exists($id, $this->commonActions)) {
            return $this->commonActions[$id];
        }
        return null;
    }


    /**
     * @param $id
     *
     * @return ActionDescriptor|null
     * @throws \OldTown\Workflow\Exception\ArgumentNotNumericException
     */
    public function getInitialAction($id)

This method seems to be duplicated in your project.

    {
        if (!is_numeric($id)) {
            $errMsg = 'Аргумент должен быть числом';
            throw new ArgumentNotNumericException($errMsg);
        }
        $id = (integer)$id;

        $initialActions = $this->getInitialActions();
        foreach ($initialActions as $actionDescriptor) {
            if ($id === $actionDescriptor->getId()) {
                return $actionDescriptor;
            }
        }

        return null;
    }

    /**
     * @return JoinDescriptor[]|SplObjectStorage
     */
    public function getJoins()
    {
        return $this->joins;
    }


    /**
     * @param $id
     *
     * @return JoinDescriptor|null
     * @throws \OldTown\Workflow\Exception\ArgumentNotNumericException
     */
    public function getJoin($id)

This method seems to be duplicated in your project.

    {
        if (!is_numeric($id)) {
            $errMsg = 'Аргумент должен быть числом';
            throw new ArgumentNotNumericException($errMsg);
        }
        $id = (integer)$id;

        $joins = $this->getJoins();
        foreach ($joins as $joinDescriptor) {
            if ($id === $joinDescriptor->getId()) {
                return $joinDescriptor;
            }
        }

        return null;
    }

    /**
     * @return array
     */
    public function getMetaAttributes()
    {
        return $this->metaAttributes;
    }

    /**
     * @return RegisterDescriptor[]|SplObjectStorage
     */
    public function getRegisters()
    {
        return $this->registers;
    }

    /**
     * @return SplitDescriptor[]|SplObjectStorage
     */
    public function getSplits()
    {
        return $this->splits;
    }



    /**
     * @param $id
     *
     * @return SplitDescriptor|null
     * @throws \OldTown\Workflow\Exception\ArgumentNotNumericException
     */
    public function getSplit($id)

This method seems to be duplicated in your project.

    {
        if (!is_numeric($id)) {
            $errMsg = 'Аргумент должен быть числом';
            throw new ArgumentNotNumericException($errMsg);
        }
        $id = (integer)$id;

        $splits = $this->getSplits();
        foreach ($splits as $splitDescriptor) {
            if ($id === $splitDescriptor->getId()) {
                return $splitDescriptor;
            }
        }

        return null;
    }

    /**
     * @param integer  $id
     * @param FunctionDescriptor $descriptor
     * @return $this
     *
     * @throws \OldTown\Workflow\Exception\ArgumentNotNumericException
     */
    public function setTriggerFunction($id, FunctionDescriptor $descriptor)
    {
        if (!is_numeric($id)) {
            $errMsg = 'Аргумент должен быть числом';
            throw new ArgumentNotNumericException($errMsg);
        }
        $id = (integer)$id;
        $this->timerFunctions[$id] = $descriptor;

        return $this;
    }

    /**
     * @param integer  $id
     * @return FunctionDescriptor
     * @throws \OldTown\Workflow\Exception\ArgumentNotNumericException
     */
    public function getTriggerFunction($id)
    {
        if (!is_numeric($id)) {
            $errMsg = 'Аргумент должен быть числом';
            throw new ArgumentNotNumericException($errMsg);
        }
        $id = (integer)$id;

        if (!array_key_exists($id, $this->timerFunctions)) {
            $errMsg = sprintf('Не найдена trigger-function с id %s', $id);
            throw new ArgumentNotNumericException($errMsg);
        }

        $this->timerFunctions[$id];

        return $this->timerFunctions[$id];
    }

    /**
     * @return FunctionDescriptor[]
     */
    public function getTriggerFunctions()
    {
        return $this->timerFunctions;
    }

    /**
     * @param ActionDescriptor $descriptor
     * @return $this
     * @throws InvalidArgumentException
     * @throws RuntimeException
     */
    public function addGlobalAction(ActionDescriptor $descriptor)
    {
        $this->addAction($this->globalActions, $descriptor);
        return $this;
    }

    /**
     * @param ActionDescriptor $descriptor
     * @return $this
     * @throws InvalidArgumentException
     * @throws RuntimeException
     */
    public function addInitialAction(ActionDescriptor $descriptor)
    {
        $this->addAction($this->initialActions, $descriptor);
        return $this;
    }


    /**
     * @param JoinDescriptor $descriptor
     * @return $this
     * @throws InvalidArgumentException
     * @throws \OldTown\Workflow\Exception\ArgumentNotNumericException
     */
    public function addJoin(JoinDescriptor $descriptor)
    {
        $id = $descriptor->getId();
        if (null !== $this->getJoin($id)) {
            $errMsg = sprintf('Объеденение с id %s уже существует', $id);
            throw new InvalidArgumentException($errMsg);
        }

        $this->getJoins()->attach($descriptor);
        return $this;
    }


    /**
     * @param SplitDescriptor $descriptor
     * @return $this
     * @throws InvalidArgumentException
     * @throws \OldTown\Workflow\Exception\ArgumentNotNumericException
     */
    public function addSplit(SplitDescriptor $descriptor)
    {
        $id = $descriptor->getId();
        if (null !== $this->getSplit($id)) {
            $errMsg = sprintf('Ветвление с id %s уже существует', $id);
            throw new InvalidArgumentException($errMsg);
        }

        $this->getSplits()->attach($descriptor);
        return $this;
    }

    /**
     * @param StepDescriptor $descriptor
     * @return $this
     *
     * @throws \OldTown\Workflow\Exception\InvalidArgumentException
     * @throws ArgumentNotNumericException
     */
    public function addStep(StepDescriptor $descriptor)
    {
        $id = $descriptor->getId();
        if (null !== $this->getStep($id)) {
            $errMsg = sprintf('Шаг с id %s уже существует', $id);
            throw new InvalidArgumentException($errMsg);
        }

        $this->getSteps()->attach($descriptor);
        return $this;
    }

    /**
     * Удаление action по id
     *
     * @param $id
     *
     * @return bool
     */
    public function removeActionActionById($id)
    {
        $descriptor = $this->getAction($id);

        return $this->removeAction($descriptor);

It seems like $descriptor defined by $this->getAction($id) on line 820 can be null; however, OldTown\Workflow\Loader\WorkflowDescriptor::removeAction() does not accept null, maybe add an additional type check?

    }

    /**
     * @param ActionDescriptor $actionToRemove
     * @return boolean
     */
    public function removeAction(ActionDescriptor $actionToRemove)
    {
        $resultRemove = false;

        $actionToRemoveId = $actionToRemove->getId();
        $globalActions = $this->getGlobalActions();
        foreach ($globalActions as $actionDescriptor) {
            if ($actionToRemoveId === $actionDescriptor->getId()) {
                $globalActions->detach($actionDescriptor);

                $resultRemove = true;
            }
        }

        $steps = $this->getSteps();
        foreach ($steps as $stepDescriptor) {
            $actionDescriptor = $stepDescriptor->getAction($actionToRemoveId);

            if (null !== $actionDescriptor) {
                $stepDescriptor->getActions()->detach($actionDescriptor);

                $resultRemove = true;
            }
        }

        return $resultRemove;
    }


    /**
     * Создает DOMElement - эквивалентный состоянию дескриптора
     *
     * @param DOMDocument|null $dom
     *
     * @return DOMDocument
     * @throws InternalWorkflowException
     * @throws InvalidDescriptorException
     * @throws InvalidWriteWorkflowException
     *
     */
    public function writeXml(DOMDocument $dom = null)
    {
        if (null === $dom) {
            $imp = new DOMImplementation();
            $dtd  = $imp->createDocumentType(
                static::DOCUMENT_TYPE_QUALIFIED_NAME,
                static::DOCUMENT_TYPE_PUBLIC_ID,
                static::DOCUMENT_TYPE_SYSTEM_ID
            );
            $dom = $imp->createDocument('', '', $dtd);
            $dom->encoding = 'UTF-8';
            $dom->xmlVersion = '1.0';
            $dom->formatOutput = true;
        }

        $descriptor = $dom->createElement('workflow');

        $metaAttributes = $this->getMetaAttributes();
        $metaElementBase = $dom->createElement('meta');
        foreach ($metaAttributes as $metaAttributeName => $metaAttributeValue) {

This code seems to be duplicated across your project.

            $metaAttributeNameEncode = XmlUtil::encode($metaAttributeName);
            $metaAttributeValueEnEncode = XmlUtil::encode($metaAttributeValue);

            $metaElement = clone $metaElementBase;
            $metaElement->setAttribute('name', $metaAttributeNameEncode);
            $metaValueElement = $dom->createTextNode($metaAttributeValueEnEncode);
            $metaElement->appendChild($metaValueElement);

            $descriptor->appendChild($metaElement);
        }

        $registers = $this->getRegisters();
        if ($registers->count() > 0) {
            $registersElement = $dom->createElement('registers');
            foreach ($registers as $register) {
                $registerElement = $register->writeXml($dom);
                $registersElement->appendChild($registerElement);
            }

            $descriptor->appendChild($registersElement);
        }


        $timerFunctions = $this->getTriggerFunctions();
        if (count($timerFunctions) > 0) {
            $timerFunctionsElement = $dom->createElement('trigger-functions');
            $timerFunctionElementBase = $dom->createElement('trigger-function');
            foreach ($timerFunctions as $timerFunctionId => $timerFunction) {
                $timerFunctionElement = clone $timerFunctionElementBase;
                $timerFunctionElement->setAttribute('id', $timerFunctionId);

                $functionElement = $timerFunction->writeXml($dom);

                $timerFunctionElement->appendChild($functionElement);

                $timerFunctionsElement->appendChild($timerFunctionElement);
            }
            $descriptor->appendChild($timerFunctionsElement);
        }


        $globalConditions = $this->getGlobalConditions();
        if (null !== $globalConditions) {
            $globalConditionsElement = $dom->createElement('global-conditions');
            $globalConditionElement = $globalConditions->writeXml($dom);
            $globalConditionsElement->appendChild($globalConditionElement);
            $descriptor->appendChild($globalConditionsElement);
        }


        $initialActionsElement = $dom->createElement('initial-actions');
        $initialActions = $this->getInitialActions();
        foreach ($initialActions as $initialAction) {
            $initialActionElement = $initialAction->writeXml($dom);
            $initialActionsElement->appendChild($initialActionElement);
        }
        $descriptor->appendChild($initialActionsElement);


        $globalActions = $this->getGlobalActions();
        if ($globalActions->count() > 0) {
            $globalActionsElement = $dom->createElement('global-actions');
            foreach ($globalActions as $globalAction) {
                $globalActionElement = $globalAction->writeXml($dom);

                $globalActionsElement->appendChild($globalActionElement);
            }

            $descriptor->appendChild($globalActionsElement);
        }

        $commonActions = $this->getCommonActions();
        if (count($commonActions) > 0) {
            $commonActionsElement = $dom->createElement('common-actions');
            foreach ($commonActions as $commonAction) {
                $commonActionElement = $commonAction->writeXml($dom);
                $commonActionsElement->appendChild($commonActionElement);
            }

            $descriptor->appendChild($commonActionsElement);
        }


        $stepsElement = $dom->createElement('steps');
        $steps = $this->getSteps();
        foreach ($steps as $step) {
            $stepElement = $step->writeXml($dom);
            $stepsElement->appendChild($stepElement);
        }

        $descriptor->appendChild($stepsElement);

        $splits = $this->getSplits();
        if ($splits->count() > 0) {
            $splitsElement = $dom->createElement('splits');
            foreach ($splits as $split) {
                $splitElement = $split->writeXml($dom);
                $splitsElement->appendChild($splitElement);
            }

            $descriptor->appendChild($splitsElement);
        }

        $joins = $this->getJoins();
        if ($joins->count() > 0) {
            $joinsElement = $dom->createElement('joins');
            foreach ($joins as $join) {
                $joinElement = $join->writeXml($dom);
                $joinsElement->appendChild($joinElement);
            }

            $descriptor->appendChild($joinsElement);
        }

        $dom->appendChild($descriptor);
        return $dom;

The return type of return $dom; (DOMDocument) is incompatible with the return type declared by the interface OldTown\Workflow\Loader\WriteXmlInterface::writeXml of type DOMElement.

    }
}