@@ -73,7 +73,7 @@ discard block |
||
73 | 73 | */ |
74 | 74 | public function getParser() : Mailcode_Parser |
75 | 75 | { |
76 | - if(!isset($this->parser)) |
|
76 | + if (!isset($this->parser)) |
|
77 | 77 | { |
78 | 78 | $this->parser = new Mailcode_Parser($this); |
79 | 79 | } |
@@ -89,7 +89,7 @@ discard block |
||
89 | 89 | */ |
90 | 90 | public function getCommands() : Mailcode_Commands |
91 | 91 | { |
92 | - if(!isset($this->commands)) |
|
92 | + if (!isset($this->commands)) |
|
93 | 93 | { |
94 | 94 | $this->commands = new Mailcode_Commands(); |
95 | 95 | } |
@@ -115,7 +115,7 @@ discard block |
||
115 | 115 | |
116 | 116 | public function createVariables() : Mailcode_Variables |
117 | 117 | { |
118 | - if(!isset($this->variables)) |
|
118 | + if (!isset($this->variables)) |
|
119 | 119 | { |
120 | 120 | $this->variables = new Mailcode_Variables(); |
121 | 121 | } |
@@ -131,7 +131,7 @@ discard block |
||
131 | 131 | */ |
132 | 132 | public function createTranslator() : Mailcode_Translator |
133 | 133 | { |
134 | - if(!isset($this->translator)) |
|
134 | + if (!isset($this->translator)) |
|
135 | 135 | { |
136 | 136 | $this->translator = new Mailcode_Translator(); |
137 | 137 | } |
@@ -26,51 +26,51 @@ discard block |
||
26 | 26 | */ |
27 | 27 | class Mailcode |
28 | 28 | { |
29 | - /** |
|
30 | - * @var Mailcode_Parser|NULL |
|
31 | - */ |
|
29 | + /** |
|
30 | + * @var Mailcode_Parser|NULL |
|
31 | + */ |
|
32 | 32 | protected $parser = null; |
33 | 33 | |
34 | - /** |
|
35 | - * @var Mailcode_Commands|NULL |
|
36 | - */ |
|
34 | + /** |
|
35 | + * @var Mailcode_Commands|NULL |
|
36 | + */ |
|
37 | 37 | protected $commands = null; |
38 | 38 | |
39 | - /** |
|
40 | - * @var Mailcode_Variables|NULL |
|
41 | - */ |
|
39 | + /** |
|
40 | + * @var Mailcode_Variables|NULL |
|
41 | + */ |
|
42 | 42 | protected $variables = null; |
43 | 43 | |
44 | - /** |
|
45 | - * @var Mailcode_Translator|NULL |
|
46 | - */ |
|
44 | + /** |
|
45 | + * @var Mailcode_Translator|NULL |
|
46 | + */ |
|
47 | 47 | protected $translator = null; |
48 | 48 | |
49 | - /** |
|
50 | - * Creates a new mailcode instance. |
|
51 | - * @return Mailcode |
|
52 | - */ |
|
49 | + /** |
|
50 | + * Creates a new mailcode instance. |
|
51 | + * @return Mailcode |
|
52 | + */ |
|
53 | 53 | public static function create() : Mailcode |
54 | 54 | { |
55 | 55 | return new Mailcode(); |
56 | 56 | } |
57 | 57 | |
58 | - /** |
|
59 | - * Parses the string to detect all commands contained within. |
|
60 | - * |
|
61 | - * @param string $string |
|
62 | - * @return Mailcode_Collection |
|
63 | - */ |
|
58 | + /** |
|
59 | + * Parses the string to detect all commands contained within. |
|
60 | + * |
|
61 | + * @param string $string |
|
62 | + * @return Mailcode_Collection |
|
63 | + */ |
|
64 | 64 | public function parseString(string $string) : Mailcode_Collection |
65 | 65 | { |
66 | 66 | return $this->getParser()->parseString($string); |
67 | 67 | } |
68 | 68 | |
69 | - /** |
|
70 | - * Retrieves the string parser instance used to detect commands. |
|
71 | - * |
|
72 | - * @return Mailcode_Parser |
|
73 | - */ |
|
69 | + /** |
|
70 | + * Retrieves the string parser instance used to detect commands. |
|
71 | + * |
|
72 | + * @return Mailcode_Parser |
|
73 | + */ |
|
74 | 74 | public function getParser() : Mailcode_Parser |
75 | 75 | { |
76 | 76 | if(!isset($this->parser)) |
@@ -81,12 +81,12 @@ discard block |
||
81 | 81 | return $this->parser; |
82 | 82 | } |
83 | 83 | |
84 | - /** |
|
85 | - * Retrieves the commands collection, which is used to |
|
86 | - * access information on the available commands. |
|
87 | - * |
|
88 | - * @return Mailcode_Commands |
|
89 | - */ |
|
84 | + /** |
|
85 | + * Retrieves the commands collection, which is used to |
|
86 | + * access information on the available commands. |
|
87 | + * |
|
88 | + * @return Mailcode_Commands |
|
89 | + */ |
|
90 | 90 | public function getCommands() : Mailcode_Commands |
91 | 91 | { |
92 | 92 | if(!isset($this->commands)) |
@@ -102,12 +102,12 @@ discard block |
||
102 | 102 | return $this->getParser()->createSafeguard($subject); |
103 | 103 | } |
104 | 104 | |
105 | - /** |
|
106 | - * Attempts to find all variables in the target string. |
|
107 | - * |
|
108 | - * @param string $subject |
|
109 | - * @return Mailcode_Variables_Collection_Regular |
|
110 | - */ |
|
105 | + /** |
|
106 | + * Attempts to find all variables in the target string. |
|
107 | + * |
|
108 | + * @param string $subject |
|
109 | + * @return Mailcode_Variables_Collection_Regular |
|
110 | + */ |
|
111 | 111 | public function findVariables(string $subject) : Mailcode_Variables_Collection_Regular |
112 | 112 | { |
113 | 113 | return $this->createVariables()->parseString($subject); |
@@ -123,12 +123,12 @@ discard block |
||
123 | 123 | return $this->variables; |
124 | 124 | } |
125 | 125 | |
126 | - /** |
|
127 | - * Creates the translator, which can be used to convert commands |
|
128 | - * to another supported syntax. |
|
129 | - * |
|
130 | - * @return Mailcode_Translator |
|
131 | - */ |
|
126 | + /** |
|
127 | + * Creates the translator, which can be used to convert commands |
|
128 | + * to another supported syntax. |
|
129 | + * |
|
130 | + * @return Mailcode_Translator |
|
131 | + */ |
|
132 | 132 | public function createTranslator() : Mailcode_Translator |
133 | 133 | { |
134 | 134 | if(!isset($this->translator)) |
@@ -139,12 +139,12 @@ discard block |
||
139 | 139 | return $this->translator; |
140 | 140 | } |
141 | 141 | |
142 | - /** |
|
143 | - * Creates the styler, which can be used to retrieve the |
|
144 | - * CSS required to style the highlighted commands in HTML. |
|
145 | - * |
|
146 | - * @return Mailcode_Styler |
|
147 | - */ |
|
142 | + /** |
|
143 | + * Creates the styler, which can be used to retrieve the |
|
144 | + * CSS required to style the highlighted commands in HTML. |
|
145 | + * |
|
146 | + * @return Mailcode_Styler |
|
147 | + */ |
|
148 | 148 | public function createStyler() : Mailcode_Styler |
149 | 149 | { |
150 | 150 | return new Mailcode_Styler(); |
@@ -25,7 +25,7 @@ |
||
25 | 25 | $this->paramsString = trim($this->paramsString); |
26 | 26 | |
27 | 27 | // automatically quote the parameters, since comments don't require any. |
28 | - if(substr($this->paramsString, 0, 1) != '"') |
|
28 | + if (substr($this->paramsString, 0, 1) != '"') |
|
29 | 29 | { |
30 | 30 | $this->paramsString = '"'.$this->paramsString.'"'; |
31 | 31 | } |
@@ -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) |
@@ -234,11 +234,11 @@ discard block |
||
234 | 234 | return false; |
235 | 235 | } |
236 | 236 | |
237 | - /** |
|
238 | - * Retrieves only show variable commands in the collection, if any. |
|
239 | - * |
|
240 | - * @return \Mailcode\Mailcode_Commands_Command_ShowVariable[] |
|
241 | - */ |
|
237 | + /** |
|
238 | + * Retrieves only show variable commands in the collection, if any. |
|
239 | + * |
|
240 | + * @return \Mailcode\Mailcode_Commands_Command_ShowVariable[] |
|
241 | + */ |
|
242 | 242 | public function getShowVariableCommands() |
243 | 243 | { |
244 | 244 | $result = array(); |
@@ -99,7 +99,7 @@ discard block |
||
99 | 99 | |
100 | 100 | $errors = $this->errors; |
101 | 101 | |
102 | - if(!$result->isValid()) |
|
102 | + if (!$result->isValid()) |
|
103 | 103 | { |
104 | 104 | $errors[] = new Mailcode_Collection_Error_Message( |
105 | 105 | '', |
@@ -115,7 +115,7 @@ discard block |
||
115 | 115 | { |
116 | 116 | $errors = $this->getErrors(); |
117 | 117 | |
118 | - if(!empty($errors)) |
|
118 | + if (!empty($errors)) |
|
119 | 119 | { |
120 | 120 | return array_shift($errors); |
121 | 121 | } |
@@ -157,11 +157,11 @@ discard block |
||
157 | 157 | { |
158 | 158 | $hashes = array(); |
159 | 159 | |
160 | - foreach($this->commands as $command) |
|
160 | + foreach ($this->commands as $command) |
|
161 | 161 | { |
162 | 162 | $hash = $command->getHash(); |
163 | 163 | |
164 | - if(!isset($hashes[$hash])) |
|
164 | + if (!isset($hashes[$hash])) |
|
165 | 165 | { |
166 | 166 | $hashes[$hash] = $command; |
167 | 167 | } |
@@ -178,7 +178,7 @@ discard block |
||
178 | 178 | */ |
179 | 179 | public function addCommands(array $commands) : Mailcode_Collection |
180 | 180 | { |
181 | - foreach($commands as $command) |
|
181 | + foreach ($commands as $command) |
|
182 | 182 | { |
183 | 183 | $this->addCommand($command); |
184 | 184 | } |
@@ -197,7 +197,7 @@ discard block |
||
197 | 197 | { |
198 | 198 | $collection = new Mailcode_Variables_Collection_Regular(); |
199 | 199 | |
200 | - foreach($this->commands as $command) |
|
200 | + foreach ($this->commands as $command) |
|
201 | 201 | { |
202 | 202 | $collection->mergeWith($command->getVariables()); |
203 | 203 | } |
@@ -207,7 +207,7 @@ discard block |
||
207 | 207 | |
208 | 208 | public function getValidationResult() : OperationResult |
209 | 209 | { |
210 | - if($this->validationResult instanceof OperationResult) |
|
210 | + if ($this->validationResult instanceof OperationResult) |
|
211 | 211 | { |
212 | 212 | return $this->validationResult; |
213 | 213 | } |
@@ -223,9 +223,9 @@ discard block |
||
223 | 223 | { |
224 | 224 | $errors = $this->getErrors(); |
225 | 225 | |
226 | - foreach($errors as $error) |
|
226 | + foreach ($errors as $error) |
|
227 | 227 | { |
228 | - if($error->getCode() === $code) |
|
228 | + if ($error->getCode() === $code) |
|
229 | 229 | { |
230 | 230 | return true; |
231 | 231 | } |
@@ -243,9 +243,9 @@ discard block |
||
243 | 243 | { |
244 | 244 | $result = array(); |
245 | 245 | |
246 | - foreach($this->commands as $command) |
|
246 | + foreach ($this->commands as $command) |
|
247 | 247 | { |
248 | - if($command instanceof Mailcode_Commands_Command_ShowVariable) |
|
248 | + if ($command instanceof Mailcode_Commands_Command_ShowVariable) |
|
249 | 249 | { |
250 | 250 | $result[] = $command; |
251 | 251 | } |
@@ -258,7 +258,7 @@ discard block |
||
258 | 258 | { |
259 | 259 | $commands = $this->getCommands(); |
260 | 260 | |
261 | - if(!empty($commands)) |
|
261 | + if (!empty($commands)) |
|
262 | 262 | { |
263 | 263 | return array_shift($commands); |
264 | 264 | } |
@@ -20,13 +20,13 @@ |
||
20 | 20 | */ |
21 | 21 | abstract class Mailcode_Translator_Syntax_ApacheVelocity extends Mailcode_Translator_Command |
22 | 22 | { |
23 | - /** |
|
24 | - * Filters the string for use in an Apache Velocity (Java) |
|
25 | - * regex string: escapes all special characters. |
|
26 | - * |
|
27 | - * @param string $string |
|
28 | - * @return string |
|
29 | - */ |
|
23 | + /** |
|
24 | + * Filters the string for use in an Apache Velocity (Java) |
|
25 | + * regex string: escapes all special characters. |
|
26 | + * |
|
27 | + * @param string $string |
|
28 | + * @return string |
|
29 | + */ |
|
30 | 30 | protected function filterRegexString(string $string) : string |
31 | 31 | { |
32 | 32 | $escape = array( |
@@ -48,7 +48,7 @@ |
||
48 | 48 | ')' |
49 | 49 | ); |
50 | 50 | |
51 | - foreach($escape as $char) |
|
51 | + foreach ($escape as $char) |
|
52 | 52 | { |
53 | 53 | $string = str_replace($char, '\\'.$char, $string); |
54 | 54 | } |
@@ -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,7 +101,7 @@ discard block |
||
101 | 101 | |
102 | 102 | $replaces = array(); |
103 | 103 | |
104 | - foreach($placeholders as $placeholder) |
|
104 | + foreach ($placeholders as $placeholder) |
|
105 | 105 | { |
106 | 106 | $replaces[$placeholder->getReplacementText()] = $this->translateCommand($placeholder->getCommand()); |
107 | 107 | } |
@@ -25,9 +25,9 @@ |
||
25 | 25 | |
26 | 26 | const VALIDATION_NOT_ASSIGNMENT_STATEMENT = 48501; |
27 | 27 | |
28 | - /** |
|
29 | - * @var Mailcode_Parser_Statement_Tokenizer_Type_Value |
|
30 | - */ |
|
28 | + /** |
|
29 | + * @var Mailcode_Parser_Statement_Tokenizer_Type_Value |
|
30 | + */ |
|
31 | 31 | protected $value; |
32 | 32 | |
33 | 33 | public function getName() : string |
@@ -68,7 +68,7 @@ discard block |
||
68 | 68 | { |
69 | 69 | $variable = $this->params->getInfo()->getVariableByIndex(0); |
70 | 70 | |
71 | - if($variable) |
|
71 | + if ($variable) |
|
72 | 72 | { |
73 | 73 | return $variable->getVariable(); |
74 | 74 | } |
@@ -96,7 +96,7 @@ discard block |
||
96 | 96 | |
97 | 97 | protected function validateSyntax_assignment() : void |
98 | 98 | { |
99 | - if($this->params->getInfo()->isVariableAssignment()) |
|
99 | + if ($this->params->getInfo()->isVariableAssignment()) |
|
100 | 100 | { |
101 | 101 | return; |
102 | 102 | } |
@@ -113,7 +113,7 @@ discard block |
||
113 | 113 | |
114 | 114 | $value = $info->getTokenByIndex(2); |
115 | 115 | |
116 | - if($value instanceof Mailcode_Parser_Statement_Tokenizer_Type_Value) |
|
116 | + if ($value instanceof Mailcode_Parser_Statement_Tokenizer_Type_Value) |
|
117 | 117 | { |
118 | 118 | $this->value = $value; |
119 | 119 | return; |
@@ -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(); |
@@ -48,7 +48,7 @@ discard block |
||
48 | 48 | $lastPos = 0; |
49 | 49 | $positions = array(); |
50 | 50 | |
51 | - while (($lastPos = mb_strpos($haystack, $needle, $lastPos))!== false) |
|
51 | + while (($lastPos = mb_strpos($haystack, $needle, $lastPos)) !== false) |
|
52 | 52 | { |
53 | 53 | $positions[] = $lastPos; |
54 | 54 | $lastPos = $lastPos + mb_strlen($needle); |
@@ -67,7 +67,7 @@ discard block |
||
67 | 67 | { |
68 | 68 | $eol = ConvertHelper::detectEOLCharacter($subject); |
69 | 69 | |
70 | - if($eol) |
|
70 | + if ($eol) |
|
71 | 71 | { |
72 | 72 | return $eol->getCharacter(); |
73 | 73 | } |
@@ -88,7 +88,7 @@ discard block |
||
88 | 88 | |
89 | 89 | $result = array(); |
90 | 90 | |
91 | - foreach($placeholders as $placeholder) |
|
91 | + foreach ($placeholders as $placeholder) |
|
92 | 92 | { |
93 | 93 | $result[] = $placeholder->getReplacementText(); |
94 | 94 | } |
@@ -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(); |
@@ -90,21 +90,21 @@ discard block |
||
90 | 90 | protected function analyzePrepend(string $subject) : void |
91 | 91 | { |
92 | 92 | // we're at the beginning of the string |
93 | - if($this->position == 0) |
|
93 | + if ($this->position == 0) |
|
94 | 94 | { |
95 | 95 | return; |
96 | 96 | } |
97 | 97 | |
98 | 98 | $prevPos = $this->position - $this->eolLength; |
99 | 99 | |
100 | - if($prevPos < 0) |
|
100 | + if ($prevPos < 0) |
|
101 | 101 | { |
102 | 102 | $prevPos = 0; |
103 | 103 | } |
104 | 104 | |
105 | 105 | $prev = mb_substr($subject, $prevPos, $this->eolLength); |
106 | 106 | |
107 | - if($prev !== $this->formatter->getEOLChar()) |
|
107 | + if ($prev !== $this->formatter->getEOLChar()) |
|
108 | 108 | { |
109 | 109 | $this->prepend = true; |
110 | 110 | } |
@@ -117,21 +117,21 @@ discard block |
||
117 | 117 | $position = $this->position + $this->placeholderLength; |
118 | 118 | |
119 | 119 | // we're at the end of the string |
120 | - if($position >= $subjectLength) |
|
120 | + if ($position >= $subjectLength) |
|
121 | 121 | { |
122 | 122 | return; |
123 | 123 | } |
124 | 124 | |
125 | 125 | $nextPos = $position + $this->eolLength; |
126 | 126 | |
127 | - if($nextPos > $subjectLength) |
|
127 | + if ($nextPos > $subjectLength) |
|
128 | 128 | { |
129 | 129 | $nextPos = $subjectLength - $this->eolLength; |
130 | 130 | } |
131 | 131 | |
132 | 132 | $next = mb_substr($subject, $nextPos, $this->eolLength); |
133 | 133 | |
134 | - if($next !== $this->formatter->getEOLChar()) |
|
134 | + if ($next !== $this->formatter->getEOLChar()) |
|
135 | 135 | { |
136 | 136 | $this->append = true; |
137 | 137 | } |
@@ -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(); |
@@ -42,7 +42,7 @@ discard block |
||
42 | 42 | |
43 | 43 | $total = count($placeholders); |
44 | 44 | |
45 | - for($i=0; $i < $total; $i++) |
|
45 | + for ($i = 0; $i < $total; $i++) |
|
46 | 46 | { |
47 | 47 | $subject = $this->process($placeholders[$i], $subject); |
48 | 48 | } |
@@ -66,7 +66,7 @@ discard block |
||
66 | 66 | $phLength = mb_strlen($placeholder); |
67 | 67 | $offset = 0; |
68 | 68 | |
69 | - foreach($positions as $position) |
|
69 | + foreach ($positions as $position) |
|
70 | 70 | { |
71 | 71 | // adjust the position if previous changes made the subject longer |
72 | 72 | $position += $offset; |
@@ -78,7 +78,7 @@ discard block |
||
78 | 78 | $position |
79 | 79 | ); |
80 | 80 | |
81 | - if(!$info->requiresAdjustment()) |
|
81 | + if (!$info->requiresAdjustment()) |
|
82 | 82 | { |
83 | 83 | continue; |
84 | 84 | } |
@@ -106,12 +106,12 @@ discard block |
||
106 | 106 | $prepend = ''; |
107 | 107 | $append = ''; |
108 | 108 | |
109 | - if($info->requiresPrepend()) |
|
109 | + if ($info->requiresPrepend()) |
|
110 | 110 | { |
111 | 111 | $prepend = $this->eol; |
112 | 112 | } |
113 | 113 | |
114 | - if($info->requiresAppend()) |
|
114 | + if ($info->requiresAppend()) |
|
115 | 115 | { |
116 | 116 | $append = $this->eol; |
117 | 117 | } |
@@ -132,9 +132,9 @@ discard block |
||
132 | 132 | |
133 | 133 | $result = array(); |
134 | 134 | |
135 | - foreach($placeholders as $placeholder) |
|
135 | + foreach ($placeholders as $placeholder) |
|
136 | 136 | { |
137 | - if(!$placeholder->getCommand()->generatesContent()) |
|
137 | + if (!$placeholder->getCommand()->generatesContent()) |
|
138 | 138 | { |
139 | 139 | $result[] = $placeholder; |
140 | 140 | } |