Spatie\ModelStates\StateConfig

Complexity

Total Complexity

18

Size/Duplication

Total Lines	119
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	2

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	10	2
A	default()	0	6	1
B	allowTransition()	0	26	7
A	allowTransitions()	0	8	2
A	transitionableStates()	0	16	3
A	resolveTransition()	0	15	2
A	createTransitionKey()	0	4	1

<?php

namespace Spatie\ModelStates;

use Illuminate\Database\Eloquent\Model;
use Spatie\ModelStates\Exceptions\InvalidConfig;

class StateConfig
{
    /** @var string */
    public $field;

    /** @var string|\Spatie\ModelStates\State */
    public $stateClass;

    /** @var string[] */
    public $allowedTransitions = [];

    /** @var string|null */
    public $defaultStateClass;

    public function __construct(string $field, string $stateClass)
    {
        if (! is_subclass_of($stateClass, State::class)) {
            throw InvalidConfig::doesNotExtendState($stateClass);
        }

        $this->field = $field;

        $this->stateClass = $stateClass;
    }

    public function default(string $defaultStateClass): StateConfig
    {
        $this->defaultStateClass = $defaultStateClass;

        return $this;
    }

    /**
     * @param string|array $from
     * @param string $to
     * @param string|null $transition
     *
     * @return \Spatie\ModelStates\StateConfig
     */
    public function allowTransition($from, string $to, string $transition = null): StateConfig
    {
        if (is_array($from)) {
            foreach ($from as $fromState) {
                $this->allowTransition($fromState, $to, $transition);
            }

            return $this;
        }

        if (! is_subclass_of($from, $this->stateClass)) {
            throw InvalidConfig::doesNotExtendBaseClass($from, $this->stateClass);

It seems like $this->stateClass can also be of type object<Spatie\ModelStates\State>; however, Spatie\ModelStates\Exceptions\InvalidConfig::doesNotExtendBaseClass() does only seem to accept string, maybe add an additional type check?

        }

        if (! is_subclass_of($to, $this->stateClass)) {
            throw InvalidConfig::doesNotExtendBaseClass($to, $this->stateClass);

It seems like $this->stateClass can also be of type object<Spatie\ModelStates\State>; however, Spatie\ModelStates\Exceptions\InvalidConfig::doesNotExtendBaseClass() does only seem to accept string, maybe add an additional type check?

        }

        if ($transition && ! is_subclass_of($transition, Transition::class)) {

The expression $transition of type null|string is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

            throw InvalidConfig::doesNotExtendTransition($transition);
        }

        $this->allowedTransitions[$this->createTransitionKey($from, $to)] = $transition;

        return $this;
    }

    public function allowTransitions(array $transitions): StateConfig
    {
        foreach ($transitions as $transition) {
            $this->allowTransition($transition[0], $transition[1], $transition[2] ?? null);
        }

        return $this;
    }

    public function transitionableStates(string $fromClass): array
    {
        $transitionableStates = [];

        foreach ($this->allowedTransitions as $allowedTransition => $value) {
            [$from, $to] = explode('-', $allowedTransition);

The variable $from does not exist. Did you forget to declare it?

The variable $to does not exist. Did you forget to declare it?

            if ($from !== $fromClass) {
                continue;
            }

            $transitionableStates[] = $to::getMorphClass();
        }

        return $transitionableStates;
    }

    /**
     * @param string $from
     * @param string $to
     *
     * @return string|\Spatie\ModelStates\Transition|null
     */
    public function resolveTransition(Model $model, string $from, string $to)
    {
        $transitionKey = $this->createTransitionKey($from, $to);

        if (! array_key_exists($transitionKey, $this->allowedTransitions)) {
            return;
        }

        return $this->allowedTransitions[$transitionKey]
            ?? new DefaultTransition(
                $model,
                $this->field,
                $this->stateClass::make($to, $model)
            );
    }

    private function createTransitionKey(string $from, string $to): string
    {
        return "{$from}-{$to}";
    }
}