@@ -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(); |
@@ -47,7 +47,7 @@ discard block |
||
| 47 | 47 | * @param string $formatString A date format string, or empty string for default. |
| 48 | 48 | * @return Mailcode_Commands_Command_ShowDate |
| 49 | 49 | */ |
| 50 | - public static function showDate(string $variableName, string $formatString="") : Mailcode_Commands_Command_ShowDate |
|
| 50 | + public static function showDate(string $variableName, string $formatString = "") : Mailcode_Commands_Command_ShowDate |
|
| 51 | 51 | { |
| 52 | 52 | return self::$commandSets->show()->showDate($variableName, $formatString); |
| 53 | 53 | } |
@@ -74,7 +74,7 @@ discard block |
||
| 74 | 74 | * |
| 75 | 75 | * @see Mailcode_Factory::ERROR_INVALID_COMMAND_CREATED |
| 76 | 76 | */ |
| 77 | - public static function setVar(string $variableName, string $value, bool $quoteValue=true) : Mailcode_Commands_Command_SetVariable |
|
| 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 | } |
@@ -107,12 +107,12 @@ discard block |
||
| 107 | 107 | return self::$commandSets->if()->end(); |
| 108 | 108 | } |
| 109 | 109 | |
| 110 | - public static function if(string $condition, string $type='') : Mailcode_Commands_Command_If |
|
| 110 | + public static function if (string $condition, string $type = '') : Mailcode_Commands_Command_If |
|
| 111 | 111 | { |
| 112 | 112 | return self::$commandSets->if()->if($condition, $type); |
| 113 | 113 | } |
| 114 | 114 | |
| 115 | - public static function ifVar(string $variable, string $operand, string $value, bool $quoteValue=false) : Mailcode_Commands_Command_If_Variable |
|
| 115 | + public static function ifVar(string $variable, string $operand, string $value, bool $quoteValue = false) : Mailcode_Commands_Command_If_Variable |
|
| 116 | 116 | { |
| 117 | 117 | return self::$commandSets->if()->ifVar($variable, $operand, $value, $quoteValue); |
| 118 | 118 | } |
@@ -122,7 +122,7 @@ discard block |
||
| 122 | 122 | return self::$commandSets->if()->ifVarString($variable, $operand, $value); |
| 123 | 123 | } |
| 124 | 124 | |
| 125 | - public static function ifVarEquals(string $variable, string $value, bool $quoteValue=false) : Mailcode_Commands_Command_If_Variable |
|
| 125 | + public static function ifVarEquals(string $variable, string $value, bool $quoteValue = false) : Mailcode_Commands_Command_If_Variable |
|
| 126 | 126 | { |
| 127 | 127 | return self::$commandSets->if()->ifVarEquals($variable, $value, $quoteValue); |
| 128 | 128 | } |
@@ -132,7 +132,7 @@ discard block |
||
| 132 | 132 | return self::$commandSets->if()->ifVarEqualsString($variable, $value); |
| 133 | 133 | } |
| 134 | 134 | |
| 135 | - public static function ifVarNotEquals(string $variable, string $value, bool $quoteValue=false) : Mailcode_Commands_Command_If_Variable |
|
| 135 | + public static function ifVarNotEquals(string $variable, string $value, bool $quoteValue = false) : Mailcode_Commands_Command_If_Variable |
|
| 136 | 136 | { |
| 137 | 137 | return self::$commandSets->if()->ifVarNotEquals($variable, $value, $quoteValue); |
| 138 | 138 | } |
@@ -142,7 +142,7 @@ discard block |
||
| 142 | 142 | return self::$commandSets->if()->ifVarNotEqualsString($variable, $value); |
| 143 | 143 | } |
| 144 | 144 | |
| 145 | - public static function elseIf(string $condition, string $type='') : Mailcode_Commands_Command_ElseIf |
|
| 145 | + public static function elseIf (string $condition, string $type = '') : Mailcode_Commands_Command_ElseIf |
|
| 146 | 146 | { |
| 147 | 147 | return self::$commandSets->elseIf()->elseIf($condition, $type); |
| 148 | 148 | } |
@@ -157,7 +157,7 @@ discard block |
||
| 157 | 157 | return self::$commandSets->elseIf()->elseIfNotEmpty($variable); |
| 158 | 158 | } |
| 159 | 159 | |
| 160 | - public static function elseIfVar(string $variable, string $operand, string $value, bool $quoteValue=false) : Mailcode_Commands_Command_ElseIf_Variable |
|
| 160 | + public static function elseIfVar(string $variable, string $operand, string $value, bool $quoteValue = false) : Mailcode_Commands_Command_ElseIf_Variable |
|
| 161 | 161 | { |
| 162 | 162 | return self::$commandSets->elseIf()->elseIfVar($variable, $operand, $value, $quoteValue); |
| 163 | 163 | } |
@@ -167,7 +167,7 @@ discard block |
||
| 167 | 167 | return self::$commandSets->elseIf()->elseIfVarString($variable, $operand, $value); |
| 168 | 168 | } |
| 169 | 169 | |
| 170 | - public static function elseIfVarEquals(string $variable, string $value, bool $quoteValue=false) : Mailcode_Commands_Command_ElseIf_Variable |
|
| 170 | + public static function elseIfVarEquals(string $variable, string $value, bool $quoteValue = false) : Mailcode_Commands_Command_ElseIf_Variable |
|
| 171 | 171 | { |
| 172 | 172 | return self::$commandSets->elseIf()->elseIfVarEquals($variable, $value, $quoteValue); |
| 173 | 173 | } |
@@ -177,7 +177,7 @@ discard block |
||
| 177 | 177 | return self::$commandSets->elseIf()->elseIfVarEqualsString($variable, $value); |
| 178 | 178 | } |
| 179 | 179 | |
| 180 | - public static function elseIfVarNotEquals(string $variable, string $value, bool $quoteValue=false) : Mailcode_Commands_Command_ElseIf_Variable |
|
| 180 | + public static function elseIfVarNotEquals(string $variable, string $value, bool $quoteValue = false) : Mailcode_Commands_Command_ElseIf_Variable |
|
| 181 | 181 | { |
| 182 | 182 | return self::$commandSets->elseIf()->elseIfVarNotEquals($variable, $value, $quoteValue); |
| 183 | 183 | } |
@@ -187,12 +187,12 @@ discard block |
||
| 187 | 187 | return self::$commandSets->elseIf()->elseIfVarNotEqualsString($variable, $value); |
| 188 | 188 | } |
| 189 | 189 | |
| 190 | - public static function ifContains(string $variable, string $search, bool $caseInsensitive=false) : Mailcode_Commands_Command_If_Contains |
|
| 190 | + public static function ifContains(string $variable, string $search, bool $caseInsensitive = false) : Mailcode_Commands_Command_If_Contains |
|
| 191 | 191 | { |
| 192 | 192 | return self::$commandSets->if()->ifContains($variable, $search, $caseInsensitive); |
| 193 | 193 | } |
| 194 | 194 | |
| 195 | - public static function elseIfContains(string $variable, string $search, bool $caseInsensitive=false) : Mailcode_Commands_Command_ElseIf_Contains |
|
| 195 | + public static function elseIfContains(string $variable, string $search, bool $caseInsensitive = false) : Mailcode_Commands_Command_ElseIf_Contains |
|
| 196 | 196 | { |
| 197 | 197 | return self::$commandSets->elseIf()->elseIfContains($variable, $search, $caseInsensitive); |
| 198 | 198 | } |
@@ -242,7 +242,7 @@ discard block |
||
| 242 | 242 | |
| 243 | 243 | public static function init() : void |
| 244 | 244 | { |
| 245 | - if(!isset(self::$commandSets)) |
|
| 245 | + if (!isset(self::$commandSets)) |
|
| 246 | 246 | { |
| 247 | 247 | self::$commandSets = new Mailcode_Factory_CommandSets(); |
| 248 | 248 | } |
@@ -97,10 +97,12 @@ |
||
| 97 | 97 | return self::$commandSets->misc()->comment($comments); |
| 98 | 98 | } |
| 99 | 99 | |
| 100 | - public static function else() : Mailcode_Commands_Command_Else |
|
| 100 | + public static function else { |
|
| 101 | + () : Mailcode_Commands_Command_Else |
|
| 101 | 102 | { |
| 102 | 103 | return self::$commandSets->if()->else(); |
| 103 | 104 | } |
| 105 | + } |
|
| 104 | 106 | |
| 105 | 107 | public static function end() : Mailcode_Commands_Command_End |
| 106 | 108 | { |
@@ -22,27 +22,27 @@ discard block |
||
| 22 | 22 | { |
| 23 | 23 | public function translate(Mailcode_Commands_Command_ElseIf $command): string |
| 24 | 24 | { |
| 25 | - if($command instanceof Mailcode_Commands_Command_ElseIf_Command) |
|
| 25 | + if ($command instanceof Mailcode_Commands_Command_ElseIf_Command) |
|
| 26 | 26 | { |
| 27 | 27 | return $this->translateCommand($command); |
| 28 | 28 | } |
| 29 | 29 | |
| 30 | - if($command instanceof Mailcode_Commands_Command_ElseIf_Variable) |
|
| 30 | + if ($command instanceof Mailcode_Commands_Command_ElseIf_Variable) |
|
| 31 | 31 | { |
| 32 | 32 | return $this->translateVariable($command); |
| 33 | 33 | } |
| 34 | 34 | |
| 35 | - if($command instanceof Mailcode_Commands_Command_ElseIf_Contains) |
|
| 35 | + if ($command instanceof Mailcode_Commands_Command_ElseIf_Contains) |
|
| 36 | 36 | { |
| 37 | 37 | return $this->translateContains($command); |
| 38 | 38 | } |
| 39 | 39 | |
| 40 | - if($command instanceof Mailcode_Commands_Command_ElseIf_Empty) |
|
| 40 | + if ($command instanceof Mailcode_Commands_Command_ElseIf_Empty) |
|
| 41 | 41 | { |
| 42 | 42 | return $this->translateEmpty($command); |
| 43 | 43 | } |
| 44 | 44 | |
| 45 | - if($command instanceof Mailcode_Commands_Command_ElseIf_NotEmpty) |
|
| 45 | + if ($command instanceof Mailcode_Commands_Command_ElseIf_NotEmpty) |
|
| 46 | 46 | { |
| 47 | 47 | return $this->translateNotEmpty($command); |
| 48 | 48 | } |
@@ -54,7 +54,7 @@ discard block |
||
| 54 | 54 | { |
| 55 | 55 | $params = $command->getParams(); |
| 56 | 56 | |
| 57 | - if(!$params) |
|
| 57 | + if (!$params) |
|
| 58 | 58 | { |
| 59 | 59 | return ''; |
| 60 | 60 | } |
@@ -78,7 +78,7 @@ discard block |
||
| 78 | 78 | protected function translateContains(Mailcode_Commands_Command_ElseIf_Contains $command) : string |
| 79 | 79 | { |
| 80 | 80 | $opts = 's'; |
| 81 | - if($command->isCaseInsensitive()) |
|
| 81 | + if ($command->isCaseInsensitive()) |
|
| 82 | 82 | { |
| 83 | 83 | $opts = 'is'; |
| 84 | 84 | } |
@@ -105,7 +105,7 @@ discard block |
||
| 105 | 105 | { |
| 106 | 106 | $sign = ''; |
| 107 | 107 | |
| 108 | - if($notEmpty) |
|
| 108 | + if ($notEmpty) |
|
| 109 | 109 | { |
| 110 | 110 | $sign = '!'; |
| 111 | 111 | } |
@@ -22,27 +22,27 @@ discard block |
||
| 22 | 22 | { |
| 23 | 23 | public function translate(Mailcode_Commands_Command_If $command): string |
| 24 | 24 | { |
| 25 | - if($command instanceof Mailcode_Commands_Command_If_Command) |
|
| 25 | + if ($command instanceof Mailcode_Commands_Command_If_Command) |
|
| 26 | 26 | { |
| 27 | 27 | return $this->translateCommand($command); |
| 28 | 28 | } |
| 29 | 29 | |
| 30 | - if($command instanceof Mailcode_Commands_Command_If_Variable) |
|
| 30 | + if ($command instanceof Mailcode_Commands_Command_If_Variable) |
|
| 31 | 31 | { |
| 32 | 32 | return $this->translateVariable($command); |
| 33 | 33 | } |
| 34 | 34 | |
| 35 | - if($command instanceof Mailcode_Commands_Command_If_Contains) |
|
| 35 | + if ($command instanceof Mailcode_Commands_Command_If_Contains) |
|
| 36 | 36 | { |
| 37 | 37 | return $this->translateContains($command); |
| 38 | 38 | } |
| 39 | 39 | |
| 40 | - if($command instanceof Mailcode_Commands_Command_If_Empty) |
|
| 40 | + if ($command instanceof Mailcode_Commands_Command_If_Empty) |
|
| 41 | 41 | { |
| 42 | 42 | return $this->translateEmpty($command); |
| 43 | 43 | } |
| 44 | 44 | |
| 45 | - if($command instanceof Mailcode_Commands_Command_If_NotEmpty) |
|
| 45 | + if ($command instanceof Mailcode_Commands_Command_If_NotEmpty) |
|
| 46 | 46 | { |
| 47 | 47 | return $this->translateNotEmpty($command); |
| 48 | 48 | } |
@@ -54,7 +54,7 @@ discard block |
||
| 54 | 54 | { |
| 55 | 55 | $params = $command->getParams(); |
| 56 | 56 | |
| 57 | - if(!$params) |
|
| 57 | + if (!$params) |
|
| 58 | 58 | { |
| 59 | 59 | return ''; |
| 60 | 60 | } |
@@ -78,7 +78,7 @@ discard block |
||
| 78 | 78 | protected function translateContains(Mailcode_Commands_Command_If_Contains $command) : string |
| 79 | 79 | { |
| 80 | 80 | $opts = 's'; |
| 81 | - if($command->isCaseInsensitive()) |
|
| 81 | + if ($command->isCaseInsensitive()) |
|
| 82 | 82 | { |
| 83 | 83 | $opts = 'is'; |
| 84 | 84 | } |
@@ -105,7 +105,7 @@ discard block |
||
| 105 | 105 | { |
| 106 | 106 | $sign = ''; |
| 107 | 107 | |
| 108 | - if($notEmpty) |
|
| 108 | + if ($notEmpty) |
|
| 109 | 109 | { |
| 110 | 110 | $sign = '!'; |
| 111 | 111 | } |
@@ -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) |
@@ -41,7 +41,7 @@ discard block |
||
| 41 | 41 | |
| 42 | 42 | $variable = $info->getVariableByIndex(0); |
| 43 | 43 | |
| 44 | - if($variable !== null) |
|
| 44 | + if ($variable !== null) |
|
| 45 | 45 | { |
| 46 | 46 | $this->variableToken = $variable; |
| 47 | 47 | return; |
@@ -60,7 +60,7 @@ discard block |
||
| 60 | 60 | */ |
| 61 | 61 | public function getVariable() : Mailcode_Variables_Variable |
| 62 | 62 | { |
| 63 | - if($this->variableToken instanceof Mailcode_Parser_Statement_Tokenizer_Token_Variable) |
|
| 63 | + if ($this->variableToken instanceof Mailcode_Parser_Statement_Tokenizer_Token_Variable) |
|
| 64 | 64 | { |
| 65 | 65 | return $this->variableToken->getVariable(); |
| 66 | 66 | } |
@@ -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) |
@@ -41,7 +41,7 @@ discard block |
||
| 41 | 41 | |
| 42 | 42 | $variable = $info->getVariableByIndex(0); |
| 43 | 43 | |
| 44 | - if($variable !== null) |
|
| 44 | + if ($variable !== null) |
|
| 45 | 45 | { |
| 46 | 46 | $this->variableToken = $variable; |
| 47 | 47 | return; |
@@ -60,7 +60,7 @@ discard block |
||
| 60 | 60 | */ |
| 61 | 61 | public function getVariable() : Mailcode_Variables_Variable |
| 62 | 62 | { |
| 63 | - if($this->variableToken instanceof Mailcode_Parser_Statement_Tokenizer_Token_Variable) |
|
| 63 | + if ($this->variableToken instanceof Mailcode_Parser_Statement_Tokenizer_Token_Variable) |
|
| 64 | 64 | { |
| 65 | 65 | return $this->variableToken->getVariable(); |
| 66 | 66 | } |
@@ -27,21 +27,21 @@ discard block |
||
| 27 | 27 | |
| 28 | 28 | const ERROR_INVALID_DUMMY_COMMAND_TYPE = 45903; |
| 29 | 29 | |
| 30 | - /** |
|
| 31 | - * @var Mailcode_Commands_Command[] |
|
| 32 | - */ |
|
| 30 | + /** |
|
| 31 | + * @var Mailcode_Commands_Command[] |
|
| 32 | + */ |
|
| 33 | 33 | private $commands = array(); |
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * @var string[]Mailcode_Commands_Command |
|
| 37 | - */ |
|
| 35 | + /** |
|
| 36 | + * @var string[]Mailcode_Commands_Command |
|
| 37 | + */ |
|
| 38 | 38 | private static $dummyCommands = array(); |
| 39 | 39 | |
| 40 | - /** |
|
| 41 | - * Retrieves a list of all available command IDs. |
|
| 42 | - * |
|
| 43 | - * @return string[] |
|
| 44 | - */ |
|
| 40 | + /** |
|
| 41 | + * Retrieves a list of all available command IDs. |
|
| 42 | + * |
|
| 43 | + * @return string[] |
|
| 44 | + */ |
|
| 45 | 45 | public function getIDs() : array |
| 46 | 46 | { |
| 47 | 47 | static $ids = array(); |
@@ -54,13 +54,13 @@ discard block |
||
| 54 | 54 | return $ids; |
| 55 | 55 | } |
| 56 | 56 | |
| 57 | - /** |
|
| 58 | - * Retrieves a list of all available commands, sorted by label. |
|
| 59 | - * |
|
| 60 | - * NOTE: These instances are only used for information purposes. |
|
| 61 | - * |
|
| 62 | - * @return Mailcode_Commands_Command[] |
|
| 63 | - */ |
|
| 57 | + /** |
|
| 58 | + * Retrieves a list of all available commands, sorted by label. |
|
| 59 | + * |
|
| 60 | + * NOTE: These instances are only used for information purposes. |
|
| 61 | + * |
|
| 62 | + * @return Mailcode_Commands_Command[] |
|
| 63 | + */ |
|
| 64 | 64 | public function getAll() |
| 65 | 65 | { |
| 66 | 66 | if(!empty($this->commands)) { |
@@ -86,12 +86,12 @@ discard block |
||
| 86 | 86 | return $result; |
| 87 | 87 | } |
| 88 | 88 | |
| 89 | - /** |
|
| 90 | - * Gets an available command by its ID. |
|
| 91 | - * |
|
| 92 | - * @param string $id |
|
| 93 | - * @return Mailcode_Commands_Command |
|
| 94 | - */ |
|
| 89 | + /** |
|
| 90 | + * Gets an available command by its ID. |
|
| 91 | + * |
|
| 92 | + * @param string $id |
|
| 93 | + * @return Mailcode_Commands_Command |
|
| 94 | + */ |
|
| 95 | 95 | public function getByID(string $id) : Mailcode_Commands_Command |
| 96 | 96 | { |
| 97 | 97 | static $instances = array(); |
@@ -104,15 +104,15 @@ discard block |
||
| 104 | 104 | return $instances[$id]; |
| 105 | 105 | } |
| 106 | 106 | |
| 107 | - /** |
|
| 108 | - * Retrieves the ID of a command by its name. |
|
| 109 | - * |
|
| 110 | - * @param string $name |
|
| 111 | - * @throws Mailcode_Exception |
|
| 112 | - * @return string |
|
| 113 | - * |
|
| 114 | - * @see Mailcode_Commands::ERROR_COMMAND_NAME_DOES_NOT_EXIST |
|
| 115 | - */ |
|
| 107 | + /** |
|
| 108 | + * Retrieves the ID of a command by its name. |
|
| 109 | + * |
|
| 110 | + * @param string $name |
|
| 111 | + * @throws Mailcode_Exception |
|
| 112 | + * @return string |
|
| 113 | + * |
|
| 114 | + * @see Mailcode_Commands::ERROR_COMMAND_NAME_DOES_NOT_EXIST |
|
| 115 | + */ |
|
| 116 | 116 | public function getIDByName(string $name) : string |
| 117 | 117 | { |
| 118 | 118 | $items = $this->getAll(); |
@@ -141,12 +141,12 @@ discard block |
||
| 141 | 141 | return in_array($id, $ids); |
| 142 | 142 | } |
| 143 | 143 | |
| 144 | - /** |
|
| 145 | - * Checks wether the specified name exists. |
|
| 146 | - * |
|
| 147 | - * @param string $name For example: "showvar". |
|
| 148 | - * @return bool |
|
| 149 | - */ |
|
| 144 | + /** |
|
| 145 | + * Checks wether the specified name exists. |
|
| 146 | + * |
|
| 147 | + * @param string $name For example: "showvar". |
|
| 148 | + * @return bool |
|
| 149 | + */ |
|
| 150 | 150 | public function nameExists(string $name) : bool |
| 151 | 151 | { |
| 152 | 152 | $items = $this->getAll(); |
@@ -200,14 +200,14 @@ discard block |
||
| 200 | 200 | return $class; |
| 201 | 201 | } |
| 202 | 202 | |
| 203 | - /** |
|
| 204 | - * Translates the command type to the expected class naming scheme. |
|
| 205 | - * |
|
| 206 | - * Example: not-empty => NotEmpty |
|
| 207 | - * |
|
| 208 | - * @param string $type |
|
| 209 | - * @return string |
|
| 210 | - */ |
|
| 203 | + /** |
|
| 204 | + * Translates the command type to the expected class naming scheme. |
|
| 205 | + * |
|
| 206 | + * Example: not-empty => NotEmpty |
|
| 207 | + * |
|
| 208 | + * @param string $type |
|
| 209 | + * @return string |
|
| 210 | + */ |
|
| 211 | 211 | private function adjustTypeName(string $type) : string |
| 212 | 212 | { |
| 213 | 213 | $type = str_replace('-', ' ', $type); |
@@ -217,13 +217,13 @@ discard block |
||
| 217 | 217 | return $type; |
| 218 | 218 | } |
| 219 | 219 | |
| 220 | - /** |
|
| 221 | - * Retrieves the dummy command of the specified type, which |
|
| 222 | - * is used to retrieve information on the command's capabilities. |
|
| 223 | - * |
|
| 224 | - * @param string $id |
|
| 225 | - * @return Mailcode_Commands_Command |
|
| 226 | - */ |
|
| 220 | + /** |
|
| 221 | + * Retrieves the dummy command of the specified type, which |
|
| 222 | + * is used to retrieve information on the command's capabilities. |
|
| 223 | + * |
|
| 224 | + * @param string $id |
|
| 225 | + * @return Mailcode_Commands_Command |
|
| 226 | + */ |
|
| 227 | 227 | private function getDummyCommand(string $id) : Mailcode_Commands_Command |
| 228 | 228 | { |
| 229 | 229 | if(!isset(self::$dummyCommands[$id])) |
@@ -20,9 +20,9 @@ |
||
| 20 | 20 | */ |
| 21 | 21 | abstract class Mailcode_Factory_CommandSets_Set |
| 22 | 22 | { |
| 23 | - /** |
|
| 24 | - * @var Mailcode_Factory_Instantiator |
|
| 25 | - */ |
|
| 23 | + /** |
|
| 24 | + * @var Mailcode_Factory_Instantiator |
|
| 25 | + */ |
|
| 26 | 26 | protected $instantiator; |
| 27 | 27 | |
| 28 | 28 | public function __construct() |
@@ -41,7 +41,7 @@ |
||
| 41 | 41 | |
| 42 | 42 | $this->instantiator->checkCommand($cmd); |
| 43 | 43 | |
| 44 | - if($cmd instanceof Mailcode_Commands_Command_End) |
|
| 44 | + if ($cmd instanceof Mailcode_Commands_Command_End) |
|
| 45 | 45 | { |
| 46 | 46 | return $cmd; |
| 47 | 47 | } |
@@ -31,7 +31,7 @@ |
||
| 31 | 31 | |
| 32 | 32 | $this->instantiator->checkCommand($cmd); |
| 33 | 33 | |
| 34 | - if($cmd instanceof Mailcode_Commands_Command_Else) |
|
| 34 | + if ($cmd instanceof Mailcode_Commands_Command_Else) |
|
| 35 | 35 | { |
| 36 | 36 | return $cmd; |
| 37 | 37 | } |
@@ -20,7 +20,8 @@ discard block |
||
| 20 | 20 | */ |
| 21 | 21 | abstract class Mailcode_Factory_CommandSets_IfBase extends Mailcode_Factory_CommandSets_Set |
| 22 | 22 | { |
| 23 | - public function else() : Mailcode_Commands_Command_Else |
|
| 23 | + public function else { |
|
| 24 | + () : Mailcode_Commands_Command_Else |
|
| 24 | 25 | { |
| 25 | 26 | $cmd = Mailcode::create()->getCommands()->createCommand( |
| 26 | 27 | 'Else', |
@@ -28,6 +29,7 @@ discard block |
||
| 28 | 29 | '', |
| 29 | 30 | '{else}' |
| 30 | 31 | ); |
| 32 | + } |
|
| 31 | 33 | |
| 32 | 34 | $this->instantiator->checkCommand($cmd); |
| 33 | 35 | |