@@ -26,9 +26,9 @@ discard block |
||
26 | 26 | */ |
27 | 27 | class OperationResult_Collection extends OperationResult |
28 | 28 | { |
29 | - /** |
|
30 | - * @var OperationResult[] |
|
31 | - */ |
|
29 | + /** |
|
30 | + * @var OperationResult[] |
|
31 | + */ |
|
32 | 32 | protected $results = array(); |
33 | 33 | |
34 | 34 | /** |
@@ -123,9 +123,9 @@ discard block |
||
123 | 123 | return $this; |
124 | 124 | } |
125 | 125 | |
126 | - /** |
|
127 | - * @return OperationResult[] |
|
128 | - */ |
|
126 | + /** |
|
127 | + * @return OperationResult[] |
|
128 | + */ |
|
129 | 129 | public function getResults() : array |
130 | 130 | { |
131 | 131 | return $this->results; |
@@ -34,46 +34,46 @@ discard block |
||
34 | 34 | const TYPE_ERROR = 'error'; |
35 | 35 | const TYPE_SUCCESS = 'success'; |
36 | 36 | |
37 | - /** |
|
38 | - * @var string |
|
39 | - */ |
|
37 | + /** |
|
38 | + * @var string |
|
39 | + */ |
|
40 | 40 | protected $message = ''; |
41 | 41 | |
42 | - /** |
|
43 | - * @var bool |
|
44 | - */ |
|
42 | + /** |
|
43 | + * @var bool |
|
44 | + */ |
|
45 | 45 | protected $valid = true; |
46 | 46 | |
47 | - /** |
|
48 | - * @var object |
|
49 | - */ |
|
47 | + /** |
|
48 | + * @var object |
|
49 | + */ |
|
50 | 50 | protected $subject; |
51 | 51 | |
52 | - /** |
|
53 | - * @var integer |
|
54 | - */ |
|
52 | + /** |
|
53 | + * @var integer |
|
54 | + */ |
|
55 | 55 | protected $code = 0; |
56 | 56 | |
57 | - /** |
|
58 | - * @var string |
|
59 | - */ |
|
57 | + /** |
|
58 | + * @var string |
|
59 | + */ |
|
60 | 60 | protected $type = ''; |
61 | 61 | |
62 | - /** |
|
63 | - * @var integer |
|
64 | - */ |
|
62 | + /** |
|
63 | + * @var integer |
|
64 | + */ |
|
65 | 65 | private static $counter = 0; |
66 | 66 | |
67 | - /** |
|
68 | - * @var int |
|
69 | - */ |
|
67 | + /** |
|
68 | + * @var int |
|
69 | + */ |
|
70 | 70 | private $id; |
71 | 71 | |
72 | - /** |
|
73 | - * The subject being validated. |
|
74 | - * |
|
75 | - * @param object $subject |
|
76 | - */ |
|
72 | + /** |
|
73 | + * The subject being validated. |
|
74 | + * |
|
75 | + * @param object $subject |
|
76 | + */ |
|
77 | 77 | public function __construct(object $subject) |
78 | 78 | { |
79 | 79 | $this->subject = $subject; |
@@ -83,21 +83,21 @@ discard block |
||
83 | 83 | $this->id = self::$counter; |
84 | 84 | } |
85 | 85 | |
86 | - /** |
|
87 | - * Retrieves the ID of the result, which is unique within a request. |
|
88 | - * |
|
89 | - * @return int |
|
90 | - */ |
|
86 | + /** |
|
87 | + * Retrieves the ID of the result, which is unique within a request. |
|
88 | + * |
|
89 | + * @return int |
|
90 | + */ |
|
91 | 91 | public function getID() : int |
92 | 92 | { |
93 | 93 | return $this->id; |
94 | 94 | } |
95 | 95 | |
96 | - /** |
|
97 | - * Whether the validation was successful. |
|
98 | - * |
|
99 | - * @return bool |
|
100 | - */ |
|
96 | + /** |
|
97 | + * Whether the validation was successful. |
|
98 | + * |
|
99 | + * @return bool |
|
100 | + */ |
|
101 | 101 | public function isValid() : bool |
102 | 102 | { |
103 | 103 | return $this->valid; |
@@ -128,33 +128,33 @@ discard block |
||
128 | 128 | return $this->type === $type; |
129 | 129 | } |
130 | 130 | |
131 | - /** |
|
132 | - * Retrieves the subject that was validated. |
|
133 | - * |
|
134 | - * @return object |
|
135 | - */ |
|
131 | + /** |
|
132 | + * Retrieves the subject that was validated. |
|
133 | + * |
|
134 | + * @return object |
|
135 | + */ |
|
136 | 136 | public function getSubject() : object |
137 | 137 | { |
138 | 138 | return $this->subject; |
139 | 139 | } |
140 | 140 | |
141 | - /** |
|
142 | - * Makes the result a success, with the specified message. |
|
143 | - * |
|
144 | - * @param string $message Should not contain a date, just the system specific info. |
|
145 | - * @return $this |
|
146 | - */ |
|
141 | + /** |
|
142 | + * Makes the result a success, with the specified message. |
|
143 | + * |
|
144 | + * @param string $message Should not contain a date, just the system specific info. |
|
145 | + * @return $this |
|
146 | + */ |
|
147 | 147 | public function makeSuccess(string $message, int $code=0) : OperationResult |
148 | 148 | { |
149 | 149 | return $this->setMessage(self::TYPE_SUCCESS, $message, $code, true); |
150 | 150 | } |
151 | 151 | |
152 | - /** |
|
153 | - * Sets the result as an error. |
|
154 | - * |
|
155 | - * @param string $message Should be as detailed as possible. |
|
156 | - * @return $this |
|
157 | - */ |
|
152 | + /** |
|
153 | + * Sets the result as an error. |
|
154 | + * |
|
155 | + * @param string $message Should be as detailed as possible. |
|
156 | + * @return $this |
|
157 | + */ |
|
158 | 158 | public function makeError(string $message, int $code=0) : OperationResult |
159 | 159 | { |
160 | 160 | return $this->setMessage(self::TYPE_ERROR, $message, $code, false); |
@@ -202,21 +202,21 @@ discard block |
||
202 | 202 | return $this->type; |
203 | 203 | } |
204 | 204 | |
205 | - /** |
|
206 | - * Retrieves the error message, if an error occurred. |
|
207 | - * |
|
208 | - * @return string The error message, or an empty string if no error occurred. |
|
209 | - */ |
|
205 | + /** |
|
206 | + * Retrieves the error message, if an error occurred. |
|
207 | + * |
|
208 | + * @return string The error message, or an empty string if no error occurred. |
|
209 | + */ |
|
210 | 210 | public function getErrorMessage() : string |
211 | 211 | { |
212 | 212 | return $this->getMessage(self::TYPE_ERROR); |
213 | 213 | } |
214 | 214 | |
215 | - /** |
|
216 | - * Retrieves the success message, if one has been provided. |
|
217 | - * |
|
218 | - * @return string |
|
219 | - */ |
|
215 | + /** |
|
216 | + * Retrieves the success message, if one has been provided. |
|
217 | + * |
|
218 | + * @return string |
|
219 | + */ |
|
220 | 220 | public function getSuccessMessage() : string |
221 | 221 | { |
222 | 222 | return $this->getMessage(self::TYPE_SUCCESS); |
@@ -232,21 +232,21 @@ discard block |
||
232 | 232 | return $this->getMessage(self::TYPE_WARNING); |
233 | 233 | } |
234 | 234 | |
235 | - /** |
|
236 | - * Whether a specific error/success code has been specified. |
|
237 | - * |
|
238 | - * @return bool |
|
239 | - */ |
|
235 | + /** |
|
236 | + * Whether a specific error/success code has been specified. |
|
237 | + * |
|
238 | + * @return bool |
|
239 | + */ |
|
240 | 240 | public function hasCode() : bool |
241 | 241 | { |
242 | 242 | return $this->code > 0; |
243 | 243 | } |
244 | 244 | |
245 | - /** |
|
246 | - * Retrieves the error/success code, if any. |
|
247 | - * |
|
248 | - * @return int The error code, or 0 if none. |
|
249 | - */ |
|
245 | + /** |
|
246 | + * Retrieves the error/success code, if any. |
|
247 | + * |
|
248 | + * @return int The error code, or 0 if none. |
|
249 | + */ |
|
250 | 250 | public function getCode() : int |
251 | 251 | { |
252 | 252 | return $this->code; |