@@ -17,6 +17,7 @@ discard block |
||
17 | 17 | * |
18 | 18 | * @param |
19 | 19 | * command the ICommand to add |
20 | + * @return void |
|
20 | 21 | */ |
21 | 22 | public function add(ICommand $command); |
22 | 23 | |
@@ -25,7 +26,7 @@ discard block |
||
25 | 26 | * |
26 | 27 | * @param |
27 | 28 | * command the ICommand to remove |
28 | - * @return Boolean, whether or not the removal was succesful |
|
29 | + * @return boolean whether or not the removal was succesful |
|
29 | 30 | */ |
30 | 31 | public function remove(ICommand $command); |
31 | 32 |
@@ -261,6 +261,9 @@ discard block |
||
261 | 261 | $this->cache = null; |
262 | 262 | } |
263 | 263 | |
264 | + /** |
|
265 | + * @param boolean $result |
|
266 | + */ |
|
264 | 267 | private function setCache($result) |
265 | 268 | { |
266 | 269 | if ($this->getCacheEnabled()) { |
@@ -281,7 +284,7 @@ discard block |
||
281 | 284 | /** |
282 | 285 | * should we cache the result if the rule is applied more than once? |
283 | 286 | * |
284 | - * @param boolean $cache |
|
287 | + * @param boolean $cached |
|
285 | 288 | */ |
286 | 289 | public final function setCacheEnabled($cached = true) |
287 | 290 | { |
@@ -121,7 +121,6 @@ |
||
121 | 121 | * and persistence adapter for a concrete statemachine type. |
122 | 122 | * |
123 | 123 | * |
124 | - * @param Identifier $id |
|
125 | 124 | * @return Context |
126 | 125 | * @throws Exception |
127 | 126 | * @link https://en.wikipedia.org/wiki/Abstract_factory_pattern |
@@ -163,7 +163,7 @@ |
||
163 | 163 | * @param string $state |
164 | 164 | * @param string $message optional message. this can be used by the persistence adapter |
165 | 165 | * to be part of the transition history to provide extra information about the transition. |
166 | - * @return boolan true if there was never any state persisted for this |
|
166 | + * @return boolean true if there was never any state persisted for this |
|
167 | 167 | * machine before (just added for the |
168 | 168 | * first time), false otherwise |
169 | 169 | */ |
@@ -131,7 +131,7 @@ |
||
131 | 131 | * domain object. |
132 | 132 | * |
133 | 133 | * @param Identifier $identifier |
134 | - * @return Object an object of any type defined by the subclass |
|
134 | + * @return Identifier an object of any type defined by the subclass |
|
135 | 135 | */ |
136 | 136 | protected function build(Identifier $identifier) |
137 | 137 | { |
@@ -45,10 +45,10 @@ |
||
45 | 45 | /** |
46 | 46 | * Constructor |
47 | 47 | * |
48 | - * @param mixed $entity_id |
|
48 | + * @param string $entity_id |
|
49 | 49 | * the id of the domain specific entity (it will internally be |
50 | 50 | * converted to a string) |
51 | - * @param string $machine |
|
51 | + * @param string $machine_name |
|
52 | 52 | * the name of the statemachine (eg: 'order') |
53 | 53 | */ |
54 | 54 | public function __construct($entity_id, $machine_name) |
@@ -95,7 +95,7 @@ |
||
95 | 95 | * since we do not want to burden a client of this code with the responsiblity of |
96 | 96 | * creating indexes, we take a statistical approach to check if we need to |
97 | 97 | * create an index in the background. This will only be done once. |
98 | - * @param number $check_index_once_in check for index creation. on average, every <x> times |
|
98 | + * @param integer $check_index_once_in check for index creation. on average, every <x> times |
|
99 | 99 | * the index should be created if it is not there already |
100 | 100 | */ |
101 | 101 | protected function checkAndCreateIndexesIfNecessary($check_index_once_in = 1000) |
@@ -2,14 +2,9 @@ |
||
2 | 2 | namespace izzum\statemachine\persistence; |
3 | 3 | use izzum\statemachine\loader\Loader; |
4 | 4 | use izzum\statemachine\StateMachine; |
5 | -use izzum\statemachine\Context; |
|
6 | -use izzum\statemachine\loader\LoaderArray; |
|
7 | -use izzum\statemachine\loader\LoaderData; |
|
8 | 5 | use izzum\statemachine\Exception; |
9 | 6 | use izzum\statemachine\Identifier; |
10 | -use izzum\statemachine\Transition; |
|
11 | 7 | use izzum\statemachine\loader\JSON; |
12 | -use izzum\statemachine\State; |
|
13 | 8 | /** |
14 | 9 | * MongoDB (from humongous) is a cross-platform document-oriented database. |
15 | 10 | * MongoDB is an open-source document database that provides high performance, high availability, and automatic scaling. |
@@ -4,7 +4,6 @@ |
||
4 | 4 | use izzum\statemachine\StateMachine; |
5 | 5 | use izzum\statemachine\Identifier; |
6 | 6 | use izzum\statemachine\loader\LoaderArray; |
7 | -use izzum\statemachine\loader\LoaderData; |
|
8 | 7 | use izzum\statemachine\Exception; |
9 | 8 | use izzum\statemachine\Transition; |
10 | 9 | use izzum\statemachine\State; |
@@ -142,7 +142,7 @@ |
||
142 | 142 | * |
143 | 143 | * @param string $host optional |
144 | 144 | * @param int $port optional |
145 | - * @param float $timeout value in seconds. default is 0 meaning unlimited |
|
145 | + * @param integer $timeout value in seconds. default is 0 meaning unlimited |
|
146 | 146 | * @param string $reserved should be NULL if $retry is specified |
147 | 147 | * @param int $retry value in milliseconds |
148 | 148 | */ |
@@ -2,12 +2,8 @@ |
||
2 | 2 | namespace izzum\statemachine\persistence; |
3 | 3 | use izzum\statemachine\loader\Loader; |
4 | 4 | use izzum\statemachine\StateMachine; |
5 | -use izzum\statemachine\Context; |
|
6 | -use izzum\statemachine\loader\LoaderArray; |
|
7 | -use izzum\statemachine\loader\LoaderData; |
|
8 | 5 | use izzum\statemachine\Exception; |
9 | 6 | use izzum\statemachine\Identifier; |
10 | -use izzum\statemachine\Transition; |
|
11 | 7 | use izzum\statemachine\loader\JSON; |
12 | 8 | /** |
13 | 9 | * Redis is an open source advanced key-value (nosql database) cache and store using |