@@ -23,21 +23,21 @@ discard block |
||
23 | 23 | */ |
24 | 24 | trait Mailcode_Traits_Formatting_HTMLHighlighting |
25 | 25 | { |
26 | - /** |
|
27 | - * @var string[] |
|
28 | - */ |
|
26 | + /** |
|
27 | + * @var string[] |
|
28 | + */ |
|
29 | 29 | private $excludeTags = array( |
30 | 30 | 'style', // NOTE: style tags are excluded natively on the parser level. |
31 | 31 | 'script' |
32 | 32 | ); |
33 | 33 | |
34 | - /** |
|
35 | - * Adds an HTML tag name to the list of tags within which |
|
36 | - * commands may not be highlighted. |
|
37 | - * |
|
38 | - * @param string $tagName Case insensitive. |
|
39 | - * @return $this |
|
40 | - */ |
|
34 | + /** |
|
35 | + * Adds an HTML tag name to the list of tags within which |
|
36 | + * commands may not be highlighted. |
|
37 | + * |
|
38 | + * @param string $tagName Case insensitive. |
|
39 | + * @return $this |
|
40 | + */ |
|
41 | 41 | public function excludeTag(string $tagName) |
42 | 42 | { |
43 | 43 | $tagName = strtolower($tagName); |
@@ -50,12 +50,12 @@ discard block |
||
50 | 50 | return $this; |
51 | 51 | } |
52 | 52 | |
53 | - /** |
|
54 | - * Adds several exluded tag names at once. |
|
55 | - * |
|
56 | - * @param string[] $tagNames |
|
57 | - * @return $this |
|
58 | - */ |
|
53 | + /** |
|
54 | + * Adds several exluded tag names at once. |
|
55 | + * |
|
56 | + * @param string[] $tagNames |
|
57 | + * @return $this |
|
58 | + */ |
|
59 | 59 | public function excludeTags(array $tagNames) |
60 | 60 | { |
61 | 61 | foreach($tagNames as $tagName) |
@@ -66,12 +66,12 @@ discard block |
||
66 | 66 | return $this; |
67 | 67 | } |
68 | 68 | |
69 | - /** |
|
70 | - * Whether the specified tag name is in the exlusion list. |
|
71 | - * |
|
72 | - * @param string $tagName |
|
73 | - * @return bool |
|
74 | - */ |
|
69 | + /** |
|
70 | + * Whether the specified tag name is in the exlusion list. |
|
71 | + * |
|
72 | + * @param string $tagName |
|
73 | + * @return bool |
|
74 | + */ |
|
75 | 75 | public function isTagExcluded(string $tagName) : bool |
76 | 76 | { |
77 | 77 | $tagName = strtolower($tagName); |
@@ -24,14 +24,14 @@ discard block |
||
24 | 24 | { |
25 | 25 | const COMMAND_MARKER = '__MAILCODE_COMMAND__'; |
26 | 26 | |
27 | - /** |
|
28 | - * @var boolean |
|
29 | - */ |
|
27 | + /** |
|
28 | + * @var boolean |
|
29 | + */ |
|
30 | 30 | private $ancestryChecked = false; |
31 | 31 | |
32 | - /** |
|
33 | - * @var array<int,array<int,string>> |
|
34 | - */ |
|
32 | + /** |
|
33 | + * @var array<int,array<int,string>> |
|
34 | + */ |
|
35 | 35 | private $tagAncestry = array(); |
36 | 36 | |
37 | 37 | protected function init() : void |
@@ -43,12 +43,12 @@ discard block |
||
43 | 43 | return !$this->isInTagAttributes() && !$this->isInExcludedTag(); |
44 | 44 | } |
45 | 45 | |
46 | - /** |
|
47 | - * Retrieves the part of the subject string that comes |
|
48 | - * before the command. |
|
49 | - * |
|
50 | - * @return string |
|
51 | - */ |
|
46 | + /** |
|
47 | + * Retrieves the part of the subject string that comes |
|
48 | + * before the command. |
|
49 | + * |
|
50 | + * @return string |
|
51 | + */ |
|
52 | 52 | private function getHaystackBefore() : string |
53 | 53 | { |
54 | 54 | $pos = $this->getStartPosition(); |
@@ -65,12 +65,12 @@ discard block |
||
65 | 65 | return $this->subject->getSubstr(0, $pos).self::COMMAND_MARKER.'>'; |
66 | 66 | } |
67 | 67 | |
68 | - /** |
|
69 | - * Whether the command is nested in one of the tags |
|
70 | - * that have been added to the list of excluded tags. |
|
71 | - * |
|
72 | - * @return bool |
|
73 | - */ |
|
68 | + /** |
|
69 | + * Whether the command is nested in one of the tags |
|
70 | + * that have been added to the list of excluded tags. |
|
71 | + * |
|
72 | + * @return bool |
|
73 | + */ |
|
74 | 74 | protected function isInExcludedTag() : bool |
75 | 75 | { |
76 | 76 | $tagNames = $this->getParentTags(); |
@@ -86,12 +86,12 @@ discard block |
||
86 | 86 | return false; |
87 | 87 | } |
88 | 88 | |
89 | - /** |
|
90 | - * Retrieves a list of the command's parent HTML tags, from |
|
91 | - * highest to lowest. |
|
92 | - * |
|
93 | - * @return string[] |
|
94 | - */ |
|
89 | + /** |
|
90 | + * Retrieves a list of the command's parent HTML tags, from |
|
91 | + * highest to lowest. |
|
92 | + * |
|
93 | + * @return string[] |
|
94 | + */ |
|
95 | 95 | private function getParentTags() : array |
96 | 96 | { |
97 | 97 | $tags = $this->getTagAncestry(); |
@@ -116,12 +116,12 @@ discard block |
||
116 | 116 | return $stack; |
117 | 117 | } |
118 | 118 | |
119 | - /** |
|
120 | - * Checks whether the command is located within the attributes |
|
121 | - * of an HTML tag. |
|
122 | - * |
|
123 | - * @return bool |
|
124 | - */ |
|
119 | + /** |
|
120 | + * Checks whether the command is located within the attributes |
|
121 | + * of an HTML tag. |
|
122 | + * |
|
123 | + * @return bool |
|
124 | + */ |
|
125 | 125 | protected function isInTagAttributes() : bool |
126 | 126 | { |
127 | 127 | $tags = $this->getTagAncestry(); |
@@ -139,12 +139,12 @@ discard block |
||
139 | 139 | return false; |
140 | 140 | } |
141 | 141 | |
142 | - /** |
|
143 | - * Retrieves a list of tag names that come as parents |
|
144 | - * above the command. |
|
145 | - * |
|
146 | - * @return array<int,array<int,string>> |
|
147 | - */ |
|
142 | + /** |
|
143 | + * Retrieves a list of tag names that come as parents |
|
144 | + * above the command. |
|
145 | + * |
|
146 | + * @return array<int,array<int,string>> |
|
147 | + */ |
|
148 | 148 | private function getTagAncestry() : array |
149 | 149 | { |
150 | 150 | if($this->ancestryChecked) |
@@ -32,29 +32,29 @@ discard block |
||
32 | 32 | const ERROR_TOO_MANY_REPLACERS = 65902; |
33 | 33 | const ERROR_NO_FORMATTERS_ADDED = 65903; |
34 | 34 | |
35 | - /** |
|
36 | - * @var Mailcode_Parser_Safeguard |
|
37 | - */ |
|
35 | + /** |
|
36 | + * @var Mailcode_Parser_Safeguard |
|
37 | + */ |
|
38 | 38 | private $safeguard; |
39 | 39 | |
40 | - /** |
|
41 | - * @var Mailcode_Parser_Safeguard_Formatter[] |
|
42 | - */ |
|
40 | + /** |
|
41 | + * @var Mailcode_Parser_Safeguard_Formatter[] |
|
42 | + */ |
|
43 | 43 | private $formatters = array(); |
44 | 44 | |
45 | - /** |
|
46 | - * @var Mailcode_StringContainer |
|
47 | - */ |
|
45 | + /** |
|
46 | + * @var Mailcode_StringContainer |
|
47 | + */ |
|
48 | 48 | private $subject; |
49 | 49 | |
50 | - /** |
|
51 | - * @var boolean |
|
52 | - */ |
|
50 | + /** |
|
51 | + * @var boolean |
|
52 | + */ |
|
53 | 53 | private $applied = false; |
54 | 54 | |
55 | - /** |
|
56 | - * @var boolean |
|
57 | - */ |
|
55 | + /** |
|
56 | + * @var boolean |
|
57 | + */ |
|
58 | 58 | private $partial = false; |
59 | 59 | |
60 | 60 | public function __construct(Mailcode_Parser_Safeguard $safeguard, Mailcode_StringContainer $subject) |
@@ -96,17 +96,17 @@ discard block |
||
96 | 96 | return $formatter; |
97 | 97 | } |
98 | 98 | |
99 | - /** |
|
100 | - * Adds a formatter that will surround all variables with |
|
101 | - * markup to highlight them independently of command syntax |
|
102 | - * highlighting. |
|
103 | - * |
|
104 | - * This is used to mark variables visually even after commands |
|
105 | - * have been replaced by the target system's post processing. |
|
106 | - * Can be combined with a replacer and other formats. |
|
107 | - * |
|
108 | - * @return Mailcode_Parser_Safeguard_Formatter_Type_MarkVariables |
|
109 | - */ |
|
99 | + /** |
|
100 | + * Adds a formatter that will surround all variables with |
|
101 | + * markup to highlight them independently of command syntax |
|
102 | + * highlighting. |
|
103 | + * |
|
104 | + * This is used to mark variables visually even after commands |
|
105 | + * have been replaced by the target system's post processing. |
|
106 | + * Can be combined with a replacer and other formats. |
|
107 | + * |
|
108 | + * @return Mailcode_Parser_Safeguard_Formatter_Type_MarkVariables |
|
109 | + */ |
|
110 | 110 | public function formatWithMarkedVariables() : Mailcode_Parser_Safeguard_Formatter_Type_MarkVariables |
111 | 111 | { |
112 | 112 | $formatter = $this->createMarkVariables(); |
@@ -200,11 +200,11 @@ discard block |
||
200 | 200 | } |
201 | 201 | } |
202 | 202 | |
203 | - /** |
|
204 | - * Counts the amount of replacer formatters that have been added. |
|
205 | - * |
|
206 | - * @return int |
|
207 | - */ |
|
203 | + /** |
|
204 | + * Counts the amount of replacer formatters that have been added. |
|
205 | + * |
|
206 | + * @return int |
|
207 | + */ |
|
208 | 208 | private function countReplacers() : int |
209 | 209 | { |
210 | 210 | $count = 0; |
@@ -220,37 +220,37 @@ discard block |
||
220 | 220 | return $count; |
221 | 221 | } |
222 | 222 | |
223 | - /** |
|
224 | - * Creates a formatter that adds HTML syntax highlighting |
|
225 | - * for all commands in the specified string, intelligently |
|
226 | - * checking the location of the commands to ensure that they |
|
227 | - * can be syntax highlighted. |
|
228 | - * |
|
229 | - * For example, commands in HTML attributes will not be |
|
230 | - * highlighted, as this would break the HTML. |
|
231 | - * |
|
232 | - * @return Mailcode_Parser_Safeguard_Formatter_Type_HTMLHighlighting |
|
233 | - */ |
|
223 | + /** |
|
224 | + * Creates a formatter that adds HTML syntax highlighting |
|
225 | + * for all commands in the specified string, intelligently |
|
226 | + * checking the location of the commands to ensure that they |
|
227 | + * can be syntax highlighted. |
|
228 | + * |
|
229 | + * For example, commands in HTML attributes will not be |
|
230 | + * highlighted, as this would break the HTML. |
|
231 | + * |
|
232 | + * @return Mailcode_Parser_Safeguard_Formatter_Type_HTMLHighlighting |
|
233 | + */ |
|
234 | 234 | public function createHTMLHighlighting() : Mailcode_Parser_Safeguard_Formatter_Type_HTMLHighlighting |
235 | 235 | { |
236 | 236 | return new Mailcode_Parser_Safeguard_Formatter_Type_HTMLHighlighting($this); |
237 | 237 | } |
238 | 238 | |
239 | - /** |
|
240 | - * Creates the formatter that ensures that all commands |
|
241 | - * are placed on a separate line in the subject string. |
|
242 | - */ |
|
239 | + /** |
|
240 | + * Creates the formatter that ensures that all commands |
|
241 | + * are placed on a separate line in the subject string. |
|
242 | + */ |
|
243 | 243 | public function createSingleLines() : Mailcode_Parser_Safeguard_Formatter_Type_SingleLines |
244 | 244 | { |
245 | 245 | return new Mailcode_Parser_Safeguard_Formatter_Type_SingleLines($this); |
246 | 246 | } |
247 | 247 | |
248 | - /** |
|
249 | - * Creates the formatter that replaces all commands by |
|
250 | - * their normalized variants. |
|
251 | - * |
|
252 | - * @return Mailcode_Parser_Safeguard_Formatter_Type_Normalized |
|
253 | - */ |
|
248 | + /** |
|
249 | + * Creates the formatter that replaces all commands by |
|
250 | + * their normalized variants. |
|
251 | + * |
|
252 | + * @return Mailcode_Parser_Safeguard_Formatter_Type_Normalized |
|
253 | + */ |
|
254 | 254 | public function createNormalized() : Mailcode_Parser_Safeguard_Formatter_Type_Normalized |
255 | 255 | { |
256 | 256 | return new Mailcode_Parser_Safeguard_Formatter_Type_Normalized($this); |
@@ -273,26 +273,26 @@ discard block |
||
273 | 273 | return $this->subject->getString(); |
274 | 274 | } |
275 | 275 | |
276 | - /** |
|
277 | - * Whether the formatting is done partially: missing placeholders |
|
278 | - * will simply be ignored. |
|
279 | - * |
|
280 | - * @return bool |
|
281 | - */ |
|
276 | + /** |
|
277 | + * Whether the formatting is done partially: missing placeholders |
|
278 | + * will simply be ignored. |
|
279 | + * |
|
280 | + * @return bool |
|
281 | + */ |
|
282 | 282 | public function isPartial() : bool |
283 | 283 | { |
284 | 284 | return $this->partial; |
285 | 285 | } |
286 | 286 | |
287 | - /** |
|
288 | - * The formatting will ignore missing placeholders. Use this if the |
|
289 | - * formatting will be done on a text that may not contain all of the |
|
290 | - * initial placeholders anymore. |
|
291 | - * |
|
292 | - * This is like the safeguard's makeWholePartial() method. |
|
293 | - * |
|
294 | - * @return Mailcode_Parser_Safeguard_Formatting |
|
295 | - */ |
|
287 | + /** |
|
288 | + * The formatting will ignore missing placeholders. Use this if the |
|
289 | + * formatting will be done on a text that may not contain all of the |
|
290 | + * initial placeholders anymore. |
|
291 | + * |
|
292 | + * This is like the safeguard's makeWholePartial() method. |
|
293 | + * |
|
294 | + * @return Mailcode_Parser_Safeguard_Formatting |
|
295 | + */ |
|
296 | 296 | public function makePartial() : Mailcode_Parser_Safeguard_Formatting |
297 | 297 | { |
298 | 298 | $this->partial = true; |
@@ -24,15 +24,15 @@ |
||
24 | 24 | { |
25 | 25 | const ERROR_UNKNOWN_DATE_FORMAT_CHARACTER = 55501; |
26 | 26 | |
27 | - /** |
|
28 | - * The date format used in the date variable. This is used to convert |
|
29 | - * the native date to the format specified in the variable command. |
|
30 | - */ |
|
27 | + /** |
|
28 | + * The date format used in the date variable. This is used to convert |
|
29 | + * the native date to the format specified in the variable command. |
|
30 | + */ |
|
31 | 31 | const DEFAULT_INTERNAL_FORMAT = "yyyy-MM-dd'T'HH:mm:ss.SSSXXX"; |
32 | 32 | |
33 | - /** |
|
34 | - * @var string[]string |
|
35 | - */ |
|
33 | + /** |
|
34 | + * @var string[]string |
|
35 | + */ |
|
36 | 36 | private $charTable = array( |
37 | 37 | 'd' => 'dd', |
38 | 38 | 'j' => 'd', |
@@ -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); |
@@ -65,41 +65,41 @@ discard block |
||
65 | 65 | return self::$commandSets->show()->showNumber($variableName, $formatString); |
66 | 66 | } |
67 | 67 | |
68 | - /** |
|
69 | - * Creates a ShowSnippet command. |
|
70 | - * |
|
71 | - * @param string $snippetName A snippet name, with or without the $ sign prepended. |
|
72 | - * @return Mailcode_Commands_Command_ShowSnippet |
|
73 | - */ |
|
68 | + /** |
|
69 | + * Creates a ShowSnippet command. |
|
70 | + * |
|
71 | + * @param string $snippetName A snippet name, with or without the $ sign prepended. |
|
72 | + * @return Mailcode_Commands_Command_ShowSnippet |
|
73 | + */ |
|
74 | 74 | public static function showSnippet(string $snippetName) : Mailcode_Commands_Command_ShowSnippet |
75 | 75 | { |
76 | 76 | return self::$commandSets->show()->showSnippet($snippetName); |
77 | 77 | } |
78 | 78 | |
79 | - /** |
|
80 | - * Creates a SetVariable command. |
|
81 | - * |
|
82 | - * @param string $variableName A variable name, with or without the $ sign prepended. |
|
83 | - * @param string $value |
|
84 | - * @param bool $quoteValue Whether to treat the value as a string literal, and add quotes to it. |
|
85 | - * @return Mailcode_Commands_Command_SetVariable |
|
86 | - * @throws Mailcode_Factory_Exception |
|
87 | - * |
|
88 | - * @see Mailcode_Factory::ERROR_INVALID_COMMAND_CREATED |
|
89 | - */ |
|
79 | + /** |
|
80 | + * Creates a SetVariable command. |
|
81 | + * |
|
82 | + * @param string $variableName A variable name, with or without the $ sign prepended. |
|
83 | + * @param string $value |
|
84 | + * @param bool $quoteValue Whether to treat the value as a string literal, and add quotes to it. |
|
85 | + * @return Mailcode_Commands_Command_SetVariable |
|
86 | + * @throws Mailcode_Factory_Exception |
|
87 | + * |
|
88 | + * @see Mailcode_Factory::ERROR_INVALID_COMMAND_CREATED |
|
89 | + */ |
|
90 | 90 | public static function setVar(string $variableName, string $value, bool $quoteValue=true) : Mailcode_Commands_Command_SetVariable |
91 | 91 | { |
92 | 92 | return self::$commandSets->set()->setVar($variableName, $value, $quoteValue); |
93 | 93 | } |
94 | 94 | |
95 | - /** |
|
96 | - * Like setVar(), but treats the value as a string literal |
|
97 | - * and automatically adds quotes to it. |
|
98 | - * |
|
99 | - * @param string $variableName |
|
100 | - * @param string $value |
|
101 | - * @return Mailcode_Commands_Command_SetVariable |
|
102 | - */ |
|
95 | + /** |
|
96 | + * Like setVar(), but treats the value as a string literal |
|
97 | + * and automatically adds quotes to it. |
|
98 | + * |
|
99 | + * @param string $variableName |
|
100 | + * @param string $value |
|
101 | + * @return Mailcode_Commands_Command_SetVariable |
|
102 | + */ |
|
103 | 103 | public static function setVarString(string $variableName, string $value) : Mailcode_Commands_Command_SetVariable |
104 | 104 | { |
105 | 105 | return self::$commandSets->set()->setVar($variableName, $value, true); |
@@ -256,13 +256,13 @@ discard block |
||
256 | 256 | } |
257 | 257 | |
258 | 258 | /** |
259 | - * Creates if contains command, with several search terms. |
|
260 | - * |
|
261 | - * @param string $variable |
|
262 | - * @param string[] $searchTerms List of search terms. Do not add surrounding quotes. |
|
263 | - * @param bool $caseInsensitive |
|
264 | - * @return Mailcode_Commands_Command_If_Contains |
|
265 | - */ |
|
259 | + * Creates if contains command, with several search terms. |
|
260 | + * |
|
261 | + * @param string $variable |
|
262 | + * @param string[] $searchTerms List of search terms. Do not add surrounding quotes. |
|
263 | + * @param bool $caseInsensitive |
|
264 | + * @return Mailcode_Commands_Command_If_Contains |
|
265 | + */ |
|
266 | 266 | public static function ifContainsAny(string $variable, array $searchTerms, bool $caseInsensitive=false) : Mailcode_Commands_Command_If_Contains |
267 | 267 | { |
268 | 268 | return self::$commandSets->if()->ifContains($variable, $searchTerms, $caseInsensitive); |
@@ -273,14 +273,14 @@ discard block |
||
273 | 273 | return self::$commandSets->elseIf()->elseIfContains($variable, array($search), $caseInsensitive); |
274 | 274 | } |
275 | 275 | |
276 | - /** |
|
277 | - * Creates else if contains command, with several search terms. |
|
278 | - * |
|
279 | - * @param string $variable |
|
280 | - * @param string[] $searchTerms List of search terms. Do not add surrounding quotes. |
|
281 | - * @param bool $caseInsensitive |
|
282 | - * @return Mailcode_Commands_Command_ElseIf_Contains |
|
283 | - */ |
|
276 | + /** |
|
277 | + * Creates else if contains command, with several search terms. |
|
278 | + * |
|
279 | + * @param string $variable |
|
280 | + * @param string[] $searchTerms List of search terms. Do not add surrounding quotes. |
|
281 | + * @param bool $caseInsensitive |
|
282 | + * @return Mailcode_Commands_Command_ElseIf_Contains |
|
283 | + */ |
|
284 | 284 | public static function elseIfContainsAny(string $variable, array $searchTerms, bool $caseInsensitive=false) : Mailcode_Commands_Command_ElseIf_Contains |
285 | 285 | { |
286 | 286 | return self::$commandSets->elseIf()->elseIfContains($variable, $searchTerms, $caseInsensitive); |
@@ -301,34 +301,34 @@ discard block |
||
301 | 301 | return self::$commandSets->misc()->for($sourceVariable, $loopVariable); |
302 | 302 | } |
303 | 303 | |
304 | - /** |
|
305 | - * Creates a renderer instance, which can be used to easily |
|
306 | - * create and convert commands to strings. |
|
307 | - * |
|
308 | - * @return Mailcode_Renderer |
|
309 | - */ |
|
304 | + /** |
|
305 | + * Creates a renderer instance, which can be used to easily |
|
306 | + * create and convert commands to strings. |
|
307 | + * |
|
308 | + * @return Mailcode_Renderer |
|
309 | + */ |
|
310 | 310 | public static function createRenderer() : Mailcode_Renderer |
311 | 311 | { |
312 | 312 | return new Mailcode_Renderer(); |
313 | 313 | } |
314 | 314 | |
315 | - /** |
|
316 | - * Creates a printer instance, which works like the renderer, |
|
317 | - * but outputs the generated strings to standard output. |
|
318 | - * |
|
319 | - * @return Mailcode_Printer |
|
320 | - */ |
|
315 | + /** |
|
316 | + * Creates a printer instance, which works like the renderer, |
|
317 | + * but outputs the generated strings to standard output. |
|
318 | + * |
|
319 | + * @return Mailcode_Printer |
|
320 | + */ |
|
321 | 321 | public static function createPrinter() : Mailcode_Printer |
322 | 322 | { |
323 | 323 | return new Mailcode_Printer(); |
324 | 324 | } |
325 | 325 | |
326 | - /** |
|
327 | - * Gets/creates the global instance of the date format info |
|
328 | - * class, used to handle date formatting aspects. |
|
329 | - * |
|
330 | - * @return Mailcode_Date_FormatInfo |
|
331 | - */ |
|
326 | + /** |
|
327 | + * Gets/creates the global instance of the date format info |
|
328 | + * class, used to handle date formatting aspects. |
|
329 | + * |
|
330 | + * @return Mailcode_Date_FormatInfo |
|
331 | + */ |
|
332 | 332 | public static function createDateInfo() : Mailcode_Date_FormatInfo |
333 | 333 | { |
334 | 334 | return Mailcode_Date_FormatInfo::getInstance(); |
@@ -24,9 +24,9 @@ discard block |
||
24 | 24 | { |
25 | 25 | const ERROR_CANNOT_RETRIEVE_FIRST_ERROR = 52301; |
26 | 26 | |
27 | - /** |
|
28 | - * @var Mailcode_Commands_Command[] |
|
29 | - */ |
|
27 | + /** |
|
28 | + * @var Mailcode_Commands_Command[] |
|
29 | + */ |
|
30 | 30 | protected $commands = array(); |
31 | 31 | |
32 | 32 | /** |
@@ -34,17 +34,17 @@ discard block |
||
34 | 34 | */ |
35 | 35 | protected $errors = array(); |
36 | 36 | |
37 | - /** |
|
38 | - * @var OperationResult|NULL |
|
39 | - */ |
|
37 | + /** |
|
38 | + * @var OperationResult|NULL |
|
39 | + */ |
|
40 | 40 | protected $validationResult; |
41 | 41 | |
42 | - /** |
|
43 | - * Adds a command to the collection. |
|
44 | - * |
|
45 | - * @param Mailcode_Commands_Command $command |
|
46 | - * @return Mailcode_Collection |
|
47 | - */ |
|
42 | + /** |
|
43 | + * Adds a command to the collection. |
|
44 | + * |
|
45 | + * @param Mailcode_Commands_Command $command |
|
46 | + * @return Mailcode_Collection |
|
47 | + */ |
|
48 | 48 | public function addCommand(Mailcode_Commands_Command $command) : Mailcode_Collection |
49 | 49 | { |
50 | 50 | $this->commands[] = $command; |
@@ -56,21 +56,21 @@ discard block |
||
56 | 56 | return $this; |
57 | 57 | } |
58 | 58 | |
59 | - /** |
|
60 | - * Whether there are any commands in the collection. |
|
61 | - * |
|
62 | - * @return bool |
|
63 | - */ |
|
59 | + /** |
|
60 | + * Whether there are any commands in the collection. |
|
61 | + * |
|
62 | + * @return bool |
|
63 | + */ |
|
64 | 64 | public function hasCommands() : bool |
65 | 65 | { |
66 | 66 | return !empty($this->commands); |
67 | 67 | } |
68 | 68 | |
69 | - /** |
|
70 | - * Counts the amount of commands in the collection. |
|
71 | - * |
|
72 | - * @return int |
|
73 | - */ |
|
69 | + /** |
|
70 | + * Counts the amount of commands in the collection. |
|
71 | + * |
|
72 | + * @return int |
|
73 | + */ |
|
74 | 74 | public function countCommands() : int |
75 | 75 | { |
76 | 76 | return count($this->commands); |
@@ -90,9 +90,9 @@ discard block |
||
90 | 90 | $this->errors[] = new Mailcode_Collection_Error_Command($command); |
91 | 91 | } |
92 | 92 | |
93 | - /** |
|
94 | - * @return Mailcode_Collection_Error[] |
|
95 | - */ |
|
93 | + /** |
|
94 | + * @return Mailcode_Collection_Error[] |
|
95 | + */ |
|
96 | 96 | public function getErrors() |
97 | 97 | { |
98 | 98 | $result = $this->getValidationResult(); |
@@ -134,25 +134,25 @@ discard block |
||
134 | 134 | return empty($errors); |
135 | 135 | } |
136 | 136 | |
137 | - /** |
|
138 | - * Retrieves all commands that were detected, in the exact order |
|
139 | - * they were found. |
|
140 | - * |
|
141 | - * @return \Mailcode\Mailcode_Commands_Command[] |
|
142 | - */ |
|
137 | + /** |
|
138 | + * Retrieves all commands that were detected, in the exact order |
|
139 | + * they were found. |
|
140 | + * |
|
141 | + * @return \Mailcode\Mailcode_Commands_Command[] |
|
142 | + */ |
|
143 | 143 | public function getCommands() |
144 | 144 | { |
145 | - return $this->commands; |
|
145 | + return $this->commands; |
|
146 | 146 | } |
147 | 147 | |
148 | - /** |
|
149 | - * Retrieves all unique commands by their matched |
|
150 | - * string hash: this ensures only commands that were |
|
151 | - * written the exact same way (including spacing) |
|
152 | - * are returned. |
|
153 | - * |
|
154 | - * @return \Mailcode\Mailcode_Commands_Command[] |
|
155 | - */ |
|
148 | + /** |
|
149 | + * Retrieves all unique commands by their matched |
|
150 | + * string hash: this ensures only commands that were |
|
151 | + * written the exact same way (including spacing) |
|
152 | + * are returned. |
|
153 | + * |
|
154 | + * @return \Mailcode\Mailcode_Commands_Command[] |
|
155 | + */ |
|
156 | 156 | public function getGroupedByHash() |
157 | 157 | { |
158 | 158 | $hashes = array(); |
@@ -170,12 +170,12 @@ discard block |
||
170 | 170 | return array_values($hashes); |
171 | 171 | } |
172 | 172 | |
173 | - /** |
|
174 | - * Adds several commands at once. |
|
175 | - * |
|
176 | - * @param Mailcode_Commands_Command[] $commands |
|
177 | - * @return Mailcode_Collection |
|
178 | - */ |
|
173 | + /** |
|
174 | + * Adds several commands at once. |
|
175 | + * |
|
176 | + * @param Mailcode_Commands_Command[] $commands |
|
177 | + * @return Mailcode_Collection |
|
178 | + */ |
|
179 | 179 | public function addCommands(array $commands) : Mailcode_Collection |
180 | 180 | { |
181 | 181 | foreach($commands as $command) |
@@ -246,10 +246,10 @@ discard block |
||
246 | 246 | } |
247 | 247 | |
248 | 248 | /** |
249 | - * Retrieves only show variable commands in the collection, if any. |
|
250 | - * |
|
251 | - * @return Mailcode_Commands_Command_ShowVariable[] |
|
252 | - */ |
|
249 | + * Retrieves only show variable commands in the collection, if any. |
|
250 | + * |
|
251 | + * @return Mailcode_Commands_Command_ShowVariable[] |
|
252 | + */ |
|
253 | 253 | public function getShowVariableCommands() |
254 | 254 | { |
255 | 255 | return $this->getCommandsByClass(Mailcode_Commands_Command_ShowVariable::class); |
@@ -263,11 +263,11 @@ discard block |
||
263 | 263 | return $this->getCommandsByClass(Mailcode_Commands_Command_For::class); |
264 | 264 | } |
265 | 265 | |
266 | - /** |
|
267 | - * Retrieves only show date commands in the collection, if any. |
|
268 | - * |
|
269 | - * @return Mailcode_Commands_Command_ShowDate[] |
|
270 | - */ |
|
266 | + /** |
|
267 | + * Retrieves only show date commands in the collection, if any. |
|
268 | + * |
|
269 | + * @return Mailcode_Commands_Command_ShowDate[] |
|
270 | + */ |
|
271 | 271 | public function getShowDateCommands() : array |
272 | 272 | { |
273 | 273 | return $this->getCommandsByClass(Mailcode_Commands_Command_ShowDate::class); |
@@ -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; |
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 |
@@ -90,11 +90,11 @@ discard block |
||
90 | 90 | ); |
91 | 91 | } |
92 | 92 | |
93 | - /** |
|
94 | - * Retrieves the format string used to format the date. |
|
95 | - * |
|
96 | - * @return string A PHP compatible date format string. |
|
97 | - */ |
|
93 | + /** |
|
94 | + * Retrieves the format string used to format the date. |
|
95 | + * |
|
96 | + * @return string A PHP compatible date format string. |
|
97 | + */ |
|
98 | 98 | public function getFormatString() : string |
99 | 99 | { |
100 | 100 | return $this->formatString; |
@@ -31,10 +31,10 @@ discard block |
||
31 | 31 | const VALIDATION_INVALID_DECIMAL_SEPARATOR = 72209; |
32 | 32 | const VALIDATION_SEPARATORS_SAME_CHARACTER = 72210; |
33 | 33 | |
34 | - /** |
|
35 | - * The default number format string. |
|
36 | - * @var string |
|
37 | - */ |
|
34 | + /** |
|
35 | + * The default number format string. |
|
36 | + * @var string |
|
37 | + */ |
|
38 | 38 | private $formatString = Mailcode_Number_Info::DEFAULT_FORMAT; |
39 | 39 | |
40 | 40 | public function getName() : string |
@@ -58,16 +58,16 @@ discard block |
||
58 | 58 | |
59 | 59 | protected function validateSyntax_check_format() : void |
60 | 60 | { |
61 | - $tokens = $this->params->getInfo()->getStringLiterals(); |
|
61 | + $tokens = $this->params->getInfo()->getStringLiterals(); |
|
62 | 62 | |
63 | - // no format specified? Use the default one. |
|
64 | - if(empty($tokens)) |
|
65 | - { |
|
66 | - return; |
|
67 | - } |
|
63 | + // no format specified? Use the default one. |
|
64 | + if(empty($tokens)) |
|
65 | + { |
|
66 | + return; |
|
67 | + } |
|
68 | 68 | |
69 | - $token = array_pop($tokens); |
|
70 | - $this->parseFormatString($token->getText()); |
|
69 | + $token = array_pop($tokens); |
|
70 | + $this->parseFormatString($token->getText()); |
|
71 | 71 | } |
72 | 72 | |
73 | 73 | private function parseFormatString(string $format) : void |
@@ -86,11 +86,11 @@ discard block |
||
86 | 86 | ); |
87 | 87 | } |
88 | 88 | |
89 | - /** |
|
90 | - * Retrieves the format string used to format the number. |
|
91 | - * |
|
92 | - * @return string |
|
93 | - */ |
|
89 | + /** |
|
90 | + * Retrieves the format string used to format the number. |
|
91 | + * |
|
92 | + * @return string |
|
93 | + */ |
|
94 | 94 | public function getFormatString() : string |
95 | 95 | { |
96 | 96 | return $this->formatString; |
@@ -20,9 +20,9 @@ discard block |
||
20 | 20 | */ |
21 | 21 | abstract class Mailcode_Translator_Syntax_ApacheVelocity extends Mailcode_Translator_Command |
22 | 22 | { |
23 | - /** |
|
24 | - * @var string[] |
|
25 | - */ |
|
23 | + /** |
|
24 | + * @var string[] |
|
25 | + */ |
|
26 | 26 | private $regexSpecialChars = array( |
27 | 27 | '?', |
28 | 28 | '.', |
@@ -47,12 +47,12 @@ discard block |
||
47 | 47 | } |
48 | 48 | |
49 | 49 | /** |
50 | - * Filters the string for use in an Apache Velocity (Java) |
|
51 | - * regex string: escapes all special characters. |
|
52 | - * |
|
53 | - * @param string $string |
|
54 | - * @return string |
|
55 | - */ |
|
50 | + * Filters the string for use in an Apache Velocity (Java) |
|
51 | + * regex string: escapes all special characters. |
|
52 | + * |
|
53 | + * @param string $string |
|
54 | + * @return string |
|
55 | + */ |
|
56 | 56 | protected function filterRegexString(string $string) : string |
57 | 57 | { |
58 | 58 | // Special case: previously escaped quotes. |