@@ -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 | } |
@@ -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 | } |
@@ -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(); |
@@ -134,7 +134,7 @@ discard block |
||
| 134 | 134 | */ |
| 135 | 135 | public function setDelimiter(string $delimiter) : Mailcode_Parser_Safeguard |
| 136 | 136 | { |
| 137 | - if(empty($delimiter)) |
|
| 137 | + if (empty($delimiter)) |
|
| 138 | 138 | { |
| 139 | 139 | throw new Mailcode_Exception( |
| 140 | 140 | 'Empty delimiter', |
@@ -171,7 +171,7 @@ discard block |
||
| 171 | 171 | $safe = str_replace(array_values($replaces), array_keys($replaces), $this->originalString); |
| 172 | 172 | |
| 173 | 173 | // If a formatter has been selected, let it modify the string. |
| 174 | - if(isset($this->formatter)) |
|
| 174 | + if (isset($this->formatter)) |
|
| 175 | 175 | { |
| 176 | 176 | $safe = $this->formatter->format($safe); |
| 177 | 177 | } |
@@ -183,7 +183,7 @@ discard block |
||
| 183 | 183 | { |
| 184 | 184 | $class = 'Mailcode\Mailcode_Parser_Safeguard_Formatter_'.$formatterID; |
| 185 | 185 | |
| 186 | - if(class_exists($class)) |
|
| 186 | + if (class_exists($class)) |
|
| 187 | 187 | { |
| 188 | 188 | $this->formatter = new $class($this); |
| 189 | 189 | |
@@ -209,7 +209,7 @@ discard block |
||
| 209 | 209 | { |
| 210 | 210 | $formatter = $this->selectFormatter('SingleLines'); |
| 211 | 211 | |
| 212 | - if($formatter instanceof Mailcode_Parser_Safeguard_Formatter_SingleLines) |
|
| 212 | + if ($formatter instanceof Mailcode_Parser_Safeguard_Formatter_SingleLines) |
|
| 213 | 213 | { |
| 214 | 214 | return $formatter; |
| 215 | 215 | } |
@@ -231,17 +231,17 @@ discard block |
||
| 231 | 231 | * @param bool $highlighted |
| 232 | 232 | * @return string[]string |
| 233 | 233 | */ |
| 234 | - protected function getReplaces(bool $highlighted=false) : array |
|
| 234 | + protected function getReplaces(bool $highlighted = false) : array |
|
| 235 | 235 | { |
| 236 | 236 | $placeholders = $this->getPlaceholders(); |
| 237 | 237 | |
| 238 | 238 | $replaces = array(); |
| 239 | 239 | |
| 240 | - foreach($placeholders as $placeholder) |
|
| 240 | + foreach ($placeholders as $placeholder) |
|
| 241 | 241 | { |
| 242 | 242 | $replace = ''; |
| 243 | 243 | |
| 244 | - if($highlighted) |
|
| 244 | + if ($highlighted) |
|
| 245 | 245 | { |
| 246 | 246 | $replace = $placeholder->getHighlightedText(); |
| 247 | 247 | } |
@@ -265,7 +265,7 @@ discard block |
||
| 265 | 265 | */ |
| 266 | 266 | public function getPlaceholders() |
| 267 | 267 | { |
| 268 | - if(isset($this->placeholders)) |
|
| 268 | + if (isset($this->placeholders)) |
|
| 269 | 269 | { |
| 270 | 270 | return $this->placeholders; |
| 271 | 271 | } |
@@ -274,7 +274,7 @@ discard block |
||
| 274 | 274 | |
| 275 | 275 | $cmds = $this->getCollection()->getGroupedByHash(); |
| 276 | 276 | |
| 277 | - foreach($cmds as $command) |
|
| 277 | + foreach ($cmds as $command) |
|
| 278 | 278 | { |
| 279 | 279 | self::$counter++; |
| 280 | 280 | |
@@ -288,7 +288,7 @@ discard block |
||
| 288 | 288 | return $this->placeholders; |
| 289 | 289 | } |
| 290 | 290 | |
| 291 | - protected function restore(string $string, bool $highlighted=false) : string |
|
| 291 | + protected function restore(string $string, bool $highlighted = false) : string |
|
| 292 | 292 | { |
| 293 | 293 | $this->requireValidCollection(); |
| 294 | 294 | |
@@ -296,9 +296,9 @@ discard block |
||
| 296 | 296 | |
| 297 | 297 | $placeholderStrings = array_keys($replaces); |
| 298 | 298 | |
| 299 | - foreach($placeholderStrings as $search) |
|
| 299 | + foreach ($placeholderStrings as $search) |
|
| 300 | 300 | { |
| 301 | - if(!strstr($string, $search)) |
|
| 301 | + if (!strstr($string, $search)) |
|
| 302 | 302 | { |
| 303 | 303 | throw new Mailcode_Exception( |
| 304 | 304 | 'Command placeholder not found', |
@@ -356,7 +356,7 @@ discard block |
||
| 356 | 356 | */ |
| 357 | 357 | public function getCollection() : Mailcode_Collection |
| 358 | 358 | { |
| 359 | - if(isset($this->collection)) |
|
| 359 | + if (isset($this->collection)) |
|
| 360 | 360 | { |
| 361 | 361 | return $this->collection; |
| 362 | 362 | } |
@@ -378,7 +378,7 @@ discard block |
||
| 378 | 378 | */ |
| 379 | 379 | protected function requireValidCollection() : void |
| 380 | 380 | { |
| 381 | - if($this->getCollection()->isValid()) |
|
| 381 | + if ($this->getCollection()->isValid()) |
|
| 382 | 382 | { |
| 383 | 383 | return; |
| 384 | 384 | } |
@@ -401,7 +401,7 @@ discard block |
||
| 401 | 401 | */ |
| 402 | 402 | public function getPlaceholderStrings() : array |
| 403 | 403 | { |
| 404 | - if(isset($this->placeholderStrings)) |
|
| 404 | + if (isset($this->placeholderStrings)) |
|
| 405 | 405 | { |
| 406 | 406 | return $this->placeholderStrings; |
| 407 | 407 | } |
@@ -410,7 +410,7 @@ discard block |
||
| 410 | 410 | |
| 411 | 411 | $this->placeholderStrings = array(); |
| 412 | 412 | |
| 413 | - foreach($placeholders as $placeholder) |
|
| 413 | + foreach ($placeholders as $placeholder) |
|
| 414 | 414 | { |
| 415 | 415 | $this->placeholderStrings[] = $placeholder->getReplacementText(); |
| 416 | 416 | } |
@@ -436,9 +436,9 @@ discard block |
||
| 436 | 436 | { |
| 437 | 437 | $placeholders = $this->getPlaceholders(); |
| 438 | 438 | |
| 439 | - foreach($placeholders as $placeholder) |
|
| 439 | + foreach ($placeholders as $placeholder) |
|
| 440 | 440 | { |
| 441 | - if($placeholder->getID() === $id) |
|
| 441 | + if ($placeholder->getID() === $id) |
|
| 442 | 442 | { |
| 443 | 443 | return $placeholder; |
| 444 | 444 | } |
@@ -465,9 +465,9 @@ discard block |
||
| 465 | 465 | { |
| 466 | 466 | $placeholders = $this->getPlaceholders(); |
| 467 | 467 | |
| 468 | - foreach($placeholders as $placeholder) |
|
| 468 | + foreach ($placeholders as $placeholder) |
|
| 469 | 469 | { |
| 470 | - if($placeholder->getReplacementText() === $string) |
|
| 470 | + if ($placeholder->getReplacementText() === $string) |
|
| 471 | 471 | { |
| 472 | 472 | return $placeholder; |
| 473 | 473 | } |
@@ -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 | } |
@@ -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 | |
@@ -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 |
@@ -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.'), |
@@ -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_Type[] |
|
| 44 | - */ |
|
| 42 | + /** |
|
| 43 | + * @var Mailcode_Commands_Command_Type[] |
|
| 44 | + */ |
|
| 45 | 45 | protected $stack = array(); |
| 46 | 46 | |
| 47 | 47 | public function __construct(Mailcode_Collection $collection) |