@@ -12,7 +12,7 @@ |
||
12 | 12 | $autoload = realpath($root.'/../vendor/autoload.php'); |
13 | 13 | |
14 | 14 | // we need the autoloader to be present |
15 | - if($autoload === false) |
|
15 | + if ($autoload === false) |
|
16 | 16 | { |
17 | 17 | die('<b>ERROR:</b> Autoloader not present. Run composer update first.'); |
18 | 18 | } |
@@ -23,16 +23,16 @@ discard block |
||
23 | 23 | { |
24 | 24 | const ERROR_COMMAND_NAME_DOES_NOT_EXIST = 45901; |
25 | 25 | |
26 | - /** |
|
27 | - * @var Mailcode_Commands_Command[] |
|
28 | - */ |
|
26 | + /** |
|
27 | + * @var Mailcode_Commands_Command[] |
|
28 | + */ |
|
29 | 29 | private $commands = array(); |
30 | 30 | |
31 | - /** |
|
32 | - * Retrieves a list of all available command IDs. |
|
33 | - * |
|
34 | - * @return string[] |
|
35 | - */ |
|
31 | + /** |
|
32 | + * Retrieves a list of all available command IDs. |
|
33 | + * |
|
34 | + * @return string[] |
|
35 | + */ |
|
36 | 36 | public function getIDs() : array |
37 | 37 | { |
38 | 38 | static $ids = array(); |
@@ -45,13 +45,13 @@ discard block |
||
45 | 45 | return $ids; |
46 | 46 | } |
47 | 47 | |
48 | - /** |
|
49 | - * Retrieves a list of all available commands, sorted by label. |
|
50 | - * |
|
51 | - * NOTE: These instances are only used for information purposes. |
|
52 | - * |
|
53 | - * @return Mailcode_Commands_Command[] |
|
54 | - */ |
|
48 | + /** |
|
49 | + * Retrieves a list of all available commands, sorted by label. |
|
50 | + * |
|
51 | + * NOTE: These instances are only used for information purposes. |
|
52 | + * |
|
53 | + * @return Mailcode_Commands_Command[] |
|
54 | + */ |
|
55 | 55 | public function getAll() |
56 | 56 | { |
57 | 57 | if(!empty($this->commands)) { |
@@ -77,12 +77,12 @@ discard block |
||
77 | 77 | return $result; |
78 | 78 | } |
79 | 79 | |
80 | - /** |
|
81 | - * Gets an available command by its ID. |
|
82 | - * |
|
83 | - * @param string $id |
|
84 | - * @return Mailcode_Commands_Command |
|
85 | - */ |
|
80 | + /** |
|
81 | + * Gets an available command by its ID. |
|
82 | + * |
|
83 | + * @param string $id |
|
84 | + * @return Mailcode_Commands_Command |
|
85 | + */ |
|
86 | 86 | public function getByID(string $id) : Mailcode_Commands_Command |
87 | 87 | { |
88 | 88 | static $instances = array(); |
@@ -95,15 +95,15 @@ discard block |
||
95 | 95 | return $instances[$id]; |
96 | 96 | } |
97 | 97 | |
98 | - /** |
|
99 | - * Retrieves the ID of a command by its name. |
|
100 | - * |
|
101 | - * @param string $name |
|
102 | - * @throws Mailcode_Exception |
|
103 | - * @return string |
|
104 | - * |
|
105 | - * @see Mailcode_Commands::ERROR_COMMAND_NAME_DOES_NOT_EXIST |
|
106 | - */ |
|
98 | + /** |
|
99 | + * Retrieves the ID of a command by its name. |
|
100 | + * |
|
101 | + * @param string $name |
|
102 | + * @throws Mailcode_Exception |
|
103 | + * @return string |
|
104 | + * |
|
105 | + * @see Mailcode_Commands::ERROR_COMMAND_NAME_DOES_NOT_EXIST |
|
106 | + */ |
|
107 | 107 | public function getIDByName(string $name) : string |
108 | 108 | { |
109 | 109 | $items = $this->getAll(); |
@@ -132,12 +132,12 @@ discard block |
||
132 | 132 | return in_array($id, $ids); |
133 | 133 | } |
134 | 134 | |
135 | - /** |
|
136 | - * Checks wether the specified name exists. |
|
137 | - * |
|
138 | - * @param string $name For example: "showvar". |
|
139 | - * @return bool |
|
140 | - */ |
|
135 | + /** |
|
136 | + * Checks wether the specified name exists. |
|
137 | + * |
|
138 | + * @param string $name For example: "showvar". |
|
139 | + * @return bool |
|
140 | + */ |
|
141 | 141 | public function nameExists(string $name) : bool |
142 | 142 | { |
143 | 143 | $items = $this->getAll(); |
@@ -37,7 +37,7 @@ discard block |
||
37 | 37 | { |
38 | 38 | static $ids = array(); |
39 | 39 | |
40 | - if(empty($ids)) { |
|
40 | + if (empty($ids)) { |
|
41 | 41 | $ids = \AppUtils\FileHelper::createFileFinder(__DIR__.'/Commands/Command') |
42 | 42 | ->getPHPClassNames(); |
43 | 43 | } |
@@ -54,7 +54,7 @@ discard block |
||
54 | 54 | */ |
55 | 55 | public function getAll() |
56 | 56 | { |
57 | - if(!empty($this->commands)) { |
|
57 | + if (!empty($this->commands)) { |
|
58 | 58 | return $this->commands; |
59 | 59 | } |
60 | 60 | |
@@ -62,7 +62,7 @@ discard block |
||
62 | 62 | |
63 | 63 | $result = array(); |
64 | 64 | |
65 | - foreach($ids as $id) |
|
65 | + foreach ($ids as $id) |
|
66 | 66 | { |
67 | 67 | $result[] = $this->getByID($id); |
68 | 68 | } |
@@ -87,7 +87,7 @@ discard block |
||
87 | 87 | { |
88 | 88 | static $instances = array(); |
89 | 89 | |
90 | - if(!isset($instances[$id])) |
|
90 | + if (!isset($instances[$id])) |
|
91 | 91 | { |
92 | 92 | $instances[$id] = $this->createCommand($id, '__dummy', '', ''); |
93 | 93 | } |
@@ -108,9 +108,9 @@ discard block |
||
108 | 108 | { |
109 | 109 | $items = $this->getAll(); |
110 | 110 | |
111 | - foreach($items as $item) |
|
111 | + foreach ($items as $item) |
|
112 | 112 | { |
113 | - if($item->getName() === $name) { |
|
113 | + if ($item->getName() === $name) { |
|
114 | 114 | return $item->getID(); |
115 | 115 | } |
116 | 116 | } |
@@ -142,9 +142,9 @@ discard block |
||
142 | 142 | { |
143 | 143 | $items = $this->getAll(); |
144 | 144 | |
145 | - foreach($items as $item) |
|
145 | + foreach ($items as $item) |
|
146 | 146 | { |
147 | - if($item->getName() === $name) { |
|
147 | + if ($item->getName() === $name) { |
|
148 | 148 | return true; |
149 | 149 | } |
150 | 150 | } |
@@ -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) |
@@ -64,7 +64,7 @@ discard block |
||
64 | 64 | |
65 | 65 | public function getReplacementText() : string |
66 | 66 | { |
67 | - if(!empty($this->replacement)) |
|
67 | + if (!empty($this->replacement)) |
|
68 | 68 | { |
69 | 69 | return $this->replacement; |
70 | 70 | } |
@@ -82,13 +82,13 @@ discard block |
||
82 | 82 | // to total amount of zeroes to pad with to obtain the total length |
83 | 83 | $padLength = $this->getLength() - $length; |
84 | 84 | |
85 | - if($padLength < 0) |
|
85 | + if ($padLength < 0) |
|
86 | 86 | { |
87 | 87 | $padLength = 0; |
88 | 88 | } |
89 | 89 | |
90 | 90 | // create the zero-padded ID to fill the format string with |
91 | - $paddedID = str_pad((string)$this->id, $padLength, '0'); |
|
91 | + $paddedID = str_pad((string)$this->id, $padLength, '0'); |
|
92 | 92 | |
93 | 93 | $this->replacement = sprintf($format, $paddedID); |
94 | 94 |
@@ -141,13 +141,11 @@ |
||
141 | 141 | if(!empty($matches[1][$index])) |
142 | 142 | { |
143 | 143 | $name = $matches[1][$index]; |
144 | - } |
|
145 | - else if(!empty($matches[2][$index])) |
|
144 | + } else if(!empty($matches[2][$index])) |
|
146 | 145 | { |
147 | 146 | $name = $matches[2][$index]; |
148 | 147 | $params = $matches[3][$index]; |
149 | - } |
|
150 | - else if(!empty($matches[4][$index])) |
|
148 | + } else if(!empty($matches[4][$index])) |
|
151 | 149 | { |
152 | 150 | $name = $matches[4][$index]; |
153 | 151 | $type = $matches[5][$index]; |
@@ -28,14 +28,14 @@ discard block |
||
28 | 28 | '{\s*([a-z]+)\s+([a-z]+)\s*:([^}]*)}' |
29 | 29 | ); |
30 | 30 | |
31 | - /** |
|
32 | - * @var Mailcode |
|
33 | - */ |
|
31 | + /** |
|
32 | + * @var Mailcode |
|
33 | + */ |
|
34 | 34 | protected $mailcode; |
35 | 35 | |
36 | - /** |
|
37 | - * @var Mailcode_Commands |
|
38 | - */ |
|
36 | + /** |
|
37 | + * @var Mailcode_Commands |
|
38 | + */ |
|
39 | 39 | protected $commands; |
40 | 40 | |
41 | 41 | public function __construct(Mailcode $mailcode) |
@@ -44,24 +44,24 @@ discard block |
||
44 | 44 | $this->commands = $this->mailcode->getCommands(); |
45 | 45 | } |
46 | 46 | |
47 | - /** |
|
48 | - * Gets the regex format string used to detect commands. |
|
49 | - * |
|
50 | - * @return string |
|
51 | - */ |
|
47 | + /** |
|
48 | + * Gets the regex format string used to detect commands. |
|
49 | + * |
|
50 | + * @return string |
|
51 | + */ |
|
52 | 52 | protected static function getRegex() : string |
53 | 53 | { |
54 | 54 | return '/'.implode('|', self::COMMAND_REGEX_PARTS).'/sixU'; |
55 | 55 | } |
56 | 56 | |
57 | - /** |
|
58 | - * Parses a string to detect all commands within. Returns a |
|
59 | - * collection instance that contains information on all the |
|
60 | - * commands. |
|
61 | - * |
|
62 | - * @param string $string |
|
63 | - * @return Mailcode_Collection A collection with all unique commands found. |
|
64 | - */ |
|
57 | + /** |
|
58 | + * Parses a string to detect all commands within. Returns a |
|
59 | + * collection instance that contains information on all the |
|
60 | + * commands. |
|
61 | + * |
|
62 | + * @param string $string |
|
63 | + * @return Mailcode_Collection A collection with all unique commands found. |
|
64 | + */ |
|
65 | 65 | public function parseString(string $string) : Mailcode_Collection |
66 | 66 | { |
67 | 67 | $collection = new Mailcode_Collection(); |
@@ -94,14 +94,14 @@ discard block |
||
94 | 94 | return preg_replace('%<style\b[^>]*>(.*?)</style>%six', '', $subject); |
95 | 95 | } |
96 | 96 | |
97 | - /** |
|
98 | - * Processes a single match found in the string: creates the command, |
|
99 | - * and adds it to the collection if it's a valid command, or to the list |
|
100 | - * of invalid commands otherwise. |
|
101 | - * |
|
102 | - * @param Mailcode_Parser_Match $match |
|
103 | - * @param Mailcode_Collection $collection |
|
104 | - */ |
|
97 | + /** |
|
98 | + * Processes a single match found in the string: creates the command, |
|
99 | + * and adds it to the collection if it's a valid command, or to the list |
|
100 | + * of invalid commands otherwise. |
|
101 | + * |
|
102 | + * @param Mailcode_Parser_Match $match |
|
103 | + * @param Mailcode_Collection $collection |
|
104 | + */ |
|
105 | 105 | protected function processMatch(Mailcode_Parser_Match $match, Mailcode_Collection $collection) : void |
106 | 106 | { |
107 | 107 | $name = $match->getName(); |
@@ -132,14 +132,14 @@ discard block |
||
132 | 132 | $collection->addInvalidCommand($cmd); |
133 | 133 | } |
134 | 134 | |
135 | - /** |
|
136 | - * Parses a single regex match: determines which named group |
|
137 | - * matches, and retrieves the according information. |
|
138 | - * |
|
139 | - * @param array[] $matches The regex results array. |
|
140 | - * @param int $index The matched index. |
|
141 | - * @return Mailcode_Parser_Match |
|
142 | - */ |
|
135 | + /** |
|
136 | + * Parses a single regex match: determines which named group |
|
137 | + * matches, and retrieves the according information. |
|
138 | + * |
|
139 | + * @param array[] $matches The regex results array. |
|
140 | + * @param int $index The matched index. |
|
141 | + * @return Mailcode_Parser_Match |
|
142 | + */ |
|
143 | 143 | protected function parseMatch(array $matches, int $index) : Mailcode_Parser_Match |
144 | 144 | { |
145 | 145 | $name = ''; // the command name, e.g. "showvar" |
@@ -177,26 +177,26 @@ discard block |
||
177 | 177 | ); |
178 | 178 | } |
179 | 179 | |
180 | - /** |
|
181 | - * Creates an instance of the safeguard tool, which |
|
182 | - * is used to safeguard commands in a string with placeholders. |
|
183 | - * |
|
184 | - * @param string $subject The string to use to safeguard commands in. |
|
185 | - * @return Mailcode_Parser_Safeguard |
|
186 | - * @see Mailcode_Parser_Safeguard |
|
187 | - */ |
|
180 | + /** |
|
181 | + * Creates an instance of the safeguard tool, which |
|
182 | + * is used to safeguard commands in a string with placeholders. |
|
183 | + * |
|
184 | + * @param string $subject The string to use to safeguard commands in. |
|
185 | + * @return Mailcode_Parser_Safeguard |
|
186 | + * @see Mailcode_Parser_Safeguard |
|
187 | + */ |
|
188 | 188 | public function createSafeguard(string $subject) : Mailcode_Parser_Safeguard |
189 | 189 | { |
190 | 190 | return new Mailcode_Parser_Safeguard($this, $subject); |
191 | 191 | } |
192 | 192 | |
193 | - /** |
|
194 | - * Creates a statement parser, which is used to validate arbitrary |
|
195 | - * command statements. |
|
196 | - * |
|
197 | - * @param string $statement |
|
198 | - * @return Mailcode_Parser_Statement |
|
199 | - */ |
|
193 | + /** |
|
194 | + * Creates a statement parser, which is used to validate arbitrary |
|
195 | + * command statements. |
|
196 | + * |
|
197 | + * @param string $statement |
|
198 | + * @return Mailcode_Parser_Statement |
|
199 | + */ |
|
200 | 200 | public function createStatement(string $statement) : Mailcode_Parser_Statement |
201 | 201 | { |
202 | 202 | return new Mailcode_Parser_Statement($statement); |
@@ -73,7 +73,7 @@ discard block |
||
73 | 73 | |
74 | 74 | $total = count($matches[0]); |
75 | 75 | |
76 | - for($i=0; $i < $total; $i++) |
|
76 | + for ($i = 0; $i < $total; $i++) |
|
77 | 77 | { |
78 | 78 | $match = $this->parseMatch($matches, $i); |
79 | 79 | |
@@ -85,7 +85,7 @@ discard block |
||
85 | 85 | |
86 | 86 | protected function prepareString(string $subject) : string |
87 | 87 | { |
88 | - if(!ConvertHelper::isStringHTML($subject)) |
|
88 | + if (!ConvertHelper::isStringHTML($subject)) |
|
89 | 89 | { |
90 | 90 | return $subject; |
91 | 91 | } |
@@ -106,7 +106,7 @@ discard block |
||
106 | 106 | { |
107 | 107 | $name = $match->getName(); |
108 | 108 | |
109 | - if(!$this->commands->nameExists($name)) |
|
109 | + if (!$this->commands->nameExists($name)) |
|
110 | 110 | { |
111 | 111 | $collection->addErrorMessage( |
112 | 112 | $match->getMatchedString(), |
@@ -123,7 +123,7 @@ discard block |
||
123 | 123 | $match->getMatchedString() |
124 | 124 | ); |
125 | 125 | |
126 | - if($cmd->isValid()) |
|
126 | + if ($cmd->isValid()) |
|
127 | 127 | { |
128 | 128 | $collection->addCommand($cmd); |
129 | 129 | return; |
@@ -153,16 +153,16 @@ discard block |
||
153 | 153 | // 5 = parameter type command, type |
154 | 154 | // 6 = parameter type command, params |
155 | 155 | |
156 | - if(!empty($matches[1][$index])) |
|
156 | + if (!empty($matches[1][$index])) |
|
157 | 157 | { |
158 | 158 | $name = $matches[1][$index]; |
159 | 159 | } |
160 | - else if(!empty($matches[2][$index])) |
|
160 | + else if (!empty($matches[2][$index])) |
|
161 | 161 | { |
162 | 162 | $name = $matches[2][$index]; |
163 | 163 | $params = $matches[3][$index]; |
164 | 164 | } |
165 | - else if(!empty($matches[4][$index])) |
|
165 | + else if (!empty($matches[4][$index])) |
|
166 | 166 | { |
167 | 167 | $name = $matches[4][$index]; |
168 | 168 | $type = $matches[5][$index]; |
@@ -158,8 +158,7 @@ |
||
158 | 158 | if($highlighted) |
159 | 159 | { |
160 | 160 | $replace = $placeholder->getHighlightedText(); |
161 | - } |
|
162 | - else |
|
161 | + } else |
|
163 | 162 | { |
164 | 163 | $replace = $placeholder->getOriginalText(); |
165 | 164 | } |
@@ -115,7 +115,7 @@ discard block |
||
115 | 115 | */ |
116 | 116 | public function setDelimiter(string $delimiter) : Mailcode_Parser_Safeguard |
117 | 117 | { |
118 | - if(empty($delimiter)) |
|
118 | + if (empty($delimiter)) |
|
119 | 119 | { |
120 | 120 | throw new Mailcode_Exception( |
121 | 121 | 'Empty delimiter', |
@@ -156,17 +156,17 @@ discard block |
||
156 | 156 | * @param bool $highlighted |
157 | 157 | * @return string[]string |
158 | 158 | */ |
159 | - protected function getReplaces(bool $highlighted=false) : array |
|
159 | + protected function getReplaces(bool $highlighted = false) : array |
|
160 | 160 | { |
161 | 161 | $placeholders = $this->getPlaceholders(); |
162 | 162 | |
163 | 163 | $replaces = array(); |
164 | 164 | |
165 | - foreach($placeholders as $placeholder) |
|
165 | + foreach ($placeholders as $placeholder) |
|
166 | 166 | { |
167 | 167 | $replace = ''; |
168 | 168 | |
169 | - if($highlighted) |
|
169 | + if ($highlighted) |
|
170 | 170 | { |
171 | 171 | $replace = $placeholder->getHighlightedText(); |
172 | 172 | } |
@@ -190,7 +190,7 @@ discard block |
||
190 | 190 | */ |
191 | 191 | public function getPlaceholders() |
192 | 192 | { |
193 | - if(isset($this->placeholders)) |
|
193 | + if (isset($this->placeholders)) |
|
194 | 194 | { |
195 | 195 | return $this->placeholders; |
196 | 196 | } |
@@ -199,7 +199,7 @@ discard block |
||
199 | 199 | |
200 | 200 | $cmds = $this->getCollection()->getGroupedByHash(); |
201 | 201 | |
202 | - foreach($cmds as $command) |
|
202 | + foreach ($cmds as $command) |
|
203 | 203 | { |
204 | 204 | self::$counter++; |
205 | 205 | |
@@ -213,7 +213,7 @@ discard block |
||
213 | 213 | return $this->placeholders; |
214 | 214 | } |
215 | 215 | |
216 | - protected function restore(string $string, bool $highlighted=false) : string |
|
216 | + protected function restore(string $string, bool $highlighted = false) : string |
|
217 | 217 | { |
218 | 218 | $this->requireValidCollection(); |
219 | 219 | |
@@ -221,9 +221,9 @@ discard block |
||
221 | 221 | |
222 | 222 | $placeholderStrings = array_keys($replaces); |
223 | 223 | |
224 | - foreach($placeholderStrings as $search) |
|
224 | + foreach ($placeholderStrings as $search) |
|
225 | 225 | { |
226 | - if(!strstr($string, $search)) |
|
226 | + if (!strstr($string, $search)) |
|
227 | 227 | { |
228 | 228 | throw new Mailcode_Exception( |
229 | 229 | 'Command placeholder not found', |
@@ -281,7 +281,7 @@ discard block |
||
281 | 281 | */ |
282 | 282 | public function getCollection() : Mailcode_Collection |
283 | 283 | { |
284 | - if(isset($this->collection)) |
|
284 | + if (isset($this->collection)) |
|
285 | 285 | { |
286 | 286 | return $this->collection; |
287 | 287 | } |
@@ -303,7 +303,7 @@ discard block |
||
303 | 303 | */ |
304 | 304 | protected function requireValidCollection() : void |
305 | 305 | { |
306 | - if($this->getCollection()->isValid()) |
|
306 | + if ($this->getCollection()->isValid()) |
|
307 | 307 | { |
308 | 308 | return; |
309 | 309 | } |
@@ -325,7 +325,7 @@ discard block |
||
325 | 325 | */ |
326 | 326 | public function getPlaceholderStrings() : array |
327 | 327 | { |
328 | - if(isset($this->placeholderStrings)) |
|
328 | + if (isset($this->placeholderStrings)) |
|
329 | 329 | { |
330 | 330 | return $this->placeholderStrings; |
331 | 331 | } |
@@ -334,7 +334,7 @@ discard block |
||
334 | 334 | |
335 | 335 | $this->placeholderStrings = array(); |
336 | 336 | |
337 | - foreach($placeholders as $placeholder) |
|
337 | + foreach ($placeholders as $placeholder) |
|
338 | 338 | { |
339 | 339 | $this->placeholderStrings[] = $placeholder->getReplacementText(); |
340 | 340 | } |
@@ -360,9 +360,9 @@ discard block |
||
360 | 360 | { |
361 | 361 | $placeholders = $this->getPlaceholders(); |
362 | 362 | |
363 | - foreach($placeholders as $placeholder) |
|
363 | + foreach ($placeholders as $placeholder) |
|
364 | 364 | { |
365 | - if($placeholder->getID() === $id) |
|
365 | + if ($placeholder->getID() === $id) |
|
366 | 366 | { |
367 | 367 | return $placeholder; |
368 | 368 | } |
@@ -389,9 +389,9 @@ discard block |
||
389 | 389 | { |
390 | 390 | $placeholders = $this->getPlaceholders(); |
391 | 391 | |
392 | - foreach($placeholders as $placeholder) |
|
392 | + foreach ($placeholders as $placeholder) |
|
393 | 393 | { |
394 | - if($placeholder->getReplacementText() === $string) |
|
394 | + if ($placeholder->getReplacementText() === $string) |
|
395 | 395 | { |
396 | 396 | return $placeholder; |
397 | 397 | } |
@@ -57,45 +57,45 @@ discard block |
||
57 | 57 | |
58 | 58 | const ERROR_PLACEHOLDER_NOT_FOUND = 47804; |
59 | 59 | |
60 | - /** |
|
61 | - * @var Mailcode_Parser |
|
62 | - */ |
|
60 | + /** |
|
61 | + * @var Mailcode_Parser |
|
62 | + */ |
|
63 | 63 | protected $parser; |
64 | 64 | |
65 | - /** |
|
66 | - * @var Mailcode_Collection |
|
67 | - */ |
|
65 | + /** |
|
66 | + * @var Mailcode_Collection |
|
67 | + */ |
|
68 | 68 | protected $commands; |
69 | 69 | |
70 | - /** |
|
71 | - * @var string |
|
72 | - */ |
|
70 | + /** |
|
71 | + * @var string |
|
72 | + */ |
|
73 | 73 | protected $originalString; |
74 | 74 | |
75 | - /** |
|
76 | - * @var Mailcode_Collection |
|
77 | - */ |
|
75 | + /** |
|
76 | + * @var Mailcode_Collection |
|
77 | + */ |
|
78 | 78 | protected $collection; |
79 | 79 | |
80 | - /** |
|
81 | - * Counter for the placeholders, global for all placeholders. |
|
82 | - * @var integer |
|
83 | - */ |
|
80 | + /** |
|
81 | + * Counter for the placeholders, global for all placeholders. |
|
82 | + * @var integer |
|
83 | + */ |
|
84 | 84 | private static $counter = 0; |
85 | 85 | |
86 | - /** |
|
87 | - * @var Mailcode_Parser_Safeguard_Placeholder[] |
|
88 | - */ |
|
86 | + /** |
|
87 | + * @var Mailcode_Parser_Safeguard_Placeholder[] |
|
88 | + */ |
|
89 | 89 | protected $placeholders; |
90 | 90 | |
91 | - /** |
|
92 | - * @var string |
|
93 | - */ |
|
91 | + /** |
|
92 | + * @var string |
|
93 | + */ |
|
94 | 94 | protected $delimiter = '__'; |
95 | 95 | |
96 | - /** |
|
97 | - * @var string[]|NULL |
|
98 | - */ |
|
96 | + /** |
|
97 | + * @var string[]|NULL |
|
98 | + */ |
|
99 | 99 | protected $placeholderStrings; |
100 | 100 | |
101 | 101 | public function __construct(Mailcode_Parser $parser, string $subject) |
@@ -104,25 +104,25 @@ discard block |
||
104 | 104 | $this->originalString = $subject; |
105 | 105 | } |
106 | 106 | |
107 | - /** |
|
108 | - * Retrieves the string the safeguard was created for. |
|
109 | - * |
|
110 | - * @return string |
|
111 | - */ |
|
107 | + /** |
|
108 | + * Retrieves the string the safeguard was created for. |
|
109 | + * |
|
110 | + * @return string |
|
111 | + */ |
|
112 | 112 | public function getOriginalString() : string |
113 | 113 | { |
114 | 114 | return $this->originalString; |
115 | 115 | } |
116 | 116 | |
117 | - /** |
|
118 | - * Sets the delimiter character sequence used to prepend |
|
119 | - * and append to the placeholders. |
|
120 | - * |
|
121 | - * The delimiter's default is "__" (two underscores). |
|
122 | - * |
|
123 | - * @param string $delimiter |
|
124 | - * @return Mailcode_Parser_Safeguard |
|
125 | - */ |
|
117 | + /** |
|
118 | + * Sets the delimiter character sequence used to prepend |
|
119 | + * and append to the placeholders. |
|
120 | + * |
|
121 | + * The delimiter's default is "__" (two underscores). |
|
122 | + * |
|
123 | + * @param string $delimiter |
|
124 | + * @return Mailcode_Parser_Safeguard |
|
125 | + */ |
|
126 | 126 | public function setDelimiter(string $delimiter) : Mailcode_Parser_Safeguard |
127 | 127 | { |
128 | 128 | if(empty($delimiter)) |
@@ -144,15 +144,15 @@ discard block |
||
144 | 144 | return $this->delimiter; |
145 | 145 | } |
146 | 146 | |
147 | - /** |
|
148 | - * Retrieves the safe string in which all commands have been replaced |
|
149 | - * by placeholder strings. |
|
150 | - * |
|
151 | - * @return string |
|
152 | - * @throws Mailcode_Exception |
|
153 | - * |
|
154 | - * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
155 | - */ |
|
147 | + /** |
|
148 | + * Retrieves the safe string in which all commands have been replaced |
|
149 | + * by placeholder strings. |
|
150 | + * |
|
151 | + * @return string |
|
152 | + * @throws Mailcode_Exception |
|
153 | + * |
|
154 | + * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
155 | + */ |
|
156 | 156 | public function makeSafe() : string |
157 | 157 | { |
158 | 158 | $this->requireValidCollection(); |
@@ -162,10 +162,10 @@ discard block |
||
162 | 162 | return str_replace(array_values($replaces), array_keys($replaces), $this->originalString); |
163 | 163 | } |
164 | 164 | |
165 | - /** |
|
166 | - * @param bool $highlighted |
|
167 | - * @return string[]string |
|
168 | - */ |
|
165 | + /** |
|
166 | + * @param bool $highlighted |
|
167 | + * @return string[]string |
|
168 | + */ |
|
169 | 169 | protected function getReplaces(bool $highlighted=false) : array |
170 | 170 | { |
171 | 171 | $placeholders = $this->getPlaceholders(); |
@@ -192,12 +192,12 @@ discard block |
||
192 | 192 | } |
193 | 193 | |
194 | 194 | |
195 | - /** |
|
196 | - * Retrieves all placeholders that have to be added to |
|
197 | - * the subject text. |
|
198 | - * |
|
199 | - * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[] |
|
200 | - */ |
|
195 | + /** |
|
196 | + * Retrieves all placeholders that have to be added to |
|
197 | + * the subject text. |
|
198 | + * |
|
199 | + * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[] |
|
200 | + */ |
|
201 | 201 | public function getPlaceholders() |
202 | 202 | { |
203 | 203 | if(isset($this->placeholders)) |
@@ -249,46 +249,46 @@ discard block |
||
249 | 249 | return str_replace($placeholderStrings, array_values($replaces), $string); |
250 | 250 | } |
251 | 251 | |
252 | - /** |
|
253 | - * Makes the string whole again after transforming or filtering it, |
|
254 | - * by replacing the command placeholders with the original commands. |
|
255 | - * |
|
256 | - * @param string $string |
|
257 | - * @return string |
|
258 | - * @throws Mailcode_Exception |
|
259 | - * |
|
260 | - * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
261 | - * @see Mailcode_Parser_Safeguard::ERROR_COMMAND_PLACEHOLDER_MISSING |
|
262 | - */ |
|
252 | + /** |
|
253 | + * Makes the string whole again after transforming or filtering it, |
|
254 | + * by replacing the command placeholders with the original commands. |
|
255 | + * |
|
256 | + * @param string $string |
|
257 | + * @return string |
|
258 | + * @throws Mailcode_Exception |
|
259 | + * |
|
260 | + * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
261 | + * @see Mailcode_Parser_Safeguard::ERROR_COMMAND_PLACEHOLDER_MISSING |
|
262 | + */ |
|
263 | 263 | public function makeWhole(string $string) : string |
264 | 264 | { |
265 | 265 | return $this->restore($string, false); |
266 | 266 | } |
267 | 267 | |
268 | - /** |
|
269 | - * Like makeWhole(), but replaces the commands with a syntax |
|
270 | - * highlighted version, meant for human readable texts only. |
|
271 | - * |
|
272 | - * Note: the commands lose their functionality (They cannot be |
|
273 | - * parsed from that string again). |
|
274 | - * |
|
275 | - * @param string $string |
|
276 | - * @return string |
|
277 | - * @throws Mailcode_Exception |
|
278 | - * |
|
279 | - * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
280 | - * @see Mailcode_Parser_Safeguard::ERROR_COMMAND_PLACEHOLDER_MISSING |
|
281 | - */ |
|
268 | + /** |
|
269 | + * Like makeWhole(), but replaces the commands with a syntax |
|
270 | + * highlighted version, meant for human readable texts only. |
|
271 | + * |
|
272 | + * Note: the commands lose their functionality (They cannot be |
|
273 | + * parsed from that string again). |
|
274 | + * |
|
275 | + * @param string $string |
|
276 | + * @return string |
|
277 | + * @throws Mailcode_Exception |
|
278 | + * |
|
279 | + * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
280 | + * @see Mailcode_Parser_Safeguard::ERROR_COMMAND_PLACEHOLDER_MISSING |
|
281 | + */ |
|
282 | 282 | public function makeHighlighted(string $string) : string |
283 | 283 | { |
284 | 284 | return $this->restore($string, true); |
285 | 285 | } |
286 | 286 | |
287 | - /** |
|
288 | - * Retrieves the commands collection contained in the string. |
|
289 | - * |
|
290 | - * @return Mailcode_Collection |
|
291 | - */ |
|
287 | + /** |
|
288 | + * Retrieves the commands collection contained in the string. |
|
289 | + * |
|
290 | + * @return Mailcode_Collection |
|
291 | + */ |
|
292 | 292 | public function getCollection() : Mailcode_Collection |
293 | 293 | { |
294 | 294 | if(isset($this->collection)) |
@@ -306,11 +306,11 @@ discard block |
||
306 | 306 | return $this->getCollection()->isValid(); |
307 | 307 | } |
308 | 308 | |
309 | - /** |
|
310 | - * @throws Mailcode_Exception |
|
311 | - * |
|
312 | - * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
313 | - */ |
|
309 | + /** |
|
310 | + * @throws Mailcode_Exception |
|
311 | + * |
|
312 | + * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
313 | + */ |
|
314 | 314 | protected function requireValidCollection() : void |
315 | 315 | { |
316 | 316 | if($this->getCollection()->isValid()) |
@@ -329,11 +329,11 @@ discard block |
||
329 | 329 | ); |
330 | 330 | } |
331 | 331 | |
332 | - /** |
|
333 | - * Retrieves a list of all placeholder IDs used in the text. |
|
334 | - * |
|
335 | - * @return string[] |
|
336 | - */ |
|
332 | + /** |
|
333 | + * Retrieves a list of all placeholder IDs used in the text. |
|
334 | + * |
|
335 | + * @return string[] |
|
336 | + */ |
|
337 | 337 | public function getPlaceholderStrings() : array |
338 | 338 | { |
339 | 339 | if(isset($this->placeholderStrings)) |
@@ -360,13 +360,13 @@ discard block |
||
360 | 360 | return in_array($subject, $ids); |
361 | 361 | } |
362 | 362 | |
363 | - /** |
|
364 | - * Retrieves a placeholder instance by its ID. |
|
365 | - * |
|
366 | - * @param int $id |
|
367 | - * @throws Mailcode_Exception If the placeholder was not found. |
|
368 | - * @return Mailcode_Parser_Safeguard_Placeholder |
|
369 | - */ |
|
363 | + /** |
|
364 | + * Retrieves a placeholder instance by its ID. |
|
365 | + * |
|
366 | + * @param int $id |
|
367 | + * @throws Mailcode_Exception If the placeholder was not found. |
|
368 | + * @return Mailcode_Parser_Safeguard_Placeholder |
|
369 | + */ |
|
370 | 370 | public function getPlaceholderByID(int $id) : Mailcode_Parser_Safeguard_Placeholder |
371 | 371 | { |
372 | 372 | $placeholders = $this->getPlaceholders(); |
@@ -389,13 +389,13 @@ discard block |
||
389 | 389 | ); |
390 | 390 | } |
391 | 391 | |
392 | - /** |
|
393 | - * Retrieves a placeholder instance by its replacement text. |
|
394 | - * |
|
395 | - * @param string $string |
|
396 | - * @throws Mailcode_Exception |
|
397 | - * @return Mailcode_Parser_Safeguard_Placeholder |
|
398 | - */ |
|
392 | + /** |
|
393 | + * Retrieves a placeholder instance by its replacement text. |
|
394 | + * |
|
395 | + * @param string $string |
|
396 | + * @throws Mailcode_Exception |
|
397 | + * @return Mailcode_Parser_Safeguard_Placeholder |
|
398 | + */ |
|
399 | 399 | public function getPlaceholderByString(string $string) : Mailcode_Parser_Safeguard_Placeholder |
400 | 400 | { |
401 | 401 | $placeholders = $this->getPlaceholders(); |
@@ -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); |
@@ -32,7 +32,7 @@ discard block |
||
32 | 32 | |
33 | 33 | public function add(Mailcode_Variables_Variable $variable) : Mailcode_Variables_Collection |
34 | 34 | { |
35 | - if(!$variable->isValid()) |
|
35 | + if (!$variable->isValid()) |
|
36 | 36 | { |
37 | 37 | return $this->addInvalid($variable); |
38 | 38 | } |
@@ -76,7 +76,7 @@ discard block |
||
76 | 76 | parent::mergeWith($collection); |
77 | 77 | |
78 | 78 | // also inherit any invalid variables |
79 | - if($collection instanceof Mailcode_Variables_Collection_Regular) |
|
79 | + if ($collection instanceof Mailcode_Variables_Collection_Regular) |
|
80 | 80 | { |
81 | 81 | $invalid = $collection->getInvalid(); |
82 | 82 |
@@ -24,7 +24,7 @@ |
||
24 | 24 | { |
25 | 25 | public function add(Mailcode_Variables_Variable $variable) : Mailcode_Variables_Collection |
26 | 26 | { |
27 | - if($variable->isValid()) |
|
27 | + if ($variable->isValid()) |
|
28 | 28 | { |
29 | 29 | return $this; |
30 | 30 | } |
@@ -29,19 +29,19 @@ |
||
29 | 29 | const VALIDATION_COMMANDS_ALREADY_CLOSED = 49103; |
30 | 30 | const VALIDATION_UNCLOSED_COMMAND = 49104; |
31 | 31 | |
32 | - /** |
|
33 | - * @var Mailcode_Collection |
|
34 | - */ |
|
32 | + /** |
|
33 | + * @var Mailcode_Collection |
|
34 | + */ |
|
35 | 35 | protected $collection; |
36 | 36 | |
37 | - /** |
|
38 | - * @var OperationResult |
|
39 | - */ |
|
37 | + /** |
|
38 | + * @var OperationResult |
|
39 | + */ |
|
40 | 40 | protected $validationResult; |
41 | 41 | |
42 | - /** |
|
43 | - * @var Mailcode_Commands_Command[] |
|
44 | - */ |
|
42 | + /** |
|
43 | + * @var Mailcode_Commands_Command[] |
|
44 | + */ |
|
45 | 45 | protected $stack = array(); |
46 | 46 | |
47 | 47 | public function __construct(Mailcode_Collection $collection) |
@@ -60,11 +60,11 @@ discard block |
||
60 | 60 | |
61 | 61 | $commands = $this->collection->getCommands(); |
62 | 62 | |
63 | - foreach($commands as $command) |
|
63 | + foreach ($commands as $command) |
|
64 | 64 | { |
65 | 65 | $method = 'validate_'.$command->getCommandType(); |
66 | 66 | |
67 | - if(!method_exists($this, $method)) |
|
67 | + if (!method_exists($this, $method)) |
|
68 | 68 | { |
69 | 69 | throw new Mailcode_Exception( |
70 | 70 | 'Unknown command type validation method.', |
@@ -79,13 +79,13 @@ discard block |
||
79 | 79 | |
80 | 80 | $this->$method($command); |
81 | 81 | |
82 | - if(!$this->validationResult->isValid()) |
|
82 | + if (!$this->validationResult->isValid()) |
|
83 | 83 | { |
84 | 84 | break; |
85 | 85 | } |
86 | 86 | } |
87 | 87 | |
88 | - if($this->validationResult->isValid()) |
|
88 | + if ($this->validationResult->isValid()) |
|
89 | 89 | { |
90 | 90 | $this->validate_Unclosed(); |
91 | 91 | } |
@@ -97,7 +97,7 @@ discard block |
||
97 | 97 | { |
98 | 98 | $leftover = $this->getOpenCommand(); |
99 | 99 | |
100 | - if($leftover === null) |
|
100 | + if ($leftover === null) |
|
101 | 101 | { |
102 | 102 | return; |
103 | 103 | } |
@@ -113,7 +113,7 @@ discard block |
||
113 | 113 | |
114 | 114 | protected function getOpenCommand() : ?Mailcode_Commands_Command_Type_Opening |
115 | 115 | { |
116 | - if(empty($this->stack)) |
|
116 | + if (empty($this->stack)) |
|
117 | 117 | { |
118 | 118 | return null; |
119 | 119 | } |
@@ -124,7 +124,7 @@ discard block |
||
124 | 124 | |
125 | 125 | $cmd = $this->stack[$idx]; |
126 | 126 | |
127 | - if($cmd instanceof Mailcode_Commands_Command_Type_Opening) |
|
127 | + if ($cmd instanceof Mailcode_Commands_Command_Type_Opening) |
|
128 | 128 | { |
129 | 129 | return $cmd; |
130 | 130 | } |
@@ -148,7 +148,7 @@ discard block |
||
148 | 148 | { |
149 | 149 | $parent = $this->getOpenCommand(); |
150 | 150 | |
151 | - if($parent === null) |
|
151 | + if ($parent === null) |
|
152 | 152 | { |
153 | 153 | $this->validationResult->makeError( |
154 | 154 | t( |
@@ -162,7 +162,7 @@ discard block |
||
162 | 162 | return; |
163 | 163 | } |
164 | 164 | |
165 | - if($parent->getName() !== $command->getParentName()) |
|
165 | + if ($parent->getName() !== $command->getParentName()) |
|
166 | 166 | { |
167 | 167 | $this->validationResult->makeError( |
168 | 168 | t( |
@@ -181,7 +181,7 @@ discard block |
||
181 | 181 | |
182 | 182 | protected function validate_Closing(Mailcode_Commands_Command_Type_Closing $command) : void |
183 | 183 | { |
184 | - if(empty($this->stack)) |
|
184 | + if (empty($this->stack)) |
|
185 | 185 | { |
186 | 186 | $this->validationResult->makeError( |
187 | 187 | t('All open commands have already been ended.'), |
@@ -23,7 +23,7 @@ |
||
23 | 23 | */ |
24 | 24 | function init() : void |
25 | 25 | { |
26 | - if(!class_exists('\AppLocalize\Localization')) { |
|
26 | + if (!class_exists('\AppLocalize\Localization')) { |
|
27 | 27 | return; |
28 | 28 | } |
29 | 29 |