@@ -22,9 +22,9 @@ |
||
22 | 22 | { |
23 | 23 | public const REGEX_VARIABLE_NAME = '/\$\s*([A-Z0-9_]+)\s*\.\s*([A-Z0-9_]+)|\$\s*([A-Z0-9_]+)/six'; |
24 | 24 | |
25 | - /** |
|
26 | - * @var Mailcode_Variables_Collection_Regular |
|
27 | - */ |
|
25 | + /** |
|
26 | + * @var Mailcode_Variables_Collection_Regular |
|
27 | + */ |
|
28 | 28 | protected Mailcode_Variables_Collection_Regular $collection; |
29 | 29 | |
30 | 30 | /** |
@@ -23,24 +23,24 @@ |
||
23 | 23 | */ |
24 | 24 | class Mailcode_Parser_Match |
25 | 25 | { |
26 | - /** |
|
27 | - * @var string |
|
28 | - */ |
|
26 | + /** |
|
27 | + * @var string |
|
28 | + */ |
|
29 | 29 | protected string $name; |
30 | 30 | |
31 | - /** |
|
32 | - * @var string |
|
33 | - */ |
|
31 | + /** |
|
32 | + * @var string |
|
33 | + */ |
|
34 | 34 | protected string $type; |
35 | 35 | |
36 | - /** |
|
37 | - * @var string |
|
38 | - */ |
|
36 | + /** |
|
37 | + * @var string |
|
38 | + */ |
|
39 | 39 | protected string $params; |
40 | 40 | |
41 | - /** |
|
42 | - * @var string |
|
43 | - */ |
|
41 | + /** |
|
42 | + * @var string |
|
43 | + */ |
|
44 | 44 | protected string $matchedString; |
45 | 45 | |
46 | 46 | public function __construct(string $name, string $type, string $params, string $matchedString) |
@@ -24,9 +24,9 @@ discard block |
||
24 | 24 | protected string $matchedText; |
25 | 25 | private ?Mailcode_Commands_Command $sourceCommand; |
26 | 26 | |
27 | - /** |
|
28 | - * @var mixed |
|
29 | - */ |
|
27 | + /** |
|
28 | + * @var mixed |
|
29 | + */ |
|
30 | 30 | protected $subject; |
31 | 31 | |
32 | 32 | /** |
@@ -58,20 +58,20 @@ discard block |
||
58 | 58 | return $this->sourceCommand; |
59 | 59 | } |
60 | 60 | |
61 | - /** |
|
62 | - * The ID of the type. i.e. the class name ("Keyword", "StringLiteral"). |
|
63 | - * @return string |
|
64 | - */ |
|
61 | + /** |
|
62 | + * The ID of the type. i.e. the class name ("Keyword", "StringLiteral"). |
|
63 | + * @return string |
|
64 | + */ |
|
65 | 65 | public function getTypeID() : string |
66 | 66 | { |
67 | 67 | $parts = explode('_', get_class($this)); |
68 | 68 | return array_pop($parts); |
69 | 69 | } |
70 | 70 | |
71 | - /** |
|
72 | - * Retrieves a unique ID of the token. |
|
73 | - * @return string |
|
74 | - */ |
|
71 | + /** |
|
72 | + * Retrieves a unique ID of the token. |
|
73 | + * @return string |
|
74 | + */ |
|
75 | 75 | public function getID() : string |
76 | 76 | { |
77 | 77 | return $this->tokenID; |
@@ -62,23 +62,23 @@ |
||
62 | 62 | |
63 | 63 | public function getNestedMailcode() : Mailcode_Collection |
64 | 64 | { |
65 | - if(isset($this->nestedMailcode)) |
|
66 | - { |
|
67 | - return $this->nestedMailcode; |
|
68 | - } |
|
69 | - |
|
70 | - if($this->isMailcodeEnabled()) |
|
71 | - { |
|
72 | - $collection = Mailcode::create()->parseString($this->getContent()); |
|
73 | - } |
|
74 | - else |
|
75 | - { |
|
76 | - $collection = new Mailcode_Collection(); |
|
77 | - } |
|
78 | - |
|
79 | - $this->nestedMailcode = $collection; |
|
80 | - |
|
81 | - return $collection; |
|
65 | + if(isset($this->nestedMailcode)) |
|
66 | + { |
|
67 | + return $this->nestedMailcode; |
|
68 | + } |
|
69 | + |
|
70 | + if($this->isMailcodeEnabled()) |
|
71 | + { |
|
72 | + $collection = Mailcode::create()->parseString($this->getContent()); |
|
73 | + } |
|
74 | + else |
|
75 | + { |
|
76 | + $collection = new Mailcode_Collection(); |
|
77 | + } |
|
78 | + |
|
79 | + $this->nestedMailcode = $collection; |
|
80 | + |
|
81 | + return $collection; |
|
82 | 82 | } |
83 | 83 | |
84 | 84 | protected function validateSyntax_nested_mailcode() : void |
@@ -25,9 +25,9 @@ discard block |
||
25 | 25 | use Mailcode_Traits_Commands_Validation_Variable; |
26 | 26 | use Mailcode_Traits_Commands_Validation_CaseSensitive; |
27 | 27 | |
28 | - /** |
|
29 | - * @var Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral[] |
|
30 | - */ |
|
28 | + /** |
|
29 | + * @var Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral[] |
|
30 | + */ |
|
31 | 31 | protected array $searchTerms = array(); |
32 | 32 | |
33 | 33 | protected function getValidations() : array |
@@ -60,10 +60,10 @@ discard block |
||
60 | 60 | } |
61 | 61 | } |
62 | 62 | |
63 | - /** |
|
64 | - * Retrieves all search terms. |
|
65 | - * @return Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral[] |
|
66 | - */ |
|
63 | + /** |
|
64 | + * Retrieves all search terms. |
|
65 | + * @return Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral[] |
|
66 | + */ |
|
67 | 67 | public function getSearchTerms() : array |
68 | 68 | { |
69 | 69 | return $this->searchTerms; |
@@ -28,21 +28,21 @@ discard block |
||
28 | 28 | public const ERROR_INVALID_DUMMY_COMMAND_TYPE = 45903; |
29 | 29 | public const ERROR_INVALID_COMMAND_CLASS = 45904; |
30 | 30 | |
31 | - /** |
|
32 | - * @var Mailcode_Commands_Command[] |
|
33 | - */ |
|
31 | + /** |
|
32 | + * @var Mailcode_Commands_Command[] |
|
33 | + */ |
|
34 | 34 | private array $commands = array(); |
35 | 35 | |
36 | - /** |
|
37 | - * @var array<string,Mailcode_Commands_Command> |
|
38 | - */ |
|
36 | + /** |
|
37 | + * @var array<string,Mailcode_Commands_Command> |
|
38 | + */ |
|
39 | 39 | private static array $dummyCommands = array(); |
40 | 40 | |
41 | - /** |
|
42 | - * Retrieves a list of all available command IDs. |
|
43 | - * |
|
44 | - * @return string[] |
|
45 | - */ |
|
41 | + /** |
|
42 | + * Retrieves a list of all available command IDs. |
|
43 | + * |
|
44 | + * @return string[] |
|
45 | + */ |
|
46 | 46 | public function getIDs() : array |
47 | 47 | { |
48 | 48 | static $ids = array(); |
@@ -88,12 +88,12 @@ discard block |
||
88 | 88 | return $result; |
89 | 89 | } |
90 | 90 | |
91 | - /** |
|
92 | - * Gets an available command by its ID. |
|
93 | - * |
|
94 | - * @param string $id |
|
95 | - * @return Mailcode_Commands_Command |
|
96 | - */ |
|
91 | + /** |
|
92 | + * Gets an available command by its ID. |
|
93 | + * |
|
94 | + * @param string $id |
|
95 | + * @return Mailcode_Commands_Command |
|
96 | + */ |
|
97 | 97 | public function getByID(string $id) : Mailcode_Commands_Command |
98 | 98 | { |
99 | 99 | static $instances = array(); |
@@ -106,15 +106,15 @@ discard block |
||
106 | 106 | return $instances[$id]; |
107 | 107 | } |
108 | 108 | |
109 | - /** |
|
110 | - * Retrieves the ID of a command by its name. |
|
111 | - * |
|
112 | - * @param string $name |
|
113 | - * @throws Mailcode_Exception |
|
114 | - * @return string |
|
115 | - * |
|
116 | - * @see Mailcode_Commands::ERROR_COMMAND_NAME_DOES_NOT_EXIST |
|
117 | - */ |
|
109 | + /** |
|
110 | + * Retrieves the ID of a command by its name. |
|
111 | + * |
|
112 | + * @param string $name |
|
113 | + * @throws Mailcode_Exception |
|
114 | + * @return string |
|
115 | + * |
|
116 | + * @see Mailcode_Commands::ERROR_COMMAND_NAME_DOES_NOT_EXIST |
|
117 | + */ |
|
118 | 118 | public function getIDByName(string $name) : string |
119 | 119 | { |
120 | 120 | $items = $this->getAll(); |
@@ -225,14 +225,14 @@ discard block |
||
225 | 225 | return $class; |
226 | 226 | } |
227 | 227 | |
228 | - /** |
|
229 | - * Translates the command type to the expected class naming scheme. |
|
230 | - * |
|
231 | - * Example: not-empty => NotEmpty |
|
232 | - * |
|
233 | - * @param string $type |
|
234 | - * @return string |
|
235 | - */ |
|
228 | + /** |
|
229 | + * Translates the command type to the expected class naming scheme. |
|
230 | + * |
|
231 | + * Example: not-empty => NotEmpty |
|
232 | + * |
|
233 | + * @param string $type |
|
234 | + * @return string |
|
235 | + */ |
|
236 | 236 | private function adjustTypeName(string $type) : string |
237 | 237 | { |
238 | 238 | $type = str_replace('-', ' ', $type); |
@@ -30,10 +30,10 @@ discard block |
||
30 | 30 | public const VALIDATION_INVALID_DECIMAL_SEPARATOR = 72209; |
31 | 31 | public const VALIDATION_SEPARATORS_SAME_CHARACTER = 72210; |
32 | 32 | |
33 | - /** |
|
34 | - * The default number format string. |
|
35 | - * @var string |
|
36 | - */ |
|
33 | + /** |
|
34 | + * The default number format string. |
|
35 | + * @var string |
|
36 | + */ |
|
37 | 37 | private string $formatString = Mailcode_Number_Info::DEFAULT_FORMAT; |
38 | 38 | |
39 | 39 | /** |
@@ -62,18 +62,18 @@ discard block |
||
62 | 62 | |
63 | 63 | protected function validateSyntax_check_format() : void |
64 | 64 | { |
65 | - $tokens = $this->requireParams() |
|
66 | - ->getInfo() |
|
67 | - ->getStringLiterals(); |
|
65 | + $tokens = $this->requireParams() |
|
66 | + ->getInfo() |
|
67 | + ->getStringLiterals(); |
|
68 | 68 | |
69 | - // no format specified? Use the default one. |
|
70 | - if(empty($tokens)) |
|
71 | - { |
|
72 | - return; |
|
73 | - } |
|
74 | - |
|
75 | - $token = array_pop($tokens); |
|
76 | - $this->parseFormatString($token->getText()); |
|
69 | + // no format specified? Use the default one. |
|
70 | + if(empty($tokens)) |
|
71 | + { |
|
72 | + return; |
|
73 | + } |
|
74 | + |
|
75 | + $token = array_pop($tokens); |
|
76 | + $this->parseFormatString($token->getText()); |
|
77 | 77 | } |
78 | 78 | |
79 | 79 | protected function validateSyntax_absolute() : void |
@@ -108,11 +108,11 @@ discard block |
||
108 | 108 | ); |
109 | 109 | } |
110 | 110 | |
111 | - /** |
|
112 | - * Retrieves the format string used to format the number. |
|
113 | - * |
|
114 | - * @return string |
|
115 | - */ |
|
111 | + /** |
|
112 | + * Retrieves the format string used to format the number. |
|
113 | + * |
|
114 | + * @return string |
|
115 | + */ |
|
116 | 116 | public function getFormatString() : string |
117 | 117 | { |
118 | 118 | return $this->formatString; |
@@ -133,11 +133,11 @@ discard block |
||
133 | 133 | |
134 | 134 | if($absolute === true && !isset($this->absoluteKeyword)) |
135 | 135 | { |
136 | - $this->requireParams() |
|
137 | - ->getInfo() |
|
138 | - ->addKeyword(Mailcode_Commands_Keywords::TYPE_ABSOLUTE); |
|
136 | + $this->requireParams() |
|
137 | + ->getInfo() |
|
138 | + ->addKeyword(Mailcode_Commands_Keywords::TYPE_ABSOLUTE); |
|
139 | 139 | |
140 | - $this->validateSyntax_absolute(); |
|
140 | + $this->validateSyntax_absolute(); |
|
141 | 141 | } |
142 | 142 | |
143 | 143 | return $this; |
@@ -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 array $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,23 +98,23 @@ 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 | return dollarize($fullName); |
110 | 110 | } |
111 | 111 | |
112 | - /** |
|
113 | - * Retrieves all variables, grouped by their hash - meaning |
|
114 | - * unique matched strings. |
|
115 | - * |
|
116 | - * @return Mailcode_Variables_Variable[] |
|
117 | - */ |
|
112 | + /** |
|
113 | + * Retrieves all variables, grouped by their hash - meaning |
|
114 | + * unique matched strings. |
|
115 | + * |
|
116 | + * @return Mailcode_Variables_Variable[] |
|
117 | + */ |
|
118 | 118 | public function getGroupedByHash() : array |
119 | 119 | { |
120 | 120 | $entries = array(); |
@@ -127,11 +127,11 @@ discard block |
||
127 | 127 | return $this->sortVariables($entries); |
128 | 128 | } |
129 | 129 | |
130 | - /** |
|
131 | - * Retrieves all variables, grouped by their name. |
|
132 | - * |
|
133 | - * @return Mailcode_Variables_Variable[] |
|
134 | - */ |
|
130 | + /** |
|
131 | + * Retrieves all variables, grouped by their name. |
|
132 | + * |
|
133 | + * @return Mailcode_Variables_Variable[] |
|
134 | + */ |
|
135 | 135 | public function getGroupedByName() : array |
136 | 136 | { |
137 | 137 | $entries = array(); |
@@ -163,19 +163,19 @@ discard block |
||
163 | 163 | return $this->sortVariables($entries); |
164 | 164 | } |
165 | 165 | |
166 | - /** |
|
167 | - * Retrieves all variables, in the order they were addded. |
|
168 | - * @return Mailcode_Variables_Variable[] |
|
169 | - */ |
|
166 | + /** |
|
167 | + * Retrieves all variables, in the order they were addded. |
|
168 | + * @return Mailcode_Variables_Variable[] |
|
169 | + */ |
|
170 | 170 | public function getAll() |
171 | 171 | { |
172 | 172 | return $this->variables; |
173 | 173 | } |
174 | 174 | |
175 | - /** |
|
176 | - * Retrieves the full names of the variables that are present in the collection. |
|
177 | - * @return string[] |
|
178 | - */ |
|
175 | + /** |
|
176 | + * Retrieves the full names of the variables that are present in the collection. |
|
177 | + * @return string[] |
|
178 | + */ |
|
179 | 179 | public function getNames() : array |
180 | 180 | { |
181 | 181 | $result = array(); |
@@ -193,13 +193,13 @@ discard block |
||
193 | 193 | return $result; |
194 | 194 | } |
195 | 195 | |
196 | - /** |
|
197 | - * Takes a list of variables and sorts them, throwing away |
|
198 | - * the source array's keys. |
|
199 | - * |
|
200 | - * @param Mailcode_Variables_Variable[] $entries |
|
201 | - * @return Mailcode_Variables_Variable[] |
|
202 | - */ |
|
196 | + /** |
|
197 | + * Takes a list of variables and sorts them, throwing away |
|
198 | + * the source array's keys. |
|
199 | + * |
|
200 | + * @param Mailcode_Variables_Variable[] $entries |
|
201 | + * @return Mailcode_Variables_Variable[] |
|
202 | + */ |
|
203 | 203 | protected function sortVariables(array $entries) |
204 | 204 | { |
205 | 205 | $result = array_values($entries); |
@@ -212,13 +212,13 @@ discard block |
||
212 | 212 | return $result; |
213 | 213 | } |
214 | 214 | |
215 | - /** |
|
216 | - * Merges the variables collection with the target collection |
|
217 | - * by inheriting all that collection's variables. |
|
218 | - * |
|
219 | - * @param Mailcode_Variables_Collection $collection |
|
220 | - * @return Mailcode_Variables_Collection |
|
221 | - */ |
|
215 | + /** |
|
216 | + * Merges the variables collection with the target collection |
|
217 | + * by inheriting all that collection's variables. |
|
218 | + * |
|
219 | + * @param Mailcode_Variables_Collection $collection |
|
220 | + * @return Mailcode_Variables_Collection |
|
221 | + */ |
|
222 | 222 | public function mergeWith(Mailcode_Variables_Collection $collection) : Mailcode_Variables_Collection |
223 | 223 | { |
224 | 224 | $variables = $collection->getGroupedByHash(); |
@@ -225,27 +225,27 @@ |
||
225 | 225 | * @return array<string,string> |
226 | 226 | * @throws Mailcode_Exception |
227 | 227 | */ |
228 | - private function parseVarName() : array |
|
229 | - { |
|
230 | - $tokens = explode('.', undollarize($this->variable->getFullName())); |
|
231 | - |
|
232 | - if(count($tokens) === 2) |
|
233 | - { |
|
234 | - return array( |
|
235 | - 'path' => $tokens[0], |
|
236 | - 'name' => $tokens[1] |
|
237 | - ); |
|
238 | - } |
|
239 | - |
|
240 | - throw new Mailcode_Exception( |
|
241 | - 'Invalid variable name for a list property.', |
|
242 | - sprintf( |
|
243 | - 'Exactly 2 parts are required, variable [%s] has [%s].', |
|
244 | - $this->variable->getFullName(), |
|
245 | - count($tokens) |
|
246 | - ), |
|
247 | - self::ERROR_INVALID_LIST_VARIABLE_NAME |
|
248 | - ); |
|
249 | - } |
|
228 | + private function parseVarName() : array |
|
229 | + { |
|
230 | + $tokens = explode('.', undollarize($this->variable->getFullName())); |
|
231 | + |
|
232 | + if(count($tokens) === 2) |
|
233 | + { |
|
234 | + return array( |
|
235 | + 'path' => $tokens[0], |
|
236 | + 'name' => $tokens[1] |
|
237 | + ); |
|
238 | + } |
|
239 | + |
|
240 | + throw new Mailcode_Exception( |
|
241 | + 'Invalid variable name for a list property.', |
|
242 | + sprintf( |
|
243 | + 'Exactly 2 parts are required, variable [%s] has [%s].', |
|
244 | + $this->variable->getFullName(), |
|
245 | + count($tokens) |
|
246 | + ), |
|
247 | + self::ERROR_INVALID_LIST_VARIABLE_NAME |
|
248 | + ); |
|
249 | + } |
|
250 | 250 | } |
251 | 251 |