OldTown\Workflow\ZF2\ServiceEngine\Workflow

Complexity

Total Complexity

50

Size/Duplication

Total Lines	470
Duplicated Lines	2.13 %

Coupling/Cohesion

Components	1
Dependencies	20

Importance

Changes	7
Bugs	0	Features	0

17 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
B	init()	0	21	5
B	doAction()	5	51	5
A	getAvailableActions()	0	23	3
C	findActionByNameForEntry()	0	31	7
B	initialize()	5	54	8
A	getModuleOptions()	0	4	1
A	setModuleOptions()	0	6	1
A	getWorkflowManager()	0	17	3
C	getActionByName()	0	27	8
A	hasWorkflowManager()	0	6	1
A	getWorkflowManagerServiceName()	0	4	1
A	getWorkflowManagerServiceNamePattern()	0	4	1
A	setWorkflowManagerServiceNamePattern()	0	6	1
A	getManagerNameByAlias()	0	10	2
A	hasWorkflowManagerAlias()	0	5	1
A	getWorkflowManagerByAlias()	0	5	1

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

use OldTown\Workflow\Loader\WorkflowDescriptor;
use OldTown\Workflow\TransientVars\TransientVarsInterface;
use OldTown\Workflow\WorkflowInterface;
use Zend\EventManager\EventManagerAwareTrait;
use Zend\ServiceManager\ServiceLocatorAwareTrait;
use Traversable;
use Zend\Stdlib\ArrayUtils;
use OldTown\Workflow\TransientVars\BaseTransientVars;
use OldTown\Workflow\ZF2\Event\WorkflowEvent;
use OldTown\Workflow\ZF2\ServiceEngine\Workflow\TransitionResult;
use OldTown\Workflow\ZF2\ServiceEngine\Workflow\TransitionResultInterface;
use OldTown\Workflow\ZF2\Options\ModuleOptions;
use OldTown\Workflow\Loader\ActionDescriptor;

/**
 * Class Workflow
 *
 * @package OldTown\Workflow\ZF2\ServiceEngine
 */
class Workflow implements WorkflowServiceInterface
{
    use ServiceLocatorAwareTrait, EventManagerAwareTrait;

    /**
     * Паттерн для получения имени сервиса workflow
     *
     * @var string
     */
    protected $workflowManagerServiceNamePattern = 'workflow.manager.%s';

    /**
     * Конфигурация модуля
     *
     * @var ModuleOptions
     */
    protected $moduleOptions;

    /**
     * @param $options
     *
     * @throws \Zend\Stdlib\Exception\InvalidArgumentException
     * @throws \OldTown\Workflow\ZF2\Service\Exception\InvalidArgumentException
     * @throws \OldTown\Workflow\ZF2\ServiceEngine\Exception\InvalidArgumentException
     */
    public function __construct($options)
    {
        $this->init($options);
    }

    /**
     * Инициализация сервиса
     *
     * @param $options
     *
     * @throws \Zend\Stdlib\Exception\InvalidArgumentException
     * @throws \OldTown\Workflow\ZF2\Service\Exception\InvalidArgumentException
     * @throws \OldTown\Workflow\ZF2\ServiceEngine\Exception\InvalidArgumentException
     */
    protected function init($options)
    {
        if ($options instanceof Traversable) {
            $options = ArrayUtils::iteratorToArray($options);
        } elseif (!is_array($options)) {
            $errMsg = sprintf('%s  expects an array or Traversable config', __METHOD__);
            throw new Exception\InvalidArgumentException($errMsg);
        }

        if (!array_key_exists('serviceLocator', $options)) {
            $errMsg = 'Argument serviceLocator not found';
            throw new Exception\InvalidArgumentException($errMsg);
        }
        $this->setServiceLocator($options['serviceLocator']);

        if (!array_key_exists('moduleOptions', $options)) {
            $errMsg = 'Argument moduleOptions not found';
            throw new Exception\InvalidArgumentException($errMsg);
        }
        $this->setModuleOptions($options['moduleOptions']);
    }

    /**
     * Запуск перехода из отдного состояния в другое
     *
     * @param                        $managerName
     * @param                        $entryId
     * @param                        $actionName
     *
     * @param TransientVarsInterface $transientVars
     *
     * @return TransitionResultInterface
     *
     * @throws \OldTown\Workflow\ZF2\ServiceEngine\Exception\DoActionException
     */
    public function doAction($managerName, $entryId, $actionName, TransientVarsInterface $transientVars = null)
    {
        try {
            $event = new WorkflowEvent();
            $event->setTarget($this);
            $event->setEntryId($entryId);

            $manager = $this->getWorkflowManager($managerName);
            $event->setWorkflowManager($manager);

            $workflowStore = $manager->getConfiguration()->getWorkflowStore();

            $entry = $workflowStore->findEntry($entryId);
            $workflowName = $entry->getWorkflowName();

            $wf = $manager->getConfiguration()->getWorkflow($workflowName);
            $event->setWorkflow($wf);

            //$action = $this->getActionByName($wf, $actionName);

65% of this comment could be valid code. Did you maybe forget this after debugging?

            $action = $this->findActionByNameForEntry($managerName, $entryId, $actionName);


            $actionId = $action->getId();

            if (null === $transientVars) {
                $transientVars = new BaseTransientVars();
            }

            $event->setTransientVars($transientVars);

            $manager->doAction($entryId, $actionId, $transientVars);

            $this->getEventManager()->trigger(WorkflowEvent::EVENT_DO_ACTION, $this, $event);

            $viewName = $action->getView();
            if (null !== $viewName) {

This code seems to be duplicated across your project.

                $event->setViewName($viewName);
                $event->setName(WorkflowEvent::EVENT_RENDER);
                $this->getEventManager()->trigger($event);
            }
        } catch (\Exception $e) {
            throw new Exception\DoActionException($e->getMessage(), $e->getCode(), $e);
        }

        $result = new TransitionResult($entryId, $manager, $wf, $transientVars);
        if ($viewName) {
            $result->setViewName($viewName);
        }

        return $result;
    }

    /**
     * Возвращает доступные действия для текущего состояния процесса
     *
     * @param $managerName
     * @param $entryId
     *
     * @return array|ActionDescriptor[]
     *
     * @throws \OldTown\Workflow\ZF2\ServiceEngine\Exception\InvalidManagerNameException
     * @throws \Zend\ServiceManager\Exception\ServiceNotFoundException
     * @throws \OldTown\Workflow\ZF2\ServiceEngine\Exception\InvalidWorkflowManagerException
     * @throws \OldTown\Workflow\Exception\ArgumentNotNumericException
     */
    public function getAvailableActions($managerName, $entryId)
    {
        $manager = $this->getWorkflowManager($managerName);
        $currentSteps = $manager->getCurrentSteps($entryId);

        $entry = $manager->getConfiguration()->getWorkflowStore()->findEntry($entryId);
        $workflowName = $entry->getWorkflowName();

        $wf = $manager->getConfiguration()->getWorkflow($workflowName);

        $findActions = [];
        foreach ($currentSteps as $currentStep) {
            $stepId = $currentStep->getStepId();
            $step = $wf->getStep($stepId);
            $actions = $step->getActions();

            foreach ($actions as $action) {
                $findActions[] = $action;
            }
        }

        return $findActions;
    }


    /**
     * Ишет действие по имени. Поиск происходит в рамках текущего step'a.
     *
     * @param $managerName
     * @param $entryId
     * @param $actionName
     *
     * @return ActionDescriptor|null
     *
     * @throws \OldTown\Workflow\ZF2\ServiceEngine\Exception\InvalidManagerNameException
     * @throws \Zend\ServiceManager\Exception\ServiceNotFoundException
     * @throws \OldTown\Workflow\ZF2\ServiceEngine\Exception\InvalidWorkflowManagerException
     * @throws \OldTown\Workflow\Exception\ArgumentNotNumericException
     * @throws \OldTown\Workflow\ZF2\ServiceEngine\Exception\InvalidWorkflowActionNameException
     * @throws \OldTown\Workflow\Exception\FactoryException
     */
    public function findActionByNameForEntry($managerName, $entryId, $actionName)
    {
        $actions = $this->getAvailableActions($managerName, $entryId);
        $findActions = [];
        foreach ($actions as $action) {
            if ($actionName === $action->getName()) {
                $findActions[] = $action;
            }
        }


        $countActions = count($findActions);
        if ($countActions > 1) {
            $errMsg = sprintf(
                'Found more than one action workflow. Manager name: %s. Name action: %s. Ids: %s',
                $managerName,
                $actionName,
                implode(',', array_map(function ($action) {
                    return is_object($action) && method_exists($action, 'getId') ? call_user_func([$action, 'getId']) : '';
                }, $findActions))
            );

            throw new Exception\InvalidWorkflowActionNameException($errMsg);
        }
        $findAction = null;
        if (1 === $countActions) {
            reset($findActions);
            $findAction = current($findActions);
        }
        return $findAction;
    }

    /**
     * Создание процесса workflow
     *
     * @param                        $managerName
     * @param                        $workflowName
     * @param                        $actionName
     *
     * @param TransientVarsInterface $transientVars
     *
     * @return TransitionResultInterface
     *
     * @throws \OldTown\Workflow\ZF2\ServiceEngine\Exception\InvalidInitializeWorkflowEntryException
     */
    public function initialize($managerName, $workflowName, $actionName, TransientVarsInterface $transientVars = null)
    {
        try {
            $event = new WorkflowEvent();
            $event->setTarget($this);

            $manager = $this->getWorkflowManager($managerName);
            $event->setWorkflowManager($manager);
            $wf = $manager->getConfiguration()->getWorkflow($workflowName);
            $event->setWorkflow($wf);

            $actionId = null;
            $initialActions = $wf->getInitialActions();

            foreach ($initialActions as $initialAction) {
                if ($actionName === $initialAction->getName()) {
                    $actionId = $initialAction->getId();
                    break;
                }
            }

            if (null === $actionId) {
                $errMsg = sprintf('Action %s not found', $actionName);
                throw new Exception\ActionNotFoundException($errMsg);
            }

            if (null === $transientVars) {
                $transientVars = new BaseTransientVars();
            }
            $event->setTransientVars($transientVars);
            $entryId = $manager->initialize($workflowName, $actionId, $transientVars);
            $event->setEntryId($entryId);

            $this->getEventManager()->trigger(WorkflowEvent::EVENT_WORKFLOW_INITIALIZE, $this, $event);


            $initialActions = $wf->getInitialAction($actionId);
            $viewName = $initialActions->getView();
            if (null !== $viewName) {

This code seems to be duplicated across your project.

                $event->setViewName($viewName);
                $event->setName(WorkflowEvent::EVENT_RENDER);
                $this->getEventManager()->trigger($event);
            }
        } catch (\Exception $e) {
            throw new Exception\InvalidInitializeWorkflowEntryException($e->getMessage(), $e->getCode(), $e);
        }

        $result = new TransitionResult($entryId, $manager, $wf, $transientVars);
        if ($viewName) {
            $result->setViewName($viewName);
        }

        return $result;
    }

    /**
     * Конфигурация модуля
     *
     * @return ModuleOptions
     */
    public function getModuleOptions()
    {
        return $this->moduleOptions;
    }

    /**
     * Устанавливает конфигурацию модуля
     *
     * @param ModuleOptions $moduleOptions
     *
     * @return $this
     */
    public function setModuleOptions(ModuleOptions $moduleOptions)
    {
        $this->moduleOptions = $moduleOptions;

        return $this;
    }



    /**
     * Получение менеджера workflow по имени
     *
     * @param string $managerName
     *
     * @return WorkflowInterface
     *
     * @throws \OldTown\Workflow\ZF2\ServiceEngine\Exception\InvalidManagerNameException
     * @throws \Zend\ServiceManager\Exception\ServiceNotFoundException
     * @throws \OldTown\Workflow\ZF2\ServiceEngine\Exception\InvalidWorkflowManagerException
     */
    public function getWorkflowManager($managerName)
    {
        if (!$this->hasWorkflowManager($managerName)) {
            $errMsg = sprintf('Invalid workflow manager name %s', $managerName);
            throw new Exception\InvalidManagerNameException($errMsg);
        }
        $workflowManagerServiceName = $this->getWorkflowManagerServiceName($managerName);

        $manager =  $this->getServiceLocator()->get($workflowManagerServiceName);

        if (!$manager instanceof WorkflowInterface) {
            $errMsg = sprintf('Workflow manager not implement %s', WorkflowInterface::class);
            throw new Exception\InvalidWorkflowManagerException($errMsg);
        }

        return $manager;
    }




    /**
     * @param WorkflowDescriptor $wf
     * @param                    $actionName
     *
     * @return null|ActionDescriptor
     */
    public function getActionByName(WorkflowDescriptor $wf, $actionName)
    {
        $actionName = (string)$actionName;

        foreach ($wf->getGlobalActions() as $actionDescriptor) {
            if ($actionName === $actionDescriptor->getName()) {
                return $actionDescriptor;
            }
        }

        foreach ($wf->getSteps() as $stepDescriptor) {
            $actions = $stepDescriptor->getActions();
            foreach ($actions as $actionDescriptor) {
                if ($actionName === $actionDescriptor->getName()) {
                    return $actionDescriptor;
                }
            }
        }

        foreach ($wf->getInitialActions() as $actionDescriptor) {
            if ($actionName === $actionDescriptor->getName()) {
                return $actionDescriptor;
            }
        }

        return null;
    }

    /**
     * Проверят есть ли менеджер workflow с заданным именем
     *
     * @param string $workflowManagerName
     *
     * @return bool
     */
    public function hasWorkflowManager($workflowManagerName)
    {
        $workflowManagerServiceName = $this->getWorkflowManagerServiceName($workflowManagerName);

        return $this->getServiceLocator()->has($workflowManagerServiceName);
    }

    /**
     * Имя сервиса для получения менеджера workflow
     *
     * @param string $workflowManagerName
     *
     * @return string
     */
    public function getWorkflowManagerServiceName($workflowManagerName)
    {
        return sprintf($this->getWorkflowManagerServiceNamePattern(), $workflowManagerName);
    }

    /**
     * @return string
     */
    public function getWorkflowManagerServiceNamePattern()
    {
        return $this->workflowManagerServiceNamePattern;
    }

    /**
     * @param string $workflowManagerServiceNamePattern
     *
     * @return $this
     */
    public function setWorkflowManagerServiceNamePattern($workflowManagerServiceNamePattern)
    {
        $this->workflowManagerServiceNamePattern = (string)$workflowManagerServiceNamePattern;

        return $this;
    }

    /**
     * Возвращает имя менеджера по его пседовниму
     *
     * @param $alias
     *
     * @return string
     *
     * @throws Exception\InvalidWorkflowManagerAliasException
     */
    public function getManagerNameByAlias($alias)
    {
        $aliasMap = $this->getModuleOptions()->getManagerAliases();
        if (!array_key_exists($alias, $aliasMap)) {
            $errMsg = sprintf('Invalid workflow manager alias: %s', $alias);
            throw new Exception\InvalidWorkflowManagerAliasException($errMsg);
        }

        return $aliasMap[$alias];
    }


    /**
     * Проверяет есть ли псевдоним для менеджера workflow
     *
     * @param string $alias
     *
     * @return boolean
     */
    public function hasWorkflowManagerAlias($alias)
    {
        $aliasMap = $this->getModuleOptions()->getManagerAliases();
        return array_key_exists($alias, $aliasMap);
    }

    /**
     * Получение менеджера workflow по его псевдониму
     *
     * @param $alias
     *
     * @return WorkflowInterface
     *
     * @throws Exception\InvalidWorkflowManagerAliasException
     * @throws \OldTown\Workflow\ZF2\ServiceEngine\Exception\InvalidManagerNameException
     * @throws \Zend\ServiceManager\Exception\ServiceNotFoundException
     * @throws \OldTown\Workflow\ZF2\ServiceEngine\Exception\InvalidWorkflowManagerException
     */
    public function getWorkflowManagerByAlias($alias)
    {
        $name = $this->getManagerNameByAlias($alias);
        return $this->getWorkflowManager($name);
    }
}