@@ -23,9 +23,9 @@ discard block |
||
23 | 23 | { |
24 | 24 | const ERROR_UNKNOWN_COMMAND_TYPE = 50401; |
25 | 25 | |
26 | - /** |
|
27 | - * @var string |
|
28 | - */ |
|
26 | + /** |
|
27 | + * @var string |
|
28 | + */ |
|
29 | 29 | protected $typeID; |
30 | 30 | |
31 | 31 | public function __construct(string $typeID) |
@@ -33,22 +33,22 @@ discard block |
||
33 | 33 | $this->typeID = $typeID; |
34 | 34 | } |
35 | 35 | |
36 | - /** |
|
37 | - * Retrieves the syntax' type ID, e.g. "ApacheVelocity". |
|
38 | - * @return string |
|
39 | - */ |
|
36 | + /** |
|
37 | + * Retrieves the syntax' type ID, e.g. "ApacheVelocity". |
|
38 | + * @return string |
|
39 | + */ |
|
40 | 40 | public function getTypeID() : string |
41 | 41 | { |
42 | 42 | return $this->typeID; |
43 | 43 | } |
44 | 44 | |
45 | - /** |
|
46 | - * Translates a single command to the target syntax. |
|
47 | - * |
|
48 | - * @param Mailcode_Commands_Command $command |
|
49 | - * @throws Mailcode_Translator_Exception |
|
50 | - * @return string |
|
51 | - */ |
|
45 | + /** |
|
46 | + * Translates a single command to the target syntax. |
|
47 | + * |
|
48 | + * @param Mailcode_Commands_Command $command |
|
49 | + * @throws Mailcode_Translator_Exception |
|
50 | + * @return string |
|
51 | + */ |
|
52 | 52 | public function translateCommand(Mailcode_Commands_Command $command) : string |
53 | 53 | { |
54 | 54 | $translator = $this->createTranslator($command); |
@@ -81,13 +81,13 @@ discard block |
||
81 | 81 | return $translator; |
82 | 82 | } |
83 | 83 | |
84 | - /** |
|
85 | - * Translates all safeguarded commands in the subject string to the |
|
86 | - * target syntax in one go. |
|
87 | - * |
|
88 | - * @param Mailcode_Parser_Safeguard $safeguard |
|
89 | - * @return string |
|
90 | - */ |
|
84 | + /** |
|
85 | + * Translates all safeguarded commands in the subject string to the |
|
86 | + * target syntax in one go. |
|
87 | + * |
|
88 | + * @param Mailcode_Parser_Safeguard $safeguard |
|
89 | + * @return string |
|
90 | + */ |
|
91 | 91 | public function translateSafeguard(Mailcode_Parser_Safeguard $safeguard) : string |
92 | 92 | { |
93 | 93 | $subject = $safeguard->makeSafe(); |
@@ -64,7 +64,7 @@ discard block |
||
64 | 64 | $command->getID() |
65 | 65 | ); |
66 | 66 | |
67 | - if(!class_exists($class)) |
|
67 | + if (!class_exists($class)) |
|
68 | 68 | { |
69 | 69 | throw new Mailcode_Translator_Exception( |
70 | 70 | sprintf('Unknown command %s in translator', $command->getID()), |
@@ -92,7 +92,7 @@ discard block |
||
92 | 92 | { |
93 | 93 | $subject = $safeguard->makeSafe(); |
94 | 94 | |
95 | - if(!$safeguard->hasPlaceholders()) |
|
95 | + if (!$safeguard->hasPlaceholders()) |
|
96 | 96 | { |
97 | 97 | return $subject; |
98 | 98 | } |
@@ -101,13 +101,13 @@ discard block |
||
101 | 101 | |
102 | 102 | $replaces = array(); |
103 | 103 | |
104 | - foreach($placeholders as $placeholder) |
|
104 | + foreach ($placeholders as $placeholder) |
|
105 | 105 | { |
106 | 106 | $command = $placeholder->getCommand(); |
107 | 107 | |
108 | 108 | $replaces[$placeholder->getReplacementText()] = $this->translateCommand($command); |
109 | 109 | |
110 | - if($command instanceof Mailcode_Interfaces_Commands_ProtectedContent) |
|
110 | + if ($command instanceof Mailcode_Interfaces_Commands_ProtectedContent) |
|
111 | 111 | { |
112 | 112 | $replaces[$command->getContentPlaceholder()] = $command->getContent(); |
113 | 113 | } |
@@ -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) |
@@ -87,7 +87,7 @@ |
||
87 | 87 | */ |
88 | 88 | public function getTypeLabel() : string |
89 | 89 | { |
90 | - switch($this->type) |
|
90 | + switch ($this->type) |
|
91 | 91 | { |
92 | 92 | case Mailcode_Date_FormatInfo::CHARTYPE_DATE: |
93 | 93 | return t('Date'); |
@@ -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(); |
@@ -58,7 +58,7 @@ discard block |
||
58 | 58 | |
59 | 59 | public static function getInstance() : Mailcode_Date_FormatInfo |
60 | 60 | { |
61 | - if(!isset(self::$instance)) |
|
61 | + if (!isset(self::$instance)) |
|
62 | 62 | { |
63 | 63 | self::$instance = new Mailcode_Date_FormatInfo(); |
64 | 64 | } |
@@ -90,7 +90,7 @@ discard block |
||
90 | 90 | array(self::CHARTYPE_PUNCTUATION, ' ', t('Space')) |
91 | 91 | ); |
92 | 92 | |
93 | - foreach($chars as $def) |
|
93 | + foreach ($chars as $def) |
|
94 | 94 | { |
95 | 95 | $char = new Mailcode_Date_FormatInfo_Character( |
96 | 96 | $def[0], |
@@ -129,7 +129,7 @@ discard block |
||
129 | 129 | |
130 | 130 | $trimmed = trim($formatString); |
131 | 131 | |
132 | - if(empty($trimmed)) |
|
132 | + if (empty($trimmed)) |
|
133 | 133 | { |
134 | 134 | $result->makeError( |
135 | 135 | t('Empty date format.'), |
@@ -142,15 +142,15 @@ discard block |
||
142 | 142 | $chars = ConvertHelper::string2array($formatString); |
143 | 143 | $total = count($chars); |
144 | 144 | |
145 | - for($i=0; $i < $total; $i++) |
|
145 | + for ($i = 0; $i < $total; $i++) |
|
146 | 146 | { |
147 | 147 | $char = $chars[$i]; |
148 | 148 | |
149 | - if(!in_array($char, $this->allowedChars)) |
|
149 | + if (!in_array($char, $this->allowedChars)) |
|
150 | 150 | { |
151 | 151 | $result->makeError( |
152 | 152 | t('Invalid character in date format:').' '. |
153 | - t('%1$s at position %2$s.', '<code>'.$char.'</code>', $i+1), |
|
153 | + t('%1$s at position %2$s.', '<code>'.$char.'</code>', $i + 1), |
|
154 | 154 | self::VALIDATION_INVALID_FORMAT_CHARACTER |
155 | 155 | ); |
156 | 156 | |
@@ -182,11 +182,11 @@ discard block |
||
182 | 182 | { |
183 | 183 | $grouped = array(); |
184 | 184 | |
185 | - foreach($this->formatChars as $char) |
|
185 | + foreach ($this->formatChars as $char) |
|
186 | 186 | { |
187 | 187 | $type = $char->getTypeLabel(); |
188 | 188 | |
189 | - if(!isset($grouped[$type])) |
|
189 | + if (!isset($grouped[$type])) |
|
190 | 190 | { |
191 | 191 | $grouped[$type] = array(); |
192 | 192 | } |
@@ -196,7 +196,7 @@ discard block |
||
196 | 196 | |
197 | 197 | $groups = array_keys($grouped); |
198 | 198 | |
199 | - foreach($groups as $group) |
|
199 | + foreach ($groups as $group) |
|
200 | 200 | { |
201 | 201 | usort($grouped[$group], function(Mailcode_Date_FormatInfo_Character $a, Mailcode_Date_FormatInfo_Character $b) |
202 | 202 | { |
@@ -46,7 +46,7 @@ discard block |
||
46 | 46 | { |
47 | 47 | static $ids = array(); |
48 | 48 | |
49 | - if(empty($ids)) { |
|
49 | + if (empty($ids)) { |
|
50 | 50 | $ids = \AppUtils\FileHelper::createFileFinder(__DIR__.'/Commands/Command') |
51 | 51 | ->getPHPClassNames(); |
52 | 52 | } |
@@ -63,7 +63,7 @@ discard block |
||
63 | 63 | */ |
64 | 64 | public function getAll() |
65 | 65 | { |
66 | - if(!empty($this->commands)) { |
|
66 | + if (!empty($this->commands)) { |
|
67 | 67 | return $this->commands; |
68 | 68 | } |
69 | 69 | |
@@ -71,7 +71,7 @@ discard block |
||
71 | 71 | |
72 | 72 | $result = array(); |
73 | 73 | |
74 | - foreach($ids as $id) |
|
74 | + foreach ($ids as $id) |
|
75 | 75 | { |
76 | 76 | $result[] = $this->getDummyCommand($id); |
77 | 77 | } |
@@ -96,7 +96,7 @@ discard block |
||
96 | 96 | { |
97 | 97 | static $instances = array(); |
98 | 98 | |
99 | - if(!isset($instances[$id])) |
|
99 | + if (!isset($instances[$id])) |
|
100 | 100 | { |
101 | 101 | $instances[$id] = $this->createCommand($id, '__dummy', '', ''); |
102 | 102 | } |
@@ -117,9 +117,9 @@ discard block |
||
117 | 117 | { |
118 | 118 | $items = $this->getAll(); |
119 | 119 | |
120 | - foreach($items as $item) |
|
120 | + foreach ($items as $item) |
|
121 | 121 | { |
122 | - if($item->getName() === $name) { |
|
122 | + if ($item->getName() === $name) { |
|
123 | 123 | return $item->getID(); |
124 | 124 | } |
125 | 125 | } |
@@ -151,9 +151,9 @@ discard block |
||
151 | 151 | { |
152 | 152 | $items = $this->getAll(); |
153 | 153 | |
154 | - foreach($items as $item) |
|
154 | + foreach ($items as $item) |
|
155 | 155 | { |
156 | - if($item->getName() === $name) { |
|
156 | + if ($item->getName() === $name) { |
|
157 | 157 | return true; |
158 | 158 | } |
159 | 159 | } |
@@ -165,7 +165,7 @@ discard block |
||
165 | 165 | { |
166 | 166 | $class = $this->resolveClassName($id, $type); |
167 | 167 | |
168 | - if(!class_exists($class)) |
|
168 | + if (!class_exists($class)) |
|
169 | 169 | { |
170 | 170 | throw new Mailcode_Exception( |
171 | 171 | 'No such command', |
@@ -187,9 +187,9 @@ discard block |
||
187 | 187 | |
188 | 188 | $dummy = $this->getDummyCommand($id); |
189 | 189 | |
190 | - if($dummy->supportsType()) |
|
190 | + if ($dummy->supportsType()) |
|
191 | 191 | { |
192 | - if(empty($type)) |
|
192 | + if (empty($type)) |
|
193 | 193 | { |
194 | 194 | $type = $dummy->getDefaultType(); |
195 | 195 | } |
@@ -209,13 +209,13 @@ discard block |
||
209 | 209 | */ |
210 | 210 | private function getDummyCommand(string $id) : Mailcode_Commands_Command |
211 | 211 | { |
212 | - if(!isset(self::$dummyCommands[$id])) |
|
212 | + if (!isset(self::$dummyCommands[$id])) |
|
213 | 213 | { |
214 | 214 | $class = 'Mailcode\Mailcode_Commands_Command_'.$id; |
215 | 215 | self::$dummyCommands[$id] = new $class('__dummy'); |
216 | 216 | } |
217 | 217 | |
218 | - if(self::$dummyCommands[$id] instanceof Mailcode_Commands_Command) |
|
218 | + if (self::$dummyCommands[$id] instanceof Mailcode_Commands_Command) |
|
219 | 219 | { |
220 | 220 | return self::$dummyCommands[$id]; |
221 | 221 | } |
@@ -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 |
@@ -35,14 +35,14 @@ |
||
35 | 35 | */ |
36 | 36 | private $misc; |
37 | 37 | |
38 | - /** |
|
39 | - * @var Mailcode_Factory_CommandSets_Set_Set |
|
40 | - */ |
|
38 | + /** |
|
39 | + * @var Mailcode_Factory_CommandSets_Set_Set |
|
40 | + */ |
|
41 | 41 | private $set; |
42 | 42 | |
43 | - /** |
|
44 | - * @var Mailcode_Factory_CommandSets_Set_ElseIf |
|
45 | - */ |
|
43 | + /** |
|
44 | + * @var Mailcode_Factory_CommandSets_Set_ElseIf |
|
45 | + */ |
|
46 | 46 | private $elseIf; |
47 | 47 | |
48 | 48 | public function if() : Mailcode_Factory_CommandSets_Set_If |
@@ -45,9 +45,9 @@ discard block |
||
45 | 45 | */ |
46 | 46 | private $elseIf; |
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 | } |
@@ -40,8 +40,7 @@ |
||
40 | 40 | if($keyCommand instanceof Mailcode_Commands_IfBase) |
41 | 41 | { |
42 | 42 | $body .= ' '.$this->getSign($keyword).' '.$this->translateBody($keyCommand); |
43 | - } |
|
44 | - else |
|
43 | + } else |
|
45 | 44 | { |
46 | 45 | throw new Mailcode_Exception( |
47 | 46 | 'Keyword command type does not match expected base class.', |
@@ -39,7 +39,7 @@ discard block |
||
39 | 39 | // IF type. |
40 | 40 | $method = 'translate'.$this->getIfType($command); |
41 | 41 | |
42 | - if(method_exists($this, $method)) |
|
42 | + if (method_exists($this, $method)) |
|
43 | 43 | { |
44 | 44 | return strval($this->$method($command)); |
45 | 45 | } |
@@ -53,11 +53,11 @@ discard block |
||
53 | 53 | |
54 | 54 | $keywords = $command->getLogicKeywords()->getKeywords(); |
55 | 55 | |
56 | - foreach($keywords as $keyword) |
|
56 | + foreach ($keywords as $keyword) |
|
57 | 57 | { |
58 | 58 | $keyCommand = $keyword->getCommand(); |
59 | 59 | |
60 | - if($keyCommand instanceof Mailcode_Commands_IfBase) |
|
60 | + if ($keyCommand instanceof Mailcode_Commands_IfBase) |
|
61 | 61 | { |
62 | 62 | $body .= ' '.$this->getSign($keyword).' '.$this->translateBody($keyCommand); |
63 | 63 | } |
@@ -80,7 +80,7 @@ discard block |
||
80 | 80 | |
81 | 81 | protected function getSign(Mailcode_Commands_LogicKeywords_Keyword $keyword) : string |
82 | 82 | { |
83 | - switch($keyword->getName()) |
|
83 | + switch ($keyword->getName()) |
|
84 | 84 | { |
85 | 85 | case 'and': |
86 | 86 | return '&&'; |
@@ -117,7 +117,7 @@ discard block |
||
117 | 117 | { |
118 | 118 | $sign = ''; |
119 | 119 | |
120 | - if($notEmpty) |
|
120 | + if ($notEmpty) |
|
121 | 121 | { |
122 | 122 | $sign = '!'; |
123 | 123 | } |
@@ -133,12 +133,12 @@ discard block |
||
133 | 133 | { |
134 | 134 | $params = $command->getParams(); |
135 | 135 | |
136 | - if(!$params) |
|
136 | + if (!$params) |
|
137 | 137 | { |
138 | 138 | return ''; |
139 | 139 | } |
140 | 140 | |
141 | - if($command->hasFreeformParameters()) |
|
141 | + if ($command->hasFreeformParameters()) |
|
142 | 142 | { |
143 | 143 | return $params->getStatementString(); |
144 | 144 | } |
@@ -151,7 +151,7 @@ discard block |
||
151 | 151 | $test = strtolower(trim($value, '"')); |
152 | 152 | $fullName = $variable->getFullName(); |
153 | 153 | |
154 | - if(in_array($test, array('true', 'false'))) |
|
154 | + if (in_array($test, array('true', 'false'))) |
|
155 | 155 | { |
156 | 156 | $fullName .= '.toLowerCase()'; |
157 | 157 | $value = '"'.$test.'"'; |
@@ -182,7 +182,7 @@ discard block |
||
182 | 182 | protected function _translateSearch(string $mode, Mailcode_Variables_Variable $variable, bool $caseSensitive, string $searchTerm) : string |
183 | 183 | { |
184 | 184 | $method = $mode.'With'; |
185 | - if($caseSensitive) |
|
185 | + if ($caseSensitive) |
|
186 | 186 | { |
187 | 187 | $method = $mode.'WithIgnoreCase'; |
188 | 188 | } |
@@ -31,27 +31,27 @@ discard block |
||
31 | 31 | const VALIDATION_CANNOT_MIX_LOGIC_KEYWORDS = 60701; |
32 | 32 | 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) |
@@ -136,9 +136,9 @@ discard block |
||
136 | 136 | } |
137 | 137 | } |
138 | 138 | |
139 | - /** |
|
140 | - * @return string[] |
|
141 | - */ |
|
139 | + /** |
|
140 | + * @return string[] |
|
141 | + */ |
|
142 | 142 | private function detectParameters() : array |
143 | 143 | { |
144 | 144 | $params = $this->paramsString; |
@@ -156,13 +156,13 @@ discard block |
||
156 | 156 | return $stack; |
157 | 157 | } |
158 | 158 | |
159 | - /** |
|
160 | - * @param string $params |
|
161 | - * @param Mailcode_Commands_LogicKeywords_Keyword $keyword |
|
162 | - * @param string[] $stack |
|
163 | - * @throws Mailcode_Exception |
|
164 | - * @return string |
|
165 | - */ |
|
159 | + /** |
|
160 | + * @param string $params |
|
161 | + * @param Mailcode_Commands_LogicKeywords_Keyword $keyword |
|
162 | + * @param string[] $stack |
|
163 | + * @throws Mailcode_Exception |
|
164 | + * @return string |
|
165 | + */ |
|
166 | 166 | private function detectParamsKeyword(string $params, Mailcode_Commands_LogicKeywords_Keyword $keyword, array &$stack) : string |
167 | 167 | { |
168 | 168 | $search = $keyword->getMatchedString(); |
@@ -187,22 +187,22 @@ discard block |
||
187 | 187 | return $params; |
188 | 188 | } |
189 | 189 | |
190 | - /** |
|
191 | - * Extracts the parameters string to use for the |
|
192 | - * original command itself, omitting all the logic |
|
193 | - * keywords for the sub-commands. |
|
194 | - * |
|
195 | - * @return string |
|
196 | - */ |
|
190 | + /** |
|
191 | + * Extracts the parameters string to use for the |
|
192 | + * original command itself, omitting all the logic |
|
193 | + * keywords for the sub-commands. |
|
194 | + * |
|
195 | + * @return string |
|
196 | + */ |
|
197 | 197 | public function getMainParamsString() : string |
198 | 198 | { |
199 | 199 | return $this->mainParams; |
200 | 200 | } |
201 | 201 | |
202 | - /** |
|
203 | - * Retrieves the detected keyword names. |
|
204 | - * @return string[] |
|
205 | - */ |
|
202 | + /** |
|
203 | + * Retrieves the detected keyword names. |
|
204 | + * @return string[] |
|
205 | + */ |
|
206 | 206 | public function getDetectedNames() : array |
207 | 207 | { |
208 | 208 | $names = array(); |
@@ -220,23 +220,23 @@ discard block |
||
220 | 220 | return $names; |
221 | 221 | } |
222 | 222 | |
223 | - /** |
|
224 | - * Retrieves all keywords that were detected in the |
|
225 | - * command's parameters string, if any. |
|
226 | - * |
|
227 | - * @return Mailcode_Commands_LogicKeywords_Keyword[] |
|
228 | - */ |
|
223 | + /** |
|
224 | + * Retrieves all keywords that were detected in the |
|
225 | + * command's parameters string, if any. |
|
226 | + * |
|
227 | + * @return Mailcode_Commands_LogicKeywords_Keyword[] |
|
228 | + */ |
|
229 | 229 | public function getKeywords() : array |
230 | 230 | { |
231 | 231 | return $this->keywords; |
232 | 232 | } |
233 | 233 | |
234 | - /** |
|
235 | - * Detects any keyword statements in the parameters by keyword name. |
|
236 | - * |
|
237 | - * @param string $name |
|
238 | - * @return Mailcode_Commands_LogicKeywords_Keyword[] |
|
239 | - */ |
|
234 | + /** |
|
235 | + * Detects any keyword statements in the parameters by keyword name. |
|
236 | + * |
|
237 | + * @param string $name |
|
238 | + * @return Mailcode_Commands_LogicKeywords_Keyword[] |
|
239 | + */ |
|
240 | 240 | private function detectKeywords(string $name) : array |
241 | 241 | { |
242 | 242 | $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( |
@@ -109,7 +109,7 @@ discard block |
||
109 | 109 | |
110 | 110 | private function splitParams() : void |
111 | 111 | { |
112 | - if(empty($this->keywords)) |
|
112 | + if (empty($this->keywords)) |
|
113 | 113 | { |
114 | 114 | $this->mainParams = $this->paramsString; |
115 | 115 | |
@@ -118,13 +118,13 @@ discard block |
||
118 | 118 | |
119 | 119 | $params = $this->detectParameters(); |
120 | 120 | |
121 | - foreach($this->keywords as $keyword) |
|
121 | + foreach ($this->keywords as $keyword) |
|
122 | 122 | { |
123 | 123 | $kParams = array_shift($params); |
124 | 124 | |
125 | 125 | $keyword->setParamsString($kParams); |
126 | 126 | |
127 | - if(!$keyword->isValid()) |
|
127 | + if (!$keyword->isValid()) |
|
128 | 128 | { |
129 | 129 | $this->makeError( |
130 | 130 | t('Error #%1$s:', $keyword->getCode()).' '.$keyword->getErrorMessage(), |
@@ -144,7 +144,7 @@ discard block |
||
144 | 144 | $params = $this->paramsString; |
145 | 145 | $stack = array(); |
146 | 146 | |
147 | - foreach($this->keywords as $keyword) |
|
147 | + foreach ($this->keywords as $keyword) |
|
148 | 148 | { |
149 | 149 | $params = $this->detectParamsKeyword($params, $keyword, $stack); |
150 | 150 | } |
@@ -168,7 +168,7 @@ discard block |
||
168 | 168 | $search = $keyword->getMatchedString(); |
169 | 169 | $pos = strpos($params, $search, 0); |
170 | 170 | |
171 | - if($pos === false) |
|
171 | + if ($pos === false) |
|
172 | 172 | { |
173 | 173 | throw new Mailcode_Exception( |
174 | 174 | 'Keyword matched string not found', |
@@ -180,7 +180,7 @@ discard block |
||
180 | 180 | $length = strlen($search); |
181 | 181 | |
182 | 182 | $store = substr($params, 0, $pos); |
183 | - $params = trim(substr($params, $pos+$length)); |
|
183 | + $params = trim(substr($params, $pos + $length)); |
|
184 | 184 | |
185 | 185 | $stack[] = $store; |
186 | 186 | |
@@ -207,11 +207,11 @@ discard block |
||
207 | 207 | { |
208 | 208 | $names = array(); |
209 | 209 | |
210 | - foreach($this->keywords as $keyword) |
|
210 | + foreach ($this->keywords as $keyword) |
|
211 | 211 | { |
212 | 212 | $name = $keyword->getName(); |
213 | 213 | |
214 | - if(!in_array($name, $names)) |
|
214 | + if (!in_array($name, $names)) |
|
215 | 215 | { |
216 | 216 | $names[] = $name; |
217 | 217 | } |
@@ -244,7 +244,7 @@ discard block |
||
244 | 244 | $matches = array(); |
245 | 245 | preg_match_all($regex, $this->paramsString, $matches, PREG_PATTERN_ORDER); |
246 | 246 | |
247 | - if(!isset($matches[0][0]) || empty($matches[0][0])) |
|
247 | + if (!isset($matches[0][0]) || empty($matches[0][0])) |
|
248 | 248 | { |
249 | 249 | return array(); |
250 | 250 | } |
@@ -252,7 +252,7 @@ discard block |
||
252 | 252 | $amount = count($matches[0]); |
253 | 253 | $result = array(); |
254 | 254 | |
255 | - for($i=0; $i < $amount; $i++) |
|
255 | + for ($i = 0; $i < $amount; $i++) |
|
256 | 256 | { |
257 | 257 | $result[] = $this->createKeyword( |
258 | 258 | $name, |
@@ -269,22 +269,22 @@ discard block |
||
269 | 269 | return !empty($this->keywords); |
270 | 270 | } |
271 | 271 | |
272 | - public function appendAND(string $paramsString, string $type='') : Mailcode_Commands_LogicKeywords_Keyword |
|
272 | + public function appendAND(string $paramsString, string $type = '') : Mailcode_Commands_LogicKeywords_Keyword |
|
273 | 273 | { |
274 | 274 | return $this->appendKeyword('and', $paramsString, $type); |
275 | 275 | } |
276 | 276 | |
277 | - public function appendOR(string $paramsString, string $type='') : Mailcode_Commands_LogicKeywords_Keyword |
|
277 | + public function appendOR(string $paramsString, string $type = '') : Mailcode_Commands_LogicKeywords_Keyword |
|
278 | 278 | { |
279 | 279 | return $this->appendKeyword('or', $paramsString, $type); |
280 | 280 | } |
281 | 281 | |
282 | - public function appendKeyword(string $name, string $paramsString, string $type='') : Mailcode_Commands_LogicKeywords_Keyword |
|
282 | + public function appendKeyword(string $name, string $paramsString, string $type = '') : Mailcode_Commands_LogicKeywords_Keyword |
|
283 | 283 | { |
284 | 284 | $keyword = $this->createKeyword($name, $type); |
285 | 285 | $keyword->setParamsString($paramsString); |
286 | 286 | |
287 | - if(!$keyword->isValid()) |
|
287 | + if (!$keyword->isValid()) |
|
288 | 288 | { |
289 | 289 | throw new Mailcode_Exception( |
290 | 290 | 'Cannot append invalid logic keyword', |
@@ -305,13 +305,13 @@ discard block |
||
305 | 305 | return $keyword; |
306 | 306 | } |
307 | 307 | |
308 | - private function createKeyword(string $name, string $type='', string $matchedString='') : Mailcode_Commands_LogicKeywords_Keyword |
|
308 | + private function createKeyword(string $name, string $type = '', string $matchedString = '') : Mailcode_Commands_LogicKeywords_Keyword |
|
309 | 309 | { |
310 | - if(empty($matchedString)) |
|
310 | + if (empty($matchedString)) |
|
311 | 311 | { |
312 | 312 | $matchedString = $name; |
313 | 313 | |
314 | - if(!empty($type)) |
|
314 | + if (!empty($type)) |
|
315 | 315 | { |
316 | 316 | $matchedString .= ' '.$type; |
317 | 317 | } |