@@ -25,24 +25,24 @@ |
||
25 | 25 | { |
26 | 26 | const ERROR_PLACEHOLDER_TOO_LONG = 47901; |
27 | 27 | |
28 | - /** |
|
29 | - * @var int |
|
30 | - */ |
|
28 | + /** |
|
29 | + * @var int |
|
30 | + */ |
|
31 | 31 | protected $id; |
32 | 32 | |
33 | - /** |
|
34 | - * @var Mailcode_Parser_Safeguard |
|
35 | - */ |
|
33 | + /** |
|
34 | + * @var Mailcode_Parser_Safeguard |
|
35 | + */ |
|
36 | 36 | protected $safeguard; |
37 | 37 | |
38 | - /** |
|
39 | - * @var Mailcode_Commands_Command |
|
40 | - */ |
|
38 | + /** |
|
39 | + * @var Mailcode_Commands_Command |
|
40 | + */ |
|
41 | 41 | protected $command; |
42 | 42 | |
43 | - /** |
|
44 | - * @var string |
|
45 | - */ |
|
43 | + /** |
|
44 | + * @var string |
|
45 | + */ |
|
46 | 46 | protected $replacement = ''; |
47 | 47 | |
48 | 48 | public function __construct(int $id, Mailcode_Commands_Command $command, Mailcode_Parser_Safeguard $safeguard) |
@@ -20,9 +20,9 @@ discard block |
||
20 | 20 | */ |
21 | 21 | class Mailcode_Variables_Collection_Regular extends Mailcode_Variables_Collection |
22 | 22 | { |
23 | - /** |
|
24 | - * @var Mailcode_Variables_Collection_Invalid |
|
25 | - */ |
|
23 | + /** |
|
24 | + * @var Mailcode_Variables_Collection_Invalid |
|
25 | + */ |
|
26 | 26 | protected $invalid; |
27 | 27 | |
28 | 28 | protected function init() : void |
@@ -47,30 +47,30 @@ discard block |
||
47 | 47 | return $this; |
48 | 48 | } |
49 | 49 | |
50 | - /** |
|
51 | - * Whether any of the variables in the collection are invalid. |
|
52 | - * |
|
53 | - * @return bool |
|
54 | - */ |
|
50 | + /** |
|
51 | + * Whether any of the variables in the collection are invalid. |
|
52 | + * |
|
53 | + * @return bool |
|
54 | + */ |
|
55 | 55 | public function hasInvalid() : bool |
56 | 56 | { |
57 | 57 | return isset($this->invalid) && $this->invalid->hasVariables(); |
58 | 58 | } |
59 | 59 | |
60 | - /** |
|
61 | - * Retrieves the collection of invalid variables, if any. |
|
62 | - * Behaves like a variables collection. |
|
63 | - * |
|
64 | - * @return Mailcode_Variables_Collection_Invalid |
|
65 | - */ |
|
60 | + /** |
|
61 | + * Retrieves the collection of invalid variables, if any. |
|
62 | + * Behaves like a variables collection. |
|
63 | + * |
|
64 | + * @return Mailcode_Variables_Collection_Invalid |
|
65 | + */ |
|
66 | 66 | public function getInvalid() : Mailcode_Variables_Collection_Invalid |
67 | 67 | { |
68 | 68 | return $this->invalid; |
69 | 69 | } |
70 | 70 | |
71 | - /** |
|
72 | - * @return Mailcode_Variables_Collection_Regular |
|
73 | - */ |
|
71 | + /** |
|
72 | + * @return Mailcode_Variables_Collection_Regular |
|
73 | + */ |
|
74 | 74 | public function mergeWith(Mailcode_Variables_Collection $collection) : Mailcode_Variables_Collection |
75 | 75 | { |
76 | 76 | parent::mergeWith($collection); |
@@ -20,19 +20,19 @@ |
||
20 | 20 | */ |
21 | 21 | abstract class Mailcode_Collection_Error |
22 | 22 | { |
23 | - /** |
|
24 | - * @var integer |
|
25 | - */ |
|
23 | + /** |
|
24 | + * @var integer |
|
25 | + */ |
|
26 | 26 | protected $code = 0; |
27 | 27 | |
28 | - /** |
|
29 | - * @var string |
|
30 | - */ |
|
28 | + /** |
|
29 | + * @var string |
|
30 | + */ |
|
31 | 31 | protected $matchedText = ''; |
32 | 32 | |
33 | - /** |
|
34 | - * @var string |
|
35 | - */ |
|
33 | + /** |
|
34 | + * @var string |
|
35 | + */ |
|
36 | 36 | protected $message = ''; |
37 | 37 | |
38 | 38 | public function getCode() : int |
@@ -20,19 +20,19 @@ discard block |
||
20 | 20 | */ |
21 | 21 | class Mailcode_Commands_Highlighter |
22 | 22 | { |
23 | - /** |
|
24 | - * @var Mailcode_Commands_Command |
|
25 | - */ |
|
23 | + /** |
|
24 | + * @var Mailcode_Commands_Command |
|
25 | + */ |
|
26 | 26 | protected $command; |
27 | 27 | |
28 | - /** |
|
29 | - * @var string[] |
|
30 | - */ |
|
28 | + /** |
|
29 | + * @var string[] |
|
30 | + */ |
|
31 | 31 | protected $parts = array(); |
32 | 32 | |
33 | 33 | public function __construct(Mailcode_Commands_Command $command) |
34 | 34 | { |
35 | - $this->command = $command; |
|
35 | + $this->command = $command; |
|
36 | 36 | } |
37 | 37 | |
38 | 38 | public function highlight() : string |
@@ -68,11 +68,11 @@ discard block |
||
68 | 68 | } |
69 | 69 | } |
70 | 70 | |
71 | - /** |
|
72 | - * @param string[] $classes |
|
73 | - * @param string $content |
|
74 | - * @return string |
|
75 | - */ |
|
71 | + /** |
|
72 | + * @param string[] $classes |
|
73 | + * @param string $content |
|
74 | + * @return string |
|
75 | + */ |
|
76 | 76 | protected function renderTag(array $classes, string $content) : string |
77 | 77 | { |
78 | 78 | $parts = array(); |
@@ -32,34 +32,34 @@ |
||
32 | 32 | const VALIDATION_ERROR_PATH_UNDERSCORE = 48203; |
33 | 33 | const VALIDATION_ERROR_NAME_UNDERSCORE = 48204; |
34 | 34 | |
35 | - /** |
|
36 | - * @var string |
|
37 | - */ |
|
35 | + /** |
|
36 | + * @var string |
|
37 | + */ |
|
38 | 38 | protected $path; |
39 | 39 | |
40 | - /** |
|
41 | - * @var string |
|
42 | - */ |
|
40 | + /** |
|
41 | + * @var string |
|
42 | + */ |
|
43 | 43 | protected $name; |
44 | 44 | |
45 | - /** |
|
46 | - * @var string |
|
47 | - */ |
|
45 | + /** |
|
46 | + * @var string |
|
47 | + */ |
|
48 | 48 | protected $matchedText; |
49 | 49 | |
50 | - /** |
|
51 | - * @var string |
|
52 | - */ |
|
50 | + /** |
|
51 | + * @var string |
|
52 | + */ |
|
53 | 53 | protected $hash = ''; |
54 | 54 | |
55 | - /** |
|
56 | - * @var OperationResult |
|
57 | - */ |
|
55 | + /** |
|
56 | + * @var OperationResult |
|
57 | + */ |
|
58 | 58 | protected $validationResult = null; |
59 | 59 | |
60 | - /** |
|
61 | - * @var array<string> |
|
62 | - */ |
|
60 | + /** |
|
61 | + * @var array<string> |
|
62 | + */ |
|
63 | 63 | protected $validations = array( |
64 | 64 | 'number_path', |
65 | 65 | 'number_name', |
@@ -20,9 +20,9 @@ discard block |
||
20 | 20 | */ |
21 | 21 | abstract class Mailcode_Variables_Collection |
22 | 22 | { |
23 | - /** |
|
24 | - * @var Mailcode_Variables_Variable[] |
|
25 | - */ |
|
23 | + /** |
|
24 | + * @var Mailcode_Variables_Variable[] |
|
25 | + */ |
|
26 | 26 | protected $variables = array(); |
27 | 27 | |
28 | 28 | public function __construct() |
@@ -52,12 +52,12 @@ discard block |
||
52 | 52 | return count($this->variables); |
53 | 53 | } |
54 | 54 | |
55 | - /** |
|
56 | - * Checks whether the collection contains a variable with the specified name. |
|
57 | - * |
|
58 | - * @param string $fullName The variable name, with or without $ sign. |
|
59 | - * @return bool |
|
60 | - */ |
|
55 | + /** |
|
56 | + * Checks whether the collection contains a variable with the specified name. |
|
57 | + * |
|
58 | + * @param string $fullName The variable name, with or without $ sign. |
|
59 | + * @return bool |
|
60 | + */ |
|
61 | 61 | public function hasVariableName(string $fullName) : bool |
62 | 62 | { |
63 | 63 | $fullName = $this->fixName($fullName); |
@@ -73,14 +73,14 @@ discard block |
||
73 | 73 | return false; |
74 | 74 | } |
75 | 75 | |
76 | - /** |
|
77 | - * Retrieves a collection of all variable instances for |
|
78 | - * the specified name (there can be several with differing |
|
79 | - * matched texts because of spacing). |
|
80 | - * |
|
81 | - * @param string $fullName |
|
82 | - * @return Mailcode_Variables_Collection |
|
83 | - */ |
|
76 | + /** |
|
77 | + * Retrieves a collection of all variable instances for |
|
78 | + * the specified name (there can be several with differing |
|
79 | + * matched texts because of spacing). |
|
80 | + * |
|
81 | + * @param string $fullName |
|
82 | + * @return Mailcode_Variables_Collection |
|
83 | + */ |
|
84 | 84 | public function getByFullName(string $fullName) : Mailcode_Variables_Collection |
85 | 85 | { |
86 | 86 | $fullName = $this->fixName($fullName); |
@@ -98,12 +98,12 @@ discard block |
||
98 | 98 | return $collection; |
99 | 99 | } |
100 | 100 | |
101 | - /** |
|
102 | - * Prepends the $ sign to a variable name if it does not have it. |
|
103 | - * |
|
104 | - * @param string $fullName |
|
105 | - * @return string |
|
106 | - */ |
|
101 | + /** |
|
102 | + * Prepends the $ sign to a variable name if it does not have it. |
|
103 | + * |
|
104 | + * @param string $fullName |
|
105 | + * @return string |
|
106 | + */ |
|
107 | 107 | protected function fixName(string $fullName) : string |
108 | 108 | { |
109 | 109 | if(substr($fullName, 0, 1) === '$') |
@@ -114,12 +114,12 @@ discard block |
||
114 | 114 | return '$'.$fullName; |
115 | 115 | } |
116 | 116 | |
117 | - /** |
|
118 | - * Retrieves all variables, grouped by their hash - meaning |
|
119 | - * unique matched strings. |
|
120 | - * |
|
121 | - * @return Mailcode_Variables_Variable[] |
|
122 | - */ |
|
117 | + /** |
|
118 | + * Retrieves all variables, grouped by their hash - meaning |
|
119 | + * unique matched strings. |
|
120 | + * |
|
121 | + * @return Mailcode_Variables_Variable[] |
|
122 | + */ |
|
123 | 123 | public function getGroupedByHash() |
124 | 124 | { |
125 | 125 | $entries = array(); |
@@ -132,11 +132,11 @@ discard block |
||
132 | 132 | return $this->sortVariables($entries); |
133 | 133 | } |
134 | 134 | |
135 | - /** |
|
136 | - * Retrieves all variables, grouped by their name. |
|
137 | - * |
|
138 | - * @return Mailcode_Variables_Variable[] |
|
139 | - */ |
|
135 | + /** |
|
136 | + * Retrieves all variables, grouped by their name. |
|
137 | + * |
|
138 | + * @return Mailcode_Variables_Variable[] |
|
139 | + */ |
|
140 | 140 | public function getGroupedByName() |
141 | 141 | { |
142 | 142 | $entries = array(); |
@@ -149,19 +149,19 @@ discard block |
||
149 | 149 | return $this->sortVariables($entries); |
150 | 150 | } |
151 | 151 | |
152 | - /** |
|
153 | - * Retrieves all variables, in the order they were addded. |
|
154 | - * @return \Mailcode\Mailcode_Variables_Variable[] |
|
155 | - */ |
|
152 | + /** |
|
153 | + * Retrieves all variables, in the order they were addded. |
|
154 | + * @return \Mailcode\Mailcode_Variables_Variable[] |
|
155 | + */ |
|
156 | 156 | public function getAll() |
157 | 157 | { |
158 | 158 | return $this->variables; |
159 | 159 | } |
160 | 160 | |
161 | - /** |
|
162 | - * Retrieves the full names of the variables that are present in the collection. |
|
163 | - * @return string[] |
|
164 | - */ |
|
161 | + /** |
|
162 | + * Retrieves the full names of the variables that are present in the collection. |
|
163 | + * @return string[] |
|
164 | + */ |
|
165 | 165 | public function getNames() : array |
166 | 166 | { |
167 | 167 | $result = array(); |
@@ -179,13 +179,13 @@ discard block |
||
179 | 179 | return $result; |
180 | 180 | } |
181 | 181 | |
182 | - /** |
|
183 | - * Takes a list of variables and sorts them, throwing away |
|
184 | - * the source array's keys. |
|
185 | - * |
|
186 | - * @param Mailcode_Variables_Variable[] $entries |
|
187 | - * @return Mailcode_Variables_Variable[] |
|
188 | - */ |
|
182 | + /** |
|
183 | + * Takes a list of variables and sorts them, throwing away |
|
184 | + * the source array's keys. |
|
185 | + * |
|
186 | + * @param Mailcode_Variables_Variable[] $entries |
|
187 | + * @return Mailcode_Variables_Variable[] |
|
188 | + */ |
|
189 | 189 | protected function sortVariables(array $entries) |
190 | 190 | { |
191 | 191 | $result = array_values($entries); |
@@ -198,13 +198,13 @@ discard block |
||
198 | 198 | return $result; |
199 | 199 | } |
200 | 200 | |
201 | - /** |
|
202 | - * Merges the variables collection with the target collection |
|
203 | - * by inheriting all that collection's variables. |
|
204 | - * |
|
205 | - * @param Mailcode_Variables_Collection $collection |
|
206 | - * @return Mailcode_Variables_Collection |
|
207 | - */ |
|
201 | + /** |
|
202 | + * Merges the variables collection with the target collection |
|
203 | + * by inheriting all that collection's variables. |
|
204 | + * |
|
205 | + * @param Mailcode_Variables_Collection $collection |
|
206 | + * @return Mailcode_Variables_Collection |
|
207 | + */ |
|
208 | 208 | public function mergeWith(Mailcode_Variables_Collection $collection) : Mailcode_Variables_Collection |
209 | 209 | { |
210 | 210 | $variables = $collection->getGroupedByHash(); |
@@ -21,24 +21,24 @@ |
||
21 | 21 | */ |
22 | 22 | class Mailcode_Parser_Match |
23 | 23 | { |
24 | - /** |
|
25 | - * @var string |
|
26 | - */ |
|
24 | + /** |
|
25 | + * @var string |
|
26 | + */ |
|
27 | 27 | protected $name; |
28 | 28 | |
29 | - /** |
|
30 | - * @var string |
|
31 | - */ |
|
29 | + /** |
|
30 | + * @var string |
|
31 | + */ |
|
32 | 32 | protected $type; |
33 | 33 | |
34 | - /** |
|
35 | - * @var string |
|
36 | - */ |
|
34 | + /** |
|
35 | + * @var string |
|
36 | + */ |
|
37 | 37 | protected $params; |
38 | 38 | |
39 | - /** |
|
40 | - * @var string |
|
41 | - */ |
|
39 | + /** |
|
40 | + * @var string |
|
41 | + */ |
|
42 | 42 | protected $matchedString; |
43 | 43 | |
44 | 44 | public function __construct(string $name, string $type, string $params, string $matchedString) |
@@ -30,11 +30,11 @@ discard block |
||
30 | 30 | return $this->getOperand(); |
31 | 31 | } |
32 | 32 | |
33 | - /** |
|
34 | - * Whether the operator is comparison related (equals, not equals, smaller, greater...). |
|
35 | - * |
|
36 | - * @return bool |
|
37 | - */ |
|
33 | + /** |
|
34 | + * Whether the operator is comparison related (equals, not equals, smaller, greater...). |
|
35 | + * |
|
36 | + * @return bool |
|
37 | + */ |
|
38 | 38 | public function isComparator() : bool |
39 | 39 | { |
40 | 40 | return |
@@ -46,11 +46,11 @@ discard block |
||
46 | 46 | $this->isSmallerOrEquals(); |
47 | 47 | } |
48 | 48 | |
49 | - /** |
|
50 | - * Whether the operator is calculation related (minus, plus, divide, multiply). |
|
51 | - * |
|
52 | - * @return bool |
|
53 | - */ |
|
49 | + /** |
|
50 | + * Whether the operator is calculation related (minus, plus, divide, multiply). |
|
51 | + * |
|
52 | + * @return bool |
|
53 | + */ |
|
54 | 54 | public function isCalculator() : bool |
55 | 55 | { |
56 | 56 | return |
@@ -20,26 +20,26 @@ |
||
20 | 20 | */ |
21 | 21 | abstract class Mailcode_Parser_Statement_Tokenizer_Token |
22 | 22 | { |
23 | - /** |
|
24 | - * @var string |
|
25 | - */ |
|
23 | + /** |
|
24 | + * @var string |
|
25 | + */ |
|
26 | 26 | protected $tokenID; |
27 | 27 | |
28 | - /** |
|
29 | - * @var string |
|
30 | - */ |
|
28 | + /** |
|
29 | + * @var string |
|
30 | + */ |
|
31 | 31 | protected $matchedText; |
32 | 32 | |
33 | - /** |
|
34 | - * @var mixed |
|
35 | - */ |
|
33 | + /** |
|
34 | + * @var mixed |
|
35 | + */ |
|
36 | 36 | protected $subject; |
37 | 37 | |
38 | - /** |
|
39 | - * @param string $tokenID |
|
40 | - * @param string $matchedText |
|
41 | - * @param mixed $subject |
|
42 | - */ |
|
38 | + /** |
|
39 | + * @param string $tokenID |
|
40 | + * @param string $matchedText |
|
41 | + * @param mixed $subject |
|
42 | + */ |
|
43 | 43 | public function __construct(string $tokenID, string $matchedText, $subject=null) |
44 | 44 | { |
45 | 45 | $this->tokenID = $tokenID; |