Skip to content

Commit d3450b6

Browse files
author
mmoreram
committed
Created state machine event dispatcher
1 parent dfb8295 commit d3450b6

4 files changed

Lines changed: 164 additions & 161 deletions

File tree

‎EventDispatcher/MachineEventDispatcher.php‎

Lines changed: 131 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
/*
44
* This file is part of the Elcodi package.
55
*
6-
* Copyright (c) 2014 Elcodi.com
6+
* Copyright (c) 2014-2015 Elcodi Networks S.L.
77
*
88
* For the full copyright and license information, please view the LICENSE
99
* file that was distributed with this source code.
@@ -14,13 +14,141 @@
1414
* @author Aldo Chiecchia <zimage@tiscali.it>
1515
* @author Elcodi Team <tech@elcodi.com>
1616
*/
17-
17+
1818
namespace Elcodi\Component\StateTransitionMachine\EventDispatcher;
1919

20+
use stdClass;
21+
22+
use Elcodi\Component\Core\EventDispatcher\Abstracts\AbstractEventDispatcher;
23+
use Elcodi\Component\StateTransitionMachine\Definition\Transition;
24+
use Elcodi\Component\StateTransitionMachine\ElcodiStateTransitionMachineEvents;
25+
use Elcodi\Component\StateTransitionMachine\Entity\StateLineStack;
26+
use Elcodi\Component\StateTransitionMachine\Event\InitializationEvent;
27+
use Elcodi\Component\StateTransitionMachine\Event\TransitionEvent;
28+
use Elcodi\Component\StateTransitionMachine\Machine\Interfaces\MachineInterface;
29+
2030
/**
2131
* Class MachineEventDispatcher
2232
*/
23-
class MachineEventDispatcher
33+
class MachineEventDispatcher extends AbstractEventDispatcher
2434
{
35+
/**
36+
* Throw initialization events
37+
*
38+
* @param MachineInterface $machine Machine
39+
* @param stdClass $object Object
40+
* @param StateLineStack $stateLineStack StateLine Stack
41+
*
42+
* @return $this Self object
43+
*/
44+
public function dispatchInitializationEvents(
45+
MachineInterface $machine,
46+
$object,
47+
StateLineStack $stateLineStack
48+
) {
49+
$this
50+
->eventDispatcher
51+
->dispatch(
52+
str_replace(
53+
'{machine_id}',
54+
$machine->getId(),
55+
ElcodiStateTransitionMachineEvents::INITIALIZATION
56+
),
57+
InitializationEvent::create(
58+
$object,
59+
$stateLineStack
60+
)
61+
);
62+
}
63+
64+
/**
65+
* Throw transition events
66+
*
67+
* @param MachineInterface $machine Machine
68+
* @param stdClass $object Object
69+
* @param StateLineStack $stateLineStack StateLine Stack
70+
* @param Transition $transition Transition
71+
*
72+
* @return $this Self object
73+
*/
74+
public function dispatchTransitionEvents(
75+
MachineInterface $machine,
76+
$object,
77+
StateLineStack $stateLineStack,
78+
Transition $transition
79+
) {
80+
$this
81+
->eventDispatcher
82+
->dispatch(
83+
ElcodiStateTransitionMachineEvents::ALL_TRANSITIONS,
84+
TransitionEvent::create(
85+
$object,
86+
$stateLineStack,
87+
$transition
88+
)
89+
);
90+
91+
$this
92+
->eventDispatcher
93+
->dispatch(
94+
str_replace(
95+
[
96+
'{machine_id}',
97+
'{state_name}',
98+
],
99+
[
100+
$machine->getId(),
101+
$transition->getStart()->getName(),
102+
],
103+
ElcodiStateTransitionMachineEvents::TRANSITION_FROM_STATE
104+
),
105+
TransitionEvent::create(
106+
$object,
107+
$stateLineStack,
108+
$transition
109+
)
110+
);
111+
112+
$this
113+
->eventDispatcher
114+
->dispatch(
115+
str_replace(
116+
[
117+
'{machine_id}',
118+
'{state_name}',
119+
],
120+
[
121+
$machine->getId(),
122+
$transition->getFinal()->getName(),
123+
],
124+
ElcodiStateTransitionMachineEvents::TRANSITION_TO_STATE
125+
),
126+
TransitionEvent::create(
127+
$object,
128+
$stateLineStack,
129+
$transition
130+
)
131+
);
25132

133+
$this
134+
->eventDispatcher
135+
->dispatch(
136+
str_replace(
137+
[
138+
'{machine_id}',
139+
'{transition_name}',
140+
],
141+
[
142+
$machine->getId(),
143+
$transition->getName(),
144+
],
145+
ElcodiStateTransitionMachineEvents::TRANSITION
146+
),
147+
TransitionEvent::create(
148+
$object,
149+
$stateLineStack,
150+
$transition
151+
)
152+
);
153+
}
26154
}

‎Machine/MachineManager.php‎

Lines changed: 23 additions & 142 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,11 @@
1818
namespace Elcodi\Component\StateTransitionMachine\Machine;
1919

2020
use stdClass;
21-
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
2221

2322
use Elcodi\Component\StateTransitionMachine\Definition\Transition;
24-
use Elcodi\Component\StateTransitionMachine\ElcodiStateTransitionMachineEvents;
2523
use Elcodi\Component\StateTransitionMachine\Entity\Interfaces\StateLineInterface;
2624
use Elcodi\Component\StateTransitionMachine\Entity\StateLineStack;
27-
use Elcodi\Component\StateTransitionMachine\Event\InitializationEvent;
28-
use Elcodi\Component\StateTransitionMachine\Event\TransitionEvent;
25+
use Elcodi\Component\StateTransitionMachine\EventDispatcher\MachineEventDispatcher;
2926
use Elcodi\Component\StateTransitionMachine\Exception\ObjectAlreadyInitializedException;
3027
use Elcodi\Component\StateTransitionMachine\Exception\ObjectNotInitializedException;
3128
use Elcodi\Component\StateTransitionMachine\Exception\StateNotReachableException;
@@ -47,11 +44,11 @@ class MachineManager
4744
private $machine;
4845

4946
/**
50-
* @var EventDispatcherInterface
47+
* @var MachineEventDispatcher
5148
*
52-
* Event Dispatcher
49+
* Machine Event Dispatcher
5350
*/
54-
private $eventDispatcher;
51+
private $machineEventDispatcher;
5552

5653
/**
5754
* @var StateLineFactory
@@ -63,17 +60,17 @@ class MachineManager
6360
/**
6461
* Construct
6562
*
66-
* @param MachineInterface $machine Machine
67-
* @param EventDispatcherInterface $eventDispatcher Event Dispatcher
68-
* @param StateLineFactory $stateLineFactory StateLine Factory
63+
* @param MachineInterface $machine Machine
64+
* @param MachineEventDispatcher $machineEventDispatcher Event Dispatcher
65+
* @param StateLineFactory $stateLineFactory StateLine Factory
6966
*/
7067
public function __construct(
7168
MachineInterface $machine,
72-
EventDispatcherInterface $eventDispatcher,
69+
MachineEventDispatcher $machineEventDispatcher,
7370
StateLineFactory $stateLineFactory
7471
) {
7572
$this->machine = $machine;
76-
$this->eventDispatcher = $eventDispatcher;
73+
$this->machineEventDispatcher = $machineEventDispatcher;
7774
$this->stateLineFactory = $stateLineFactory;
7875
}
7976

@@ -108,11 +105,13 @@ public function initialize(
108105

109106
$stateLineStack->addStateLine($stateLine);
110107

111-
$this->dispatchInitializationEvents(
112-
$this->machine,
113-
$object,
114-
$stateLineStack
115-
);
108+
$this
109+
->machineEventDispatcher
110+
->dispatchInitializationEvents(
111+
$this->machine,
112+
$object,
113+
$stateLineStack
114+
);
116115

117116
return $stateLineStack;
118117
}
@@ -240,133 +239,15 @@ private function applyTransitionAction(
240239

241240
$stateLineStack->addStateLine($stateLine);
242241

243-
$this->dispatchTransitionEvents(
244-
$this->machine,
245-
$object,
246-
$stateLineStack,
247-
$transition
248-
);
249-
250-
return $stateLineStack;
251-
}
252-
253-
/**
254-
* Throw initialization events
255-
*
256-
* @param MachineInterface $machine Machine
257-
* @param stdClass $object Object
258-
* @param StateLineStack $stateLineStack StateLine Stack
259-
*
260-
* @return $this Self object
261-
*/
262-
private function dispatchInitializationEvents(
263-
MachineInterface $machine,
264-
$object,
265-
StateLineStack $stateLineStack
266-
) {
267242
$this
268-
->eventDispatcher
269-
->dispatch(
270-
str_replace(
271-
'{machine_id}',
272-
$machine->getId(),
273-
ElcodiStateTransitionMachineEvents::INITIALIZATION
274-
),
275-
InitializationEvent::create(
276-
$object,
277-
$stateLineStack
278-
)
279-
);
280-
}
281-
282-
/**
283-
* Throw transition events
284-
*
285-
* @param MachineInterface $machine Machine
286-
* @param stdClass $object Object
287-
* @param StateLineStack $stateLineStack StateLine Stack
288-
* @param Transition $transition Transition
289-
*
290-
* @return $this Self object
291-
*/
292-
private function dispatchTransitionEvents(
293-
MachineInterface $machine,
294-
$object,
295-
StateLineStack $stateLineStack,
296-
Transition $transition
297-
) {
298-
$this
299-
->eventDispatcher
300-
->dispatch(
301-
ElcodiStateTransitionMachineEvents::ALL_TRANSITIONS,
302-
TransitionEvent::create(
303-
$object,
304-
$stateLineStack,
305-
$transition
306-
)
307-
);
308-
309-
$this
310-
->eventDispatcher
311-
->dispatch(
312-
str_replace(
313-
[
314-
'{machine_id}',
315-
'{state_name}',
316-
],
317-
[
318-
$machine->getId(),
319-
$transition->getStart()->getName(),
320-
],
321-
ElcodiStateTransitionMachineEvents::TRANSITION_FROM_STATE
322-
),
323-
TransitionEvent::create(
324-
$object,
325-
$stateLineStack,
326-
$transition
327-
)
328-
);
329-
330-
$this
331-
->eventDispatcher
332-
->dispatch(
333-
str_replace(
334-
[
335-
'{machine_id}',
336-
'{state_name}',
337-
],
338-
[
339-
$machine->getId(),
340-
$transition->getFinal()->getName(),
341-
],
342-
ElcodiStateTransitionMachineEvents::TRANSITION_TO_STATE
343-
),
344-
TransitionEvent::create(
345-
$object,
346-
$stateLineStack,
347-
$transition
348-
)
243+
->machineEventDispatcher
244+
->dispatchTransitionEvents(
245+
$this->machine,
246+
$object,
247+
$stateLineStack,
248+
$transition
349249
);
350250

351-
$this
352-
->eventDispatcher
353-
->dispatch(
354-
str_replace(
355-
[
356-
'{machine_id}',
357-
'{transition_name}',
358-
],
359-
[
360-
$machine->getId(),
361-
$transition->getName(),
362-
],
363-
ElcodiStateTransitionMachineEvents::TRANSITION
364-
),
365-
TransitionEvent::create(
366-
$object,
367-
$stateLineStack,
368-
$transition
369-
)
370-
);
251+
return $stateLineStack;
371252
}
372253
}

‎Tests/UnitTest/Fixtures/AbstractStateTransitionTest.php‎

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -74,15 +74,12 @@ public function getTransition()
7474
/**
7575
* Return MachineManager
7676
*
77-
* @param integer $nbEventDispatcherCalls Number of times eventDispatcher::dispatch will be called
78-
* @param string $stateLineNamespace StateLine Entity Namespace
77+
* @param string $stateLineNamespace StateLine Entity Namespace
7978
*
8079
* @return MachineManager Machine Manager
8180
*/
82-
public function getMachineManager(
83-
$nbEventDispatcherCalls = 4,
84-
$stateLineNamespace = 'Elcodi\Component\StateTransitionMachine\Entity\StateLine'
85-
) {
81+
public function getMachineManager($stateLineNamespace = 'Elcodi\Component\StateTransitionMachine\Entity\StateLine')
82+
{
8683
$machine = $this->getMachine();
8784
$stateLineFactory = new StateLineFactory();
8885
$stateLineFactory->setEntityNamespace($stateLineNamespace);
@@ -91,10 +88,7 @@ public function getMachineManager(
9188
/**
9289
* @var EventDispatcherInterface $eventDispatcher
9390
*/
94-
$eventDispatcher = $this->getMock('Symfony\Component\EventDispatcher\EventDispatcherInterface');
95-
$eventDispatcher
96-
->expects($this->exactly($nbEventDispatcherCalls))
97-
->method('dispatch');
91+
$eventDispatcher = $this->getMock('Elcodi\Component\StateTransitionMachine\EventDispatcher\MachineEventDispatcher', [], [], '', false);
9892

9993
$machineManager = new MachineManager(
10094
$machine,

0 commit comments

Comments
 (0)