Netzmacht\Workflow\Flow\Step

Complexity

Total Complexity

14

Size/Duplication

Total Lines	152
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	2

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	isFinal()	0	4	1
A	setFinal()	0	6	1
A	allowTransition()	0	8	2
A	disallowTransition()	0	11	2
A	getAllowedTransitions()	0	8	2
A	isTransitionAllowed()	0	8	2
A	hasPermission()	0	8	2
A	getPermission()	0	4	1
A	setPermission()	0	6	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;

use Netzmacht\Workflow\Flow\Security\Permission;

/**
 * Class Step defines fixed step in the workflow process.
 *
 * @package Netzmacht\Workflow\Flow
 */
class Step extends Base
{
    /**
     * The allowed transition names.
     *
     * @var array
     */
    private $allowedTransitions = array();

    /**
     * Step is a final step.
     *
     * @var bool
     */
    private $final = false;

    /**
     * Assigned permission.
     *
     * @var Permission|null
     */
    private $permission;

    /**
     * Consider if step is final.
     *
     * @return bool
     */
    public function isFinal(): bool
    {
        return $this->final;
    }

    /**
     * Mark step as final.
     *
     * @param bool $final Step is a final step.
     *
     * @return $this
     */
    public function setFinal(bool $final): self
    {
        $this->final = $final;

        return $this;
    }

    /**
     * Allow a transition.
     *
     * @param string $transitionName The name of the allowed transition.
     *
     * @return $this
     */
    public function allowTransition(string $transitionName): self
    {
        if (!in_array($transitionName, $this->allowedTransitions)) {
            $this->allowedTransitions[] = $transitionName;
        }

        return $this;
    }

    /**
     * Disallow a transition.
     *
     * @param string $transitionName The name of the disallowed transition.
     *
     * @return $this
     */
    public function disallowTransition(string $transitionName): self
    {
        $key = array_search($transitionName, $this->allowedTransitions);

        if ($key !== false) {
            unset($this->allowedTransitions[$key]);
            $this->allowedTransitions = array_values($this->allowedTransitions);
        }

        return $this;
    }

    /**
     * Get all allowed transition names.
     *
     * @return array
     */
    public function getAllowedTransitions(): array
    {
        if ($this->isFinal()) {
            return array();
        }

        return $this->allowedTransitions;
    }

    /**
     * Consider if transition is allowed.
     *
     * @param string $transitionName The name of the checked transition.
     *
     * @return bool
     */
    public function isTransitionAllowed(string $transitionName): bool
    {
        if ($this->isFinal()) {
            return false;
        }

        return in_array($transitionName, $this->allowedTransitions);
    }

    /**
     * Consider if step has a specific permission.
     *
     * @param Permission $permission Permission to be checked.
     *
     * @return bool
     */
    public function hasPermission(Permission $permission): bool
    {
        if ($this->permission) {
            return $this->permission->equals($permission);
        }

        return false;
    }

    /**
     * Get permission of the step. If none is assigned it returns null.
     *
     * @return Permission|null
     */
    public function getPermission():? Permission
    {
        return $this->permission;
    }

    /**
     * Set permission.
     *
     * @param Permission $permission Permission to be set.
     *
     * @return $this
     */
    public function setPermission(Permission $permission): self
    {
        $this->permission = $permission;

        return $this;
    }
}