StateConfiguration::__construct() - Code Metrics - tmilos/light-fsm - Measure and Improve Code Quality continuously with Scrutinizer

StateConfiguration::__construct() A
last analyzed 2016-01-25 12:30 UTC

↳ Parent: StateConfiguration

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	4
rs	10
cc	1
eloc	2
nc	1
nop	1

<?php

namespace LightFsm;

class StateConfiguration
{
    /** @var string|int */
    private $state;

    /**
     * @var TransitionConfiguration[] event => TransitionConfiguration
     */
    private $transitions = [];

    /** @var callable[] */
    private $entryCallbacks = [];

    /** @var callable[] */
    private $exitCallbacks = [];

    /** @var string|int|null */
    private $parentState;

    /**
     * @param string|int $state
     */
    public function __construct($state)
    {
        $this->state = $state;
    }

    /**
     * @return string|int
     */
    public function getState()
    {
        return $this->state;
    }

    /**
     * @param string|int    $event
     * @param string|int    $nextState
     * @param callable|null $guardCallback f($data)
     * @param string|null   $guardName
     *
     * @return StateConfiguration
     */
    public function permit($event, $nextState, $guardCallback = null, $guardName = null)
    {
        $this->transitions[$event] = new TransitionConfiguration($this->state, $event, $nextState, $guardCallback, $guardName);

        return $this;
    }

    /**
     * @param string|int $parentState
     *
     * @return StateConfiguration
     */
    public function setParentState($parentState)
    {
        $this->parentState = $parentState;

        return $this;
    }

    /**
     * @return int|string|null
     */
    public function getParentState()
    {
        return $this->parentState;
    }

    /**
     * @param callable    $callback     f($isSubState, $data, $state)
     * @param string|null $listenerName
     *
     * @return StateConfiguration
     */
    public function onEntry($callback, $listenerName = null)
    {
        if ($listenerName) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $this->entryCallbacks[$listenerName] = $callback;
        } else {
            $this->entryCallbacks[] = $callback;
        }

        return $this;
    }

    /**
     * @param callable    $callback     f($isSubState, $data, $state)
     * @param string|null $listenerName
     *
     * @return StateConfiguration
     */
    public function onExit($callback, $listenerName = null)
    {
        if ($listenerName) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $this->exitCallbacks[$listenerName] = $callback;
        } else {
            $this->exitCallbacks[] = $callback;
        }

        return $this;
    }

    /**
     * @param string|int $event
     *
     * @return TransitionConfiguration|null
     */
    public function getTransition($event)
    {
        return isset($this->transitions[$event]) ? $this->transitions[$event ] : null;
    }

    /**
     * @return TransitionConfiguration[]
     */
    public function getAllTransitions()
    {
        return $this->transitions;
    }

    /**
     * @param bool  $isSubState
     * @param mixed $data
     */
    public function triggerEntry($isSubState, $data)
    {
        foreach ($this->entryCallbacks as $callback) {
            call_user_func($callback, $isSubState, $data, $this->state);
        }
    }

    /**
     * @param bool  $isSubState
     * @param mixed $data
     */
    public function triggerExit($isSubState, $data)
    {
        foreach ($this->exitCallbacks as $callback) {
            call_user_func($callback, $isSubState, $data, $this->state);
        }
    }

    /**
     * @return \callable[]
     */
    public function getAllEntryCallbacks()
    {
        return $this->entryCallbacks;
    }

    /**
     * @return \callable[]
     */
    public function getAllExitCallbacks()
    {
        return $this->exitCallbacks;
    }
}


1			<?php
2
3			namespace LightFsm;
4
5			class StateConfiguration
6			{
7			/** @var string\|int */
8			private $state;
9
10			/**
11			* @var TransitionConfiguration[] event => TransitionConfiguration
12			*/
13			private $transitions = [];
14
15			/** @var callable[] */
16			private $entryCallbacks = [];
17
18			/** @var callable[] */
19			private $exitCallbacks = [];
20
21			/** @var string\|int\|null */
22			private $parentState;
23
24			/**
25			* @param string\|int $state
26			*/
27			public function __construct($state)
28			{
29			$this->state = $state;
30			}
31
32			/**
33			* @return string\|int
34			*/
35			public function getState()
36			{
37			return $this->state;
38			}
39
40			/**
41			* @param string\|int $event
42			* @param string\|int $nextState
43			* @param callable\|null $guardCallback f($data)
44			* @param string\|null $guardName
45			*
46			* @return StateConfiguration
47			*/
48			public function permit($event, $nextState, $guardCallback = null, $guardName = null)
49			{
50			$this->transitions[$event] = new TransitionConfiguration($this->state, $event, $nextState, $guardCallback, $guardName);
51
52			return $this;
53			}
54
55			/**
56			* @param string\|int $parentState
57			*
58			* @return StateConfiguration
59			*/
60			public function setParentState($parentState)
61			{
62			$this->parentState = $parentState;
63
64			return $this;
65			}
66
67			/**
68			* @return int\|string\|null
69			*/
70			public function getParentState()
71			{
72			return $this->parentState;
73			}
74
75			/**
76			* @param callable $callback f($isSubState, $data, $state)
77			* @param string\|null $listenerName
78			*
79			* @return StateConfiguration
80			*/
81			public function onEntry($callback, $listenerName = null)
82			{
83			if ($listenerName) {
			0 ignored issues – show Bug Best Practice introduced 2016-01-25 12:30 UTC by Report Bug Copy Issue Report The expression `$listenerName` of type `string\|null` 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...
84			$this->entryCallbacks[$listenerName] = $callback;
85			} else {
86			$this->entryCallbacks[] = $callback;
87			}
88
89			return $this;
90			}
91
92			/**
93			* @param callable $callback f($isSubState, $data, $state)
94			* @param string\|null $listenerName
95			*
96			* @return StateConfiguration
97			*/
98			public function onExit($callback, $listenerName = null)
99			{
100			if ($listenerName) {
			0 ignored issues – show Bug Best Practice introduced 2016-01-25 12:30 UTC by Report Bug Copy Issue Report The expression `$listenerName` of type `string\|null` 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...
101			$this->exitCallbacks[$listenerName] = $callback;
102			} else {
103			$this->exitCallbacks[] = $callback;
104			}
105
106			return $this;
107			}
108
109			/**
110			* @param string\|int $event
111			*
112			* @return TransitionConfiguration\|null
113			*/
114			public function getTransition($event)
115			{
116			return isset($this->transitions[$event]) ? $this->transitions[$event ] : null;
117			}
118
119			/**
120			* @return TransitionConfiguration[]
121			*/
122			public function getAllTransitions()
123			{
124			return $this->transitions;
125			}
126
127			/**
128			* @param bool $isSubState
129			* @param mixed $data
130			*/
131			public function triggerEntry($isSubState, $data)
132			{
133			foreach ($this->entryCallbacks as $callback) {
134			call_user_func($callback, $isSubState, $data, $this->state);
135			}
136			}
137
138			/**
139			* @param bool $isSubState
140			* @param mixed $data
141			*/
142			public function triggerExit($isSubState, $data)
143			{
144			foreach ($this->exitCallbacks as $callback) {
145			call_user_func($callback, $isSubState, $data, $this->state);
146			}
147			}
148
149			/**
150			* @return \callable[]
151			*/
152			public function getAllEntryCallbacks()
153			{
154			return $this->entryCallbacks;
155			}
156
157			/**
158			* @return \callable[]
159			*/
160			public function getAllExitCallbacks()
161			{
162			return $this->exitCallbacks;
163			}
164			}
165

tmilos / light-fsm

StateConfiguration::__construct() A last analyzed 2016-01-25 12:30 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

StateConfiguration::__construct() A
last analyzed 2016-01-25 12:30 UTC