Complex classes like StateMachine often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use StateMachine, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
23 | class StateMachine implements StateMachineInterface |
||
24 | { |
||
25 | /** |
||
26 | * The stateful object. |
||
27 | * |
||
28 | * @var object |
||
29 | */ |
||
30 | protected $object; |
||
31 | |||
32 | /** |
||
33 | * The available states. |
||
34 | * |
||
35 | * @var array |
||
36 | */ |
||
37 | protected $states = array(); |
||
38 | |||
39 | /** |
||
40 | * The available transitions. |
||
41 | * |
||
42 | * @var array |
||
43 | */ |
||
44 | protected $transitions = array(); |
||
45 | |||
46 | /** |
||
47 | * The current state. |
||
48 | * |
||
49 | * @var StateInterface |
||
50 | */ |
||
51 | protected $currentState; |
||
52 | |||
53 | /** |
||
54 | * @var EventDispatcherInterface |
||
55 | */ |
||
56 | protected $dispatcher; |
||
57 | |||
58 | /** |
||
59 | * @var StateAccessorInterface |
||
60 | */ |
||
61 | protected $stateAccessor; |
||
62 | |||
63 | /** |
||
64 | * @var string |
||
65 | */ |
||
66 | protected $graph; |
||
67 | |||
68 | /** |
||
69 | * @param object $object |
||
70 | * @param EventDispatcherInterface $dispatcher |
||
71 | * @param StateAccessorInterface $stateAccessor |
||
72 | */ |
||
73 | 185 | public function __construct( |
|
82 | |||
83 | /** |
||
84 | * {@inheritdoc} |
||
85 | */ |
||
86 | 160 | public function initialize() |
|
87 | { |
||
88 | 160 | if (null === $this->object) { |
|
89 | throw new Exception\ObjectException('No object bound to the State Machine'); |
||
90 | } |
||
91 | |||
92 | try { |
||
93 | 160 | $initialState = $this->stateAccessor->getState($this->object); |
|
94 | 64 | } catch (Exception\NoSuchPropertyException $e) { |
|
95 | throw new Exception\ObjectException(sprintf( |
||
96 | 'StateMachine can\'t be initialized because the defined property_path of object "%s" does not exist.', |
||
97 | $this->getObject() ? get_class($this->getObject()) : null |
||
98 | ), $e->getCode(), $e); |
||
99 | } |
||
100 | |||
101 | 160 | if (null === $initialState) { |
|
102 | 20 | $initialState = $this->findInitialState(); |
|
103 | 20 | $this->stateAccessor->setState($this->object, $initialState); |
|
104 | |||
105 | 20 | $this->dispatcher->dispatch(FiniteEvents::SET_INITIAL_STATE, new StateMachineEvent($this)); |
|
106 | 8 | } |
|
107 | |||
108 | 160 | $this->currentState = $this->getState($initialState); |
|
109 | |||
110 | 160 | $this->dispatcher->dispatch(FiniteEvents::INITIALIZE, new StateMachineEvent($this)); |
|
111 | 160 | } |
|
112 | |||
113 | /** |
||
114 | * {@inheritdoc} |
||
115 | * |
||
116 | * @throws Exception\StateException |
||
117 | */ |
||
118 | 20 | public function apply($transitionName, array $parameters = array()) |
|
119 | { |
||
120 | 20 | $transition = $this->getTransition($transitionName); |
|
121 | 20 | $event = new TransitionEvent($this->getCurrentState(), $transition, $this, $parameters); |
|
122 | 20 | if (!$this->can($transition, $parameters)) { |
|
123 | 5 | throw new Exception\StateException(sprintf( |
|
124 | 5 | 'The "%s" transition can not be applied to the "%s" state of object "%s" with graph "%s".', |
|
125 | 5 | $transition->getName(), |
|
126 | 5 | $this->currentState->getName(), |
|
127 | 5 | $this->getObject() ? get_class($this->getObject()) : null, |
|
128 | 5 | $this->getGraph() |
|
129 | 2 | )); |
|
130 | } |
||
131 | |||
132 | 20 | $this->dispatchTransitionEvent($transition, $event, FiniteEvents::PRE_TRANSITION); |
|
133 | |||
134 | 20 | $returnValue = $transition->process($this); |
|
135 | 20 | $this->stateAccessor->setState($this->object, $transition->getState()); |
|
136 | 20 | $this->currentState = $this->getState($transition->getState()); |
|
137 | |||
138 | 20 | $this->dispatchTransitionEvent($transition, $event, FiniteEvents::POST_TRANSITION); |
|
139 | |||
140 | 20 | return $returnValue; |
|
141 | } |
||
142 | |||
143 | /** |
||
144 | * {@inheritdoc} |
||
145 | */ |
||
146 | 55 | public function can($transition, array $parameters = array()) |
|
163 | |||
164 | /** |
||
165 | * {@inheritdoc} |
||
166 | */ |
||
167 | 185 | public function addState($state) |
|
175 | |||
176 | /** |
||
177 | * {@inheritdoc} |
||
178 | */ |
||
179 | 180 | public function addTransition($transition, $initialState = null, $finalState = null) |
|
216 | |||
217 | /** |
||
218 | * {@inheritdoc} |
||
219 | */ |
||
220 | 160 | public function getTransition($name) |
|
233 | |||
234 | /** |
||
235 | * {@inheritdoc} |
||
236 | */ |
||
237 | 185 | public function getState($name) |
|
252 | |||
253 | /** |
||
254 | * {@inheritdoc} |
||
255 | */ |
||
256 | 5 | public function getTransitions() |
|
260 | |||
261 | /** |
||
262 | * {@inheritdoc} |
||
263 | */ |
||
264 | 5 | public function getStates() |
|
268 | |||
269 | /** |
||
270 | * {@inheritdoc} |
||
271 | */ |
||
272 | 150 | public function setObject($object) |
|
276 | |||
277 | /** |
||
278 | * {@inheritdoc} |
||
279 | */ |
||
280 | 175 | public function getObject() |
|
284 | |||
285 | /** |
||
286 | * {@inheritdoc} |
||
287 | */ |
||
288 | 115 | public function getCurrentState() |
|
292 | |||
293 | /** |
||
294 | * Find and return the Initial state if exists. |
||
295 | * |
||
296 | * @return string |
||
297 | * |
||
298 | * @throws Exception\StateException |
||
299 | */ |
||
300 | 20 | protected function findInitialState() |
|
314 | |||
315 | /** |
||
316 | * @param EventDispatcherInterface $dispatcher |
||
317 | */ |
||
318 | public function setDispatcher(EventDispatcherInterface $dispatcher) |
||
322 | |||
323 | /** |
||
324 | * @return EventDispatcherInterface |
||
325 | */ |
||
326 | 5 | public function getDispatcher() |
|
330 | |||
331 | /** |
||
332 | * @param StateAccessorInterface $stateAccessor |
||
333 | */ |
||
334 | 5 | public function setStateAccessor(StateAccessorInterface $stateAccessor) |
|
338 | |||
339 | /** |
||
340 | * {@inheritdoc} |
||
341 | */ |
||
342 | 15 | public function hasStateAccessor() |
|
346 | |||
347 | /** |
||
348 | * {@inheritdoc} |
||
349 | */ |
||
350 | 20 | public function setGraph($graph) |
|
354 | |||
355 | /** |
||
356 | * {@inheritdoc} |
||
357 | */ |
||
358 | 175 | public function getGraph() |
|
362 | |||
363 | /** |
||
364 | * {@inheritDoc} |
||
365 | */ |
||
366 | 10 | public function findStateWithProperty($property, $value = null) |
|
367 | { |
||
368 | 10 | return array_keys( |
|
369 | 10 | array_map( |
|
370 | 2 | function (State $state) { |
|
371 | 10 | return $state->getName(); |
|
372 | 10 | }, |
|
373 | 10 | array_filter( |
|
374 | 10 | $this->states, |
|
375 | 10 | function (State $state) use ($property, $value) { |
|
376 | 10 | if (!$state->has($property)) { |
|
377 | 10 | return false; |
|
378 | } |
||
379 | |||
380 | 10 | if (null !== $value && $state->get($property) !== $value) { |
|
381 | 5 | return false; |
|
382 | } |
||
383 | |||
384 | 10 | return true; |
|
385 | 6 | } |
|
386 | 4 | ) |
|
387 | 4 | ) |
|
388 | 4 | ); |
|
389 | } |
||
390 | |||
391 | /** |
||
392 | * Dispatches event for the transition |
||
393 | * |
||
394 | * @param TransitionInterface $transition |
||
395 | * @param TransitionEvent $event |
||
396 | * @param type $transitionState |
||
397 | */ |
||
398 | 50 | private function dispatchTransitionEvent(TransitionInterface $transition, TransitionEvent $event, $transitionState) |
|
406 | } |
||
407 |
It seems like the type of the argument is not accepted by the function/method which you are calling.
In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.
We suggest to add an explicit type cast like in the following example: