@@ -22,15 +22,15 @@ discard block |
||
| 22 | 22 | { |
| 23 | 23 | const VALIDATION_NOT_A_FORMAT_STRING = 55401; |
| 24 | 24 | |
| 25 | - /** |
|
| 26 | - * The date format string. |
|
| 27 | - * @var string |
|
| 28 | - */ |
|
| 25 | + /** |
|
| 26 | + * The date format string. |
|
| 27 | + * @var string |
|
| 28 | + */ |
|
| 29 | 29 | private $formatString = "Y/m/d"; |
| 30 | 30 | |
| 31 | - /** |
|
| 32 | - * @var Mailcode_Date_FormatInfo |
|
| 33 | - */ |
|
| 31 | + /** |
|
| 32 | + * @var Mailcode_Date_FormatInfo |
|
| 33 | + */ |
|
| 34 | 34 | private $formatInfo; |
| 35 | 35 | |
| 36 | 36 | public function getName() : string |
@@ -53,46 +53,46 @@ discard block |
||
| 53 | 53 | |
| 54 | 54 | protected function validateSyntax_check_format() : void |
| 55 | 55 | { |
| 56 | - $token = $this->params->getInfo()->getTokenByIndex(1); |
|
| 56 | + $token = $this->params->getInfo()->getTokenByIndex(1); |
|
| 57 | 57 | |
| 58 | - // no format specified? Use the default one. |
|
| 59 | - if($token === null) |
|
| 60 | - { |
|
| 61 | - return; |
|
| 62 | - } |
|
| 58 | + // no format specified? Use the default one. |
|
| 59 | + if($token === null) |
|
| 60 | + { |
|
| 61 | + return; |
|
| 62 | + } |
|
| 63 | 63 | |
| 64 | - if($token instanceof Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral) |
|
| 65 | - { |
|
| 66 | - $format = $token->getText(); |
|
| 64 | + if($token instanceof Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral) |
|
| 65 | + { |
|
| 66 | + $format = $token->getText(); |
|
| 67 | 67 | |
| 68 | - $result = $this->formatInfo->validateFormat($format); |
|
| 68 | + $result = $this->formatInfo->validateFormat($format); |
|
| 69 | 69 | |
| 70 | - if($result->isValid()) |
|
| 71 | - { |
|
| 70 | + if($result->isValid()) |
|
| 71 | + { |
|
| 72 | 72 | $this->formatString = $format; |
| 73 | - } |
|
| 74 | - else |
|
| 75 | - { |
|
| 76 | - $this->validationResult->makeError( |
|
| 77 | - $result->getErrorMessage(), |
|
| 78 | - $result->getCode() |
|
| 79 | - ); |
|
| 80 | - } |
|
| 73 | + } |
|
| 74 | + else |
|
| 75 | + { |
|
| 76 | + $this->validationResult->makeError( |
|
| 77 | + $result->getErrorMessage(), |
|
| 78 | + $result->getCode() |
|
| 79 | + ); |
|
| 80 | + } |
|
| 81 | 81 | |
| 82 | - return; |
|
| 83 | - } |
|
| 82 | + return; |
|
| 83 | + } |
|
| 84 | 84 | |
| 85 | - $this->validationResult->makeError( |
|
| 85 | + $this->validationResult->makeError( |
|
| 86 | 86 | t('The second parameter must be a date format string.'), |
| 87 | 87 | self::VALIDATION_NOT_A_FORMAT_STRING |
| 88 | - ); |
|
| 88 | + ); |
|
| 89 | 89 | } |
| 90 | 90 | |
| 91 | - /** |
|
| 92 | - * Retrieves the format string used to format the date. |
|
| 93 | - * |
|
| 94 | - * @return string A PHP compatible date format string. |
|
| 95 | - */ |
|
| 91 | + /** |
|
| 92 | + * Retrieves the format string used to format the date. |
|
| 93 | + * |
|
| 94 | + * @return string A PHP compatible date format string. |
|
| 95 | + */ |
|
| 96 | 96 | public function getFormatString() : string |
| 97 | 97 | { |
| 98 | 98 | return $this->formatString; |
@@ -29,24 +29,24 @@ discard block |
||
| 29 | 29 | |
| 30 | 30 | const VALIDATION_UNQUOTED_STRING_LITERALS = 48802; |
| 31 | 31 | |
| 32 | - /** |
|
| 33 | - * @var string |
|
| 34 | - */ |
|
| 32 | + /** |
|
| 33 | + * @var string |
|
| 34 | + */ |
|
| 35 | 35 | protected $statement; |
| 36 | 36 | |
| 37 | - /** |
|
| 38 | - * @var OperationResult |
|
| 39 | - */ |
|
| 37 | + /** |
|
| 38 | + * @var OperationResult |
|
| 39 | + */ |
|
| 40 | 40 | protected $result; |
| 41 | 41 | |
| 42 | - /** |
|
| 43 | - * @var Mailcode_Parser_Statement_Tokenizer |
|
| 44 | - */ |
|
| 42 | + /** |
|
| 43 | + * @var Mailcode_Parser_Statement_Tokenizer |
|
| 44 | + */ |
|
| 45 | 45 | protected $tokenizer; |
| 46 | 46 | |
| 47 | - /** |
|
| 48 | - * @var Mailcode_Parser_Statement_Info|NULL |
|
| 49 | - */ |
|
| 47 | + /** |
|
| 48 | + * @var Mailcode_Parser_Statement_Info|NULL |
|
| 49 | + */ |
|
| 50 | 50 | protected $info; |
| 51 | 51 | |
| 52 | 52 | public function __construct(string $statement) |
@@ -102,7 +102,7 @@ discard block |
||
| 102 | 102 | if($unknown) |
| 103 | 103 | { |
| 104 | 104 | $this->result->makeError( |
| 105 | - t('Unquoted string literal found:').' ('.htmlspecialchars($unknown->getMatchedText()).')', |
|
| 105 | + t('Unquoted string literal found:').' ('.htmlspecialchars($unknown->getMatchedText()).')', |
|
| 106 | 106 | self::VALIDATION_UNQUOTED_STRING_LITERALS |
| 107 | 107 | ); |
| 108 | 108 | } |
@@ -23,19 +23,19 @@ discard block |
||
| 23 | 23 | */ |
| 24 | 24 | trait Mailcode_Traits_Commands_IfVariable |
| 25 | 25 | { |
| 26 | - /** |
|
| 27 | - * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL |
|
| 28 | - */ |
|
| 26 | + /** |
|
| 27 | + * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL |
|
| 28 | + */ |
|
| 29 | 29 | protected $variableToken; |
| 30 | 30 | |
| 31 | - /** |
|
| 32 | - * @var Mailcode_Parser_Statement_Tokenizer_Token_Operand|NULL |
|
| 33 | - */ |
|
| 31 | + /** |
|
| 32 | + * @var Mailcode_Parser_Statement_Tokenizer_Token_Operand|NULL |
|
| 33 | + */ |
|
| 34 | 34 | protected $comparisonToken; |
| 35 | 35 | |
| 36 | - /** |
|
| 37 | - * @var Mailcode_Parser_Statement_Tokenizer_Type_Value|NULL |
|
| 38 | - */ |
|
| 36 | + /** |
|
| 37 | + * @var Mailcode_Parser_Statement_Tokenizer_Type_Value|NULL |
|
| 38 | + */ |
|
| 39 | 39 | protected $valueToken; |
| 40 | 40 | |
| 41 | 41 | protected function getValidations() : array |
@@ -123,11 +123,11 @@ discard block |
||
| 123 | 123 | ); |
| 124 | 124 | } |
| 125 | 125 | |
| 126 | - /** |
|
| 127 | - * Retrieves the variable being compared. |
|
| 128 | - * |
|
| 129 | - * @return Mailcode_Variables_Variable |
|
| 130 | - */ |
|
| 126 | + /** |
|
| 127 | + * Retrieves the variable being compared. |
|
| 128 | + * |
|
| 129 | + * @return Mailcode_Variables_Variable |
|
| 130 | + */ |
|
| 131 | 131 | public function getVariable() : Mailcode_Variables_Variable |
| 132 | 132 | { |
| 133 | 133 | if($this->variableToken instanceof Mailcode_Parser_Statement_Tokenizer_Token_Variable) |
@@ -142,12 +142,12 @@ discard block |
||
| 142 | 142 | ); |
| 143 | 143 | } |
| 144 | 144 | |
| 145 | - /** |
|
| 146 | - * Retrieves the comparison operator sign. |
|
| 147 | - * |
|
| 148 | - * @throws Mailcode_Exception |
|
| 149 | - * @return string The comparison string, e.g. "==", "!=", etc. |
|
| 150 | - */ |
|
| 145 | + /** |
|
| 146 | + * Retrieves the comparison operator sign. |
|
| 147 | + * |
|
| 148 | + * @throws Mailcode_Exception |
|
| 149 | + * @return string The comparison string, e.g. "==", "!=", etc. |
|
| 150 | + */ |
|
| 151 | 151 | public function getComparator() : string |
| 152 | 152 | { |
| 153 | 153 | if($this->comparisonToken instanceof Mailcode_Parser_Statement_Tokenizer_Token_Operand) |
@@ -162,10 +162,10 @@ discard block |
||
| 162 | 162 | ); |
| 163 | 163 | } |
| 164 | 164 | |
| 165 | - /** |
|
| 166 | - * Retrieves the unquoted value |
|
| 167 | - * @return string |
|
| 168 | - */ |
|
| 165 | + /** |
|
| 166 | + * Retrieves the unquoted value |
|
| 167 | + * @return string |
|
| 168 | + */ |
|
| 169 | 169 | public function getValue() : string |
| 170 | 170 | { |
| 171 | 171 | if($this->valueToken instanceof Mailcode_Parser_Statement_Tokenizer_Type_Value) |
@@ -28,14 +28,14 @@ discard block |
||
| 28 | 28 | */ |
| 29 | 29 | protected $variableToken; |
| 30 | 30 | |
| 31 | - /** |
|
| 32 | - * @var Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral|NULL |
|
| 33 | - */ |
|
| 31 | + /** |
|
| 32 | + * @var Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral|NULL |
|
| 33 | + */ |
|
| 34 | 34 | protected $stringToken; |
| 35 | 35 | |
| 36 | - /** |
|
| 37 | - * @var boolean |
|
| 38 | - */ |
|
| 36 | + /** |
|
| 37 | + * @var boolean |
|
| 38 | + */ |
|
| 39 | 39 | protected $caseInsensitive = false; |
| 40 | 40 | |
| 41 | 41 | protected function getValidations() : array |
@@ -131,11 +131,11 @@ discard block |
||
| 131 | 131 | ); |
| 132 | 132 | } |
| 133 | 133 | |
| 134 | - /** |
|
| 135 | - * Retrieves the variable being compared. |
|
| 136 | - * |
|
| 137 | - * @return Mailcode_Variables_Variable |
|
| 138 | - */ |
|
| 134 | + /** |
|
| 135 | + * Retrieves the variable being compared. |
|
| 136 | + * |
|
| 137 | + * @return Mailcode_Variables_Variable |
|
| 138 | + */ |
|
| 139 | 139 | public function getVariable() : Mailcode_Variables_Variable |
| 140 | 140 | { |
| 141 | 141 | if($this->variableToken instanceof Mailcode_Parser_Statement_Tokenizer_Token_Variable) |
@@ -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(); |
@@ -169,16 +169,16 @@ discard block |
||
| 169 | 169 | return $this->makeSafePartial(); |
| 170 | 170 | } |
| 171 | 171 | |
| 172 | - /** |
|
| 173 | - * Like makeSafe(), but allows partial (invalid) commands: use this |
|
| 174 | - * if the subject string may contain only part of the whole set of |
|
| 175 | - * commands. |
|
| 176 | - * |
|
| 177 | - * Example: parsing a text with an opening if statement, without the |
|
| 178 | - * matching end statement. |
|
| 179 | - * |
|
| 180 | - * @return string |
|
| 181 | - */ |
|
| 172 | + /** |
|
| 173 | + * Like makeSafe(), but allows partial (invalid) commands: use this |
|
| 174 | + * if the subject string may contain only part of the whole set of |
|
| 175 | + * commands. |
|
| 176 | + * |
|
| 177 | + * Example: parsing a text with an opening if statement, without the |
|
| 178 | + * matching end statement. |
|
| 179 | + * |
|
| 180 | + * @return string |
|
| 181 | + */ |
|
| 182 | 182 | public function makeSafePartial() : string |
| 183 | 183 | { |
| 184 | 184 | $replaces = $this->getReplaces(); |
@@ -216,10 +216,10 @@ discard block |
||
| 216 | 216 | ); |
| 217 | 217 | } |
| 218 | 218 | |
| 219 | - /** |
|
| 220 | - * Enables the formatter that ensures that all commands that |
|
| 221 | - * @return Mailcode_Parser_Safeguard_Formatter_SingleLines |
|
| 222 | - */ |
|
| 219 | + /** |
|
| 220 | + * Enables the formatter that ensures that all commands that |
|
| 221 | + * @return Mailcode_Parser_Safeguard_Formatter_SingleLines |
|
| 222 | + */ |
|
| 223 | 223 | public function selectSingleLinesFormatter() : Mailcode_Parser_Safeguard_Formatter_SingleLines |
| 224 | 224 | { |
| 225 | 225 | $formatter = $this->selectFormatter('SingleLines'); |
@@ -239,13 +239,13 @@ discard block |
||
| 239 | 239 | ); |
| 240 | 240 | } |
| 241 | 241 | |
| 242 | - /** |
|
| 243 | - * Retrieves an associative array with pairs of |
|
| 244 | - * [placeholder string => replacement text]. |
|
| 245 | - * |
|
| 246 | - * @param bool $highlighted |
|
| 247 | - * @return string[]string |
|
| 248 | - */ |
|
| 242 | + /** |
|
| 243 | + * Retrieves an associative array with pairs of |
|
| 244 | + * [placeholder string => replacement text]. |
|
| 245 | + * |
|
| 246 | + * @param bool $highlighted |
|
| 247 | + * @return string[]string |
|
| 248 | + */ |
|
| 249 | 249 | protected function getReplaces(bool $highlighted=false) : array |
| 250 | 250 | { |
| 251 | 251 | $placeholders = $this->getPlaceholders(); |
@@ -272,12 +272,12 @@ discard block |
||
| 272 | 272 | } |
| 273 | 273 | |
| 274 | 274 | |
| 275 | - /** |
|
| 276 | - * Retrieves all placeholders that have to be added to |
|
| 277 | - * the subject text. |
|
| 278 | - * |
|
| 279 | - * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[] |
|
| 280 | - */ |
|
| 275 | + /** |
|
| 276 | + * Retrieves all placeholders that have to be added to |
|
| 277 | + * the subject text. |
|
| 278 | + * |
|
| 279 | + * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[] |
|
| 280 | + */ |
|
| 281 | 281 | public function getPlaceholders() |
| 282 | 282 | { |
| 283 | 283 | if(isset($this->placeholders)) |
@@ -329,17 +329,17 @@ discard block |
||
| 329 | 329 | return str_replace($placeholderStrings, array_values($replaces), $string); |
| 330 | 330 | } |
| 331 | 331 | |
| 332 | - /** |
|
| 333 | - * Makes the string whole again after transforming or filtering it, |
|
| 334 | - * by replacing the command placeholders with the original commands. |
|
| 335 | - * |
|
| 336 | - * @param string $string |
|
| 337 | - * @return string |
|
| 338 | - * @throws Mailcode_Exception |
|
| 339 | - * |
|
| 340 | - * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
| 341 | - * @see Mailcode_Parser_Safeguard::ERROR_COMMAND_PLACEHOLDER_MISSING |
|
| 342 | - */ |
|
| 332 | + /** |
|
| 333 | + * Makes the string whole again after transforming or filtering it, |
|
| 334 | + * by replacing the command placeholders with the original commands. |
|
| 335 | + * |
|
| 336 | + * @param string $string |
|
| 337 | + * @return string |
|
| 338 | + * @throws Mailcode_Exception |
|
| 339 | + * |
|
| 340 | + * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
| 341 | + * @see Mailcode_Parser_Safeguard::ERROR_COMMAND_PLACEHOLDER_MISSING |
|
| 342 | + */ |
|
| 343 | 343 | public function makeWhole(string $string) : string |
| 344 | 344 | { |
| 345 | 345 | return $this->restore( |
@@ -349,15 +349,15 @@ discard block |
||
| 349 | 349 | ); |
| 350 | 350 | } |
| 351 | 351 | |
| 352 | - /** |
|
| 353 | - * Like `makeWhole()`, but ignores missing command placeholders. |
|
| 354 | - * |
|
| 355 | - * @param string $string |
|
| 356 | - * @return string |
|
| 357 | - * @throws Mailcode_Exception |
|
| 358 | - * |
|
| 359 | - * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
| 360 | - */ |
|
| 352 | + /** |
|
| 353 | + * Like `makeWhole()`, but ignores missing command placeholders. |
|
| 354 | + * |
|
| 355 | + * @param string $string |
|
| 356 | + * @return string |
|
| 357 | + * @throws Mailcode_Exception |
|
| 358 | + * |
|
| 359 | + * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
| 360 | + */ |
|
| 361 | 361 | public function makeWholePartial(string $string) : string |
| 362 | 362 | { |
| 363 | 363 | return $this->restore( |
@@ -367,20 +367,20 @@ discard block |
||
| 367 | 367 | ); |
| 368 | 368 | } |
| 369 | 369 | |
| 370 | - /** |
|
| 371 | - * Like `makeWhole()`, but replaces the commands with a syntax |
|
| 372 | - * highlighted version, meant for human readable texts only. |
|
| 373 | - * |
|
| 374 | - * Note: the commands lose their functionality (They cannot be |
|
| 375 | - * parsed from that string again). |
|
| 376 | - * |
|
| 377 | - * @param string $string |
|
| 378 | - * @return string |
|
| 379 | - * @throws Mailcode_Exception |
|
| 380 | - * |
|
| 381 | - * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
| 382 | - * @see Mailcode_Parser_Safeguard::ERROR_COMMAND_PLACEHOLDER_MISSING |
|
| 383 | - */ |
|
| 370 | + /** |
|
| 371 | + * Like `makeWhole()`, but replaces the commands with a syntax |
|
| 372 | + * highlighted version, meant for human readable texts only. |
|
| 373 | + * |
|
| 374 | + * Note: the commands lose their functionality (They cannot be |
|
| 375 | + * parsed from that string again). |
|
| 376 | + * |
|
| 377 | + * @param string $string |
|
| 378 | + * @return string |
|
| 379 | + * @throws Mailcode_Exception |
|
| 380 | + * |
|
| 381 | + * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
| 382 | + * @see Mailcode_Parser_Safeguard::ERROR_COMMAND_PLACEHOLDER_MISSING |
|
| 383 | + */ |
|
| 384 | 384 | public function makeHighlighted(string $string) : string |
| 385 | 385 | { |
| 386 | 386 | return $this->restore( |
@@ -390,15 +390,15 @@ discard block |
||
| 390 | 390 | ); |
| 391 | 391 | } |
| 392 | 392 | |
| 393 | - /** |
|
| 394 | - * Like `makeHighlighted()`, but ignores missing command placeholders. |
|
| 395 | - * |
|
| 396 | - * @param string $string |
|
| 397 | - * @return string |
|
| 398 | - * @throws Mailcode_Exception |
|
| 399 | - * |
|
| 400 | - * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
| 401 | - */ |
|
| 393 | + /** |
|
| 394 | + * Like `makeHighlighted()`, but ignores missing command placeholders. |
|
| 395 | + * |
|
| 396 | + * @param string $string |
|
| 397 | + * @return string |
|
| 398 | + * @throws Mailcode_Exception |
|
| 399 | + * |
|
| 400 | + * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
| 401 | + */ |
|
| 402 | 402 | public function makeHighlightedPartial(string $string) : string |
| 403 | 403 | { |
| 404 | 404 | return $this->restore( |
@@ -408,11 +408,11 @@ discard block |
||
| 408 | 408 | ); |
| 409 | 409 | } |
| 410 | 410 | |
| 411 | - /** |
|
| 412 | - * Retrieves the commands collection contained in the string. |
|
| 413 | - * |
|
| 414 | - * @return Mailcode_Collection |
|
| 415 | - */ |
|
| 411 | + /** |
|
| 412 | + * Retrieves the commands collection contained in the string. |
|
| 413 | + * |
|
| 414 | + * @return Mailcode_Collection |
|
| 415 | + */ |
|
| 416 | 416 | public function getCollection() : Mailcode_Collection |
| 417 | 417 | { |
| 418 | 418 | if(isset($this->collection)) |
@@ -430,11 +430,11 @@ discard block |
||
| 430 | 430 | return $this->getCollection()->isValid(); |
| 431 | 431 | } |
| 432 | 432 | |
| 433 | - /** |
|
| 434 | - * @throws Mailcode_Exception |
|
| 435 | - * |
|
| 436 | - * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
| 437 | - */ |
|
| 433 | + /** |
|
| 434 | + * @throws Mailcode_Exception |
|
| 435 | + * |
|
| 436 | + * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
| 437 | + */ |
|
| 438 | 438 | protected function requireValidCollection() : void |
| 439 | 439 | { |
| 440 | 440 | if($this->getCollection()->isValid()) |
@@ -453,11 +453,11 @@ discard block |
||
| 453 | 453 | ); |
| 454 | 454 | } |
| 455 | 455 | |
| 456 | - /** |
|
| 457 | - * Retrieves a list of all placeholder IDs used in the text. |
|
| 458 | - * |
|
| 459 | - * @return string[] |
|
| 460 | - */ |
|
| 456 | + /** |
|
| 457 | + * Retrieves a list of all placeholder IDs used in the text. |
|
| 458 | + * |
|
| 459 | + * @return string[] |
|
| 460 | + */ |
|
| 461 | 461 | public function getPlaceholderStrings() : array |
| 462 | 462 | { |
| 463 | 463 | if(is_array($this->placeholderStrings)) |
@@ -484,13 +484,13 @@ discard block |
||
| 484 | 484 | return in_array($subject, $ids); |
| 485 | 485 | } |
| 486 | 486 | |
| 487 | - /** |
|
| 488 | - * Retrieves a placeholder instance by its ID. |
|
| 489 | - * |
|
| 490 | - * @param int $id |
|
| 491 | - * @throws Mailcode_Exception If the placeholder was not found. |
|
| 492 | - * @return Mailcode_Parser_Safeguard_Placeholder |
|
| 493 | - */ |
|
| 487 | + /** |
|
| 488 | + * Retrieves a placeholder instance by its ID. |
|
| 489 | + * |
|
| 490 | + * @param int $id |
|
| 491 | + * @throws Mailcode_Exception If the placeholder was not found. |
|
| 492 | + * @return Mailcode_Parser_Safeguard_Placeholder |
|
| 493 | + */ |
|
| 494 | 494 | public function getPlaceholderByID(int $id) : Mailcode_Parser_Safeguard_Placeholder |
| 495 | 495 | { |
| 496 | 496 | $placeholders = $this->getPlaceholders(); |
@@ -513,13 +513,13 @@ discard block |
||
| 513 | 513 | ); |
| 514 | 514 | } |
| 515 | 515 | |
| 516 | - /** |
|
| 517 | - * Retrieves a placeholder instance by its replacement text. |
|
| 518 | - * |
|
| 519 | - * @param string $string |
|
| 520 | - * @throws Mailcode_Exception |
|
| 521 | - * @return Mailcode_Parser_Safeguard_Placeholder |
|
| 522 | - */ |
|
| 516 | + /** |
|
| 517 | + * Retrieves a placeholder instance by its replacement text. |
|
| 518 | + * |
|
| 519 | + * @param string $string |
|
| 520 | + * @throws Mailcode_Exception |
|
| 521 | + * @return Mailcode_Parser_Safeguard_Placeholder |
|
| 522 | + */ |
|
| 523 | 523 | public function getPlaceholderByString(string $string) : Mailcode_Parser_Safeguard_Placeholder |
| 524 | 524 | { |
| 525 | 525 | $placeholders = $this->getPlaceholders(); |
@@ -23,17 +23,17 @@ discard block |
||
| 23 | 23 | const ERROR_INVALID_COMMAND_CREATED = 50001; |
| 24 | 24 | const ERROR_UNEXPECTED_COMMAND_TYPE = 50002; |
| 25 | 25 | |
| 26 | - /** |
|
| 27 | - * @var Mailcode_Factory_CommandSets |
|
| 28 | - */ |
|
| 26 | + /** |
|
| 27 | + * @var Mailcode_Factory_CommandSets |
|
| 28 | + */ |
|
| 29 | 29 | private static $commandSets; |
| 30 | 30 | |
| 31 | - /** |
|
| 32 | - * Creates a ShowVariable command. |
|
| 33 | - * |
|
| 34 | - * @param string $variableName A variable name, with or without the $ sign prepended. |
|
| 35 | - * @return Mailcode_Commands_Command_ShowVariable |
|
| 36 | - */ |
|
| 31 | + /** |
|
| 32 | + * Creates a ShowVariable command. |
|
| 33 | + * |
|
| 34 | + * @param string $variableName A variable name, with or without the $ sign prepended. |
|
| 35 | + * @return Mailcode_Commands_Command_ShowVariable |
|
| 36 | + */ |
|
| 37 | 37 | public static function showVar(string $variableName) : Mailcode_Commands_Command_ShowVariable |
| 38 | 38 | { |
| 39 | 39 | return self::$commandSets->show()->showVar($variableName); |
@@ -52,41 +52,41 @@ discard block |
||
| 52 | 52 | return self::$commandSets->show()->showDate($variableName, $formatString); |
| 53 | 53 | } |
| 54 | 54 | |
| 55 | - /** |
|
| 56 | - * Creates a ShowSnippet command. |
|
| 57 | - * |
|
| 58 | - * @param string $snippetName A snippet name, with or without the $ sign prepended. |
|
| 59 | - * @return Mailcode_Commands_Command_ShowSnippet |
|
| 60 | - */ |
|
| 55 | + /** |
|
| 56 | + * Creates a ShowSnippet command. |
|
| 57 | + * |
|
| 58 | + * @param string $snippetName A snippet name, with or without the $ sign prepended. |
|
| 59 | + * @return Mailcode_Commands_Command_ShowSnippet |
|
| 60 | + */ |
|
| 61 | 61 | public static function showSnippet(string $snippetName) : Mailcode_Commands_Command_ShowSnippet |
| 62 | 62 | { |
| 63 | 63 | return self::$commandSets->show()->showSnippet($snippetName); |
| 64 | 64 | } |
| 65 | 65 | |
| 66 | - /** |
|
| 67 | - * Creates a SetVariable command. |
|
| 68 | - * |
|
| 69 | - * @param string $variableName A variable name, with or without the $ sign prepended. |
|
| 70 | - * @param string $value |
|
| 71 | - * @param bool $quoteValue Whether to treat the value as a string literal, and add quotes to it. |
|
| 72 | - * @return Mailcode_Commands_Command_SetVariable |
|
| 73 | - * @throws Mailcode_Factory_Exception |
|
| 74 | - * |
|
| 75 | - * @see Mailcode_Factory::ERROR_INVALID_COMMAND_CREATED |
|
| 76 | - */ |
|
| 66 | + /** |
|
| 67 | + * Creates a SetVariable command. |
|
| 68 | + * |
|
| 69 | + * @param string $variableName A variable name, with or without the $ sign prepended. |
|
| 70 | + * @param string $value |
|
| 71 | + * @param bool $quoteValue Whether to treat the value as a string literal, and add quotes to it. |
|
| 72 | + * @return Mailcode_Commands_Command_SetVariable |
|
| 73 | + * @throws Mailcode_Factory_Exception |
|
| 74 | + * |
|
| 75 | + * @see Mailcode_Factory::ERROR_INVALID_COMMAND_CREATED |
|
| 76 | + */ |
|
| 77 | 77 | public static function setVar(string $variableName, string $value, bool $quoteValue=true) : Mailcode_Commands_Command_SetVariable |
| 78 | 78 | { |
| 79 | 79 | return self::$commandSets->set()->setVar($variableName, $value, $quoteValue); |
| 80 | 80 | } |
| 81 | 81 | |
| 82 | - /** |
|
| 83 | - * Like setVar(), but treats the value as a string literal |
|
| 84 | - * and automatically adds quotes to it. |
|
| 85 | - * |
|
| 86 | - * @param string $variableName |
|
| 87 | - * @param string $value |
|
| 88 | - * @return Mailcode_Commands_Command_SetVariable |
|
| 89 | - */ |
|
| 82 | + /** |
|
| 83 | + * Like setVar(), but treats the value as a string literal |
|
| 84 | + * and automatically adds quotes to it. |
|
| 85 | + * |
|
| 86 | + * @param string $variableName |
|
| 87 | + * @param string $value |
|
| 88 | + * @return Mailcode_Commands_Command_SetVariable |
|
| 89 | + */ |
|
| 90 | 90 | public static function setVarString(string $variableName, string $value) : Mailcode_Commands_Command_SetVariable |
| 91 | 91 | { |
| 92 | 92 | return self::$commandSets->set()->setVar($variableName, $value, true); |
@@ -207,34 +207,34 @@ discard block |
||
| 207 | 207 | return self::$commandSets->if()->ifNotEmpty($variable); |
| 208 | 208 | } |
| 209 | 209 | |
| 210 | - /** |
|
| 211 | - * Creates a renderer instance, which can be used to easily |
|
| 212 | - * create and convert commands to strings. |
|
| 213 | - * |
|
| 214 | - * @return Mailcode_Renderer |
|
| 215 | - */ |
|
| 210 | + /** |
|
| 211 | + * Creates a renderer instance, which can be used to easily |
|
| 212 | + * create and convert commands to strings. |
|
| 213 | + * |
|
| 214 | + * @return Mailcode_Renderer |
|
| 215 | + */ |
|
| 216 | 216 | public static function createRenderer() : Mailcode_Renderer |
| 217 | 217 | { |
| 218 | 218 | return new Mailcode_Renderer(); |
| 219 | 219 | } |
| 220 | 220 | |
| 221 | - /** |
|
| 222 | - * Creates a printer instance, which works like the renderer, |
|
| 223 | - * but outputs the generated strings to standard output. |
|
| 224 | - * |
|
| 225 | - * @return Mailcode_Printer |
|
| 226 | - */ |
|
| 221 | + /** |
|
| 222 | + * Creates a printer instance, which works like the renderer, |
|
| 223 | + * but outputs the generated strings to standard output. |
|
| 224 | + * |
|
| 225 | + * @return Mailcode_Printer |
|
| 226 | + */ |
|
| 227 | 227 | public static function createPrinter() : Mailcode_Printer |
| 228 | 228 | { |
| 229 | 229 | return new Mailcode_Printer(); |
| 230 | 230 | } |
| 231 | 231 | |
| 232 | - /** |
|
| 233 | - * Gets/creates the global instance of the date format info |
|
| 234 | - * class, used to handle date formatting aspects. |
|
| 235 | - * |
|
| 236 | - * @return Mailcode_Date_FormatInfo |
|
| 237 | - */ |
|
| 232 | + /** |
|
| 233 | + * Gets/creates the global instance of the date format info |
|
| 234 | + * class, used to handle date formatting aspects. |
|
| 235 | + * |
|
| 236 | + * @return Mailcode_Date_FormatInfo |
|
| 237 | + */ |
|
| 238 | 238 | public static function createDateInfo() : Mailcode_Date_FormatInfo |
| 239 | 239 | { |
| 240 | 240 | return Mailcode_Date_FormatInfo::getInstance(); |
@@ -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); |
@@ -23,9 +23,9 @@ discard block |
||
| 23 | 23 | */ |
| 24 | 24 | trait Mailcode_Traits_Commands_IfNotEmpty |
| 25 | 25 | { |
| 26 | - /** |
|
| 27 | - * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL |
|
| 28 | - */ |
|
| 26 | + /** |
|
| 27 | + * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL |
|
| 28 | + */ |
|
| 29 | 29 | protected $variableToken; |
| 30 | 30 | |
| 31 | 31 | protected function getValidations() : array |
@@ -53,11 +53,11 @@ discard block |
||
| 53 | 53 | ); |
| 54 | 54 | } |
| 55 | 55 | |
| 56 | - /** |
|
| 57 | - * Retrieves the variable being compared. |
|
| 58 | - * |
|
| 59 | - * @return Mailcode_Variables_Variable |
|
| 60 | - */ |
|
| 56 | + /** |
|
| 57 | + * Retrieves the variable being compared. |
|
| 58 | + * |
|
| 59 | + * @return Mailcode_Variables_Variable |
|
| 60 | + */ |
|
| 61 | 61 | public function getVariable() : Mailcode_Variables_Variable |
| 62 | 62 | { |
| 63 | 63 | if($this->variableToken instanceof Mailcode_Parser_Statement_Tokenizer_Token_Variable) |
@@ -23,9 +23,9 @@ discard block |
||
| 23 | 23 | */ |
| 24 | 24 | trait Mailcode_Traits_Commands_IfEmpty |
| 25 | 25 | { |
| 26 | - /** |
|
| 27 | - * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL |
|
| 28 | - */ |
|
| 26 | + /** |
|
| 27 | + * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL |
|
| 28 | + */ |
|
| 29 | 29 | protected $variableToken; |
| 30 | 30 | |
| 31 | 31 | protected function getValidations() : array |
@@ -53,11 +53,11 @@ discard block |
||
| 53 | 53 | ); |
| 54 | 54 | } |
| 55 | 55 | |
| 56 | - /** |
|
| 57 | - * Retrieves the variable being compared. |
|
| 58 | - * |
|
| 59 | - * @return Mailcode_Variables_Variable |
|
| 60 | - */ |
|
| 56 | + /** |
|
| 57 | + * Retrieves the variable being compared. |
|
| 58 | + * |
|
| 59 | + * @return Mailcode_Variables_Variable |
|
| 60 | + */ |
|
| 61 | 61 | public function getVariable() : Mailcode_Variables_Variable |
| 62 | 62 | { |
| 63 | 63 | if($this->variableToken instanceof Mailcode_Parser_Statement_Tokenizer_Token_Variable) |