1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
/** |
4
|
|
|
* Copyright (c) 2011-present Mediasift Ltd |
5
|
|
|
* All rights reserved. |
6
|
|
|
* |
7
|
|
|
* Redistribution and use in source and binary forms, with or without |
8
|
|
|
* modification, are permitted provided that the following conditions |
9
|
|
|
* are met: |
10
|
|
|
* |
11
|
|
|
* * Redistributions of source code must retain the above copyright |
12
|
|
|
* notice, this list of conditions and the following disclaimer. |
13
|
|
|
* |
14
|
|
|
* * Redistributions in binary form must reproduce the above copyright |
15
|
|
|
* notice, this list of conditions and the following disclaimer in |
16
|
|
|
* the documentation and/or other materials provided with the |
17
|
|
|
* distribution. |
18
|
|
|
* |
19
|
|
|
* * Neither the names of the copyright holders nor the names of his |
20
|
|
|
* contributors may be used to endorse or promote products derived |
21
|
|
|
* from this software without specific prior written permission. |
22
|
|
|
* |
23
|
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
24
|
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
25
|
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS |
26
|
|
|
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE |
27
|
|
|
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, |
28
|
|
|
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, |
29
|
|
|
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; |
30
|
|
|
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
31
|
|
|
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
32
|
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN |
33
|
|
|
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
34
|
|
|
* POSSIBILITY OF SUCH DAMAGE. |
35
|
|
|
* |
36
|
|
|
* @category Libraries |
37
|
|
|
* @package Storyplayer/Phases |
38
|
|
|
* @author Stuart Herbert <[email protected]> |
39
|
|
|
* @copyright 2011-present Mediasift Ltd www.datasift.com |
40
|
|
|
* @license http://www.opensource.org/licenses/bsd-license.php BSD License |
41
|
|
|
* @link http://datasift.github.io/storyplayer |
42
|
|
|
*/ |
43
|
|
|
|
44
|
|
|
namespace DataSift\Storyplayer\Phases; |
45
|
|
|
|
46
|
|
|
use Exception; |
47
|
|
|
use Storyplayer\SPv2\Modules\Exceptions\ActionFailedException; |
48
|
|
|
use Storyplayer\SPv2\Modules\Exceptions\ExpectFailedException; |
49
|
|
|
use Storyplayer\SPv2\Modules\Exceptions\NotImplementedException; |
50
|
|
|
|
51
|
|
|
/** |
52
|
|
|
* the Action phase |
53
|
|
|
* |
54
|
|
|
* @category Libraries |
55
|
|
|
* @package Storyplayer/Phases |
56
|
|
|
* @author Stuart Herbert <[email protected]> |
57
|
|
|
* @copyright 2011-present Mediasift Ltd www.datasift.com |
58
|
|
|
* @license http://www.opensource.org/licenses/bsd-license.php BSD License |
59
|
|
|
* @link http://datasift.github.io/storyplayer |
60
|
|
|
*/ |
61
|
|
|
|
62
|
|
View Code Duplication |
class ActionPhase extends StoryPhase |
|
|
|
|
63
|
|
|
{ |
64
|
|
|
protected $sequenceNo = 5; |
65
|
|
|
|
66
|
|
|
public function doPhase($story) |
67
|
|
|
{ |
68
|
|
|
// shorthand |
69
|
|
|
$st = $this->st; |
70
|
|
|
$storyResult = $story->getResult(); |
71
|
|
|
|
72
|
|
|
// keep track of what happens with the action |
73
|
|
|
$phaseResult = $this->getNewPhaseResult(); |
74
|
|
|
|
75
|
|
|
// do we have anything to do? |
76
|
|
|
if (!$story->hasActions()) |
77
|
|
|
{ |
78
|
|
|
$phaseResult->setContinuePlaying( |
79
|
|
|
$phaseResult::HASNOACTIONS, |
80
|
|
|
"story has no action instructions" |
81
|
|
|
); |
82
|
|
|
return $phaseResult; |
83
|
|
|
} |
84
|
|
|
|
85
|
|
|
try { |
86
|
|
|
// do any setup |
87
|
|
|
$this->doPerPhaseSetup(); |
88
|
|
|
|
89
|
|
|
$callbacks = $story->getAction(); |
90
|
|
|
foreach ($callbacks as $action) { |
91
|
|
|
if (is_callable($action)) { |
92
|
|
|
call_user_func($action,$st); |
93
|
|
|
} |
94
|
|
|
} |
95
|
|
|
|
96
|
|
|
// if we get here, all is well |
97
|
|
|
if ($storyResult->getStoryShouldFail()) { |
98
|
|
|
$phaseResult->setPlayingFailed( |
99
|
|
|
$phaseResult::COMPLETED, |
100
|
|
|
"action completed successfully; was expected to fail" |
101
|
|
|
); |
102
|
|
|
$storyResult->setStoryHasFailed($phaseResult); |
103
|
|
|
} |
104
|
|
|
else { |
105
|
|
|
$phaseResult->setContinuePlaying(); |
106
|
|
|
} |
107
|
|
|
} |
108
|
|
|
|
109
|
|
|
// if the set of actions fails, it will throw this exception |
110
|
|
|
catch (ActionFailedException $e) { |
|
|
|
|
111
|
|
|
if ($storyResult->getStoryShouldFail()) { |
112
|
|
|
$phaseResult->setContinuePlaying( |
113
|
|
|
$phaseResult::FAILED, |
114
|
|
|
$e->getMessage(), |
115
|
|
|
$e |
116
|
|
|
); |
117
|
|
|
} |
118
|
|
|
else { |
119
|
|
|
$phaseResult->setPlayingFailed( |
120
|
|
|
$phaseResult::FAILED, |
121
|
|
|
$e->getMessage(), |
122
|
|
|
$e |
123
|
|
|
); |
124
|
|
|
$storyResult->setStoryHasFailed($phaseResult); |
125
|
|
|
} |
126
|
|
|
} |
127
|
|
|
catch (ExpectFailedException $e) { |
|
|
|
|
128
|
|
|
if ($storyResult->getStoryShouldFail()) { |
129
|
|
|
$phaseResult->setContinuePlaying( |
130
|
|
|
$phaseResult::FAILED, |
131
|
|
|
$e->getMessage(), |
132
|
|
|
$e |
133
|
|
|
); |
134
|
|
|
} |
135
|
|
|
else { |
136
|
|
|
$phaseResult->setPlayingFailed( |
137
|
|
|
$phaseResult::FAILED, |
138
|
|
|
$e->getMessage(), |
139
|
|
|
$e |
140
|
|
|
); |
141
|
|
|
$storyResult->setStoryHasFailed($phaseResult); |
142
|
|
|
} |
143
|
|
|
} |
144
|
|
|
|
145
|
|
|
// we treat this as a hard failure |
146
|
|
|
catch (NotImplementedException $e) { |
|
|
|
|
147
|
|
|
$phaseResult->setPlayingFailed( |
148
|
|
|
$phaseResult::INCOMPLETE, |
149
|
|
|
$e->getMessage(), |
150
|
|
|
$e |
151
|
|
|
); |
152
|
|
|
$storyResult->setStoryIsIncomplete($phaseResult); |
153
|
|
|
} |
154
|
|
|
|
155
|
|
|
// if this happens, something has gone badly wrong |
156
|
|
|
catch (Exception $e) { |
157
|
|
|
$phaseResult->setPlayingFailed( |
158
|
|
|
$phaseResult::ERROR, |
159
|
|
|
$e->getMessage(), |
160
|
|
|
$e |
161
|
|
|
); |
162
|
|
|
$storyResult->setStoryHasError($phaseResult); |
163
|
|
|
} |
164
|
|
|
|
165
|
|
|
// close off any open log actions |
166
|
|
|
$st->closeAllOpenActions(); |
167
|
|
|
|
168
|
|
|
// tidy up after ourselves |
169
|
|
|
$this->doPerPhaseTeardown(); |
170
|
|
|
|
171
|
|
|
// all done |
172
|
|
|
return $phaseResult; |
173
|
|
|
} |
174
|
|
|
} |
175
|
|
|
|
Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.
You can also find more detailed suggestions in the “Code” section of your repository.