@@ -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) |
@@ -21,14 +21,14 @@ discard block |
||
21 | 21 | */ |
22 | 22 | class Mailcode_Parser_Statement_Info |
23 | 23 | { |
24 | - /** |
|
25 | - * @var Mailcode_Parser_Statement_Tokenizer |
|
26 | - */ |
|
24 | + /** |
|
25 | + * @var Mailcode_Parser_Statement_Tokenizer |
|
26 | + */ |
|
27 | 27 | protected $tokenizer; |
28 | 28 | |
29 | - /** |
|
30 | - * @var Mailcode_Parser_Statement_Tokenizer_Token[] |
|
31 | - */ |
|
29 | + /** |
|
30 | + * @var Mailcode_Parser_Statement_Tokenizer_Token[] |
|
31 | + */ |
|
32 | 32 | protected $tokens = array(); |
33 | 33 | |
34 | 34 | public function __construct(Mailcode_Parser_Statement_Tokenizer $tokenizer) |
@@ -37,11 +37,11 @@ discard block |
||
37 | 37 | $this->tokens = $this->tokenizer->getTokens(); |
38 | 38 | } |
39 | 39 | |
40 | - /** |
|
41 | - * Whether the whole statement is a variable being assigned a value. |
|
42 | - * |
|
43 | - * @return bool |
|
44 | - */ |
|
40 | + /** |
|
41 | + * Whether the whole statement is a variable being assigned a value. |
|
42 | + * |
|
43 | + * @return bool |
|
44 | + */ |
|
45 | 45 | public function isVariableAssignment() : bool |
46 | 46 | { |
47 | 47 | $variable = $this->getVariableByIndex(0); |
@@ -56,11 +56,11 @@ discard block |
||
56 | 56 | return false; |
57 | 57 | } |
58 | 58 | |
59 | - /** |
|
60 | - * Whether the whole statement is a variable being compared to something. |
|
61 | - * |
|
62 | - * @return bool |
|
63 | - */ |
|
59 | + /** |
|
60 | + * Whether the whole statement is a variable being compared to something. |
|
61 | + * |
|
62 | + * @return bool |
|
63 | + */ |
|
64 | 64 | public function isVariableComparison() : bool |
65 | 65 | { |
66 | 66 | $variable = $this->getVariableByIndex(0); |
@@ -75,11 +75,11 @@ discard block |
||
75 | 75 | return false; |
76 | 76 | } |
77 | 77 | |
78 | - /** |
|
79 | - * Retrieves all variables used in the statement. |
|
80 | - * |
|
81 | - * @return \Mailcode\Mailcode_Variables_Variable[] |
|
82 | - */ |
|
78 | + /** |
|
79 | + * Retrieves all variables used in the statement. |
|
80 | + * |
|
81 | + * @return \Mailcode\Mailcode_Variables_Variable[] |
|
82 | + */ |
|
83 | 83 | public function getVariables() |
84 | 84 | { |
85 | 85 | $result = array(); |
@@ -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; |
@@ -23,9 +23,9 @@ discard block |
||
23 | 23 | { |
24 | 24 | const ERROR_TOKENIZE_METHOD_MISSING = 49801; |
25 | 25 | |
26 | - /** |
|
27 | - * @var string[] |
|
28 | - */ |
|
26 | + /** |
|
27 | + * @var string[] |
|
28 | + */ |
|
29 | 29 | protected $operands = array( |
30 | 30 | '==', |
31 | 31 | '<=', |
@@ -40,16 +40,16 @@ discard block |
||
40 | 40 | '<' |
41 | 41 | ); |
42 | 42 | |
43 | - /** |
|
44 | - * @var string[] |
|
45 | - */ |
|
43 | + /** |
|
44 | + * @var string[] |
|
45 | + */ |
|
46 | 46 | protected $keywords = array( |
47 | 47 | 'in:' |
48 | 48 | ); |
49 | 49 | |
50 | - /** |
|
51 | - * @var string |
|
52 | - */ |
|
50 | + /** |
|
51 | + * @var string |
|
52 | + */ |
|
53 | 53 | protected $delimiter = '§§'; |
54 | 54 | |
55 | 55 | /** |
@@ -65,19 +65,19 @@ discard block |
||
65 | 65 | 'extract_tokens' |
66 | 66 | ); |
67 | 67 | |
68 | - /** |
|
69 | - * @var Mailcode_Parser_Statement |
|
70 | - */ |
|
68 | + /** |
|
69 | + * @var Mailcode_Parser_Statement |
|
70 | + */ |
|
71 | 71 | protected $statement; |
72 | 72 | |
73 | - /** |
|
74 | - * @var string |
|
75 | - */ |
|
73 | + /** |
|
74 | + * @var string |
|
75 | + */ |
|
76 | 76 | protected $tokenized; |
77 | 77 | |
78 | - /** |
|
79 | - * @var Mailcode_Parser_Statement_Tokenizer_Token[] |
|
80 | - */ |
|
78 | + /** |
|
79 | + * @var Mailcode_Parser_Statement_Tokenizer_Token[] |
|
80 | + */ |
|
81 | 81 | protected $tokensTemporary = array(); |
82 | 82 | |
83 | 83 | /** |
@@ -85,9 +85,9 @@ discard block |
||
85 | 85 | */ |
86 | 86 | protected $tokensOrdered = array(); |
87 | 87 | |
88 | - /** |
|
89 | - * @var string[] |
|
90 | - */ |
|
88 | + /** |
|
89 | + * @var string[] |
|
90 | + */ |
|
91 | 91 | protected static $ids = array(); |
92 | 92 | |
93 | 93 | public function __construct(Mailcode_Parser_Statement $statement) |
@@ -97,12 +97,12 @@ discard block |
||
97 | 97 | $this->tokenize($statement->getStatementString()); |
98 | 98 | } |
99 | 99 | |
100 | - /** |
|
101 | - * Retrieves all tokens detected in the statement string, in |
|
102 | - * the order they were found. |
|
103 | - * |
|
104 | - * @return Mailcode_Parser_Statement_Tokenizer_Token[] |
|
105 | - */ |
|
100 | + /** |
|
101 | + * Retrieves all tokens detected in the statement string, in |
|
102 | + * the order they were found. |
|
103 | + * |
|
104 | + * @return Mailcode_Parser_Statement_Tokenizer_Token[] |
|
105 | + */ |
|
106 | 106 | public function getTokens() |
107 | 107 | { |
108 | 108 | return $this->tokensOrdered; |
@@ -113,11 +113,11 @@ discard block |
||
113 | 113 | return !empty($this->tokensOrdered); |
114 | 114 | } |
115 | 115 | |
116 | - /** |
|
117 | - * Whether there were any unknown tokens in the statement. |
|
118 | - * |
|
119 | - * @return bool |
|
120 | - */ |
|
116 | + /** |
|
117 | + * Whether there were any unknown tokens in the statement. |
|
118 | + * |
|
119 | + * @return bool |
|
120 | + */ |
|
121 | 121 | public function hasUnknown() : bool |
122 | 122 | { |
123 | 123 | $unknown = $this->getUnknown(); |
@@ -125,11 +125,11 @@ discard block |
||
125 | 125 | return !empty($unknown); |
126 | 126 | } |
127 | 127 | |
128 | - /** |
|
129 | - * Retrieves all unknown content tokens, if any. |
|
130 | - * |
|
131 | - * @return \Mailcode\Mailcode_Parser_Statement_Tokenizer_Token_Unknown[] |
|
132 | - */ |
|
128 | + /** |
|
129 | + * Retrieves all unknown content tokens, if any. |
|
130 | + * |
|
131 | + * @return \Mailcode\Mailcode_Parser_Statement_Tokenizer_Token_Unknown[] |
|
132 | + */ |
|
133 | 133 | public function getUnknown() |
134 | 134 | { |
135 | 135 | $result = array(); |
@@ -199,13 +199,13 @@ discard block |
||
199 | 199 | } |
200 | 200 | } |
201 | 201 | |
202 | - /** |
|
203 | - * Registers a token to add in the statement string. |
|
204 | - * |
|
205 | - * @param string $type |
|
206 | - * @param string $matchedText |
|
207 | - * @param mixed $subject |
|
208 | - */ |
|
202 | + /** |
|
203 | + * Registers a token to add in the statement string. |
|
204 | + * |
|
205 | + * @param string $type |
|
206 | + * @param string $matchedText |
|
207 | + * @param mixed $subject |
|
208 | + */ |
|
209 | 209 | protected function registerToken(string $type, string $matchedText, $subject=null) : void |
210 | 210 | { |
211 | 211 | $tokenID = $this->generateID(); |
@@ -317,13 +317,13 @@ discard block |
||
317 | 317 | } |
318 | 318 | } |
319 | 319 | |
320 | - /** |
|
321 | - * Generates a unique alphabet-based ID without numbers |
|
322 | - * to use as token name, to avoid conflicts with the |
|
323 | - * numbers detection. |
|
324 | - * |
|
325 | - * @return string |
|
326 | - */ |
|
320 | + /** |
|
321 | + * Generates a unique alphabet-based ID without numbers |
|
322 | + * to use as token name, to avoid conflicts with the |
|
323 | + * numbers detection. |
|
324 | + * |
|
325 | + * @return string |
|
326 | + */ |
|
327 | 327 | protected function generateID() : string |
328 | 328 | { |
329 | 329 | static $alphas; |
@@ -29,24 +29,24 @@ discard block |
||
29 | 29 | |
30 | 30 | const VALIDATION_UNQUOTED_STRING_LITERALS = 48802; |
31 | 31 | |
32 | - /** |
|
33 | - * @var string |
|
34 | - */ |
|
32 | + /** |
|
33 | + * @var string |
|
34 | + */ |
|
35 | 35 | protected $statement; |
36 | 36 | |
37 | - /** |
|
38 | - * @var OperationResult |
|
39 | - */ |
|
37 | + /** |
|
38 | + * @var OperationResult |
|
39 | + */ |
|
40 | 40 | protected $result; |
41 | 41 | |
42 | - /** |
|
43 | - * @var Mailcode_Parser_Statement_Tokenizer|NULL |
|
44 | - */ |
|
42 | + /** |
|
43 | + * @var Mailcode_Parser_Statement_Tokenizer|NULL |
|
44 | + */ |
|
45 | 45 | protected $tokenizer; |
46 | 46 | |
47 | - /** |
|
48 | - * @var Mailcode_Parser_Statement_Info|NULL |
|
49 | - */ |
|
47 | + /** |
|
48 | + * @var Mailcode_Parser_Statement_Info|NULL |
|
49 | + */ |
|
50 | 50 | protected $info; |
51 | 51 | |
52 | 52 | public function __construct(string $statement) |
@@ -102,7 +102,7 @@ discard block |
||
102 | 102 | if($unknown) |
103 | 103 | { |
104 | 104 | $this->result->makeError( |
105 | - t('Unquoted string literal found:').' ('.$unknown->getMatchedText().')', |
|
105 | + t('Unquoted string literal found:').' ('.$unknown->getMatchedText().')', |
|
106 | 106 | self::VALIDATION_UNQUOTED_STRING_LITERALS |
107 | 107 | ); |
108 | 108 | } |
@@ -20,18 +20,18 @@ discard block |
||
20 | 20 | */ |
21 | 21 | class Mailcode_Factory_Exception extends Mailcode_Exception |
22 | 22 | { |
23 | - /** |
|
24 | - * @var Mailcode_Commands_Command|NULL |
|
25 | - */ |
|
23 | + /** |
|
24 | + * @var Mailcode_Commands_Command|NULL |
|
25 | + */ |
|
26 | 26 | protected $command; |
27 | 27 | |
28 | - /** |
|
29 | - * @param string $message |
|
30 | - * @param string|NULL $details |
|
31 | - * @param int|NULL $code |
|
32 | - * @param \Exception|NULL $previous |
|
33 | - * @param Mailcode_Commands_Command|NULL $command |
|
34 | - */ |
|
28 | + /** |
|
29 | + * @param string $message |
|
30 | + * @param string|NULL $details |
|
31 | + * @param int|NULL $code |
|
32 | + * @param \Exception|NULL $previous |
|
33 | + * @param Mailcode_Commands_Command|NULL $command |
|
34 | + */ |
|
35 | 35 | public function __construct(string $message, $details=null, $code=null, $previous=null, Mailcode_Commands_Command $command=null) |
36 | 36 | { |
37 | 37 | parent::__construct($message, $details, $code, $previous); |
@@ -39,11 +39,11 @@ discard block |
||
39 | 39 | $this->command = $command; |
40 | 40 | } |
41 | 41 | |
42 | - /** |
|
43 | - * Retrieves the erroneous command, if any. |
|
44 | - * |
|
45 | - * @return Mailcode_Commands_Command|NULL |
|
46 | - */ |
|
42 | + /** |
|
43 | + * Retrieves the erroneous command, if any. |
|
44 | + * |
|
45 | + * @return Mailcode_Commands_Command|NULL |
|
46 | + */ |
|
47 | 47 | public function getCommand() : ?Mailcode_Commands_Command |
48 | 48 | { |
49 | 49 | return $this->command; |
@@ -26,14 +26,14 @@ discard block |
||
26 | 26 | '{\s*([a-z]+)\s+([a-z]+)\s*:([^}]*)}' |
27 | 27 | ); |
28 | 28 | |
29 | - /** |
|
30 | - * @var Mailcode |
|
31 | - */ |
|
29 | + /** |
|
30 | + * @var Mailcode |
|
31 | + */ |
|
32 | 32 | protected $mailcode; |
33 | 33 | |
34 | - /** |
|
35 | - * @var Mailcode_Commands |
|
36 | - */ |
|
34 | + /** |
|
35 | + * @var Mailcode_Commands |
|
36 | + */ |
|
37 | 37 | protected $commands; |
38 | 38 | |
39 | 39 | public function __construct(Mailcode $mailcode) |
@@ -42,24 +42,24 @@ discard block |
||
42 | 42 | $this->commands = $this->mailcode->getCommands(); |
43 | 43 | } |
44 | 44 | |
45 | - /** |
|
46 | - * Gets the regex format string used to detect commands. |
|
47 | - * |
|
48 | - * @return string |
|
49 | - */ |
|
45 | + /** |
|
46 | + * Gets the regex format string used to detect commands. |
|
47 | + * |
|
48 | + * @return string |
|
49 | + */ |
|
50 | 50 | protected static function getRegex() : string |
51 | 51 | { |
52 | 52 | return '/'.implode('|', self::COMMAND_REGEX_PARTS).'/sixU'; |
53 | 53 | } |
54 | 54 | |
55 | - /** |
|
56 | - * Parses a string to detect all commands within. Returns a |
|
57 | - * collection instance that contains information on all the |
|
58 | - * commands. |
|
59 | - * |
|
60 | - * @param string $string |
|
61 | - * @return Mailcode_Collection A collection with all unique commands found. |
|
62 | - */ |
|
55 | + /** |
|
56 | + * Parses a string to detect all commands within. Returns a |
|
57 | + * collection instance that contains information on all the |
|
58 | + * commands. |
|
59 | + * |
|
60 | + * @param string $string |
|
61 | + * @return Mailcode_Collection A collection with all unique commands found. |
|
62 | + */ |
|
63 | 63 | public function parseString(string $string) : Mailcode_Collection |
64 | 64 | { |
65 | 65 | $collection = new Mailcode_Collection(); |
@@ -79,14 +79,14 @@ discard block |
||
79 | 79 | return $collection; |
80 | 80 | } |
81 | 81 | |
82 | - /** |
|
83 | - * Processes a single match found in the string: creates the command, |
|
84 | - * and adds it to the collection if it's a valid command, or to the list |
|
85 | - * of invalid commands otherwise. |
|
86 | - * |
|
87 | - * @param Mailcode_Parser_Match $match |
|
88 | - * @param Mailcode_Collection $collection |
|
89 | - */ |
|
82 | + /** |
|
83 | + * Processes a single match found in the string: creates the command, |
|
84 | + * and adds it to the collection if it's a valid command, or to the list |
|
85 | + * of invalid commands otherwise. |
|
86 | + * |
|
87 | + * @param Mailcode_Parser_Match $match |
|
88 | + * @param Mailcode_Collection $collection |
|
89 | + */ |
|
90 | 90 | protected function processMatch(Mailcode_Parser_Match $match, Mailcode_Collection $collection) : void |
91 | 91 | { |
92 | 92 | $name = $match->getName(); |
@@ -117,14 +117,14 @@ discard block |
||
117 | 117 | $collection->addInvalidCommand($cmd); |
118 | 118 | } |
119 | 119 | |
120 | - /** |
|
121 | - * Parses a single regex match: determines which named group |
|
122 | - * matches, and retrieves the according information. |
|
123 | - * |
|
124 | - * @param array[] $matches The regex results array. |
|
125 | - * @param int $index The matched index. |
|
126 | - * @return Mailcode_Parser_Match |
|
127 | - */ |
|
120 | + /** |
|
121 | + * Parses a single regex match: determines which named group |
|
122 | + * matches, and retrieves the according information. |
|
123 | + * |
|
124 | + * @param array[] $matches The regex results array. |
|
125 | + * @param int $index The matched index. |
|
126 | + * @return Mailcode_Parser_Match |
|
127 | + */ |
|
128 | 128 | protected function parseMatch(array $matches, int $index) : Mailcode_Parser_Match |
129 | 129 | { |
130 | 130 | $name = ''; // the command name, e.g. "showvar" |
@@ -162,26 +162,26 @@ discard block |
||
162 | 162 | ); |
163 | 163 | } |
164 | 164 | |
165 | - /** |
|
166 | - * Creates an instance of the safeguard tool, which |
|
167 | - * is used to safeguard commands in a string with placeholders. |
|
168 | - * |
|
169 | - * @param string $subject The string to use to safeguard commands in. |
|
170 | - * @return Mailcode_Parser_Safeguard |
|
171 | - * @see Mailcode_Parser_Safeguard |
|
172 | - */ |
|
165 | + /** |
|
166 | + * Creates an instance of the safeguard tool, which |
|
167 | + * is used to safeguard commands in a string with placeholders. |
|
168 | + * |
|
169 | + * @param string $subject The string to use to safeguard commands in. |
|
170 | + * @return Mailcode_Parser_Safeguard |
|
171 | + * @see Mailcode_Parser_Safeguard |
|
172 | + */ |
|
173 | 173 | public function createSafeguard(string $subject) : Mailcode_Parser_Safeguard |
174 | 174 | { |
175 | 175 | return new Mailcode_Parser_Safeguard($this, $subject); |
176 | 176 | } |
177 | 177 | |
178 | - /** |
|
179 | - * Creates a statement parser, which is used to validate arbitrary |
|
180 | - * command statements. |
|
181 | - * |
|
182 | - * @param string $statement |
|
183 | - * @return Mailcode_Parser_Statement |
|
184 | - */ |
|
178 | + /** |
|
179 | + * Creates a statement parser, which is used to validate arbitrary |
|
180 | + * command statements. |
|
181 | + * |
|
182 | + * @param string $statement |
|
183 | + * @return Mailcode_Parser_Statement |
|
184 | + */ |
|
185 | 185 | public function createStatement(string $statement) : Mailcode_Parser_Statement |
186 | 186 | { |
187 | 187 | return new Mailcode_Parser_Statement($statement); |