Netzmacht\Workflow\Flow\Condition\Transition\StepPermissionCondition

Complexity

Total Complexity

7

Size/Duplication

Total Lines	74
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes	1
Bugs	0	Features	1

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
B	match()	0	30	5
A	getStepPermission()	0	8	1

<?php

/**
 * Workflow library.
 *
 * @package    workflow
 * @author     David Molineus <david.molineus@netzmacht.de>
 * @copyright  2014-2017 netzmacht David Molineus
 * @license    LGPL 3.0 https://github.com/netzmacht/workflow
 * @filesource
 */

declare(strict_types=1);

namespace Netzmacht\Workflow\Flow\Condition\Transition;

use Netzmacht\Workflow\Data\ErrorCollection;
use Netzmacht\Workflow\Security\Permission;
use Netzmacht\Workflow\Flow\Context;
use Netzmacht\Workflow\Flow\Item;
use Netzmacht\Workflow\Flow\Transition;
use Netzmacht\Workflow\Security\User;

/**
 * Class StepPermissionCondition can be used to limit permissions of a workflow step.
 *
 * That means that a user can only transform the transition if he has the role which is assigned to the starting step.
 *
 * If this condition is assigned it always requires that the step has a role. If no role is given it will always fail.
 *
 * @package Netzmacht\Workflow\Flow\Condition\Transition
 */
class StepPermissionCondition extends AbstractPermissionCondition
{
    /**
     * If a workflow is not started it does not have a current step. So you can decide if it should be allowed.
     *
     * @var bool
     */
    private $allowStartTransition;

    /**
     * StepPermissionCondition constructor.
     *
     * @param User $user                 Security user instance.
     * @param bool $grantAccessByDefault Default access value if no permission is found.
     * @param bool $allowStartTransition Allow start transition.
     */
    public function __construct(User $user, bool $grantAccessByDefault = false, bool $allowStartTransition = true)
    {
        parent::__construct($user, $grantAccessByDefault);

        $this->allowStartTransition = $allowStartTransition;
    }

    /**
     * {@inheritdoc}
     */
    public function match(Transition $transition, Item $item, Context $context, ErrorCollection $errorCollection): bool
    {
        // workflow is not started, so no start step exists
        if (!$item->isWorkflowStarted()) {
            if ($this->allowStartTransition) {
                return true;
            }

            $errorCollection->addError(
                'transition.condition.step.failed.not-started'
            );

            return false;
        }

        $permission = $this->getStepPermission($transition, $item);
        if ($this->checkPermission($permission)) {
            return true;
        }

        $errorCollection->addError(
            'transition.condition.step.failed',
            array(
                $item->getCurrentStepName(),
                $permission ? ((string) $permission) : '-'
            )
        );

        return false;
    }

    /**
     * Get role of current step.
     *
     * @param Transition $transition The transition being in.
     * @param Item       $item       The entity being transits.
     *
     * @return Permission|null
     */
    protected function getStepPermission(Transition $transition, Item $item):? Permission
    {
        $stepName   = $item->getCurrentStepName();
        $step       = $transition->getWorkflow()->getStep($stepName);
        $permission = $step->getPermission();

        return $permission;
    }
}