@@ -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) |
@@ -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); |
@@ -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 | } |
@@ -61,50 +61,50 @@ discard block |
||
| 61 | 61 | |
| 62 | 62 | const ERROR_NOT_A_SINGLE_LINES_FORMATTER = 47806; |
| 63 | 63 | |
| 64 | - /** |
|
| 65 | - * @var Mailcode_Parser |
|
| 66 | - */ |
|
| 64 | + /** |
|
| 65 | + * @var Mailcode_Parser |
|
| 66 | + */ |
|
| 67 | 67 | protected $parser; |
| 68 | 68 | |
| 69 | - /** |
|
| 70 | - * @var Mailcode_Collection |
|
| 71 | - */ |
|
| 69 | + /** |
|
| 70 | + * @var Mailcode_Collection |
|
| 71 | + */ |
|
| 72 | 72 | protected $commands; |
| 73 | 73 | |
| 74 | - /** |
|
| 75 | - * @var string |
|
| 76 | - */ |
|
| 74 | + /** |
|
| 75 | + * @var string |
|
| 76 | + */ |
|
| 77 | 77 | protected $originalString; |
| 78 | 78 | |
| 79 | - /** |
|
| 80 | - * @var Mailcode_Collection |
|
| 81 | - */ |
|
| 79 | + /** |
|
| 80 | + * @var Mailcode_Collection |
|
| 81 | + */ |
|
| 82 | 82 | protected $collection; |
| 83 | 83 | |
| 84 | - /** |
|
| 85 | - * Counter for the placeholders, global for all placeholders. |
|
| 86 | - * @var integer |
|
| 87 | - */ |
|
| 84 | + /** |
|
| 85 | + * Counter for the placeholders, global for all placeholders. |
|
| 86 | + * @var integer |
|
| 87 | + */ |
|
| 88 | 88 | private static $counter = 0; |
| 89 | 89 | |
| 90 | - /** |
|
| 91 | - * @var Mailcode_Parser_Safeguard_Placeholder[] |
|
| 92 | - */ |
|
| 90 | + /** |
|
| 91 | + * @var Mailcode_Parser_Safeguard_Placeholder[] |
|
| 92 | + */ |
|
| 93 | 93 | protected $placeholders; |
| 94 | 94 | |
| 95 | - /** |
|
| 96 | - * @var string |
|
| 97 | - */ |
|
| 95 | + /** |
|
| 96 | + * @var string |
|
| 97 | + */ |
|
| 98 | 98 | protected $delimiter = '__'; |
| 99 | 99 | |
| 100 | - /** |
|
| 101 | - * @var string[]|NULL |
|
| 102 | - */ |
|
| 100 | + /** |
|
| 101 | + * @var string[]|NULL |
|
| 102 | + */ |
|
| 103 | 103 | protected $placeholderStrings; |
| 104 | 104 | |
| 105 | - /** |
|
| 106 | - * @var Mailcode_Parser_Safeguard_Formatter |
|
| 107 | - */ |
|
| 105 | + /** |
|
| 106 | + * @var Mailcode_Parser_Safeguard_Formatter |
|
| 107 | + */ |
|
| 108 | 108 | protected $formatter; |
| 109 | 109 | |
| 110 | 110 | public function __construct(Mailcode_Parser $parser, string $subject) |
@@ -113,25 +113,25 @@ discard block |
||
| 113 | 113 | $this->originalString = $subject; |
| 114 | 114 | } |
| 115 | 115 | |
| 116 | - /** |
|
| 117 | - * Retrieves the string the safeguard was created for. |
|
| 118 | - * |
|
| 119 | - * @return string |
|
| 120 | - */ |
|
| 116 | + /** |
|
| 117 | + * Retrieves the string the safeguard was created for. |
|
| 118 | + * |
|
| 119 | + * @return string |
|
| 120 | + */ |
|
| 121 | 121 | public function getOriginalString() : string |
| 122 | 122 | { |
| 123 | 123 | return $this->originalString; |
| 124 | 124 | } |
| 125 | 125 | |
| 126 | - /** |
|
| 127 | - * Sets the delimiter character sequence used to prepend |
|
| 128 | - * and append to the placeholders. |
|
| 129 | - * |
|
| 130 | - * The delimiter's default is "__" (two underscores). |
|
| 131 | - * |
|
| 132 | - * @param string $delimiter |
|
| 133 | - * @return Mailcode_Parser_Safeguard |
|
| 134 | - */ |
|
| 126 | + /** |
|
| 127 | + * Sets the delimiter character sequence used to prepend |
|
| 128 | + * and append to the placeholders. |
|
| 129 | + * |
|
| 130 | + * The delimiter's default is "__" (two underscores). |
|
| 131 | + * |
|
| 132 | + * @param string $delimiter |
|
| 133 | + * @return Mailcode_Parser_Safeguard |
|
| 134 | + */ |
|
| 135 | 135 | public function setDelimiter(string $delimiter) : Mailcode_Parser_Safeguard |
| 136 | 136 | { |
| 137 | 137 | if(empty($delimiter)) |
@@ -153,15 +153,15 @@ discard block |
||
| 153 | 153 | return $this->delimiter; |
| 154 | 154 | } |
| 155 | 155 | |
| 156 | - /** |
|
| 157 | - * Retrieves the safe string in which all commands have been replaced |
|
| 158 | - * by placeholder strings. |
|
| 159 | - * |
|
| 160 | - * @return string |
|
| 161 | - * @throws Mailcode_Exception |
|
| 162 | - * |
|
| 163 | - * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
| 164 | - */ |
|
| 156 | + /** |
|
| 157 | + * Retrieves the safe string in which all commands have been replaced |
|
| 158 | + * by placeholder strings. |
|
| 159 | + * |
|
| 160 | + * @return string |
|
| 161 | + * @throws Mailcode_Exception |
|
| 162 | + * |
|
| 163 | + * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
| 164 | + */ |
|
| 165 | 165 | public function makeSafe() : string |
| 166 | 166 | { |
| 167 | 167 | $this->requireValidCollection(); |
@@ -201,10 +201,10 @@ discard block |
||
| 201 | 201 | ); |
| 202 | 202 | } |
| 203 | 203 | |
| 204 | - /** |
|
| 205 | - * Enables the formatter that ensures that all commands that |
|
| 206 | - * @return Mailcode_Parser_Safeguard_Formatter_SingleLines |
|
| 207 | - */ |
|
| 204 | + /** |
|
| 205 | + * Enables the formatter that ensures that all commands that |
|
| 206 | + * @return Mailcode_Parser_Safeguard_Formatter_SingleLines |
|
| 207 | + */ |
|
| 208 | 208 | public function selectSingleLinesFormatter() : Mailcode_Parser_Safeguard_Formatter_SingleLines |
| 209 | 209 | { |
| 210 | 210 | $formatter = $this->selectFormatter('SingleLines'); |
@@ -224,13 +224,13 @@ discard block |
||
| 224 | 224 | ); |
| 225 | 225 | } |
| 226 | 226 | |
| 227 | - /** |
|
| 228 | - * Retrieves an associative array with pairs of |
|
| 229 | - * [placeholder string => replacement text]. |
|
| 230 | - * |
|
| 231 | - * @param bool $highlighted |
|
| 232 | - * @return string[]string |
|
| 233 | - */ |
|
| 227 | + /** |
|
| 228 | + * Retrieves an associative array with pairs of |
|
| 229 | + * [placeholder string => replacement text]. |
|
| 230 | + * |
|
| 231 | + * @param bool $highlighted |
|
| 232 | + * @return string[]string |
|
| 233 | + */ |
|
| 234 | 234 | protected function getReplaces(bool $highlighted=false) : array |
| 235 | 235 | { |
| 236 | 236 | $placeholders = $this->getPlaceholders(); |
@@ -257,12 +257,12 @@ discard block |
||
| 257 | 257 | } |
| 258 | 258 | |
| 259 | 259 | |
| 260 | - /** |
|
| 261 | - * Retrieves all placeholders that have to be added to |
|
| 262 | - * the subject text. |
|
| 263 | - * |
|
| 264 | - * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[] |
|
| 265 | - */ |
|
| 260 | + /** |
|
| 261 | + * Retrieves all placeholders that have to be added to |
|
| 262 | + * the subject text. |
|
| 263 | + * |
|
| 264 | + * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[] |
|
| 265 | + */ |
|
| 266 | 266 | public function getPlaceholders() |
| 267 | 267 | { |
| 268 | 268 | if(isset($this->placeholders)) |
@@ -314,46 +314,46 @@ discard block |
||
| 314 | 314 | return str_replace($placeholderStrings, array_values($replaces), $string); |
| 315 | 315 | } |
| 316 | 316 | |
| 317 | - /** |
|
| 318 | - * Makes the string whole again after transforming or filtering it, |
|
| 319 | - * by replacing the command placeholders with the original commands. |
|
| 320 | - * |
|
| 321 | - * @param string $string |
|
| 322 | - * @return string |
|
| 323 | - * @throws Mailcode_Exception |
|
| 324 | - * |
|
| 325 | - * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
| 326 | - * @see Mailcode_Parser_Safeguard::ERROR_COMMAND_PLACEHOLDER_MISSING |
|
| 327 | - */ |
|
| 317 | + /** |
|
| 318 | + * Makes the string whole again after transforming or filtering it, |
|
| 319 | + * by replacing the command placeholders with the original commands. |
|
| 320 | + * |
|
| 321 | + * @param string $string |
|
| 322 | + * @return string |
|
| 323 | + * @throws Mailcode_Exception |
|
| 324 | + * |
|
| 325 | + * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
| 326 | + * @see Mailcode_Parser_Safeguard::ERROR_COMMAND_PLACEHOLDER_MISSING |
|
| 327 | + */ |
|
| 328 | 328 | public function makeWhole(string $string) : string |
| 329 | 329 | { |
| 330 | 330 | return $this->restore($string, false); |
| 331 | 331 | } |
| 332 | 332 | |
| 333 | - /** |
|
| 334 | - * Like makeWhole(), but replaces the commands with a syntax |
|
| 335 | - * highlighted version, meant for human readable texts only. |
|
| 336 | - * |
|
| 337 | - * Note: the commands lose their functionality (They cannot be |
|
| 338 | - * parsed from that string again). |
|
| 339 | - * |
|
| 340 | - * @param string $string |
|
| 341 | - * @return string |
|
| 342 | - * @throws Mailcode_Exception |
|
| 343 | - * |
|
| 344 | - * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
| 345 | - * @see Mailcode_Parser_Safeguard::ERROR_COMMAND_PLACEHOLDER_MISSING |
|
| 346 | - */ |
|
| 333 | + /** |
|
| 334 | + * Like makeWhole(), but replaces the commands with a syntax |
|
| 335 | + * highlighted version, meant for human readable texts only. |
|
| 336 | + * |
|
| 337 | + * Note: the commands lose their functionality (They cannot be |
|
| 338 | + * parsed from that string again). |
|
| 339 | + * |
|
| 340 | + * @param string $string |
|
| 341 | + * @return string |
|
| 342 | + * @throws Mailcode_Exception |
|
| 343 | + * |
|
| 344 | + * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
| 345 | + * @see Mailcode_Parser_Safeguard::ERROR_COMMAND_PLACEHOLDER_MISSING |
|
| 346 | + */ |
|
| 347 | 347 | public function makeHighlighted(string $string) : string |
| 348 | 348 | { |
| 349 | 349 | return $this->restore($string, true); |
| 350 | 350 | } |
| 351 | 351 | |
| 352 | - /** |
|
| 353 | - * Retrieves the commands collection contained in the string. |
|
| 354 | - * |
|
| 355 | - * @return Mailcode_Collection |
|
| 356 | - */ |
|
| 352 | + /** |
|
| 353 | + * Retrieves the commands collection contained in the string. |
|
| 354 | + * |
|
| 355 | + * @return Mailcode_Collection |
|
| 356 | + */ |
|
| 357 | 357 | public function getCollection() : Mailcode_Collection |
| 358 | 358 | { |
| 359 | 359 | if(isset($this->collection)) |
@@ -371,11 +371,11 @@ discard block |
||
| 371 | 371 | return $this->getCollection()->isValid(); |
| 372 | 372 | } |
| 373 | 373 | |
| 374 | - /** |
|
| 375 | - * @throws Mailcode_Exception |
|
| 376 | - * |
|
| 377 | - * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
| 378 | - */ |
|
| 374 | + /** |
|
| 375 | + * @throws Mailcode_Exception |
|
| 376 | + * |
|
| 377 | + * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
| 378 | + */ |
|
| 379 | 379 | protected function requireValidCollection() : void |
| 380 | 380 | { |
| 381 | 381 | if($this->getCollection()->isValid()) |
@@ -394,11 +394,11 @@ discard block |
||
| 394 | 394 | ); |
| 395 | 395 | } |
| 396 | 396 | |
| 397 | - /** |
|
| 398 | - * Retrieves a list of all placeholder IDs used in the text. |
|
| 399 | - * |
|
| 400 | - * @return string[] |
|
| 401 | - */ |
|
| 397 | + /** |
|
| 398 | + * Retrieves a list of all placeholder IDs used in the text. |
|
| 399 | + * |
|
| 400 | + * @return string[] |
|
| 401 | + */ |
|
| 402 | 402 | public function getPlaceholderStrings() : array |
| 403 | 403 | { |
| 404 | 404 | if(isset($this->placeholderStrings)) |
@@ -425,13 +425,13 @@ discard block |
||
| 425 | 425 | return in_array($subject, $ids); |
| 426 | 426 | } |
| 427 | 427 | |
| 428 | - /** |
|
| 429 | - * Retrieves a placeholder instance by its ID. |
|
| 430 | - * |
|
| 431 | - * @param int $id |
|
| 432 | - * @throws Mailcode_Exception If the placeholder was not found. |
|
| 433 | - * @return Mailcode_Parser_Safeguard_Placeholder |
|
| 434 | - */ |
|
| 428 | + /** |
|
| 429 | + * Retrieves a placeholder instance by its ID. |
|
| 430 | + * |
|
| 431 | + * @param int $id |
|
| 432 | + * @throws Mailcode_Exception If the placeholder was not found. |
|
| 433 | + * @return Mailcode_Parser_Safeguard_Placeholder |
|
| 434 | + */ |
|
| 435 | 435 | public function getPlaceholderByID(int $id) : Mailcode_Parser_Safeguard_Placeholder |
| 436 | 436 | { |
| 437 | 437 | $placeholders = $this->getPlaceholders(); |
@@ -454,13 +454,13 @@ discard block |
||
| 454 | 454 | ); |
| 455 | 455 | } |
| 456 | 456 | |
| 457 | - /** |
|
| 458 | - * Retrieves a placeholder instance by its replacement text. |
|
| 459 | - * |
|
| 460 | - * @param string $string |
|
| 461 | - * @throws Mailcode_Exception |
|
| 462 | - * @return Mailcode_Parser_Safeguard_Placeholder |
|
| 463 | - */ |
|
| 457 | + /** |
|
| 458 | + * Retrieves a placeholder instance by its replacement text. |
|
| 459 | + * |
|
| 460 | + * @param string $string |
|
| 461 | + * @throws Mailcode_Exception |
|
| 462 | + * @return Mailcode_Parser_Safeguard_Placeholder |
|
| 463 | + */ |
|
| 464 | 464 | public function getPlaceholderByString(string $string) : Mailcode_Parser_Safeguard_Placeholder |
| 465 | 465 | { |
| 466 | 466 | $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); |
@@ -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) |