@@ -29,19 +29,19 @@ |
||
29 | 29 | const VALIDATION_COMMANDS_ALREADY_CLOSED = 49103; |
30 | 30 | const VALIDATION_UNCLOSED_COMMAND = 49104; |
31 | 31 | |
32 | - /** |
|
33 | - * @var Mailcode_Collection |
|
34 | - */ |
|
32 | + /** |
|
33 | + * @var Mailcode_Collection |
|
34 | + */ |
|
35 | 35 | protected $collection; |
36 | 36 | |
37 | - /** |
|
38 | - * @var OperationResult |
|
39 | - */ |
|
37 | + /** |
|
38 | + * @var OperationResult |
|
39 | + */ |
|
40 | 40 | protected $validationResult; |
41 | 41 | |
42 | - /** |
|
43 | - * @var Mailcode_Commands_Command_Type[] |
|
44 | - */ |
|
42 | + /** |
|
43 | + * @var Mailcode_Commands_Command_Type[] |
|
44 | + */ |
|
45 | 45 | protected $stack = array(); |
46 | 46 | |
47 | 47 | public function __construct(Mailcode_Collection $collection) |
@@ -24,9 +24,9 @@ discard block |
||
24 | 24 | */ |
25 | 25 | abstract class Mailcode_Parser_Safeguard_Formatter |
26 | 26 | { |
27 | - /** |
|
28 | - * @var Mailcode_Parser_Safeguard |
|
29 | - */ |
|
27 | + /** |
|
28 | + * @var Mailcode_Parser_Safeguard |
|
29 | + */ |
|
30 | 30 | protected $safeguard; |
31 | 31 | |
32 | 32 | public function __construct(Mailcode_Parser_Safeguard $safeguard) |
@@ -36,13 +36,13 @@ discard block |
||
36 | 36 | |
37 | 37 | abstract public function format(string $subject) : string; |
38 | 38 | |
39 | - /** |
|
40 | - * Resolves a list of positions of needle in the haystack. |
|
41 | - * |
|
42 | - * @param string $needle |
|
43 | - * @param string $haystack |
|
44 | - * @return int[] |
|
45 | - */ |
|
39 | + /** |
|
40 | + * Resolves a list of positions of needle in the haystack. |
|
41 | + * |
|
42 | + * @param string $needle |
|
43 | + * @param string $haystack |
|
44 | + * @return int[] |
|
45 | + */ |
|
46 | 46 | protected function resolvePositions(string $needle, string $haystack) : array |
47 | 47 | { |
48 | 48 | $lastPos = 0; |
@@ -57,12 +57,12 @@ discard block |
||
57 | 57 | return $positions; |
58 | 58 | } |
59 | 59 | |
60 | - /** |
|
61 | - * Resolves the newline character used in the string. |
|
62 | - * |
|
63 | - * @param string $subject |
|
64 | - * @return string |
|
65 | - */ |
|
60 | + /** |
|
61 | + * Resolves the newline character used in the string. |
|
62 | + * |
|
63 | + * @param string $subject |
|
64 | + * @return string |
|
65 | + */ |
|
66 | 66 | protected function resolveNewlineChar(string $subject) : string |
67 | 67 | { |
68 | 68 | $eol = ConvertHelper::detectEOLCharacter($subject); |
@@ -75,13 +75,13 @@ discard block |
||
75 | 75 | return PHP_EOL; |
76 | 76 | } |
77 | 77 | |
78 | - /** |
|
79 | - * Resolves the list of placeholder strings that need |
|
80 | - * to be formatted. This includes only commands that |
|
81 | - * do not generate content. |
|
82 | - * |
|
83 | - * @return string[] |
|
84 | - */ |
|
78 | + /** |
|
79 | + * Resolves the list of placeholder strings that need |
|
80 | + * to be formatted. This includes only commands that |
|
81 | + * do not generate content. |
|
82 | + * |
|
83 | + * @return string[] |
|
84 | + */ |
|
85 | 85 | protected function resolvePlaceholderStrings() : array |
86 | 86 | { |
87 | 87 | $placeholders = $this->filterPlaceholders(); |
@@ -96,9 +96,9 @@ discard block |
||
96 | 96 | return $result; |
97 | 97 | } |
98 | 98 | |
99 | - /** |
|
100 | - * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[] |
|
101 | - */ |
|
99 | + /** |
|
100 | + * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[] |
|
101 | + */ |
|
102 | 102 | protected function filterPlaceholders() |
103 | 103 | { |
104 | 104 | return $this->safeguard->getPlaceholders(); |
@@ -21,39 +21,39 @@ discard block |
||
21 | 21 | */ |
22 | 22 | class Mailcode_Parser_Safeguard_Formatter_SingleLines_Placeholder |
23 | 23 | { |
24 | - /** |
|
25 | - * @var int |
|
26 | - */ |
|
24 | + /** |
|
25 | + * @var int |
|
26 | + */ |
|
27 | 27 | protected $eolLength; |
28 | 28 | |
29 | - /** |
|
30 | - * @var int |
|
31 | - */ |
|
29 | + /** |
|
30 | + * @var int |
|
31 | + */ |
|
32 | 32 | protected $position; |
33 | 33 | |
34 | - /** |
|
35 | - * @var string |
|
36 | - */ |
|
34 | + /** |
|
35 | + * @var string |
|
36 | + */ |
|
37 | 37 | protected $subject; |
38 | 38 | |
39 | - /** |
|
40 | - * @var Mailcode_Parser_Safeguard_Formatter_SingleLines |
|
41 | - */ |
|
39 | + /** |
|
40 | + * @var Mailcode_Parser_Safeguard_Formatter_SingleLines |
|
41 | + */ |
|
42 | 42 | protected $formatter; |
43 | 43 | |
44 | - /** |
|
45 | - * @var boolean |
|
46 | - */ |
|
44 | + /** |
|
45 | + * @var boolean |
|
46 | + */ |
|
47 | 47 | protected $prepend = false; |
48 | 48 | |
49 | - /** |
|
50 | - * @var boolean |
|
51 | - */ |
|
49 | + /** |
|
50 | + * @var boolean |
|
51 | + */ |
|
52 | 52 | protected $append = false; |
53 | 53 | |
54 | - /** |
|
55 | - * @var int |
|
56 | - */ |
|
54 | + /** |
|
55 | + * @var int |
|
56 | + */ |
|
57 | 57 | protected $placeholderLength; |
58 | 58 | |
59 | 59 | public function __construct(Mailcode_Parser_Safeguard_Formatter_SingleLines $formatter, string $subject, int $placeholderLength, int $position) |
@@ -67,11 +67,11 @@ discard block |
||
67 | 67 | $this->analyzeAppend($subject); |
68 | 68 | } |
69 | 69 | |
70 | - /** |
|
71 | - * Whether an EOL character needs to be appended or prepended. |
|
72 | - * |
|
73 | - * @return bool |
|
74 | - */ |
|
70 | + /** |
|
71 | + * Whether an EOL character needs to be appended or prepended. |
|
72 | + * |
|
73 | + * @return bool |
|
74 | + */ |
|
75 | 75 | public function requiresAdjustment() : bool |
76 | 76 | { |
77 | 77 | return $this->requiresAppend() || $this->requiresPrepend(); |
@@ -23,14 +23,14 @@ discard block |
||
23 | 23 | */ |
24 | 24 | class Mailcode_Parser_Safeguard_Formatter_SingleLines extends Mailcode_Parser_Safeguard_Formatter |
25 | 25 | { |
26 | - /** |
|
27 | - * @var string |
|
28 | - */ |
|
26 | + /** |
|
27 | + * @var string |
|
28 | + */ |
|
29 | 29 | protected $eol; |
30 | 30 | |
31 | - /** |
|
32 | - * @var int |
|
33 | - */ |
|
31 | + /** |
|
32 | + * @var int |
|
33 | + */ |
|
34 | 34 | protected $eolLength; |
35 | 35 | |
36 | 36 | public function format(string $subject) : string |
@@ -119,13 +119,13 @@ discard block |
||
119 | 119 | return $prepend.$placeholder.$append; |
120 | 120 | } |
121 | 121 | |
122 | - /** |
|
123 | - * We only use placeholders that contain commands that do |
|
124 | - * not generate contents, since these are the only ones |
|
125 | - * that may need adjusting. |
|
126 | - * |
|
127 | - * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[] |
|
128 | - */ |
|
122 | + /** |
|
123 | + * We only use placeholders that contain commands that do |
|
124 | + * not generate contents, since these are the only ones |
|
125 | + * that may need adjusting. |
|
126 | + * |
|
127 | + * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[] |
|
128 | + */ |
|
129 | 129 | protected function filterPlaceholders() |
130 | 130 | { |
131 | 131 | $placeholders = $this->safeguard->getPlaceholders(); |
@@ -24,9 +24,9 @@ |
||
24 | 24 | { |
25 | 25 | const ERROR_UNKNOWN_DATE_FORMAT_CHARACTER = 55501; |
26 | 26 | |
27 | - /** |
|
28 | - * @var string[]string |
|
29 | - */ |
|
27 | + /** |
|
28 | + * @var string[]string |
|
29 | + */ |
|
30 | 30 | private $charTable = array( |
31 | 31 | 'd' => 'd', |
32 | 32 | 'm' => 'M', |
@@ -23,19 +23,19 @@ discard block |
||
23 | 23 | { |
24 | 24 | const ERROR_UNHANDLED_CHARTYPE = 55601; |
25 | 25 | |
26 | - /** |
|
27 | - * @var string |
|
28 | - */ |
|
26 | + /** |
|
27 | + * @var string |
|
28 | + */ |
|
29 | 29 | private $type; |
30 | 30 | |
31 | - /** |
|
32 | - * @var string |
|
33 | - */ |
|
31 | + /** |
|
32 | + * @var string |
|
33 | + */ |
|
34 | 34 | private $char; |
35 | 35 | |
36 | - /** |
|
37 | - * @var string |
|
38 | - */ |
|
36 | + /** |
|
37 | + * @var string |
|
38 | + */ |
|
39 | 39 | private $description; |
40 | 40 | |
41 | 41 | public function __construct(string $type, string $char, string $description) |
@@ -45,46 +45,46 @@ discard block |
||
45 | 45 | $this->description = $description; |
46 | 46 | } |
47 | 47 | |
48 | - /** |
|
49 | - * Retrieves the format character (PHP date format). |
|
50 | - * |
|
51 | - * @return string |
|
52 | - */ |
|
48 | + /** |
|
49 | + * Retrieves the format character (PHP date format). |
|
50 | + * |
|
51 | + * @return string |
|
52 | + */ |
|
53 | 53 | public function getChar() : string |
54 | 54 | { |
55 | 55 | return $this->char; |
56 | 56 | } |
57 | 57 | |
58 | - /** |
|
59 | - * Retrieves a human readable description of the character's role. |
|
60 | - * |
|
61 | - * @return string |
|
62 | - */ |
|
58 | + /** |
|
59 | + * Retrieves a human readable description of the character's role. |
|
60 | + * |
|
61 | + * @return string |
|
62 | + */ |
|
63 | 63 | public function getDescription() : string |
64 | 64 | { |
65 | 65 | return $this->description; |
66 | 66 | } |
67 | 67 | |
68 | - /** |
|
69 | - * Retrieves the character type ID. |
|
70 | - * |
|
71 | - * @return string |
|
72 | - * |
|
73 | - * @see Mailcode_Date_FormatInfo::CHARTYPE_DATE |
|
74 | - * @see Mailcode_Date_FormatInfo::CHARTYPE_TIME |
|
75 | - * @see Mailcode_Date_FormatInfo::CHARTYPE_PUNCTUATION |
|
76 | - */ |
|
68 | + /** |
|
69 | + * Retrieves the character type ID. |
|
70 | + * |
|
71 | + * @return string |
|
72 | + * |
|
73 | + * @see Mailcode_Date_FormatInfo::CHARTYPE_DATE |
|
74 | + * @see Mailcode_Date_FormatInfo::CHARTYPE_TIME |
|
75 | + * @see Mailcode_Date_FormatInfo::CHARTYPE_PUNCTUATION |
|
76 | + */ |
|
77 | 77 | public function getTypeID() : string |
78 | 78 | { |
79 | 79 | return $this->type; |
80 | 80 | } |
81 | 81 | |
82 | - /** |
|
83 | - * Retrieves a human readable label for the character's type, e.g. "Date", "Time", "Punctuation". |
|
84 | - * |
|
85 | - * @throws Mailcode_Exception If the character type is unknown. |
|
86 | - * @return string |
|
87 | - */ |
|
82 | + /** |
|
83 | + * Retrieves a human readable label for the character's type, e.g. "Date", "Time", "Punctuation". |
|
84 | + * |
|
85 | + * @throws Mailcode_Exception If the character type is unknown. |
|
86 | + * @return string |
|
87 | + */ |
|
88 | 88 | public function getTypeLabel() : string |
89 | 89 | { |
90 | 90 | switch($this->type) |
@@ -31,24 +31,24 @@ discard block |
||
31 | 31 | const CHARTYPE_TIME = 'time'; |
32 | 32 | const CHARTYPE_PUNCTUATION = 'punctuation'; |
33 | 33 | |
34 | - /** |
|
35 | - * @var string |
|
36 | - */ |
|
34 | + /** |
|
35 | + * @var string |
|
36 | + */ |
|
37 | 37 | private $defaultFormat = "Y/m/d"; |
38 | 38 | |
39 | - /** |
|
40 | - * @var Mailcode_Date_FormatInfo_Character[] |
|
41 | - */ |
|
39 | + /** |
|
40 | + * @var Mailcode_Date_FormatInfo_Character[] |
|
41 | + */ |
|
42 | 42 | private $formatChars = array(); |
43 | 43 | |
44 | - /** |
|
45 | - * @var string[] |
|
46 | - */ |
|
44 | + /** |
|
45 | + * @var string[] |
|
46 | + */ |
|
47 | 47 | private $allowedChars = array(); |
48 | 48 | |
49 | - /** |
|
50 | - * @var Mailcode_Date_FormatInfo|NULL |
|
51 | - */ |
|
49 | + /** |
|
50 | + * @var Mailcode_Date_FormatInfo|NULL |
|
51 | + */ |
|
52 | 52 | private static $instance; |
53 | 53 | |
54 | 54 | private function __construct() |
@@ -66,11 +66,11 @@ discard block |
||
66 | 66 | return self::$instance; |
67 | 67 | } |
68 | 68 | |
69 | - /** |
|
70 | - * Initialized the list of allowed date formatting |
|
71 | - * characters. This is done only once per request |
|
72 | - * by storing them statically for performance reasons. |
|
73 | - */ |
|
69 | + /** |
|
70 | + * Initialized the list of allowed date formatting |
|
71 | + * characters. This is done only once per request |
|
72 | + * by storing them statically for performance reasons. |
|
73 | + */ |
|
74 | 74 | private function initCharacters() : void |
75 | 75 | { |
76 | 76 | $chars = array( |
@@ -113,16 +113,16 @@ discard block |
||
113 | 113 | $this->defaultFormat = $formatString; |
114 | 114 | } |
115 | 115 | |
116 | - /** |
|
117 | - * Validates the date format string, by ensuring that |
|
118 | - * all the characters it is composed of are known. |
|
119 | - * |
|
120 | - * @param string $formatString |
|
121 | - * @return OperationResult |
|
122 | - * |
|
123 | - * @see Mailcode_Commands_Command_ShowDate::VALIDATION_EMPTY_FORMAT_STRING |
|
124 | - * @see Mailcode_Commands_Command_ShowDate::VALIDATION_INVALID_FORMAT_CHARACTER |
|
125 | - */ |
|
116 | + /** |
|
117 | + * Validates the date format string, by ensuring that |
|
118 | + * all the characters it is composed of are known. |
|
119 | + * |
|
120 | + * @param string $formatString |
|
121 | + * @return OperationResult |
|
122 | + * |
|
123 | + * @see Mailcode_Commands_Command_ShowDate::VALIDATION_EMPTY_FORMAT_STRING |
|
124 | + * @see Mailcode_Commands_Command_ShowDate::VALIDATION_INVALID_FORMAT_CHARACTER |
|
125 | + */ |
|
126 | 126 | public function validateFormat(string $formatString) : OperationResult |
127 | 127 | { |
128 | 128 | $result = new OperationResult($this); |
@@ -161,23 +161,23 @@ discard block |
||
161 | 161 | return $result; |
162 | 162 | } |
163 | 163 | |
164 | - /** |
|
165 | - * Retrieves all characters that are allowed to |
|
166 | - * be used in a date format string, with information |
|
167 | - * on each. |
|
168 | - * |
|
169 | - * @return Mailcode_Date_FormatInfo_Character[] |
|
170 | - */ |
|
164 | + /** |
|
165 | + * Retrieves all characters that are allowed to |
|
166 | + * be used in a date format string, with information |
|
167 | + * on each. |
|
168 | + * |
|
169 | + * @return Mailcode_Date_FormatInfo_Character[] |
|
170 | + */ |
|
171 | 171 | public function getCharactersList() : array |
172 | 172 | { |
173 | 173 | return $this->formatChars; |
174 | 174 | } |
175 | 175 | |
176 | - /** |
|
177 | - * Retrieves the characters list, grouped by type label. |
|
178 | - * |
|
179 | - * @return array<string, array> |
|
180 | - */ |
|
176 | + /** |
|
177 | + * Retrieves the characters list, grouped by type label. |
|
178 | + * |
|
179 | + * @return array<string, array> |
|
180 | + */ |
|
181 | 181 | public function getCharactersGrouped() : array |
182 | 182 | { |
183 | 183 | $grouped = array(); |
@@ -22,15 +22,15 @@ discard block |
||
22 | 22 | { |
23 | 23 | const VALIDATION_NOT_A_FORMAT_STRING = 55401; |
24 | 24 | |
25 | - /** |
|
26 | - * The date format string. |
|
27 | - * @var string |
|
28 | - */ |
|
25 | + /** |
|
26 | + * The date format string. |
|
27 | + * @var string |
|
28 | + */ |
|
29 | 29 | private $formatString = "Y/m/d"; |
30 | 30 | |
31 | - /** |
|
32 | - * @var Mailcode_Date_FormatInfo |
|
33 | - */ |
|
31 | + /** |
|
32 | + * @var Mailcode_Date_FormatInfo |
|
33 | + */ |
|
34 | 34 | private $formatInfo; |
35 | 35 | |
36 | 36 | public function getName() : string |
@@ -53,46 +53,46 @@ discard block |
||
53 | 53 | |
54 | 54 | protected function validateSyntax_check_format() : void |
55 | 55 | { |
56 | - $token = $this->params->getInfo()->getTokenByIndex(1); |
|
56 | + $token = $this->params->getInfo()->getTokenByIndex(1); |
|
57 | 57 | |
58 | - // no format specified? Use the default one. |
|
59 | - if($token === null) |
|
60 | - { |
|
61 | - return; |
|
62 | - } |
|
58 | + // no format specified? Use the default one. |
|
59 | + if($token === null) |
|
60 | + { |
|
61 | + return; |
|
62 | + } |
|
63 | 63 | |
64 | - if($token instanceof Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral) |
|
65 | - { |
|
66 | - $format = $token->getText(); |
|
64 | + if($token instanceof Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral) |
|
65 | + { |
|
66 | + $format = $token->getText(); |
|
67 | 67 | |
68 | - $result = $this->formatInfo->validateFormat($format); |
|
68 | + $result = $this->formatInfo->validateFormat($format); |
|
69 | 69 | |
70 | - if($result->isValid()) |
|
71 | - { |
|
70 | + if($result->isValid()) |
|
71 | + { |
|
72 | 72 | $this->formatString = $format; |
73 | - } |
|
74 | - else |
|
75 | - { |
|
76 | - $this->validationResult->makeError( |
|
77 | - $result->getErrorMessage(), |
|
78 | - $result->getCode() |
|
79 | - ); |
|
80 | - } |
|
73 | + } |
|
74 | + else |
|
75 | + { |
|
76 | + $this->validationResult->makeError( |
|
77 | + $result->getErrorMessage(), |
|
78 | + $result->getCode() |
|
79 | + ); |
|
80 | + } |
|
81 | 81 | |
82 | - return; |
|
83 | - } |
|
82 | + return; |
|
83 | + } |
|
84 | 84 | |
85 | - $this->validationResult->makeError( |
|
85 | + $this->validationResult->makeError( |
|
86 | 86 | t('The second parameter must be a date format string.'), |
87 | 87 | self::VALIDATION_NOT_A_FORMAT_STRING |
88 | - ); |
|
88 | + ); |
|
89 | 89 | } |
90 | 90 | |
91 | - /** |
|
92 | - * Retrieves the format string used to format the date. |
|
93 | - * |
|
94 | - * @return string A PHP compatible date format string. |
|
95 | - */ |
|
91 | + /** |
|
92 | + * Retrieves the format string used to format the date. |
|
93 | + * |
|
94 | + * @return string A PHP compatible date format string. |
|
95 | + */ |
|
96 | 96 | public function getFormatString() : string |
97 | 97 | { |
98 | 98 | return $this->formatString; |
@@ -29,24 +29,24 @@ discard block |
||
29 | 29 | |
30 | 30 | const VALIDATION_UNQUOTED_STRING_LITERALS = 48802; |
31 | 31 | |
32 | - /** |
|
33 | - * @var string |
|
34 | - */ |
|
32 | + /** |
|
33 | + * @var string |
|
34 | + */ |
|
35 | 35 | protected $statement; |
36 | 36 | |
37 | - /** |
|
38 | - * @var OperationResult |
|
39 | - */ |
|
37 | + /** |
|
38 | + * @var OperationResult |
|
39 | + */ |
|
40 | 40 | protected $result; |
41 | 41 | |
42 | - /** |
|
43 | - * @var Mailcode_Parser_Statement_Tokenizer |
|
44 | - */ |
|
42 | + /** |
|
43 | + * @var Mailcode_Parser_Statement_Tokenizer |
|
44 | + */ |
|
45 | 45 | protected $tokenizer; |
46 | 46 | |
47 | - /** |
|
48 | - * @var Mailcode_Parser_Statement_Info|NULL |
|
49 | - */ |
|
47 | + /** |
|
48 | + * @var Mailcode_Parser_Statement_Info|NULL |
|
49 | + */ |
|
50 | 50 | protected $info; |
51 | 51 | |
52 | 52 | public function __construct(string $statement) |
@@ -102,7 +102,7 @@ discard block |
||
102 | 102 | if($unknown) |
103 | 103 | { |
104 | 104 | $this->result->makeError( |
105 | - t('Unquoted string literal found:').' ('.htmlspecialchars($unknown->getMatchedText()).')', |
|
105 | + t('Unquoted string literal found:').' ('.htmlspecialchars($unknown->getMatchedText()).')', |
|
106 | 106 | self::VALIDATION_UNQUOTED_STRING_LITERALS |
107 | 107 | ); |
108 | 108 | } |