@@ -31,27 +31,27 @@ discard block |
||
| 31 | 31 | public const VALIDATION_CANNOT_MIX_LOGIC_KEYWORDS = 60701; |
| 32 | 32 | public const VALIDATION_INVALID_SUB_COMMAND = 60702; |
| 33 | 33 | |
| 34 | - /** |
|
| 35 | - * @var string |
|
| 36 | - */ |
|
| 34 | + /** |
|
| 35 | + * @var string |
|
| 36 | + */ |
|
| 37 | 37 | private $paramsString; |
| 38 | 38 | |
| 39 | - /** |
|
| 40 | - * @var string[] |
|
| 41 | - */ |
|
| 39 | + /** |
|
| 40 | + * @var string[] |
|
| 41 | + */ |
|
| 42 | 42 | private $names = array( |
| 43 | 43 | 'and', |
| 44 | 44 | 'or' |
| 45 | 45 | ); |
| 46 | 46 | |
| 47 | - /** |
|
| 48 | - * @var Mailcode_Commands_LogicKeywords_Keyword[] |
|
| 49 | - */ |
|
| 47 | + /** |
|
| 48 | + * @var Mailcode_Commands_LogicKeywords_Keyword[] |
|
| 49 | + */ |
|
| 50 | 50 | private $keywords = array(); |
| 51 | 51 | |
| 52 | - /** |
|
| 53 | - * @var string |
|
| 54 | - */ |
|
| 52 | + /** |
|
| 53 | + * @var string |
|
| 54 | + */ |
|
| 55 | 55 | private $mainParams = ''; |
| 56 | 56 | |
| 57 | 57 | public function __construct(Mailcode_Commands_Command $command, string $paramsString) |
@@ -137,9 +137,9 @@ discard block |
||
| 137 | 137 | } |
| 138 | 138 | } |
| 139 | 139 | |
| 140 | - /** |
|
| 141 | - * @return string[] |
|
| 142 | - */ |
|
| 140 | + /** |
|
| 141 | + * @return string[] |
|
| 142 | + */ |
|
| 143 | 143 | private function detectParameters() : array |
| 144 | 144 | { |
| 145 | 145 | $params = $this->paramsString; |
@@ -157,13 +157,13 @@ discard block |
||
| 157 | 157 | return $stack; |
| 158 | 158 | } |
| 159 | 159 | |
| 160 | - /** |
|
| 161 | - * @param string $params |
|
| 162 | - * @param Mailcode_Commands_LogicKeywords_Keyword $keyword |
|
| 163 | - * @param string[] $stack |
|
| 164 | - * @throws Mailcode_Exception |
|
| 165 | - * @return string |
|
| 166 | - */ |
|
| 160 | + /** |
|
| 161 | + * @param string $params |
|
| 162 | + * @param Mailcode_Commands_LogicKeywords_Keyword $keyword |
|
| 163 | + * @param string[] $stack |
|
| 164 | + * @throws Mailcode_Exception |
|
| 165 | + * @return string |
|
| 166 | + */ |
|
| 167 | 167 | private function detectParamsKeyword(string $params, Mailcode_Commands_LogicKeywords_Keyword $keyword, array &$stack) : string |
| 168 | 168 | { |
| 169 | 169 | $search = $keyword->getMatchedString(); |
@@ -188,22 +188,22 @@ discard block |
||
| 188 | 188 | return $params; |
| 189 | 189 | } |
| 190 | 190 | |
| 191 | - /** |
|
| 192 | - * Extracts the parameters string to use for the |
|
| 193 | - * original command itself, omitting all the logic |
|
| 194 | - * keywords for the sub-commands. |
|
| 195 | - * |
|
| 196 | - * @return string |
|
| 197 | - */ |
|
| 191 | + /** |
|
| 192 | + * Extracts the parameters string to use for the |
|
| 193 | + * original command itself, omitting all the logic |
|
| 194 | + * keywords for the sub-commands. |
|
| 195 | + * |
|
| 196 | + * @return string |
|
| 197 | + */ |
|
| 198 | 198 | public function getMainParamsString() : string |
| 199 | 199 | { |
| 200 | 200 | return $this->mainParams; |
| 201 | 201 | } |
| 202 | 202 | |
| 203 | - /** |
|
| 204 | - * Retrieves the detected keyword names. |
|
| 205 | - * @return string[] |
|
| 206 | - */ |
|
| 203 | + /** |
|
| 204 | + * Retrieves the detected keyword names. |
|
| 205 | + * @return string[] |
|
| 206 | + */ |
|
| 207 | 207 | public function getDetectedNames() : array |
| 208 | 208 | { |
| 209 | 209 | $names = array(); |
@@ -221,23 +221,23 @@ discard block |
||
| 221 | 221 | return $names; |
| 222 | 222 | } |
| 223 | 223 | |
| 224 | - /** |
|
| 225 | - * Retrieves all keywords that were detected in the |
|
| 226 | - * command's parameters string, if any. |
|
| 227 | - * |
|
| 228 | - * @return Mailcode_Commands_LogicKeywords_Keyword[] |
|
| 229 | - */ |
|
| 224 | + /** |
|
| 225 | + * Retrieves all keywords that were detected in the |
|
| 226 | + * command's parameters string, if any. |
|
| 227 | + * |
|
| 228 | + * @return Mailcode_Commands_LogicKeywords_Keyword[] |
|
| 229 | + */ |
|
| 230 | 230 | public function getKeywords() : array |
| 231 | 231 | { |
| 232 | 232 | return $this->keywords; |
| 233 | 233 | } |
| 234 | 234 | |
| 235 | - /** |
|
| 236 | - * Detects any keyword statements in the parameters by keyword name. |
|
| 237 | - * |
|
| 238 | - * @param string $name |
|
| 239 | - * @return Mailcode_Commands_LogicKeywords_Keyword[] |
|
| 240 | - */ |
|
| 235 | + /** |
|
| 236 | + * Detects any keyword statements in the parameters by keyword name. |
|
| 237 | + * |
|
| 238 | + * @param string $name |
|
| 239 | + * @return Mailcode_Commands_LogicKeywords_Keyword[] |
|
| 240 | + */ |
|
| 241 | 241 | private function detectKeywords(string $name) : array |
| 242 | 242 | { |
| 243 | 243 | $regex = sprintf('/%1$s\s+([a-z\-0-9]+):|%1$s:/x', $name); |
@@ -71,9 +71,9 @@ discard block |
||
| 71 | 71 | |
| 72 | 72 | private function parse() : void |
| 73 | 73 | { |
| 74 | - foreach($this->names as $name) |
|
| 74 | + foreach ($this->names as $name) |
|
| 75 | 75 | { |
| 76 | - if(!stristr($this->paramsString, $name)) |
|
| 76 | + if (!stristr($this->paramsString, $name)) |
|
| 77 | 77 | { |
| 78 | 78 | continue; |
| 79 | 79 | } |
@@ -90,7 +90,7 @@ discard block |
||
| 90 | 90 | $names = $this->getDetectedNames(); |
| 91 | 91 | $amount = count($names); |
| 92 | 92 | |
| 93 | - if($amount > 1) |
|
| 93 | + if ($amount > 1) |
|
| 94 | 94 | { |
| 95 | 95 | $this->makeError( |
| 96 | 96 | t( |
@@ -110,7 +110,7 @@ discard block |
||
| 110 | 110 | |
| 111 | 111 | private function splitParams() : void |
| 112 | 112 | { |
| 113 | - if(empty($this->keywords)) |
|
| 113 | + if (empty($this->keywords)) |
|
| 114 | 114 | { |
| 115 | 115 | $this->mainParams = $this->paramsString; |
| 116 | 116 | |
@@ -119,13 +119,13 @@ discard block |
||
| 119 | 119 | |
| 120 | 120 | $params = $this->detectParameters(); |
| 121 | 121 | |
| 122 | - foreach($this->keywords as $keyword) |
|
| 122 | + foreach ($this->keywords as $keyword) |
|
| 123 | 123 | { |
| 124 | 124 | $kParams = (string)array_shift($params); |
| 125 | 125 | |
| 126 | 126 | $keyword->setParamsString($kParams); |
| 127 | 127 | |
| 128 | - if(!$keyword->isValid()) |
|
| 128 | + if (!$keyword->isValid()) |
|
| 129 | 129 | { |
| 130 | 130 | $this->makeError( |
| 131 | 131 | t('Error #%1$s:', $keyword->getCode()).' '.$keyword->getErrorMessage(), |
@@ -145,7 +145,7 @@ discard block |
||
| 145 | 145 | $params = $this->paramsString; |
| 146 | 146 | $stack = array(); |
| 147 | 147 | |
| 148 | - foreach($this->keywords as $keyword) |
|
| 148 | + foreach ($this->keywords as $keyword) |
|
| 149 | 149 | { |
| 150 | 150 | $params = $this->detectParamsKeyword($params, $keyword, $stack); |
| 151 | 151 | } |
@@ -169,7 +169,7 @@ discard block |
||
| 169 | 169 | $search = $keyword->getMatchedString(); |
| 170 | 170 | $pos = strpos($params, $search, 0); |
| 171 | 171 | |
| 172 | - if($pos === false) |
|
| 172 | + if ($pos === false) |
|
| 173 | 173 | { |
| 174 | 174 | throw new Mailcode_Exception( |
| 175 | 175 | 'Keyword matched string not found', |
@@ -181,7 +181,7 @@ discard block |
||
| 181 | 181 | $length = strlen($search); |
| 182 | 182 | |
| 183 | 183 | $store = substr($params, 0, $pos); |
| 184 | - $params = trim(substr($params, $pos+$length)); |
|
| 184 | + $params = trim(substr($params, $pos + $length)); |
|
| 185 | 185 | |
| 186 | 186 | $stack[] = $store; |
| 187 | 187 | |
@@ -208,11 +208,11 @@ discard block |
||
| 208 | 208 | { |
| 209 | 209 | $names = array(); |
| 210 | 210 | |
| 211 | - foreach($this->keywords as $keyword) |
|
| 211 | + foreach ($this->keywords as $keyword) |
|
| 212 | 212 | { |
| 213 | 213 | $name = $keyword->getName(); |
| 214 | 214 | |
| 215 | - if(!in_array($name, $names)) |
|
| 215 | + if (!in_array($name, $names)) |
|
| 216 | 216 | { |
| 217 | 217 | $names[] = $name; |
| 218 | 218 | } |
@@ -245,7 +245,7 @@ discard block |
||
| 245 | 245 | $matches = array(); |
| 246 | 246 | preg_match_all($regex, $this->paramsString, $matches, PREG_PATTERN_ORDER); |
| 247 | 247 | |
| 248 | - if(!isset($matches[0][0]) || empty($matches[0][0])) |
|
| 248 | + if (!isset($matches[0][0]) || empty($matches[0][0])) |
|
| 249 | 249 | { |
| 250 | 250 | return array(); |
| 251 | 251 | } |
@@ -253,7 +253,7 @@ discard block |
||
| 253 | 253 | $amount = count($matches[0]); |
| 254 | 254 | $result = array(); |
| 255 | 255 | |
| 256 | - for($i=0; $i < $amount; $i++) |
|
| 256 | + for ($i = 0; $i < $amount; $i++) |
|
| 257 | 257 | { |
| 258 | 258 | $result[] = $this->createKeyword( |
| 259 | 259 | $name, |
@@ -270,22 +270,22 @@ discard block |
||
| 270 | 270 | return !empty($this->keywords); |
| 271 | 271 | } |
| 272 | 272 | |
| 273 | - public function appendAND(string $paramsString, string $type='') : Mailcode_Commands_LogicKeywords_Keyword |
|
| 273 | + public function appendAND(string $paramsString, string $type = '') : Mailcode_Commands_LogicKeywords_Keyword |
|
| 274 | 274 | { |
| 275 | 275 | return $this->appendKeyword('and', $paramsString, $type); |
| 276 | 276 | } |
| 277 | 277 | |
| 278 | - public function appendOR(string $paramsString, string $type='') : Mailcode_Commands_LogicKeywords_Keyword |
|
| 278 | + public function appendOR(string $paramsString, string $type = '') : Mailcode_Commands_LogicKeywords_Keyword |
|
| 279 | 279 | { |
| 280 | 280 | return $this->appendKeyword('or', $paramsString, $type); |
| 281 | 281 | } |
| 282 | 282 | |
| 283 | - public function appendKeyword(string $name, string $paramsString, string $type='') : Mailcode_Commands_LogicKeywords_Keyword |
|
| 283 | + public function appendKeyword(string $name, string $paramsString, string $type = '') : Mailcode_Commands_LogicKeywords_Keyword |
|
| 284 | 284 | { |
| 285 | 285 | $keyword = $this->createKeyword($name, $type); |
| 286 | 286 | $keyword->setParamsString($paramsString); |
| 287 | 287 | |
| 288 | - if(!$keyword->isValid()) |
|
| 288 | + if (!$keyword->isValid()) |
|
| 289 | 289 | { |
| 290 | 290 | throw new Mailcode_Exception( |
| 291 | 291 | 'Cannot append invalid logic keyword', |
@@ -306,13 +306,13 @@ discard block |
||
| 306 | 306 | return $keyword; |
| 307 | 307 | } |
| 308 | 308 | |
| 309 | - private function createKeyword(string $name, string $type='', string $matchedString='') : Mailcode_Commands_LogicKeywords_Keyword |
|
| 309 | + private function createKeyword(string $name, string $type = '', string $matchedString = '') : Mailcode_Commands_LogicKeywords_Keyword |
|
| 310 | 310 | { |
| 311 | - if(empty($matchedString)) |
|
| 311 | + if (empty($matchedString)) |
|
| 312 | 312 | { |
| 313 | 313 | $matchedString = $name; |
| 314 | 314 | |
| 315 | - if(!empty($type)) |
|
| 315 | + if (!empty($type)) |
|
| 316 | 316 | { |
| 317 | 317 | $matchedString .= ' '.$type; |
| 318 | 318 | } |
@@ -26,41 +26,41 @@ discard block |
||
| 26 | 26 | */ |
| 27 | 27 | class Mailcode |
| 28 | 28 | { |
| 29 | - /** |
|
| 30 | - * @var Mailcode_Parser|NULL |
|
| 31 | - */ |
|
| 29 | + /** |
|
| 30 | + * @var Mailcode_Parser|NULL |
|
| 31 | + */ |
|
| 32 | 32 | protected $parser = null; |
| 33 | 33 | |
| 34 | - /** |
|
| 35 | - * @var Mailcode_Commands|NULL |
|
| 36 | - */ |
|
| 34 | + /** |
|
| 35 | + * @var Mailcode_Commands|NULL |
|
| 36 | + */ |
|
| 37 | 37 | protected $commands = null; |
| 38 | 38 | |
| 39 | - /** |
|
| 40 | - * @var Mailcode_Variables|NULL |
|
| 41 | - */ |
|
| 39 | + /** |
|
| 40 | + * @var Mailcode_Variables|NULL |
|
| 41 | + */ |
|
| 42 | 42 | protected $variables = null; |
| 43 | 43 | |
| 44 | - /** |
|
| 45 | - * @var Mailcode_Translator|NULL |
|
| 46 | - */ |
|
| 44 | + /** |
|
| 45 | + * @var Mailcode_Translator|NULL |
|
| 46 | + */ |
|
| 47 | 47 | protected $translator = null; |
| 48 | 48 | |
| 49 | - /** |
|
| 50 | - * Creates a new mailcode instance. |
|
| 51 | - * @return Mailcode |
|
| 52 | - */ |
|
| 49 | + /** |
|
| 50 | + * Creates a new mailcode instance. |
|
| 51 | + * @return Mailcode |
|
| 52 | + */ |
|
| 53 | 53 | public static function create() : Mailcode |
| 54 | 54 | { |
| 55 | 55 | return new Mailcode(); |
| 56 | 56 | } |
| 57 | 57 | |
| 58 | - /** |
|
| 59 | - * Parses the string to detect all commands contained within. |
|
| 60 | - * |
|
| 61 | - * @param string $string |
|
| 62 | - * @return Mailcode_Collection |
|
| 63 | - */ |
|
| 58 | + /** |
|
| 59 | + * Parses the string to detect all commands contained within. |
|
| 60 | + * |
|
| 61 | + * @param string $string |
|
| 62 | + * @return Mailcode_Collection |
|
| 63 | + */ |
|
| 64 | 64 | public function parseString(string $string) : Mailcode_Collection |
| 65 | 65 | { |
| 66 | 66 | return $this->getParser() |
@@ -68,11 +68,11 @@ discard block |
||
| 68 | 68 | ->getCollection(); |
| 69 | 69 | } |
| 70 | 70 | |
| 71 | - /** |
|
| 72 | - * Retrieves the string parser instance used to detect commands. |
|
| 73 | - * |
|
| 74 | - * @return Mailcode_Parser |
|
| 75 | - */ |
|
| 71 | + /** |
|
| 72 | + * Retrieves the string parser instance used to detect commands. |
|
| 73 | + * |
|
| 74 | + * @return Mailcode_Parser |
|
| 75 | + */ |
|
| 76 | 76 | public function getParser() : Mailcode_Parser |
| 77 | 77 | { |
| 78 | 78 | if(!isset($this->parser)) |
@@ -83,12 +83,12 @@ discard block |
||
| 83 | 83 | return $this->parser; |
| 84 | 84 | } |
| 85 | 85 | |
| 86 | - /** |
|
| 87 | - * Retrieves the commands collection, which is used to |
|
| 88 | - * access information on the available commands. |
|
| 89 | - * |
|
| 90 | - * @return Mailcode_Commands |
|
| 91 | - */ |
|
| 86 | + /** |
|
| 87 | + * Retrieves the commands collection, which is used to |
|
| 88 | + * access information on the available commands. |
|
| 89 | + * |
|
| 90 | + * @return Mailcode_Commands |
|
| 91 | + */ |
|
| 92 | 92 | public function getCommands() : Mailcode_Commands |
| 93 | 93 | { |
| 94 | 94 | if(!isset($this->commands)) |
@@ -131,12 +131,12 @@ discard block |
||
| 131 | 131 | return $this->variables; |
| 132 | 132 | } |
| 133 | 133 | |
| 134 | - /** |
|
| 135 | - * Creates the translator, which can be used to convert commands |
|
| 136 | - * to another supported syntax. |
|
| 137 | - * |
|
| 138 | - * @return Mailcode_Translator |
|
| 139 | - */ |
|
| 134 | + /** |
|
| 135 | + * Creates the translator, which can be used to convert commands |
|
| 136 | + * to another supported syntax. |
|
| 137 | + * |
|
| 138 | + * @return Mailcode_Translator |
|
| 139 | + */ |
|
| 140 | 140 | public function createTranslator() : Mailcode_Translator |
| 141 | 141 | { |
| 142 | 142 | if(!isset($this->translator)) |
@@ -147,12 +147,12 @@ discard block |
||
| 147 | 147 | return $this->translator; |
| 148 | 148 | } |
| 149 | 149 | |
| 150 | - /** |
|
| 151 | - * Creates the styler, which can be used to retrieve the |
|
| 152 | - * CSS required to style the highlighted commands in HTML. |
|
| 153 | - * |
|
| 154 | - * @return Mailcode_Styler |
|
| 155 | - */ |
|
| 150 | + /** |
|
| 151 | + * Creates the styler, which can be used to retrieve the |
|
| 152 | + * CSS required to style the highlighted commands in HTML. |
|
| 153 | + * |
|
| 154 | + * @return Mailcode_Styler |
|
| 155 | + */ |
|
| 156 | 156 | public function createStyler() : Mailcode_Styler |
| 157 | 157 | { |
| 158 | 158 | return new Mailcode_Styler(); |
@@ -77,7 +77,7 @@ discard block |
||
| 77 | 77 | */ |
| 78 | 78 | public function getParser() : Mailcode_Parser |
| 79 | 79 | { |
| 80 | - if(!isset($this->parser)) |
|
| 80 | + if (!isset($this->parser)) |
|
| 81 | 81 | { |
| 82 | 82 | $this->parser = new Mailcode_Parser($this); |
| 83 | 83 | } |
@@ -93,7 +93,7 @@ discard block |
||
| 93 | 93 | */ |
| 94 | 94 | public function getCommands() : Mailcode_Commands |
| 95 | 95 | { |
| 96 | - if(!isset($this->commands)) |
|
| 96 | + if (!isset($this->commands)) |
|
| 97 | 97 | { |
| 98 | 98 | $this->commands = new Mailcode_Commands(); |
| 99 | 99 | } |
@@ -118,14 +118,14 @@ discard block |
||
| 118 | 118 | * @param Mailcode_Commands_Command|null $sourceCommand |
| 119 | 119 | * @return Mailcode_Variables_Collection_Regular |
| 120 | 120 | */ |
| 121 | - public function findVariables(string $subject, ?Mailcode_Commands_Command $sourceCommand=null) : Mailcode_Variables_Collection_Regular |
|
| 121 | + public function findVariables(string $subject, ?Mailcode_Commands_Command $sourceCommand = null) : Mailcode_Variables_Collection_Regular |
|
| 122 | 122 | { |
| 123 | 123 | return $this->createVariables()->parseString($subject, $sourceCommand); |
| 124 | 124 | } |
| 125 | 125 | |
| 126 | 126 | public function createVariables() : Mailcode_Variables |
| 127 | 127 | { |
| 128 | - if(!isset($this->variables)) |
|
| 128 | + if (!isset($this->variables)) |
|
| 129 | 129 | { |
| 130 | 130 | $this->variables = new Mailcode_Variables(); |
| 131 | 131 | } |
@@ -141,7 +141,7 @@ discard block |
||
| 141 | 141 | */ |
| 142 | 142 | public function createTranslator() : Mailcode_Translator |
| 143 | 143 | { |
| 144 | - if(!isset($this->translator)) |
|
| 144 | + if (!isset($this->translator)) |
|
| 145 | 145 | { |
| 146 | 146 | $this->translator = new Mailcode_Translator(); |
| 147 | 147 | } |
@@ -189,7 +189,7 @@ discard block |
||
| 189 | 189 | return self::$logger; |
| 190 | 190 | } |
| 191 | 191 | |
| 192 | - public static function setDebugging(bool $enabled=true) : void |
|
| 192 | + public static function setDebugging(bool $enabled = true) : void |
|
| 193 | 193 | { |
| 194 | 194 | self::$debug = $enabled; |
| 195 | 195 | } |
@@ -204,9 +204,9 @@ discard block |
||
| 204 | 204 | * @param array<string|int,mixed> $context |
| 205 | 205 | * @return void |
| 206 | 206 | */ |
| 207 | - public static function debug(string $message, array $context=array()) : void |
|
| 207 | + public static function debug(string $message, array $context = array()) : void |
|
| 208 | 208 | { |
| 209 | - if(self::$debug && isset(self::$logger)) |
|
| 209 | + if (self::$debug && isset(self::$logger)) |
|
| 210 | 210 | { |
| 211 | 211 | self::$logger->debug($message, $context); |
| 212 | 212 | } |
@@ -26,7 +26,7 @@ discard block |
||
| 26 | 26 | |
| 27 | 27 | public function add(Mailcode_Variables_Variable $variable) : Mailcode_Variables_Collection |
| 28 | 28 | { |
| 29 | - if($variable->isValid()) |
|
| 29 | + if ($variable->isValid()) |
|
| 30 | 30 | { |
| 31 | 31 | return $this; |
| 32 | 32 | } |
@@ -38,7 +38,7 @@ discard block |
||
| 38 | 38 | { |
| 39 | 39 | $first = $this->getFirst(); |
| 40 | 40 | |
| 41 | - if($first) |
|
| 41 | + if ($first) |
|
| 42 | 42 | { |
| 43 | 43 | return $first->getValidationResult(); |
| 44 | 44 | } |
@@ -32,34 +32,34 @@ |
||
| 32 | 32 | public const VALIDATION_ERROR_PATH_UNDERSCORE = 48203; |
| 33 | 33 | public const VALIDATION_ERROR_NAME_UNDERSCORE = 48204; |
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * @var string |
|
| 37 | - */ |
|
| 35 | + /** |
|
| 36 | + * @var string |
|
| 37 | + */ |
|
| 38 | 38 | protected string $path; |
| 39 | 39 | |
| 40 | - /** |
|
| 41 | - * @var string |
|
| 42 | - */ |
|
| 40 | + /** |
|
| 41 | + * @var string |
|
| 42 | + */ |
|
| 43 | 43 | protected string $name; |
| 44 | 44 | |
| 45 | - /** |
|
| 46 | - * @var string |
|
| 47 | - */ |
|
| 45 | + /** |
|
| 46 | + * @var string |
|
| 47 | + */ |
|
| 48 | 48 | protected string $matchedText; |
| 49 | 49 | |
| 50 | - /** |
|
| 51 | - * @var string |
|
| 52 | - */ |
|
| 50 | + /** |
|
| 51 | + * @var string |
|
| 52 | + */ |
|
| 53 | 53 | protected string $hash = ''; |
| 54 | 54 | |
| 55 | - /** |
|
| 56 | - * @var OperationResult|NULL |
|
| 57 | - */ |
|
| 55 | + /** |
|
| 56 | + * @var OperationResult|NULL |
|
| 57 | + */ |
|
| 58 | 58 | protected ?OperationResult $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', |
@@ -72,7 +72,7 @@ discard block |
||
| 72 | 72 | */ |
| 73 | 73 | private ?Mailcode_Commands_Command $command; |
| 74 | 74 | |
| 75 | - public function __construct(string $path, string $name, string $matchedText, ?Mailcode_Commands_Command $sourceCommand=null) |
|
| 75 | + public function __construct(string $path, string $name, string $matchedText, ?Mailcode_Commands_Command $sourceCommand = null) |
|
| 76 | 76 | { |
| 77 | 77 | $this->path = $path; |
| 78 | 78 | $this->name = $name; |
@@ -95,7 +95,7 @@ discard block |
||
| 95 | 95 | |
| 96 | 96 | public function getFullName() : string |
| 97 | 97 | { |
| 98 | - if(empty($this->path)) |
|
| 98 | + if (empty($this->path)) |
|
| 99 | 99 | { |
| 100 | 100 | return dollarize($this->name); |
| 101 | 101 | } |
@@ -113,7 +113,7 @@ discard block |
||
| 113 | 113 | */ |
| 114 | 114 | public function getUniqueName() : string |
| 115 | 115 | { |
| 116 | - if(isset($this->command)) |
|
| 116 | + if (isset($this->command)) |
|
| 117 | 117 | { |
| 118 | 118 | return $this->getFullName().'/'.$this->command->getHash(); |
| 119 | 119 | } |
@@ -138,7 +138,7 @@ discard block |
||
| 138 | 138 | |
| 139 | 139 | public function getHash() : string |
| 140 | 140 | { |
| 141 | - if(empty($this->hash)) |
|
| 141 | + if (empty($this->hash)) |
|
| 142 | 142 | { |
| 143 | 143 | $this->hash = md5($this->matchedText); |
| 144 | 144 | } |
@@ -157,7 +157,7 @@ discard block |
||
| 157 | 157 | */ |
| 158 | 158 | public function getValidationResult() : OperationResult |
| 159 | 159 | { |
| 160 | - if(isset($this->validationResult)) |
|
| 160 | + if (isset($this->validationResult)) |
|
| 161 | 161 | { |
| 162 | 162 | return $this->validationResult; |
| 163 | 163 | } |
@@ -171,11 +171,11 @@ discard block |
||
| 171 | 171 | |
| 172 | 172 | protected function validate(OperationResult $result) : void |
| 173 | 173 | { |
| 174 | - foreach($this->validations as $validation) |
|
| 174 | + foreach ($this->validations as $validation) |
|
| 175 | 175 | { |
| 176 | 176 | $method = 'validate_'.$validation; |
| 177 | 177 | |
| 178 | - if(!method_exists($this, $method)) |
|
| 178 | + if (!method_exists($this, $method)) |
|
| 179 | 179 | { |
| 180 | 180 | throw new Mailcode_Exception( |
| 181 | 181 | 'Unknown validation method', |
@@ -220,7 +220,7 @@ discard block |
||
| 220 | 220 | |
| 221 | 221 | protected function validateNumber(string $value, int $errorCode) : void |
| 222 | 222 | { |
| 223 | - if(!is_numeric(substr($value, 0, 1))) |
|
| 223 | + if (!is_numeric(substr($value, 0, 1))) |
|
| 224 | 224 | { |
| 225 | 225 | return; |
| 226 | 226 | } |
@@ -238,7 +238,7 @@ discard block |
||
| 238 | 238 | protected function validateUnderscore(string $value, int $errorCode) : void |
| 239 | 239 | { |
| 240 | 240 | // allow empty paths |
| 241 | - if(empty($value)) |
|
| 241 | + if (empty($value)) |
|
| 242 | 242 | { |
| 243 | 243 | return; |
| 244 | 244 | } |
@@ -246,7 +246,7 @@ discard block |
||
| 246 | 246 | $length = strlen($value); |
| 247 | 247 | |
| 248 | 248 | // trimming underscores does not change the length: no underscores at start or end of string. |
| 249 | - if(strlen(trim($value, '_')) === $length) |
|
| 249 | + if (strlen(trim($value, '_')) === $length) |
|
| 250 | 250 | { |
| 251 | 251 | return; |
| 252 | 252 | } |
@@ -26,24 +26,24 @@ discard block |
||
| 26 | 26 | public const VALIDATION_EMPTY = 48801; |
| 27 | 27 | public const VALIDATION_UNQUOTED_STRING_LITERALS = 48802; |
| 28 | 28 | |
| 29 | - /** |
|
| 30 | - * @var string |
|
| 31 | - */ |
|
| 29 | + /** |
|
| 30 | + * @var string |
|
| 31 | + */ |
|
| 32 | 32 | protected string $statement; |
| 33 | 33 | |
| 34 | - /** |
|
| 35 | - * @var OperationResult |
|
| 36 | - */ |
|
| 34 | + /** |
|
| 35 | + * @var OperationResult |
|
| 36 | + */ |
|
| 37 | 37 | protected OperationResult $result; |
| 38 | 38 | |
| 39 | - /** |
|
| 40 | - * @var Mailcode_Parser_Statement_Tokenizer |
|
| 41 | - */ |
|
| 39 | + /** |
|
| 40 | + * @var Mailcode_Parser_Statement_Tokenizer |
|
| 41 | + */ |
|
| 42 | 42 | protected Mailcode_Parser_Statement_Tokenizer $tokenizer; |
| 43 | 43 | |
| 44 | - /** |
|
| 45 | - * @var Mailcode_Parser_Statement_Info|NULL |
|
| 46 | - */ |
|
| 44 | + /** |
|
| 45 | + * @var Mailcode_Parser_Statement_Info|NULL |
|
| 46 | + */ |
|
| 47 | 47 | protected ?Mailcode_Parser_Statement_Info $info = null; |
| 48 | 48 | |
| 49 | 49 | /** |
@@ -138,7 +138,7 @@ discard block |
||
| 138 | 138 | if($unknown) |
| 139 | 139 | { |
| 140 | 140 | $this->result->makeError( |
| 141 | - t('Unquoted string literal found:').' ('.htmlspecialchars($unknown->getMatchedText()).')', |
|
| 141 | + t('Unquoted string literal found:').' ('.htmlspecialchars($unknown->getMatchedText()).')', |
|
| 142 | 142 | self::VALIDATION_UNQUOTED_STRING_LITERALS |
| 143 | 143 | ); |
| 144 | 144 | } |
@@ -56,7 +56,7 @@ discard block |
||
| 56 | 56 | */ |
| 57 | 57 | private ?Mailcode_Commands_Command $sourceCommand = null; |
| 58 | 58 | |
| 59 | - public function __construct(string $statement, bool $freeform=false, ?Mailcode_Commands_Command $sourceCommand=null) |
|
| 59 | + public function __construct(string $statement, bool $freeform = false, ?Mailcode_Commands_Command $sourceCommand = null) |
|
| 60 | 60 | { |
| 61 | 61 | $this->sourceCommand = $sourceCommand; |
| 62 | 62 | $this->statement = $this->prepareStatement($statement); |
@@ -106,7 +106,7 @@ discard block |
||
| 106 | 106 | |
| 107 | 107 | public function getInfo() : Mailcode_Parser_Statement_Info |
| 108 | 108 | { |
| 109 | - if($this->info instanceof Mailcode_Parser_Statement_Info) |
|
| 109 | + if ($this->info instanceof Mailcode_Parser_Statement_Info) |
|
| 110 | 110 | { |
| 111 | 111 | return $this->info; |
| 112 | 112 | } |
@@ -118,12 +118,12 @@ discard block |
||
| 118 | 118 | |
| 119 | 119 | protected function validate() : void |
| 120 | 120 | { |
| 121 | - if($this->freeform) |
|
| 121 | + if ($this->freeform) |
|
| 122 | 122 | { |
| 123 | 123 | return; |
| 124 | 124 | } |
| 125 | 125 | |
| 126 | - if(!$this->tokenizer->hasTokens()) |
|
| 126 | + if (!$this->tokenizer->hasTokens()) |
|
| 127 | 127 | { |
| 128 | 128 | $this->result->makeError( |
| 129 | 129 | t('Empty statement'), |
@@ -135,7 +135,7 @@ discard block |
||
| 135 | 135 | |
| 136 | 136 | $unknown = $this->tokenizer->getFirstUnknown(); |
| 137 | 137 | |
| 138 | - if($unknown) |
|
| 138 | + if ($unknown) |
|
| 139 | 139 | { |
| 140 | 140 | $this->result->makeError( |
| 141 | 141 | t('Unquoted string literal found:').' ('.htmlspecialchars($unknown->getMatchedText()).')', |
@@ -139,11 +139,11 @@ |
||
| 139 | 139 | $commands = $parser->getCommands(); |
| 140 | 140 | $content = $this->getContent(); |
| 141 | 141 | |
| 142 | - foreach($commands as $command) |
|
| 142 | + foreach ($commands as $command) |
|
| 143 | 143 | { |
| 144 | 144 | $string = $command->getOpeningText(); |
| 145 | 145 | |
| 146 | - if(strpos($content, $string) !== false) |
|
| 146 | + if (strpos($content, $string) !== false) |
|
| 147 | 147 | { |
| 148 | 148 | $this->addEscapeError($command, $collection); |
| 149 | 149 | return false; |
@@ -39,7 +39,7 @@ discard block |
||
| 39 | 39 | */ |
| 40 | 40 | public function getByIndex(int $index) : Mailcode_Parser_Safeguard_Placeholder |
| 41 | 41 | { |
| 42 | - if(isset($this->placeholders[$index])) |
|
| 42 | + if (isset($this->placeholders[$index])) |
|
| 43 | 43 | { |
| 44 | 44 | return $this->placeholders[$index]; |
| 45 | 45 | } |
@@ -53,9 +53,9 @@ discard block |
||
| 53 | 53 | |
| 54 | 54 | public function getByCommand(Mailcode_Commands_Command $command) : Mailcode_Parser_Safeguard_Placeholder |
| 55 | 55 | { |
| 56 | - foreach($this->placeholders as $placeholder) |
|
| 56 | + foreach ($this->placeholders as $placeholder) |
|
| 57 | 57 | { |
| 58 | - if($placeholder->getCommand() === $command) |
|
| 58 | + if ($placeholder->getCommand() === $command) |
|
| 59 | 59 | { |
| 60 | 60 | return $placeholder; |
| 61 | 61 | } |
@@ -77,9 +77,9 @@ discard block |
||
| 77 | 77 | */ |
| 78 | 78 | public function getByID(int $id) : Mailcode_Parser_Safeguard_Placeholder |
| 79 | 79 | { |
| 80 | - foreach($this->placeholders as $placeholder) |
|
| 80 | + foreach ($this->placeholders as $placeholder) |
|
| 81 | 81 | { |
| 82 | - if($placeholder->getID() === $id) |
|
| 82 | + if ($placeholder->getID() === $id) |
|
| 83 | 83 | { |
| 84 | 84 | return $placeholder; |
| 85 | 85 | } |
@@ -104,9 +104,9 @@ discard block |
||
| 104 | 104 | */ |
| 105 | 105 | public function getByString(string $string) : Mailcode_Parser_Safeguard_Placeholder |
| 106 | 106 | { |
| 107 | - foreach($this->placeholders as $placeholder) |
|
| 107 | + foreach ($this->placeholders as $placeholder) |
|
| 108 | 108 | { |
| 109 | - if($placeholder->getReplacementText() === $string) |
|
| 109 | + if ($placeholder->getReplacementText() === $string) |
|
| 110 | 110 | { |
| 111 | 111 | return $placeholder; |
| 112 | 112 | } |
@@ -129,14 +129,14 @@ discard block |
||
| 129 | 129 | */ |
| 130 | 130 | public function getStrings() : array |
| 131 | 131 | { |
| 132 | - if(is_array($this->placeholderStrings)) |
|
| 132 | + if (is_array($this->placeholderStrings)) |
|
| 133 | 133 | { |
| 134 | 134 | return $this->placeholderStrings; |
| 135 | 135 | } |
| 136 | 136 | |
| 137 | 137 | $this->placeholderStrings = array(); |
| 138 | 138 | |
| 139 | - foreach($this->placeholders as $placeholder) |
|
| 139 | + foreach ($this->placeholders as $placeholder) |
|
| 140 | 140 | { |
| 141 | 141 | $this->placeholderStrings[] = $placeholder->getReplacementText(); |
| 142 | 142 | } |
@@ -35,14 +35,14 @@ |
||
| 35 | 35 | */ |
| 36 | 36 | private ?Mailcode_Factory_CommandSets_Set_Misc $misc = null; |
| 37 | 37 | |
| 38 | - /** |
|
| 39 | - * @var Mailcode_Factory_CommandSets_Set_Set|NULL |
|
| 40 | - */ |
|
| 38 | + /** |
|
| 39 | + * @var Mailcode_Factory_CommandSets_Set_Set|NULL |
|
| 40 | + */ |
|
| 41 | 41 | private ?Mailcode_Factory_CommandSets_Set_Set $set = null; |
| 42 | 42 | |
| 43 | - /** |
|
| 44 | - * @var Mailcode_Factory_CommandSets_Set_ElseIf|NULL |
|
| 45 | - */ |
|
| 43 | + /** |
|
| 44 | + * @var Mailcode_Factory_CommandSets_Set_ElseIf|NULL |
|
| 45 | + */ |
|
| 46 | 46 | private ?Mailcode_Factory_CommandSets_Set_ElseIf $elseIf = null; |
| 47 | 47 | |
| 48 | 48 | public function if() : Mailcode_Factory_CommandSets_Set_If |
@@ -45,9 +45,9 @@ discard block |
||
| 45 | 45 | */ |
| 46 | 46 | private ?Mailcode_Factory_CommandSets_Set_ElseIf $elseIf = null; |
| 47 | 47 | |
| 48 | - public function if() : Mailcode_Factory_CommandSets_Set_If |
|
| 48 | + public function if () : Mailcode_Factory_CommandSets_Set_If |
|
| 49 | 49 | { |
| 50 | - if(!isset($this->if)) |
|
| 50 | + if (!isset($this->if)) |
|
| 51 | 51 | { |
| 52 | 52 | $this->if = new Mailcode_Factory_CommandSets_Set_If(); |
| 53 | 53 | } |
@@ -55,9 +55,9 @@ discard block |
||
| 55 | 55 | return $this->if; |
| 56 | 56 | } |
| 57 | 57 | |
| 58 | - public function elseIf() : Mailcode_Factory_CommandSets_Set_ElseIf |
|
| 58 | + public function elseIf () : Mailcode_Factory_CommandSets_Set_ElseIf |
|
| 59 | 59 | { |
| 60 | - if(!isset($this->elseIf)) |
|
| 60 | + if (!isset($this->elseIf)) |
|
| 61 | 61 | { |
| 62 | 62 | $this->elseIf = new Mailcode_Factory_CommandSets_Set_ElseIf(); |
| 63 | 63 | } |
@@ -67,7 +67,7 @@ discard block |
||
| 67 | 67 | |
| 68 | 68 | public function show() : Mailcode_Factory_CommandSets_Set_Show |
| 69 | 69 | { |
| 70 | - if(!isset($this->show)) |
|
| 70 | + if (!isset($this->show)) |
|
| 71 | 71 | { |
| 72 | 72 | $this->show = new Mailcode_Factory_CommandSets_Set_Show(); |
| 73 | 73 | } |
@@ -77,7 +77,7 @@ discard block |
||
| 77 | 77 | |
| 78 | 78 | public function misc() : Mailcode_Factory_CommandSets_Set_Misc |
| 79 | 79 | { |
| 80 | - if(!isset($this->misc)) |
|
| 80 | + if (!isset($this->misc)) |
|
| 81 | 81 | { |
| 82 | 82 | $this->misc = new Mailcode_Factory_CommandSets_Set_Misc(); |
| 83 | 83 | } |
@@ -87,7 +87,7 @@ discard block |
||
| 87 | 87 | |
| 88 | 88 | public function set() : Mailcode_Factory_CommandSets_Set_Set |
| 89 | 89 | { |
| 90 | - if(!isset($this->set)) |
|
| 90 | + if (!isset($this->set)) |
|
| 91 | 91 | { |
| 92 | 92 | $this->set = new Mailcode_Factory_CommandSets_Set_Set(); |
| 93 | 93 | } |
@@ -38,9 +38,9 @@ discard block |
||
| 38 | 38 | |
| 39 | 39 | $keywords = $this->params->getInfo()->getKeywords(); |
| 40 | 40 | |
| 41 | - foreach($keywords as $keyword) |
|
| 41 | + foreach ($keywords as $keyword) |
|
| 42 | 42 | { |
| 43 | - if($keyword->isNoHTML()) |
|
| 43 | + if ($keyword->isNoHTML()) |
|
| 44 | 44 | { |
| 45 | 45 | $this->noHTMLToken = $keyword; |
| 46 | 46 | break; |
@@ -55,7 +55,7 @@ discard block |
||
| 55 | 55 | * @return $this |
| 56 | 56 | * @throws Mailcode_Exception |
| 57 | 57 | */ |
| 58 | - public function setHTMLEnabled(bool $enabled=true) : self |
|
| 58 | + public function setHTMLEnabled(bool $enabled = true) : self |
|
| 59 | 59 | { |
| 60 | 60 | $this->params->getInfo()->setKeywordEnabled(Mailcode_Commands_Keywords::TYPE_NOHTML, !$enabled); |
| 61 | 61 | |