StateConfig::default() - Code Metrics - Inspection of "Default support via `new`" - spatie/laravel-model-states - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 97dcfe...b2d8a3 )

by Brent

created 2019-10-02 11:34 UTC

StateConfig::default() A

↳ Parent: StateConfig

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	6
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	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);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
        }

        if (! is_subclass_of($to, $this->stateClass)) {
            throw InvalidConfig::doesNotExtendBaseClass($to, $this->stateClass);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
        }

        if ($transition && ! is_subclass_of($transition, Transition::class)) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            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;
    }

    /**
     * @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}";
    }
}


1			<?php
2
3			namespace Spatie\ModelStates;
4
5			use Illuminate\Database\Eloquent\Model;
6			use Spatie\ModelStates\Exceptions\InvalidConfig;
7
8			class StateConfig
9			{
10			/** @var string */
11			public $field;
12
13			/** @var string\|\Spatie\ModelStates\State */
14			public $stateClass;
15
16			/** @var string[] */
17			public $allowedTransitions = [];
18
19			/** @var string\|null */
20			public $defaultStateClass;
21
22			public function __construct(string $field, string $stateClass)
23			{
24			if (! is_subclass_of($stateClass, State::class)) {
25			throw InvalidConfig::doesNotExtendState($stateClass);
26			}
27
28			$this->field = $field;
29
30			$this->stateClass = $stateClass;
31			}
32
33			public function default(string $defaultStateClass): StateConfig
34			{
35			$this->defaultStateClass = $defaultStateClass;
36
37			return $this;
38			}
39
40			/**
41			* @param string\|array $from
42			* @param string $to
43			* @param string\|null $transition
44			*
45			* @return \Spatie\ModelStates\StateConfig
46			*/
47			public function allowTransition($from, string $to, string $transition = null): StateConfig
48			{
49			if (is_array($from)) {
50			foreach ($from as $fromState) {
51			$this->allowTransition($fromState, $to, $transition);
52			}
53
54			return $this;
55			}
56
57			if (! is_subclass_of($from, $this->stateClass)) {
58			throw InvalidConfig::doesNotExtendBaseClass($from, $this->stateClass);
			0 ignored issues – show Bug introduced 2019-09-27 07:39 UTC by Report Bug Copy Issue Report It seems like `$this->stateClass` can also be of type `object<Spatie\ModelStates\State>`; however, `Spatie\ModelStates\Excep...oesNotExtendBaseClass()` does only seem to accept `string`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
59			}
60
61			if (! is_subclass_of($to, $this->stateClass)) {
62			throw InvalidConfig::doesNotExtendBaseClass($to, $this->stateClass);
			0 ignored issues – show Bug introduced 2019-09-27 07:39 UTC by Report Bug Copy Issue Report It seems like `$this->stateClass` can also be of type `object<Spatie\ModelStates\State>`; however, `Spatie\ModelStates\Excep...oesNotExtendBaseClass()` does only seem to accept `string`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
63			}
64
65			if ($transition && ! is_subclass_of($transition, Transition::class)) {
			0 ignored issues – show Bug Best Practice introduced 2019-09-27 07:39 UTC by Report Bug Copy Issue Report 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. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
66			throw InvalidConfig::doesNotExtendTransition($transition);
67			}
68
69			$this->allowedTransitions[$this->createTransitionKey($from, $to)] = $transition;
70
71			return $this;
72			}
73
74			public function allowTransitions(array $transitions): StateConfig
75			{
76			foreach ($transitions as $transition) {
77			$this->allowTransition($transition[0], $transition[1], $transition[2] ?? null);
78			}
79
80			return $this;
81			}
82
83			/**
84			* @param string $from
85			* @param string $to
86			*
87			* @return string\|\Spatie\ModelStates\Transition\|null
88			*/
89			public function resolveTransition(Model $model, string $from, string $to)
90			{
91			$transitionKey = $this->createTransitionKey($from, $to);
92
93			if (! array_key_exists($transitionKey, $this->allowedTransitions)) {
94			return;
95			}
96
97			return $this->allowedTransitions[$transitionKey]
98			?? new DefaultTransition(
99			$model,
100			$this->field,
101			$this->stateClass::make($to, $model)
102			);
103			}
104
105			private function createTransitionKey(string $from, string $to): string
106			{
107			return "{$from}-{$to}";
108			}
109			}
110

spatie / laravel-model-states

Push — master ( 97dcfe...b2d8a3 )

StateConfig::default() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like