@@ -20,19 +20,19 @@ discard block |
||
20 | 20 | */ |
21 | 21 | class Mailcode_Commands_Highlighter |
22 | 22 | { |
23 | - /** |
|
24 | - * @var Mailcode_Commands_Command |
|
25 | - */ |
|
23 | + /** |
|
24 | + * @var Mailcode_Commands_Command |
|
25 | + */ |
|
26 | 26 | protected $command; |
27 | 27 | |
28 | - /** |
|
29 | - * @var string[] |
|
30 | - */ |
|
28 | + /** |
|
29 | + * @var string[] |
|
30 | + */ |
|
31 | 31 | protected $parts = array(); |
32 | 32 | |
33 | 33 | public function __construct(Mailcode_Commands_Command $command) |
34 | 34 | { |
35 | - $this->command = $command; |
|
35 | + $this->command = $command; |
|
36 | 36 | } |
37 | 37 | |
38 | 38 | public function highlight() : string |
@@ -68,11 +68,11 @@ discard block |
||
68 | 68 | } |
69 | 69 | } |
70 | 70 | |
71 | - /** |
|
72 | - * @param string[] $classes |
|
73 | - * @param string $content |
|
74 | - * @return string |
|
75 | - */ |
|
71 | + /** |
|
72 | + * @param string[] $classes |
|
73 | + * @param string $content |
|
74 | + * @return string |
|
75 | + */ |
|
76 | 76 | protected function renderTag(array $classes, string $content) : string |
77 | 77 | { |
78 | 78 | $parts = array(); |
@@ -51,7 +51,7 @@ discard block |
||
51 | 51 | { |
52 | 52 | $this->parts[] = $this->renderTag(array('command-name'), $this->command->getName()); |
53 | 53 | |
54 | - if($this->command->hasType()) |
|
54 | + if ($this->command->hasType()) |
|
55 | 55 | { |
56 | 56 | $this->parts[] = ' '.$this->renderTag(array('command-type'), $this->command->getType()); |
57 | 57 | } |
@@ -62,7 +62,7 @@ discard block |
||
62 | 62 | |
63 | 63 | protected function appendParams() : void |
64 | 64 | { |
65 | - if($this->command->hasParameters()) |
|
65 | + if ($this->command->hasParameters()) |
|
66 | 66 | { |
67 | 67 | $this->parts[] = ' '.$this->renderTag(array('params'), $this->command->getParamsString()); |
68 | 68 | } |
@@ -77,7 +77,7 @@ discard block |
||
77 | 77 | { |
78 | 78 | $parts = array(); |
79 | 79 | |
80 | - foreach($classes as $class) |
|
80 | + foreach ($classes as $class) |
|
81 | 81 | { |
82 | 82 | $parts[] = 'mailcode-'.$class; |
83 | 83 | } |
@@ -32,34 +32,34 @@ |
||
32 | 32 | const VALIDATION_ERROR_PATH_UNDERSCORE = 48203; |
33 | 33 | const VALIDATION_ERROR_NAME_UNDERSCORE = 48204; |
34 | 34 | |
35 | - /** |
|
36 | - * @var string |
|
37 | - */ |
|
35 | + /** |
|
36 | + * @var string |
|
37 | + */ |
|
38 | 38 | protected $path; |
39 | 39 | |
40 | - /** |
|
41 | - * @var string |
|
42 | - */ |
|
40 | + /** |
|
41 | + * @var string |
|
42 | + */ |
|
43 | 43 | protected $name; |
44 | 44 | |
45 | - /** |
|
46 | - * @var string |
|
47 | - */ |
|
45 | + /** |
|
46 | + * @var string |
|
47 | + */ |
|
48 | 48 | protected $matchedText; |
49 | 49 | |
50 | - /** |
|
51 | - * @var string |
|
52 | - */ |
|
50 | + /** |
|
51 | + * @var string |
|
52 | + */ |
|
53 | 53 | protected $hash = ''; |
54 | 54 | |
55 | - /** |
|
56 | - * @var OperationResult |
|
57 | - */ |
|
55 | + /** |
|
56 | + * @var OperationResult |
|
57 | + */ |
|
58 | 58 | protected $validationResult = null; |
59 | 59 | |
60 | - /** |
|
61 | - * @var array<string> |
|
62 | - */ |
|
60 | + /** |
|
61 | + * @var array<string> |
|
62 | + */ |
|
63 | 63 | protected $validations = array( |
64 | 64 | 'number_path', |
65 | 65 | 'number_name', |
@@ -96,7 +96,7 @@ discard block |
||
96 | 96 | |
97 | 97 | public function getHash() : string |
98 | 98 | { |
99 | - if(empty($this->hash)) |
|
99 | + if (empty($this->hash)) |
|
100 | 100 | { |
101 | 101 | $this->hash = md5($this->matchedText); |
102 | 102 | } |
@@ -111,7 +111,7 @@ discard block |
||
111 | 111 | |
112 | 112 | public function getValidationResult() : OperationResult |
113 | 113 | { |
114 | - if(isset($this->validationResult)) |
|
114 | + if (isset($this->validationResult)) |
|
115 | 115 | { |
116 | 116 | return $this->validationResult; |
117 | 117 | } |
@@ -125,11 +125,11 @@ discard block |
||
125 | 125 | |
126 | 126 | protected function validate() : void |
127 | 127 | { |
128 | - foreach($this->validations as $validation) |
|
128 | + foreach ($this->validations as $validation) |
|
129 | 129 | { |
130 | 130 | $method = 'validate_'.$validation; |
131 | 131 | |
132 | - if(!method_exists($this, $method)) |
|
132 | + if (!method_exists($this, $method)) |
|
133 | 133 | { |
134 | 134 | throw new Mailcode_Exception( |
135 | 135 | 'Unknown validation method', |
@@ -144,7 +144,7 @@ discard block |
||
144 | 144 | |
145 | 145 | $this->$method(); |
146 | 146 | |
147 | - if(!$this->validationResult->isValid()) |
|
147 | + if (!$this->validationResult->isValid()) |
|
148 | 148 | { |
149 | 149 | return; |
150 | 150 | } |
@@ -173,7 +173,7 @@ discard block |
||
173 | 173 | |
174 | 174 | protected function validateNumber(string $value, int $errorCode) : void |
175 | 175 | { |
176 | - if(!is_numeric(substr($value, 0, 1))) |
|
176 | + if (!is_numeric(substr($value, 0, 1))) |
|
177 | 177 | { |
178 | 178 | return; |
179 | 179 | } |
@@ -193,7 +193,7 @@ discard block |
||
193 | 193 | $length = strlen($value); |
194 | 194 | |
195 | 195 | // trimming underscores does not change the length: no underscores at start or end of string. |
196 | - if(strlen(trim($value, '_')) == $length) |
|
196 | + if (strlen(trim($value, '_')) == $length) |
|
197 | 197 | { |
198 | 198 | return; |
199 | 199 | } |
@@ -20,9 +20,9 @@ discard block |
||
20 | 20 | */ |
21 | 21 | abstract class Mailcode_Variables_Collection |
22 | 22 | { |
23 | - /** |
|
24 | - * @var Mailcode_Variables_Variable[] |
|
25 | - */ |
|
23 | + /** |
|
24 | + * @var Mailcode_Variables_Variable[] |
|
25 | + */ |
|
26 | 26 | protected $variables = array(); |
27 | 27 | |
28 | 28 | public function __construct() |
@@ -52,12 +52,12 @@ discard block |
||
52 | 52 | return count($this->variables); |
53 | 53 | } |
54 | 54 | |
55 | - /** |
|
56 | - * Checks whether the collection contains a variable with the specified name. |
|
57 | - * |
|
58 | - * @param string $fullName The variable name, with or without $ sign. |
|
59 | - * @return bool |
|
60 | - */ |
|
55 | + /** |
|
56 | + * Checks whether the collection contains a variable with the specified name. |
|
57 | + * |
|
58 | + * @param string $fullName The variable name, with or without $ sign. |
|
59 | + * @return bool |
|
60 | + */ |
|
61 | 61 | public function hasVariableName(string $fullName) : bool |
62 | 62 | { |
63 | 63 | $fullName = $this->fixName($fullName); |
@@ -73,14 +73,14 @@ discard block |
||
73 | 73 | return false; |
74 | 74 | } |
75 | 75 | |
76 | - /** |
|
77 | - * Retrieves a collection of all variable instances for |
|
78 | - * the specified name (there can be several with differing |
|
79 | - * matched texts because of spacing). |
|
80 | - * |
|
81 | - * @param string $fullName |
|
82 | - * @return Mailcode_Variables_Collection |
|
83 | - */ |
|
76 | + /** |
|
77 | + * Retrieves a collection of all variable instances for |
|
78 | + * the specified name (there can be several with differing |
|
79 | + * matched texts because of spacing). |
|
80 | + * |
|
81 | + * @param string $fullName |
|
82 | + * @return Mailcode_Variables_Collection |
|
83 | + */ |
|
84 | 84 | public function getByFullName(string $fullName) : Mailcode_Variables_Collection |
85 | 85 | { |
86 | 86 | $fullName = $this->fixName($fullName); |
@@ -98,12 +98,12 @@ discard block |
||
98 | 98 | return $collection; |
99 | 99 | } |
100 | 100 | |
101 | - /** |
|
102 | - * Prepends the $ sign to a variable name if it does not have it. |
|
103 | - * |
|
104 | - * @param string $fullName |
|
105 | - * @return string |
|
106 | - */ |
|
101 | + /** |
|
102 | + * Prepends the $ sign to a variable name if it does not have it. |
|
103 | + * |
|
104 | + * @param string $fullName |
|
105 | + * @return string |
|
106 | + */ |
|
107 | 107 | protected function fixName(string $fullName) : string |
108 | 108 | { |
109 | 109 | if(substr($fullName, 0, 1) === '$') |
@@ -114,12 +114,12 @@ discard block |
||
114 | 114 | return '$'.$fullName; |
115 | 115 | } |
116 | 116 | |
117 | - /** |
|
118 | - * Retrieves all variables, grouped by their hash - meaning |
|
119 | - * unique matched strings. |
|
120 | - * |
|
121 | - * @return Mailcode_Variables_Variable[] |
|
122 | - */ |
|
117 | + /** |
|
118 | + * Retrieves all variables, grouped by their hash - meaning |
|
119 | + * unique matched strings. |
|
120 | + * |
|
121 | + * @return Mailcode_Variables_Variable[] |
|
122 | + */ |
|
123 | 123 | public function getGroupedByHash() |
124 | 124 | { |
125 | 125 | $entries = array(); |
@@ -132,11 +132,11 @@ discard block |
||
132 | 132 | return $this->sortVariables($entries); |
133 | 133 | } |
134 | 134 | |
135 | - /** |
|
136 | - * Retrieves all variables, grouped by their name. |
|
137 | - * |
|
138 | - * @return Mailcode_Variables_Variable[] |
|
139 | - */ |
|
135 | + /** |
|
136 | + * Retrieves all variables, grouped by their name. |
|
137 | + * |
|
138 | + * @return Mailcode_Variables_Variable[] |
|
139 | + */ |
|
140 | 140 | public function getGroupedByName() |
141 | 141 | { |
142 | 142 | $entries = array(); |
@@ -149,19 +149,19 @@ discard block |
||
149 | 149 | return $this->sortVariables($entries); |
150 | 150 | } |
151 | 151 | |
152 | - /** |
|
153 | - * Retrieves all variables, in the order they were addded. |
|
154 | - * @return \Mailcode\Mailcode_Variables_Variable[] |
|
155 | - */ |
|
152 | + /** |
|
153 | + * Retrieves all variables, in the order they were addded. |
|
154 | + * @return \Mailcode\Mailcode_Variables_Variable[] |
|
155 | + */ |
|
156 | 156 | public function getAll() |
157 | 157 | { |
158 | 158 | return $this->variables; |
159 | 159 | } |
160 | 160 | |
161 | - /** |
|
162 | - * Retrieves the full names of the variables that are present in the collection. |
|
163 | - * @return string[] |
|
164 | - */ |
|
161 | + /** |
|
162 | + * Retrieves the full names of the variables that are present in the collection. |
|
163 | + * @return string[] |
|
164 | + */ |
|
165 | 165 | public function getNames() : array |
166 | 166 | { |
167 | 167 | $result = array(); |
@@ -179,13 +179,13 @@ discard block |
||
179 | 179 | return $result; |
180 | 180 | } |
181 | 181 | |
182 | - /** |
|
183 | - * Takes a list of variables and sorts them, throwing away |
|
184 | - * the source array's keys. |
|
185 | - * |
|
186 | - * @param Mailcode_Variables_Variable[] $entries |
|
187 | - * @return Mailcode_Variables_Variable[] |
|
188 | - */ |
|
182 | + /** |
|
183 | + * Takes a list of variables and sorts them, throwing away |
|
184 | + * the source array's keys. |
|
185 | + * |
|
186 | + * @param Mailcode_Variables_Variable[] $entries |
|
187 | + * @return Mailcode_Variables_Variable[] |
|
188 | + */ |
|
189 | 189 | protected function sortVariables(array $entries) |
190 | 190 | { |
191 | 191 | $result = array_values($entries); |
@@ -198,13 +198,13 @@ discard block |
||
198 | 198 | return $result; |
199 | 199 | } |
200 | 200 | |
201 | - /** |
|
202 | - * Merges the variables collection with the target collection |
|
203 | - * by inheriting all that collection's variables. |
|
204 | - * |
|
205 | - * @param Mailcode_Variables_Collection $collection |
|
206 | - * @return Mailcode_Variables_Collection |
|
207 | - */ |
|
201 | + /** |
|
202 | + * Merges the variables collection with the target collection |
|
203 | + * by inheriting all that collection's variables. |
|
204 | + * |
|
205 | + * @param Mailcode_Variables_Collection $collection |
|
206 | + * @return Mailcode_Variables_Collection |
|
207 | + */ |
|
208 | 208 | public function mergeWith(Mailcode_Variables_Collection $collection) : Mailcode_Variables_Collection |
209 | 209 | { |
210 | 210 | $variables = $collection->getGroupedByHash(); |
@@ -62,9 +62,9 @@ discard block |
||
62 | 62 | { |
63 | 63 | $fullName = $this->fixName($fullName); |
64 | 64 | |
65 | - foreach($this->variables as $variable) |
|
65 | + foreach ($this->variables as $variable) |
|
66 | 66 | { |
67 | - if($variable->getFullName() === $fullName) |
|
67 | + if ($variable->getFullName() === $fullName) |
|
68 | 68 | { |
69 | 69 | return true; |
70 | 70 | } |
@@ -87,9 +87,9 @@ discard block |
||
87 | 87 | |
88 | 88 | $collection = new Mailcode_Variables_Collection_Regular(); |
89 | 89 | |
90 | - foreach($this->variables as $variable) |
|
90 | + foreach ($this->variables as $variable) |
|
91 | 91 | { |
92 | - if($variable->getFullName() === $fullName) |
|
92 | + if ($variable->getFullName() === $fullName) |
|
93 | 93 | { |
94 | 94 | $collection->add($variable); |
95 | 95 | } |
@@ -106,7 +106,7 @@ discard block |
||
106 | 106 | */ |
107 | 107 | protected function fixName(string $fullName) : string |
108 | 108 | { |
109 | - if(substr($fullName, 0, 1) === '$') |
|
109 | + if (substr($fullName, 0, 1) === '$') |
|
110 | 110 | { |
111 | 111 | return $fullName; |
112 | 112 | } |
@@ -124,7 +124,7 @@ discard block |
||
124 | 124 | { |
125 | 125 | $entries = array(); |
126 | 126 | |
127 | - foreach($this->variables as $variable) |
|
127 | + foreach ($this->variables as $variable) |
|
128 | 128 | { |
129 | 129 | $entries[$variable->getHash()] = $variable; |
130 | 130 | } |
@@ -141,7 +141,7 @@ discard block |
||
141 | 141 | { |
142 | 142 | $entries = array(); |
143 | 143 | |
144 | - foreach($this->variables as $variable) |
|
144 | + foreach ($this->variables as $variable) |
|
145 | 145 | { |
146 | 146 | $entries[$variable->getFullName()] = $variable; |
147 | 147 | } |
@@ -166,11 +166,11 @@ discard block |
||
166 | 166 | { |
167 | 167 | $result = array(); |
168 | 168 | |
169 | - foreach($this->variables as $variable) |
|
169 | + foreach ($this->variables as $variable) |
|
170 | 170 | { |
171 | 171 | $name = $variable->getFullName(); |
172 | 172 | |
173 | - if(!in_array($name, $result)) |
|
173 | + if (!in_array($name, $result)) |
|
174 | 174 | { |
175 | 175 | $result[] = $name; |
176 | 176 | } |
@@ -209,7 +209,7 @@ discard block |
||
209 | 209 | { |
210 | 210 | $variables = $collection->getGroupedByHash(); |
211 | 211 | |
212 | - foreach($variables as $variable) |
|
212 | + foreach ($variables as $variable) |
|
213 | 213 | { |
214 | 214 | $this->add($variable); |
215 | 215 | } |
@@ -55,40 +55,40 @@ discard block |
||
55 | 55 | |
56 | 56 | const ERROR_EMPTY_DELIMITER = 47803; |
57 | 57 | |
58 | - /** |
|
59 | - * @var Mailcode_Parser |
|
60 | - */ |
|
58 | + /** |
|
59 | + * @var Mailcode_Parser |
|
60 | + */ |
|
61 | 61 | protected $parser; |
62 | 62 | |
63 | - /** |
|
64 | - * @var Mailcode_Collection |
|
65 | - */ |
|
63 | + /** |
|
64 | + * @var Mailcode_Collection |
|
65 | + */ |
|
66 | 66 | protected $commands; |
67 | 67 | |
68 | - /** |
|
69 | - * @var string |
|
70 | - */ |
|
68 | + /** |
|
69 | + * @var string |
|
70 | + */ |
|
71 | 71 | protected $originalString; |
72 | 72 | |
73 | - /** |
|
74 | - * @var Mailcode_Collection |
|
75 | - */ |
|
73 | + /** |
|
74 | + * @var Mailcode_Collection |
|
75 | + */ |
|
76 | 76 | protected $collection; |
77 | 77 | |
78 | - /** |
|
79 | - * Counter for the placeholders, global for all placeholders. |
|
80 | - * @var integer |
|
81 | - */ |
|
78 | + /** |
|
79 | + * Counter for the placeholders, global for all placeholders. |
|
80 | + * @var integer |
|
81 | + */ |
|
82 | 82 | private static $counter = 0; |
83 | 83 | |
84 | - /** |
|
85 | - * @var Mailcode_Parser_Safeguard_Placeholder[] |
|
86 | - */ |
|
84 | + /** |
|
85 | + * @var Mailcode_Parser_Safeguard_Placeholder[] |
|
86 | + */ |
|
87 | 87 | protected $placeholders; |
88 | 88 | |
89 | - /** |
|
90 | - * @var string |
|
91 | - */ |
|
89 | + /** |
|
90 | + * @var string |
|
91 | + */ |
|
92 | 92 | protected $delimiter = '__'; |
93 | 93 | |
94 | 94 | public function __construct(Mailcode_Parser $parser, string $subject) |
@@ -97,15 +97,15 @@ discard block |
||
97 | 97 | $this->originalString = $subject; |
98 | 98 | } |
99 | 99 | |
100 | - /** |
|
101 | - * Sets the delimiter character sequence used to prepend |
|
102 | - * and append to the placeholders. |
|
103 | - * |
|
104 | - * The delimiter's default is "__" (two underscores). |
|
105 | - * |
|
106 | - * @param string $delimiter |
|
107 | - * @return Mailcode_Parser_Safeguard |
|
108 | - */ |
|
100 | + /** |
|
101 | + * Sets the delimiter character sequence used to prepend |
|
102 | + * and append to the placeholders. |
|
103 | + * |
|
104 | + * The delimiter's default is "__" (two underscores). |
|
105 | + * |
|
106 | + * @param string $delimiter |
|
107 | + * @return Mailcode_Parser_Safeguard |
|
108 | + */ |
|
109 | 109 | public function setDelimiter(string $delimiter) : Mailcode_Parser_Safeguard |
110 | 110 | { |
111 | 111 | if(empty($delimiter)) |
@@ -127,15 +127,15 @@ discard block |
||
127 | 127 | return $this->delimiter; |
128 | 128 | } |
129 | 129 | |
130 | - /** |
|
131 | - * Retrieves the safe string in which all commands have been replaced |
|
132 | - * by placeholder strings. |
|
133 | - * |
|
134 | - * @return string |
|
135 | - * @throws Mailcode_Exception |
|
136 | - * |
|
137 | - * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
138 | - */ |
|
130 | + /** |
|
131 | + * Retrieves the safe string in which all commands have been replaced |
|
132 | + * by placeholder strings. |
|
133 | + * |
|
134 | + * @return string |
|
135 | + * @throws Mailcode_Exception |
|
136 | + * |
|
137 | + * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
138 | + */ |
|
139 | 139 | public function makeSafe() : string |
140 | 140 | { |
141 | 141 | $this->requireValidCollection(); |
@@ -145,10 +145,10 @@ discard block |
||
145 | 145 | return str_replace(array_values($replaces), array_keys($replaces), $this->originalString); |
146 | 146 | } |
147 | 147 | |
148 | - /** |
|
149 | - * @param bool $highlighted |
|
150 | - * @return string[]string |
|
151 | - */ |
|
148 | + /** |
|
149 | + * @param bool $highlighted |
|
150 | + * @return string[]string |
|
151 | + */ |
|
152 | 152 | protected function getReplaces(bool $highlighted=false) : array |
153 | 153 | { |
154 | 154 | $placeholders = $this->getPlaceholders(); |
@@ -175,12 +175,12 @@ discard block |
||
175 | 175 | } |
176 | 176 | |
177 | 177 | |
178 | - /** |
|
179 | - * Retrieves all placeholders that have to be added to |
|
180 | - * the subject text. |
|
181 | - * |
|
182 | - * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[] |
|
183 | - */ |
|
178 | + /** |
|
179 | + * Retrieves all placeholders that have to be added to |
|
180 | + * the subject text. |
|
181 | + * |
|
182 | + * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[] |
|
183 | + */ |
|
184 | 184 | public function getPlaceholders() |
185 | 185 | { |
186 | 186 | if(isset($this->placeholders)) |
@@ -232,46 +232,46 @@ discard block |
||
232 | 232 | return str_replace($placeholderStrings, array_values($replaces), $string); |
233 | 233 | } |
234 | 234 | |
235 | - /** |
|
236 | - * Makes the string whole again after transforming or filtering it, |
|
237 | - * by replacing the command placeholders with the original commands. |
|
238 | - * |
|
239 | - * @param string $string |
|
240 | - * @return string |
|
241 | - * @throws Mailcode_Exception |
|
242 | - * |
|
243 | - * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
244 | - * @see Mailcode_Parser_Safeguard::ERROR_COMMAND_PLACEHOLDER_MISSING |
|
245 | - */ |
|
235 | + /** |
|
236 | + * Makes the string whole again after transforming or filtering it, |
|
237 | + * by replacing the command placeholders with the original commands. |
|
238 | + * |
|
239 | + * @param string $string |
|
240 | + * @return string |
|
241 | + * @throws Mailcode_Exception |
|
242 | + * |
|
243 | + * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
244 | + * @see Mailcode_Parser_Safeguard::ERROR_COMMAND_PLACEHOLDER_MISSING |
|
245 | + */ |
|
246 | 246 | public function makeWhole(string $string) : string |
247 | 247 | { |
248 | 248 | return $this->restore($string, false); |
249 | 249 | } |
250 | 250 | |
251 | - /** |
|
252 | - * Like makeWhole(), but replaces the commands with a syntax |
|
253 | - * highlighted version, meant for human readable texts only. |
|
254 | - * |
|
255 | - * Note: the commands lose their functionality (They cannot be |
|
256 | - * parsed from that string again). |
|
257 | - * |
|
258 | - * @param string $string |
|
259 | - * @return string |
|
260 | - * @throws Mailcode_Exception |
|
261 | - * |
|
262 | - * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
263 | - * @see Mailcode_Parser_Safeguard::ERROR_COMMAND_PLACEHOLDER_MISSING |
|
264 | - */ |
|
251 | + /** |
|
252 | + * Like makeWhole(), but replaces the commands with a syntax |
|
253 | + * highlighted version, meant for human readable texts only. |
|
254 | + * |
|
255 | + * Note: the commands lose their functionality (They cannot be |
|
256 | + * parsed from that string again). |
|
257 | + * |
|
258 | + * @param string $string |
|
259 | + * @return string |
|
260 | + * @throws Mailcode_Exception |
|
261 | + * |
|
262 | + * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
263 | + * @see Mailcode_Parser_Safeguard::ERROR_COMMAND_PLACEHOLDER_MISSING |
|
264 | + */ |
|
265 | 265 | public function makeHighlighted(string $string) : string |
266 | 266 | { |
267 | 267 | return $this->restore($string, true); |
268 | 268 | } |
269 | 269 | |
270 | - /** |
|
271 | - * Retrieves the commands collection contained in the string. |
|
272 | - * |
|
273 | - * @return Mailcode_Collection |
|
274 | - */ |
|
270 | + /** |
|
271 | + * Retrieves the commands collection contained in the string. |
|
272 | + * |
|
273 | + * @return Mailcode_Collection |
|
274 | + */ |
|
275 | 275 | public function getCollection() : Mailcode_Collection |
276 | 276 | { |
277 | 277 | if(isset($this->collection)) |
@@ -289,11 +289,11 @@ discard block |
||
289 | 289 | return $this->getCollection()->isValid(); |
290 | 290 | } |
291 | 291 | |
292 | - /** |
|
293 | - * @throws Mailcode_Exception |
|
294 | - * |
|
295 | - * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
296 | - */ |
|
292 | + /** |
|
293 | + * @throws Mailcode_Exception |
|
294 | + * |
|
295 | + * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
296 | + */ |
|
297 | 297 | protected function requireValidCollection() : void |
298 | 298 | { |
299 | 299 | if($this->getCollection()->isValid()) |
@@ -108,7 +108,7 @@ discard block |
||
108 | 108 | */ |
109 | 109 | public function setDelimiter(string $delimiter) : Mailcode_Parser_Safeguard |
110 | 110 | { |
111 | - if(empty($delimiter)) |
|
111 | + if (empty($delimiter)) |
|
112 | 112 | { |
113 | 113 | throw new Mailcode_Exception( |
114 | 114 | 'Empty delimiter', |
@@ -149,17 +149,17 @@ discard block |
||
149 | 149 | * @param bool $highlighted |
150 | 150 | * @return string[]string |
151 | 151 | */ |
152 | - protected function getReplaces(bool $highlighted=false) : array |
|
152 | + protected function getReplaces(bool $highlighted = false) : array |
|
153 | 153 | { |
154 | 154 | $placeholders = $this->getPlaceholders(); |
155 | 155 | |
156 | 156 | $replaces = array(); |
157 | 157 | |
158 | - foreach($placeholders as $placeholder) |
|
158 | + foreach ($placeholders as $placeholder) |
|
159 | 159 | { |
160 | 160 | $replace = ''; |
161 | 161 | |
162 | - if($highlighted) |
|
162 | + if ($highlighted) |
|
163 | 163 | { |
164 | 164 | $replace = $placeholder->getHighlightedText(); |
165 | 165 | } |
@@ -183,7 +183,7 @@ discard block |
||
183 | 183 | */ |
184 | 184 | public function getPlaceholders() |
185 | 185 | { |
186 | - if(isset($this->placeholders)) |
|
186 | + if (isset($this->placeholders)) |
|
187 | 187 | { |
188 | 188 | return $this->placeholders; |
189 | 189 | } |
@@ -192,7 +192,7 @@ discard block |
||
192 | 192 | |
193 | 193 | $cmds = $this->getCollection()->getCommands(); |
194 | 194 | |
195 | - foreach($cmds as $command) |
|
195 | + foreach ($cmds as $command) |
|
196 | 196 | { |
197 | 197 | self::$counter++; |
198 | 198 | |
@@ -206,7 +206,7 @@ discard block |
||
206 | 206 | return $this->placeholders; |
207 | 207 | } |
208 | 208 | |
209 | - protected function restore(string $string, bool $highlighted=false) : string |
|
209 | + protected function restore(string $string, bool $highlighted = false) : string |
|
210 | 210 | { |
211 | 211 | $this->requireValidCollection(); |
212 | 212 | |
@@ -214,9 +214,9 @@ discard block |
||
214 | 214 | |
215 | 215 | $placeholderStrings = array_keys($replaces); |
216 | 216 | |
217 | - foreach($placeholderStrings as $search) |
|
217 | + foreach ($placeholderStrings as $search) |
|
218 | 218 | { |
219 | - if(!strstr($string, $search)) |
|
219 | + if (!strstr($string, $search)) |
|
220 | 220 | { |
221 | 221 | throw new Mailcode_Exception( |
222 | 222 | 'Command placeholder not found', |
@@ -274,7 +274,7 @@ discard block |
||
274 | 274 | */ |
275 | 275 | public function getCollection() : Mailcode_Collection |
276 | 276 | { |
277 | - if(isset($this->collection)) |
|
277 | + if (isset($this->collection)) |
|
278 | 278 | { |
279 | 279 | return $this->collection; |
280 | 280 | } |
@@ -296,7 +296,7 @@ discard block |
||
296 | 296 | */ |
297 | 297 | protected function requireValidCollection() : void |
298 | 298 | { |
299 | - if($this->getCollection()->isValid()) |
|
299 | + if ($this->getCollection()->isValid()) |
|
300 | 300 | { |
301 | 301 | return; |
302 | 302 | } |
@@ -21,24 +21,24 @@ |
||
21 | 21 | */ |
22 | 22 | class Mailcode_Parser_Match |
23 | 23 | { |
24 | - /** |
|
25 | - * @var string |
|
26 | - */ |
|
24 | + /** |
|
25 | + * @var string |
|
26 | + */ |
|
27 | 27 | protected $name; |
28 | 28 | |
29 | - /** |
|
30 | - * @var string |
|
31 | - */ |
|
29 | + /** |
|
30 | + * @var string |
|
31 | + */ |
|
32 | 32 | protected $type; |
33 | 33 | |
34 | - /** |
|
35 | - * @var string |
|
36 | - */ |
|
34 | + /** |
|
35 | + * @var string |
|
36 | + */ |
|
37 | 37 | protected $params; |
38 | 38 | |
39 | - /** |
|
40 | - * @var string |
|
41 | - */ |
|
39 | + /** |
|
40 | + * @var string |
|
41 | + */ |
|
42 | 42 | protected $matchedString; |
43 | 43 | |
44 | 44 | public function __construct(string $name, string $type, string $params, string $matchedString) |
@@ -21,14 +21,14 @@ discard block |
||
21 | 21 | */ |
22 | 22 | class Mailcode_Parser_Statement_Info |
23 | 23 | { |
24 | - /** |
|
25 | - * @var Mailcode_Parser_Statement_Tokenizer |
|
26 | - */ |
|
24 | + /** |
|
25 | + * @var Mailcode_Parser_Statement_Tokenizer |
|
26 | + */ |
|
27 | 27 | protected $tokenizer; |
28 | 28 | |
29 | - /** |
|
30 | - * @var Mailcode_Parser_Statement_Tokenizer_Token[] |
|
31 | - */ |
|
29 | + /** |
|
30 | + * @var Mailcode_Parser_Statement_Tokenizer_Token[] |
|
31 | + */ |
|
32 | 32 | protected $tokens = array(); |
33 | 33 | |
34 | 34 | public function __construct(Mailcode_Parser_Statement_Tokenizer $tokenizer) |
@@ -37,11 +37,11 @@ discard block |
||
37 | 37 | $this->tokens = $this->tokenizer->getTokens(); |
38 | 38 | } |
39 | 39 | |
40 | - /** |
|
41 | - * Whether the whole statement is a variable being assigned a value. |
|
42 | - * |
|
43 | - * @return bool |
|
44 | - */ |
|
40 | + /** |
|
41 | + * Whether the whole statement is a variable being assigned a value. |
|
42 | + * |
|
43 | + * @return bool |
|
44 | + */ |
|
45 | 45 | public function isVariableAssignment() : bool |
46 | 46 | { |
47 | 47 | $variable = $this->getVariableByIndex(0); |
@@ -56,11 +56,11 @@ discard block |
||
56 | 56 | return false; |
57 | 57 | } |
58 | 58 | |
59 | - /** |
|
60 | - * Whether the whole statement is a variable being compared to something. |
|
61 | - * |
|
62 | - * @return bool |
|
63 | - */ |
|
59 | + /** |
|
60 | + * Whether the whole statement is a variable being compared to something. |
|
61 | + * |
|
62 | + * @return bool |
|
63 | + */ |
|
64 | 64 | public function isVariableComparison() : bool |
65 | 65 | { |
66 | 66 | $variable = $this->getVariableByIndex(0); |
@@ -75,11 +75,11 @@ discard block |
||
75 | 75 | return false; |
76 | 76 | } |
77 | 77 | |
78 | - /** |
|
79 | - * Retrieves all variables used in the statement. |
|
80 | - * |
|
81 | - * @return \Mailcode\Mailcode_Variables_Variable[] |
|
82 | - */ |
|
78 | + /** |
|
79 | + * Retrieves all variables used in the statement. |
|
80 | + * |
|
81 | + * @return \Mailcode\Mailcode_Variables_Variable[] |
|
82 | + */ |
|
83 | 83 | public function getVariables() |
84 | 84 | { |
85 | 85 | $result = array(); |
@@ -48,7 +48,7 @@ discard block |
||
48 | 48 | $operand = $this->getOperandByIndex(1); |
49 | 49 | $value = $this->getTokenByIndex(2); |
50 | 50 | |
51 | - if($variable && $operand && $value && $operand->isAssignment()) |
|
51 | + if ($variable && $operand && $value && $operand->isAssignment()) |
|
52 | 52 | { |
53 | 53 | return true; |
54 | 54 | } |
@@ -67,7 +67,7 @@ discard block |
||
67 | 67 | $operand = $this->getOperandByIndex(1); |
68 | 68 | $value = $this->getTokenByIndex(2); |
69 | 69 | |
70 | - if($variable && $operand && $value && $operand->isComparator()) |
|
70 | + if ($variable && $operand && $value && $operand->isComparator()) |
|
71 | 71 | { |
72 | 72 | return true; |
73 | 73 | } |
@@ -84,9 +84,9 @@ discard block |
||
84 | 84 | { |
85 | 85 | $result = array(); |
86 | 86 | |
87 | - foreach($this->tokens as $token) |
|
87 | + foreach ($this->tokens as $token) |
|
88 | 88 | { |
89 | - if($token instanceof Mailcode_Parser_Statement_Tokenizer_Token_Variable) |
|
89 | + if ($token instanceof Mailcode_Parser_Statement_Tokenizer_Token_Variable) |
|
90 | 90 | { |
91 | 91 | $result[] = $token->getVariable(); |
92 | 92 | } |
@@ -99,7 +99,7 @@ discard block |
||
99 | 99 | { |
100 | 100 | $token = $this->getTokenByIndex($index); |
101 | 101 | |
102 | - if($token instanceof Mailcode_Parser_Statement_Tokenizer_Token_Variable) |
|
102 | + if ($token instanceof Mailcode_Parser_Statement_Tokenizer_Token_Variable) |
|
103 | 103 | { |
104 | 104 | return $token; |
105 | 105 | } |
@@ -111,7 +111,7 @@ discard block |
||
111 | 111 | { |
112 | 112 | $token = $this->getTokenByIndex($index); |
113 | 113 | |
114 | - if($token instanceof Mailcode_Parser_Statement_Tokenizer_Token_Keyword) |
|
114 | + if ($token instanceof Mailcode_Parser_Statement_Tokenizer_Token_Keyword) |
|
115 | 115 | { |
116 | 116 | return $token; |
117 | 117 | } |
@@ -123,7 +123,7 @@ discard block |
||
123 | 123 | { |
124 | 124 | $token = $this->getTokenByIndex($index); |
125 | 125 | |
126 | - if($token instanceof Mailcode_Parser_Statement_Tokenizer_Token_Operand) |
|
126 | + if ($token instanceof Mailcode_Parser_Statement_Tokenizer_Token_Operand) |
|
127 | 127 | { |
128 | 128 | return $token; |
129 | 129 | } |
@@ -133,7 +133,7 @@ discard block |
||
133 | 133 | |
134 | 134 | public function getTokenByIndex(int $index) : ?Mailcode_Parser_Statement_Tokenizer_Token |
135 | 135 | { |
136 | - if(isset($this->tokens[$index])) |
|
136 | + if (isset($this->tokens[$index])) |
|
137 | 137 | { |
138 | 138 | return $this->tokens[$index]; |
139 | 139 | } |
@@ -30,11 +30,11 @@ discard block |
||
30 | 30 | return $this->getOperand(); |
31 | 31 | } |
32 | 32 | |
33 | - /** |
|
34 | - * Whether the operator is comparison related (equals, not equals, smaller, greater...). |
|
35 | - * |
|
36 | - * @return bool |
|
37 | - */ |
|
33 | + /** |
|
34 | + * Whether the operator is comparison related (equals, not equals, smaller, greater...). |
|
35 | + * |
|
36 | + * @return bool |
|
37 | + */ |
|
38 | 38 | public function isComparator() : bool |
39 | 39 | { |
40 | 40 | return |
@@ -46,11 +46,11 @@ discard block |
||
46 | 46 | $this->isSmallerOrEquals(); |
47 | 47 | } |
48 | 48 | |
49 | - /** |
|
50 | - * Whether the operator is calculation related (minus, plus, divide, multiply). |
|
51 | - * |
|
52 | - * @return bool |
|
53 | - */ |
|
49 | + /** |
|
50 | + * Whether the operator is calculation related (minus, plus, divide, multiply). |
|
51 | + * |
|
52 | + * @return bool |
|
53 | + */ |
|
54 | 54 | public function isCalculator() : bool |
55 | 55 | { |
56 | 56 | return |
@@ -24,7 +24,7 @@ |
||
24 | 24 | |
25 | 25 | public function getVariable() : Mailcode_Variables_Variable |
26 | 26 | { |
27 | - if($this->subject instanceof Mailcode_Variables_Variable) |
|
27 | + if ($this->subject instanceof Mailcode_Variables_Variable) |
|
28 | 28 | { |
29 | 29 | return $this->subject; |
30 | 30 | } |
@@ -20,26 +20,26 @@ |
||
20 | 20 | */ |
21 | 21 | abstract class Mailcode_Parser_Statement_Tokenizer_Token |
22 | 22 | { |
23 | - /** |
|
24 | - * @var string |
|
25 | - */ |
|
23 | + /** |
|
24 | + * @var string |
|
25 | + */ |
|
26 | 26 | protected $tokenID; |
27 | 27 | |
28 | - /** |
|
29 | - * @var string |
|
30 | - */ |
|
28 | + /** |
|
29 | + * @var string |
|
30 | + */ |
|
31 | 31 | protected $matchedText; |
32 | 32 | |
33 | - /** |
|
34 | - * @var mixed |
|
35 | - */ |
|
33 | + /** |
|
34 | + * @var mixed |
|
35 | + */ |
|
36 | 36 | protected $subject; |
37 | 37 | |
38 | - /** |
|
39 | - * @param string $tokenID |
|
40 | - * @param string $matchedText |
|
41 | - * @param mixed $subject |
|
42 | - */ |
|
38 | + /** |
|
39 | + * @param string $tokenID |
|
40 | + * @param string $matchedText |
|
41 | + * @param mixed $subject |
|
42 | + */ |
|
43 | 43 | public function __construct(string $tokenID, string $matchedText, $subject=null) |
44 | 44 | { |
45 | 45 | $this->tokenID = $tokenID; |
@@ -40,7 +40,7 @@ |
||
40 | 40 | * @param string $matchedText |
41 | 41 | * @param mixed $subject |
42 | 42 | */ |
43 | - public function __construct(string $tokenID, string $matchedText, $subject=null) |
|
43 | + public function __construct(string $tokenID, string $matchedText, $subject = null) |
|
44 | 44 | { |
45 | 45 | $this->tokenID = $tokenID; |
46 | 46 | $this->matchedText = $matchedText; |