@@ -15,52 +15,52 @@ |
||
15 | 15 | */ |
16 | 16 | class UUIDUtil |
17 | 17 | { |
18 | - /** |
|
19 | - * Returns a pseudo-random v4 UUID. |
|
20 | - * |
|
21 | - * This function is based on a comment by Andrew Moore on php.net |
|
22 | - * |
|
23 | - * @see http://www.php.net/manual/en/function.uniqid.php#94959 |
|
24 | - * |
|
25 | - * @return string |
|
26 | - */ |
|
27 | - public static function getUUID() |
|
28 | - { |
|
29 | - return sprintf( |
|
30 | - '%04x%04x-%04x-%04x-%04x-%04x%04x%04x', |
|
18 | + /** |
|
19 | + * Returns a pseudo-random v4 UUID. |
|
20 | + * |
|
21 | + * This function is based on a comment by Andrew Moore on php.net |
|
22 | + * |
|
23 | + * @see http://www.php.net/manual/en/function.uniqid.php#94959 |
|
24 | + * |
|
25 | + * @return string |
|
26 | + */ |
|
27 | + public static function getUUID() |
|
28 | + { |
|
29 | + return sprintf( |
|
30 | + '%04x%04x-%04x-%04x-%04x-%04x%04x%04x', |
|
31 | 31 | |
32 | - // 32 bits for "time_low" |
|
33 | - mt_rand(0, 0xffff), mt_rand(0, 0xffff), |
|
32 | + // 32 bits for "time_low" |
|
33 | + mt_rand(0, 0xffff), mt_rand(0, 0xffff), |
|
34 | 34 | |
35 | - // 16 bits for "time_mid" |
|
36 | - mt_rand(0, 0xffff), |
|
35 | + // 16 bits for "time_mid" |
|
36 | + mt_rand(0, 0xffff), |
|
37 | 37 | |
38 | - // 16 bits for "time_hi_and_version", |
|
39 | - // four most significant bits holds version number 4 |
|
40 | - mt_rand(0, 0x0fff) | 0x4000, |
|
38 | + // 16 bits for "time_hi_and_version", |
|
39 | + // four most significant bits holds version number 4 |
|
40 | + mt_rand(0, 0x0fff) | 0x4000, |
|
41 | 41 | |
42 | - // 16 bits, 8 bits for "clk_seq_hi_res", |
|
43 | - // 8 bits for "clk_seq_low", |
|
44 | - // two most significant bits holds zero and one for variant DCE1.1 |
|
45 | - mt_rand(0, 0x3fff) | 0x8000, |
|
42 | + // 16 bits, 8 bits for "clk_seq_hi_res", |
|
43 | + // 8 bits for "clk_seq_low", |
|
44 | + // two most significant bits holds zero and one for variant DCE1.1 |
|
45 | + mt_rand(0, 0x3fff) | 0x8000, |
|
46 | 46 | |
47 | - // 48 bits for "node" |
|
48 | - mt_rand(0, 0xffff), mt_rand(0, 0xffff), mt_rand(0, 0xffff) |
|
49 | - ); |
|
50 | - } |
|
47 | + // 48 bits for "node" |
|
48 | + mt_rand(0, 0xffff), mt_rand(0, 0xffff), mt_rand(0, 0xffff) |
|
49 | + ); |
|
50 | + } |
|
51 | 51 | |
52 | - /** |
|
53 | - * Checks if a string is a valid UUID. |
|
54 | - * |
|
55 | - * @param string $uuid |
|
56 | - * |
|
57 | - * @return bool |
|
58 | - */ |
|
59 | - public static function validateUUID($uuid) |
|
60 | - { |
|
61 | - return 0 !== preg_match( |
|
62 | - '/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/i', |
|
63 | - $uuid |
|
64 | - ); |
|
65 | - } |
|
52 | + /** |
|
53 | + * Checks if a string is a valid UUID. |
|
54 | + * |
|
55 | + * @param string $uuid |
|
56 | + * |
|
57 | + * @return bool |
|
58 | + */ |
|
59 | + public static function validateUUID($uuid) |
|
60 | + { |
|
61 | + return 0 !== preg_match( |
|
62 | + '/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/i', |
|
63 | + $uuid |
|
64 | + ); |
|
65 | + } |
|
66 | 66 | } |
@@ -11,411 +11,411 @@ |
||
11 | 11 | */ |
12 | 12 | class VCardConverter |
13 | 13 | { |
14 | - /** |
|
15 | - * Converts a vCard object to a new version. |
|
16 | - * |
|
17 | - * targetVersion must be one of: |
|
18 | - * Document::VCARD21 |
|
19 | - * Document::VCARD30 |
|
20 | - * Document::VCARD40 |
|
21 | - * |
|
22 | - * Currently only 3.0 and 4.0 as input and output versions. |
|
23 | - * |
|
24 | - * 2.1 has some minor support for the input version, it's incomplete at the |
|
25 | - * moment though. |
|
26 | - * |
|
27 | - * If input and output version are identical, a clone is returned. |
|
28 | - * |
|
29 | - * @param int $targetVersion |
|
30 | - */ |
|
31 | - public function convert(Component\VCard $input, $targetVersion) |
|
32 | - { |
|
33 | - $inputVersion = $input->getDocumentType(); |
|
34 | - if ($inputVersion === $targetVersion) { |
|
35 | - return clone $input; |
|
36 | - } |
|
37 | - |
|
38 | - if (!in_array($inputVersion, [Document::VCARD21, Document::VCARD30, Document::VCARD40])) { |
|
39 | - throw new \InvalidArgumentException('Only vCard 2.1, 3.0 and 4.0 are supported for the input data'); |
|
40 | - } |
|
41 | - if (!in_array($targetVersion, [Document::VCARD30, Document::VCARD40])) { |
|
42 | - throw new \InvalidArgumentException('You can only use vCard 3.0 or 4.0 for the target version'); |
|
43 | - } |
|
44 | - |
|
45 | - $newVersion = Document::VCARD40 === $targetVersion ? '4.0' : '3.0'; |
|
46 | - |
|
47 | - $output = new Component\VCard([ |
|
48 | - 'VERSION' => $newVersion, |
|
49 | - ]); |
|
50 | - |
|
51 | - // We might have generated a default UID. Remove it! |
|
52 | - unset($output->UID); |
|
53 | - |
|
54 | - foreach ($input->children() as $property) { |
|
55 | - $this->convertProperty($input, $output, $property, $targetVersion); |
|
56 | - } |
|
57 | - |
|
58 | - return $output; |
|
59 | - } |
|
60 | - |
|
61 | - /** |
|
62 | - * Handles conversion of a single property. |
|
63 | - * |
|
64 | - * @param int $targetVersion |
|
65 | - */ |
|
66 | - protected function convertProperty(Component\VCard $input, Component\VCard $output, Property $property, $targetVersion) |
|
67 | - { |
|
68 | - // Skipping these, those are automatically added. |
|
69 | - if (in_array($property->name, ['VERSION', 'PRODID'])) { |
|
70 | - return; |
|
71 | - } |
|
72 | - |
|
73 | - $parameters = $property->parameters(); |
|
74 | - $valueType = null; |
|
75 | - if (isset($parameters['VALUE'])) { |
|
76 | - $valueType = $parameters['VALUE']->getValue(); |
|
77 | - unset($parameters['VALUE']); |
|
78 | - } |
|
79 | - if (!$valueType) { |
|
80 | - $valueType = $property->getValueType(); |
|
81 | - } |
|
82 | - if (Document::VCARD30 !== $targetVersion && 'PHONE-NUMBER' === $valueType) { |
|
83 | - $valueType = null; |
|
84 | - } |
|
85 | - $newProperty = $output->createProperty( |
|
86 | - $property->name, |
|
87 | - $property->getParts(), |
|
88 | - [], // parameters will get added a bit later. |
|
89 | - $valueType |
|
90 | - ); |
|
91 | - |
|
92 | - if (Document::VCARD30 === $targetVersion) { |
|
93 | - if ($property instanceof Property\Uri && in_array($property->name, ['PHOTO', 'LOGO', 'SOUND'])) { |
|
94 | - $newProperty = $this->convertUriToBinary($output, $newProperty); |
|
95 | - } elseif ($property instanceof Property\VCard\DateAndOrTime) { |
|
96 | - // In vCard 4, the birth year may be optional. This is not the |
|
97 | - // case for vCard 3. Apple has a workaround for this that |
|
98 | - // allows applications that support Apple's extension still |
|
99 | - // omit birthyears in vCard 3, but applications that do not |
|
100 | - // support this, will just use a random birthyear. We're |
|
101 | - // choosing 1604 for the birthyear, because that's what apple |
|
102 | - // uses. |
|
103 | - $parts = DateTimeParser::parseVCardDateTime($property->getValue()); |
|
104 | - if (is_null($parts['year'])) { |
|
105 | - $newValue = '1604-'.$parts['month'].'-'.$parts['date']; |
|
106 | - $newProperty->setValue($newValue); |
|
107 | - $newProperty['X-APPLE-OMIT-YEAR'] = '1604'; |
|
108 | - } |
|
109 | - |
|
110 | - if ('ANNIVERSARY' == $newProperty->name) { |
|
111 | - // Microsoft non-standard anniversary |
|
112 | - $newProperty->name = 'X-ANNIVERSARY'; |
|
113 | - |
|
114 | - // We also need to add a new apple property for the same |
|
115 | - // purpose. This apple property needs a 'label' in the same |
|
116 | - // group, so we first need to find a groupname that doesn't |
|
117 | - // exist yet. |
|
118 | - $x = 1; |
|
119 | - while ($output->select('ITEM'.$x.'.')) { |
|
120 | - ++$x; |
|
121 | - } |
|
122 | - $output->add('ITEM'.$x.'.X-ABDATE', $newProperty->getValue(), ['VALUE' => 'DATE-AND-OR-TIME']); |
|
123 | - $output->add('ITEM'.$x.'.X-ABLABEL', '_$!<Anniversary>!$_'); |
|
124 | - } |
|
125 | - } elseif ('KIND' === $property->name) { |
|
126 | - switch (strtolower($property->getValue())) { |
|
127 | - case 'org': |
|
128 | - // vCard 3.0 does not have an equivalent to KIND:ORG, |
|
129 | - // but apple has an extension that means the same |
|
130 | - // thing. |
|
131 | - $newProperty = $output->createProperty('X-ABSHOWAS', 'COMPANY'); |
|
132 | - break; |
|
133 | - |
|
134 | - case 'individual': |
|
135 | - // Individual is implicit, so we skip it. |
|
136 | - return; |
|
137 | - |
|
138 | - case 'group': |
|
139 | - // OS X addressbook property |
|
140 | - $newProperty = $output->createProperty('X-ADDRESSBOOKSERVER-KIND', 'GROUP'); |
|
141 | - break; |
|
142 | - } |
|
143 | - } elseif ('MEMBER' === $property->name) { |
|
144 | - $newProperty = $output->createProperty('X-ADDRESSBOOKSERVER-MEMBER', $property->getValue()); |
|
145 | - } |
|
146 | - } elseif (Document::VCARD40 === $targetVersion) { |
|
147 | - // These properties were removed in vCard 4.0 |
|
148 | - if (in_array($property->name, ['NAME', 'MAILER', 'LABEL', 'CLASS'])) { |
|
149 | - return; |
|
150 | - } |
|
151 | - |
|
152 | - if ($property instanceof Property\Binary) { |
|
153 | - $newProperty = $this->convertBinaryToUri($output, $newProperty, $parameters); |
|
154 | - } elseif ($property instanceof Property\VCard\DateAndOrTime && isset($parameters['X-APPLE-OMIT-YEAR'])) { |
|
155 | - // If a property such as BDAY contained 'X-APPLE-OMIT-YEAR', |
|
156 | - // then we're stripping the year from the vcard 4 value. |
|
157 | - $parts = DateTimeParser::parseVCardDateTime($property->getValue()); |
|
158 | - if ($parts['year'] === $property['X-APPLE-OMIT-YEAR']->getValue()) { |
|
159 | - $newValue = '--'.$parts['month'].'-'.$parts['date']; |
|
160 | - $newProperty->setValue($newValue); |
|
161 | - } |
|
162 | - |
|
163 | - // Regardless if the year matched or not, we do need to strip |
|
164 | - // X-APPLE-OMIT-YEAR. |
|
165 | - unset($parameters['X-APPLE-OMIT-YEAR']); |
|
166 | - } |
|
167 | - switch ($property->name) { |
|
168 | - case 'X-ABSHOWAS': |
|
169 | - if ('COMPANY' === strtoupper($property->getValue())) { |
|
170 | - $newProperty = $output->createProperty('KIND', 'ORG'); |
|
171 | - } |
|
172 | - break; |
|
173 | - case 'X-ADDRESSBOOKSERVER-KIND': |
|
174 | - if ('GROUP' === strtoupper($property->getValue())) { |
|
175 | - $newProperty = $output->createProperty('KIND', 'GROUP'); |
|
176 | - } |
|
177 | - break; |
|
178 | - case 'X-ADDRESSBOOKSERVER-MEMBER': |
|
179 | - $newProperty = $output->createProperty('MEMBER', $property->getValue()); |
|
180 | - break; |
|
181 | - case 'X-ANNIVERSARY': |
|
182 | - $newProperty->name = 'ANNIVERSARY'; |
|
183 | - // If we already have an anniversary property with the same |
|
184 | - // value, ignore. |
|
185 | - foreach ($output->select('ANNIVERSARY') as $anniversary) { |
|
186 | - if ($anniversary->getValue() === $newProperty->getValue()) { |
|
187 | - return; |
|
188 | - } |
|
189 | - } |
|
190 | - break; |
|
191 | - case 'X-ABDATE': |
|
192 | - // Find out what the label was, if it exists. |
|
193 | - if (!$property->group) { |
|
194 | - break; |
|
195 | - } |
|
196 | - $label = $input->{$property->group.'.X-ABLABEL'}; |
|
197 | - |
|
198 | - // We only support converting anniversaries. |
|
199 | - if (!$label || '_$!<Anniversary>!$_' !== $label->getValue()) { |
|
200 | - break; |
|
201 | - } |
|
202 | - |
|
203 | - // If we already have an anniversary property with the same |
|
204 | - // value, ignore. |
|
205 | - foreach ($output->select('ANNIVERSARY') as $anniversary) { |
|
206 | - if ($anniversary->getValue() === $newProperty->getValue()) { |
|
207 | - return; |
|
208 | - } |
|
209 | - } |
|
210 | - $newProperty->name = 'ANNIVERSARY'; |
|
211 | - break; |
|
212 | - // Apple's per-property label system. |
|
213 | - case 'X-ABLABEL': |
|
214 | - if ('_$!<Anniversary>!$_' === $newProperty->getValue()) { |
|
215 | - // We can safely remove these, as they are converted to |
|
216 | - // ANNIVERSARY properties. |
|
217 | - return; |
|
218 | - } |
|
219 | - break; |
|
220 | - } |
|
221 | - } |
|
222 | - |
|
223 | - // set property group |
|
224 | - $newProperty->group = $property->group; |
|
225 | - |
|
226 | - if (Document::VCARD40 === $targetVersion) { |
|
227 | - $this->convertParameters40($newProperty, $parameters); |
|
228 | - } else { |
|
229 | - $this->convertParameters30($newProperty, $parameters); |
|
230 | - } |
|
231 | - |
|
232 | - // Lastly, we need to see if there's a need for a VALUE parameter. |
|
233 | - // |
|
234 | - // We can do that by instantiating a empty property with that name, and |
|
235 | - // seeing if the default valueType is identical to the current one. |
|
236 | - $tempProperty = $output->createProperty($newProperty->name); |
|
237 | - if ($tempProperty->getValueType() !== $newProperty->getValueType()) { |
|
238 | - $newProperty['VALUE'] = $newProperty->getValueType(); |
|
239 | - } |
|
240 | - |
|
241 | - $output->add($newProperty); |
|
242 | - } |
|
243 | - |
|
244 | - /** |
|
245 | - * Converts a BINARY property to a URI property. |
|
246 | - * |
|
247 | - * vCard 4.0 no longer supports BINARY properties. |
|
248 | - * |
|
249 | - * @param Property\Uri $property the input property |
|
250 | - * @param $parameters list of parameters that will eventually be added to |
|
251 | - * the new property |
|
252 | - * |
|
253 | - * @return Property\Uri |
|
254 | - */ |
|
255 | - protected function convertBinaryToUri(Component\VCard $output, Property\Binary $newProperty, array &$parameters) |
|
256 | - { |
|
257 | - $value = $newProperty->getValue(); |
|
258 | - $newProperty = $output->createProperty( |
|
259 | - $newProperty->name, |
|
260 | - null, // no value |
|
261 | - [], // no parameters yet |
|
262 | - 'URI' // Forcing the BINARY type |
|
263 | - ); |
|
264 | - |
|
265 | - $mimeType = 'application/octet-stream'; |
|
266 | - |
|
267 | - // See if we can find a better mimetype. |
|
268 | - if (isset($parameters['TYPE'])) { |
|
269 | - $newTypes = []; |
|
270 | - foreach ($parameters['TYPE']->getParts() as $typePart) { |
|
271 | - if (in_array( |
|
272 | - strtoupper($typePart), |
|
273 | - ['JPEG', 'PNG', 'GIF'] |
|
274 | - )) { |
|
275 | - $mimeType = 'image/'.strtolower($typePart); |
|
276 | - } else { |
|
277 | - $newTypes[] = $typePart; |
|
278 | - } |
|
279 | - } |
|
280 | - |
|
281 | - // If there were any parameters we're not converting to a |
|
282 | - // mime-type, we need to keep them. |
|
283 | - if ($newTypes) { |
|
284 | - $parameters['TYPE']->setParts($newTypes); |
|
285 | - } else { |
|
286 | - unset($parameters['TYPE']); |
|
287 | - } |
|
288 | - } |
|
289 | - |
|
290 | - $newProperty->setValue('data:'.$mimeType.';base64,'.base64_encode($value)); |
|
291 | - |
|
292 | - return $newProperty; |
|
293 | - } |
|
294 | - |
|
295 | - /** |
|
296 | - * Converts a URI property to a BINARY property. |
|
297 | - * |
|
298 | - * In vCard 4.0 attachments are encoded as data: uri. Even though these may |
|
299 | - * be valid in vCard 3.0 as well, we should convert those to BINARY if |
|
300 | - * possible, to improve compatibility. |
|
301 | - * |
|
302 | - * @param Property\Uri $property the input property |
|
303 | - * |
|
304 | - * @return Property\Binary|null |
|
305 | - */ |
|
306 | - protected function convertUriToBinary(Component\VCard $output, Property\Uri $newProperty) |
|
307 | - { |
|
308 | - $value = $newProperty->getValue(); |
|
309 | - |
|
310 | - // Only converting data: uris |
|
311 | - if ('data:' !== substr($value, 0, 5)) { |
|
312 | - return $newProperty; |
|
313 | - } |
|
314 | - |
|
315 | - $newProperty = $output->createProperty( |
|
316 | - $newProperty->name, |
|
317 | - null, // no value |
|
318 | - [], // no parameters yet |
|
319 | - 'BINARY' |
|
320 | - ); |
|
321 | - |
|
322 | - $mimeType = substr($value, 5, strpos($value, ',') - 5); |
|
323 | - if (strpos($mimeType, ';')) { |
|
324 | - $mimeType = substr($mimeType, 0, strpos($mimeType, ';')); |
|
325 | - $newProperty->setValue(base64_decode(substr($value, strpos($value, ',') + 1))); |
|
326 | - } else { |
|
327 | - $newProperty->setValue(substr($value, strpos($value, ',') + 1)); |
|
328 | - } |
|
329 | - unset($value); |
|
330 | - |
|
331 | - $newProperty['ENCODING'] = 'b'; |
|
332 | - switch ($mimeType) { |
|
333 | - case 'image/jpeg': |
|
334 | - $newProperty['TYPE'] = 'JPEG'; |
|
335 | - break; |
|
336 | - case 'image/png': |
|
337 | - $newProperty['TYPE'] = 'PNG'; |
|
338 | - break; |
|
339 | - case 'image/gif': |
|
340 | - $newProperty['TYPE'] = 'GIF'; |
|
341 | - break; |
|
342 | - } |
|
343 | - |
|
344 | - return $newProperty; |
|
345 | - } |
|
346 | - |
|
347 | - /** |
|
348 | - * Adds parameters to a new property for vCard 4.0. |
|
349 | - */ |
|
350 | - protected function convertParameters40(Property $newProperty, array $parameters) |
|
351 | - { |
|
352 | - // Adding all parameters. |
|
353 | - foreach ($parameters as $param) { |
|
354 | - // vCard 2.1 allowed parameters with no name |
|
355 | - if ($param->noName) { |
|
356 | - $param->noName = false; |
|
357 | - } |
|
358 | - |
|
359 | - switch ($param->name) { |
|
360 | - // We need to see if there's any TYPE=PREF, because in vCard 4 |
|
361 | - // that's now PREF=1. |
|
362 | - case 'TYPE': |
|
363 | - foreach ($param->getParts() as $paramPart) { |
|
364 | - if ('PREF' === strtoupper($paramPart)) { |
|
365 | - $newProperty->add('PREF', '1'); |
|
366 | - } else { |
|
367 | - $newProperty->add($param->name, $paramPart); |
|
368 | - } |
|
369 | - } |
|
370 | - break; |
|
371 | - // These no longer exist in vCard 4 |
|
372 | - case 'ENCODING': |
|
373 | - case 'CHARSET': |
|
374 | - break; |
|
375 | - |
|
376 | - default: |
|
377 | - $newProperty->add($param->name, $param->getParts()); |
|
378 | - break; |
|
379 | - } |
|
380 | - } |
|
381 | - } |
|
382 | - |
|
383 | - /** |
|
384 | - * Adds parameters to a new property for vCard 3.0. |
|
385 | - */ |
|
386 | - protected function convertParameters30(Property $newProperty, array $parameters) |
|
387 | - { |
|
388 | - // Adding all parameters. |
|
389 | - foreach ($parameters as $param) { |
|
390 | - // vCard 2.1 allowed parameters with no name |
|
391 | - if ($param->noName) { |
|
392 | - $param->noName = false; |
|
393 | - } |
|
394 | - |
|
395 | - switch ($param->name) { |
|
396 | - case 'ENCODING': |
|
397 | - // This value only existed in vCard 2.1, and should be |
|
398 | - // removed for anything else. |
|
399 | - if ('QUOTED-PRINTABLE' !== strtoupper($param->getValue())) { |
|
400 | - $newProperty->add($param->name, $param->getParts()); |
|
401 | - } |
|
402 | - break; |
|
403 | - |
|
404 | - /* |
|
14 | + /** |
|
15 | + * Converts a vCard object to a new version. |
|
16 | + * |
|
17 | + * targetVersion must be one of: |
|
18 | + * Document::VCARD21 |
|
19 | + * Document::VCARD30 |
|
20 | + * Document::VCARD40 |
|
21 | + * |
|
22 | + * Currently only 3.0 and 4.0 as input and output versions. |
|
23 | + * |
|
24 | + * 2.1 has some minor support for the input version, it's incomplete at the |
|
25 | + * moment though. |
|
26 | + * |
|
27 | + * If input and output version are identical, a clone is returned. |
|
28 | + * |
|
29 | + * @param int $targetVersion |
|
30 | + */ |
|
31 | + public function convert(Component\VCard $input, $targetVersion) |
|
32 | + { |
|
33 | + $inputVersion = $input->getDocumentType(); |
|
34 | + if ($inputVersion === $targetVersion) { |
|
35 | + return clone $input; |
|
36 | + } |
|
37 | + |
|
38 | + if (!in_array($inputVersion, [Document::VCARD21, Document::VCARD30, Document::VCARD40])) { |
|
39 | + throw new \InvalidArgumentException('Only vCard 2.1, 3.0 and 4.0 are supported for the input data'); |
|
40 | + } |
|
41 | + if (!in_array($targetVersion, [Document::VCARD30, Document::VCARD40])) { |
|
42 | + throw new \InvalidArgumentException('You can only use vCard 3.0 or 4.0 for the target version'); |
|
43 | + } |
|
44 | + |
|
45 | + $newVersion = Document::VCARD40 === $targetVersion ? '4.0' : '3.0'; |
|
46 | + |
|
47 | + $output = new Component\VCard([ |
|
48 | + 'VERSION' => $newVersion, |
|
49 | + ]); |
|
50 | + |
|
51 | + // We might have generated a default UID. Remove it! |
|
52 | + unset($output->UID); |
|
53 | + |
|
54 | + foreach ($input->children() as $property) { |
|
55 | + $this->convertProperty($input, $output, $property, $targetVersion); |
|
56 | + } |
|
57 | + |
|
58 | + return $output; |
|
59 | + } |
|
60 | + |
|
61 | + /** |
|
62 | + * Handles conversion of a single property. |
|
63 | + * |
|
64 | + * @param int $targetVersion |
|
65 | + */ |
|
66 | + protected function convertProperty(Component\VCard $input, Component\VCard $output, Property $property, $targetVersion) |
|
67 | + { |
|
68 | + // Skipping these, those are automatically added. |
|
69 | + if (in_array($property->name, ['VERSION', 'PRODID'])) { |
|
70 | + return; |
|
71 | + } |
|
72 | + |
|
73 | + $parameters = $property->parameters(); |
|
74 | + $valueType = null; |
|
75 | + if (isset($parameters['VALUE'])) { |
|
76 | + $valueType = $parameters['VALUE']->getValue(); |
|
77 | + unset($parameters['VALUE']); |
|
78 | + } |
|
79 | + if (!$valueType) { |
|
80 | + $valueType = $property->getValueType(); |
|
81 | + } |
|
82 | + if (Document::VCARD30 !== $targetVersion && 'PHONE-NUMBER' === $valueType) { |
|
83 | + $valueType = null; |
|
84 | + } |
|
85 | + $newProperty = $output->createProperty( |
|
86 | + $property->name, |
|
87 | + $property->getParts(), |
|
88 | + [], // parameters will get added a bit later. |
|
89 | + $valueType |
|
90 | + ); |
|
91 | + |
|
92 | + if (Document::VCARD30 === $targetVersion) { |
|
93 | + if ($property instanceof Property\Uri && in_array($property->name, ['PHOTO', 'LOGO', 'SOUND'])) { |
|
94 | + $newProperty = $this->convertUriToBinary($output, $newProperty); |
|
95 | + } elseif ($property instanceof Property\VCard\DateAndOrTime) { |
|
96 | + // In vCard 4, the birth year may be optional. This is not the |
|
97 | + // case for vCard 3. Apple has a workaround for this that |
|
98 | + // allows applications that support Apple's extension still |
|
99 | + // omit birthyears in vCard 3, but applications that do not |
|
100 | + // support this, will just use a random birthyear. We're |
|
101 | + // choosing 1604 for the birthyear, because that's what apple |
|
102 | + // uses. |
|
103 | + $parts = DateTimeParser::parseVCardDateTime($property->getValue()); |
|
104 | + if (is_null($parts['year'])) { |
|
105 | + $newValue = '1604-'.$parts['month'].'-'.$parts['date']; |
|
106 | + $newProperty->setValue($newValue); |
|
107 | + $newProperty['X-APPLE-OMIT-YEAR'] = '1604'; |
|
108 | + } |
|
109 | + |
|
110 | + if ('ANNIVERSARY' == $newProperty->name) { |
|
111 | + // Microsoft non-standard anniversary |
|
112 | + $newProperty->name = 'X-ANNIVERSARY'; |
|
113 | + |
|
114 | + // We also need to add a new apple property for the same |
|
115 | + // purpose. This apple property needs a 'label' in the same |
|
116 | + // group, so we first need to find a groupname that doesn't |
|
117 | + // exist yet. |
|
118 | + $x = 1; |
|
119 | + while ($output->select('ITEM'.$x.'.')) { |
|
120 | + ++$x; |
|
121 | + } |
|
122 | + $output->add('ITEM'.$x.'.X-ABDATE', $newProperty->getValue(), ['VALUE' => 'DATE-AND-OR-TIME']); |
|
123 | + $output->add('ITEM'.$x.'.X-ABLABEL', '_$!<Anniversary>!$_'); |
|
124 | + } |
|
125 | + } elseif ('KIND' === $property->name) { |
|
126 | + switch (strtolower($property->getValue())) { |
|
127 | + case 'org': |
|
128 | + // vCard 3.0 does not have an equivalent to KIND:ORG, |
|
129 | + // but apple has an extension that means the same |
|
130 | + // thing. |
|
131 | + $newProperty = $output->createProperty('X-ABSHOWAS', 'COMPANY'); |
|
132 | + break; |
|
133 | + |
|
134 | + case 'individual': |
|
135 | + // Individual is implicit, so we skip it. |
|
136 | + return; |
|
137 | + |
|
138 | + case 'group': |
|
139 | + // OS X addressbook property |
|
140 | + $newProperty = $output->createProperty('X-ADDRESSBOOKSERVER-KIND', 'GROUP'); |
|
141 | + break; |
|
142 | + } |
|
143 | + } elseif ('MEMBER' === $property->name) { |
|
144 | + $newProperty = $output->createProperty('X-ADDRESSBOOKSERVER-MEMBER', $property->getValue()); |
|
145 | + } |
|
146 | + } elseif (Document::VCARD40 === $targetVersion) { |
|
147 | + // These properties were removed in vCard 4.0 |
|
148 | + if (in_array($property->name, ['NAME', 'MAILER', 'LABEL', 'CLASS'])) { |
|
149 | + return; |
|
150 | + } |
|
151 | + |
|
152 | + if ($property instanceof Property\Binary) { |
|
153 | + $newProperty = $this->convertBinaryToUri($output, $newProperty, $parameters); |
|
154 | + } elseif ($property instanceof Property\VCard\DateAndOrTime && isset($parameters['X-APPLE-OMIT-YEAR'])) { |
|
155 | + // If a property such as BDAY contained 'X-APPLE-OMIT-YEAR', |
|
156 | + // then we're stripping the year from the vcard 4 value. |
|
157 | + $parts = DateTimeParser::parseVCardDateTime($property->getValue()); |
|
158 | + if ($parts['year'] === $property['X-APPLE-OMIT-YEAR']->getValue()) { |
|
159 | + $newValue = '--'.$parts['month'].'-'.$parts['date']; |
|
160 | + $newProperty->setValue($newValue); |
|
161 | + } |
|
162 | + |
|
163 | + // Regardless if the year matched or not, we do need to strip |
|
164 | + // X-APPLE-OMIT-YEAR. |
|
165 | + unset($parameters['X-APPLE-OMIT-YEAR']); |
|
166 | + } |
|
167 | + switch ($property->name) { |
|
168 | + case 'X-ABSHOWAS': |
|
169 | + if ('COMPANY' === strtoupper($property->getValue())) { |
|
170 | + $newProperty = $output->createProperty('KIND', 'ORG'); |
|
171 | + } |
|
172 | + break; |
|
173 | + case 'X-ADDRESSBOOKSERVER-KIND': |
|
174 | + if ('GROUP' === strtoupper($property->getValue())) { |
|
175 | + $newProperty = $output->createProperty('KIND', 'GROUP'); |
|
176 | + } |
|
177 | + break; |
|
178 | + case 'X-ADDRESSBOOKSERVER-MEMBER': |
|
179 | + $newProperty = $output->createProperty('MEMBER', $property->getValue()); |
|
180 | + break; |
|
181 | + case 'X-ANNIVERSARY': |
|
182 | + $newProperty->name = 'ANNIVERSARY'; |
|
183 | + // If we already have an anniversary property with the same |
|
184 | + // value, ignore. |
|
185 | + foreach ($output->select('ANNIVERSARY') as $anniversary) { |
|
186 | + if ($anniversary->getValue() === $newProperty->getValue()) { |
|
187 | + return; |
|
188 | + } |
|
189 | + } |
|
190 | + break; |
|
191 | + case 'X-ABDATE': |
|
192 | + // Find out what the label was, if it exists. |
|
193 | + if (!$property->group) { |
|
194 | + break; |
|
195 | + } |
|
196 | + $label = $input->{$property->group.'.X-ABLABEL'}; |
|
197 | + |
|
198 | + // We only support converting anniversaries. |
|
199 | + if (!$label || '_$!<Anniversary>!$_' !== $label->getValue()) { |
|
200 | + break; |
|
201 | + } |
|
202 | + |
|
203 | + // If we already have an anniversary property with the same |
|
204 | + // value, ignore. |
|
205 | + foreach ($output->select('ANNIVERSARY') as $anniversary) { |
|
206 | + if ($anniversary->getValue() === $newProperty->getValue()) { |
|
207 | + return; |
|
208 | + } |
|
209 | + } |
|
210 | + $newProperty->name = 'ANNIVERSARY'; |
|
211 | + break; |
|
212 | + // Apple's per-property label system. |
|
213 | + case 'X-ABLABEL': |
|
214 | + if ('_$!<Anniversary>!$_' === $newProperty->getValue()) { |
|
215 | + // We can safely remove these, as they are converted to |
|
216 | + // ANNIVERSARY properties. |
|
217 | + return; |
|
218 | + } |
|
219 | + break; |
|
220 | + } |
|
221 | + } |
|
222 | + |
|
223 | + // set property group |
|
224 | + $newProperty->group = $property->group; |
|
225 | + |
|
226 | + if (Document::VCARD40 === $targetVersion) { |
|
227 | + $this->convertParameters40($newProperty, $parameters); |
|
228 | + } else { |
|
229 | + $this->convertParameters30($newProperty, $parameters); |
|
230 | + } |
|
231 | + |
|
232 | + // Lastly, we need to see if there's a need for a VALUE parameter. |
|
233 | + // |
|
234 | + // We can do that by instantiating a empty property with that name, and |
|
235 | + // seeing if the default valueType is identical to the current one. |
|
236 | + $tempProperty = $output->createProperty($newProperty->name); |
|
237 | + if ($tempProperty->getValueType() !== $newProperty->getValueType()) { |
|
238 | + $newProperty['VALUE'] = $newProperty->getValueType(); |
|
239 | + } |
|
240 | + |
|
241 | + $output->add($newProperty); |
|
242 | + } |
|
243 | + |
|
244 | + /** |
|
245 | + * Converts a BINARY property to a URI property. |
|
246 | + * |
|
247 | + * vCard 4.0 no longer supports BINARY properties. |
|
248 | + * |
|
249 | + * @param Property\Uri $property the input property |
|
250 | + * @param $parameters list of parameters that will eventually be added to |
|
251 | + * the new property |
|
252 | + * |
|
253 | + * @return Property\Uri |
|
254 | + */ |
|
255 | + protected function convertBinaryToUri(Component\VCard $output, Property\Binary $newProperty, array &$parameters) |
|
256 | + { |
|
257 | + $value = $newProperty->getValue(); |
|
258 | + $newProperty = $output->createProperty( |
|
259 | + $newProperty->name, |
|
260 | + null, // no value |
|
261 | + [], // no parameters yet |
|
262 | + 'URI' // Forcing the BINARY type |
|
263 | + ); |
|
264 | + |
|
265 | + $mimeType = 'application/octet-stream'; |
|
266 | + |
|
267 | + // See if we can find a better mimetype. |
|
268 | + if (isset($parameters['TYPE'])) { |
|
269 | + $newTypes = []; |
|
270 | + foreach ($parameters['TYPE']->getParts() as $typePart) { |
|
271 | + if (in_array( |
|
272 | + strtoupper($typePart), |
|
273 | + ['JPEG', 'PNG', 'GIF'] |
|
274 | + )) { |
|
275 | + $mimeType = 'image/'.strtolower($typePart); |
|
276 | + } else { |
|
277 | + $newTypes[] = $typePart; |
|
278 | + } |
|
279 | + } |
|
280 | + |
|
281 | + // If there were any parameters we're not converting to a |
|
282 | + // mime-type, we need to keep them. |
|
283 | + if ($newTypes) { |
|
284 | + $parameters['TYPE']->setParts($newTypes); |
|
285 | + } else { |
|
286 | + unset($parameters['TYPE']); |
|
287 | + } |
|
288 | + } |
|
289 | + |
|
290 | + $newProperty->setValue('data:'.$mimeType.';base64,'.base64_encode($value)); |
|
291 | + |
|
292 | + return $newProperty; |
|
293 | + } |
|
294 | + |
|
295 | + /** |
|
296 | + * Converts a URI property to a BINARY property. |
|
297 | + * |
|
298 | + * In vCard 4.0 attachments are encoded as data: uri. Even though these may |
|
299 | + * be valid in vCard 3.0 as well, we should convert those to BINARY if |
|
300 | + * possible, to improve compatibility. |
|
301 | + * |
|
302 | + * @param Property\Uri $property the input property |
|
303 | + * |
|
304 | + * @return Property\Binary|null |
|
305 | + */ |
|
306 | + protected function convertUriToBinary(Component\VCard $output, Property\Uri $newProperty) |
|
307 | + { |
|
308 | + $value = $newProperty->getValue(); |
|
309 | + |
|
310 | + // Only converting data: uris |
|
311 | + if ('data:' !== substr($value, 0, 5)) { |
|
312 | + return $newProperty; |
|
313 | + } |
|
314 | + |
|
315 | + $newProperty = $output->createProperty( |
|
316 | + $newProperty->name, |
|
317 | + null, // no value |
|
318 | + [], // no parameters yet |
|
319 | + 'BINARY' |
|
320 | + ); |
|
321 | + |
|
322 | + $mimeType = substr($value, 5, strpos($value, ',') - 5); |
|
323 | + if (strpos($mimeType, ';')) { |
|
324 | + $mimeType = substr($mimeType, 0, strpos($mimeType, ';')); |
|
325 | + $newProperty->setValue(base64_decode(substr($value, strpos($value, ',') + 1))); |
|
326 | + } else { |
|
327 | + $newProperty->setValue(substr($value, strpos($value, ',') + 1)); |
|
328 | + } |
|
329 | + unset($value); |
|
330 | + |
|
331 | + $newProperty['ENCODING'] = 'b'; |
|
332 | + switch ($mimeType) { |
|
333 | + case 'image/jpeg': |
|
334 | + $newProperty['TYPE'] = 'JPEG'; |
|
335 | + break; |
|
336 | + case 'image/png': |
|
337 | + $newProperty['TYPE'] = 'PNG'; |
|
338 | + break; |
|
339 | + case 'image/gif': |
|
340 | + $newProperty['TYPE'] = 'GIF'; |
|
341 | + break; |
|
342 | + } |
|
343 | + |
|
344 | + return $newProperty; |
|
345 | + } |
|
346 | + |
|
347 | + /** |
|
348 | + * Adds parameters to a new property for vCard 4.0. |
|
349 | + */ |
|
350 | + protected function convertParameters40(Property $newProperty, array $parameters) |
|
351 | + { |
|
352 | + // Adding all parameters. |
|
353 | + foreach ($parameters as $param) { |
|
354 | + // vCard 2.1 allowed parameters with no name |
|
355 | + if ($param->noName) { |
|
356 | + $param->noName = false; |
|
357 | + } |
|
358 | + |
|
359 | + switch ($param->name) { |
|
360 | + // We need to see if there's any TYPE=PREF, because in vCard 4 |
|
361 | + // that's now PREF=1. |
|
362 | + case 'TYPE': |
|
363 | + foreach ($param->getParts() as $paramPart) { |
|
364 | + if ('PREF' === strtoupper($paramPart)) { |
|
365 | + $newProperty->add('PREF', '1'); |
|
366 | + } else { |
|
367 | + $newProperty->add($param->name, $paramPart); |
|
368 | + } |
|
369 | + } |
|
370 | + break; |
|
371 | + // These no longer exist in vCard 4 |
|
372 | + case 'ENCODING': |
|
373 | + case 'CHARSET': |
|
374 | + break; |
|
375 | + |
|
376 | + default: |
|
377 | + $newProperty->add($param->name, $param->getParts()); |
|
378 | + break; |
|
379 | + } |
|
380 | + } |
|
381 | + } |
|
382 | + |
|
383 | + /** |
|
384 | + * Adds parameters to a new property for vCard 3.0. |
|
385 | + */ |
|
386 | + protected function convertParameters30(Property $newProperty, array $parameters) |
|
387 | + { |
|
388 | + // Adding all parameters. |
|
389 | + foreach ($parameters as $param) { |
|
390 | + // vCard 2.1 allowed parameters with no name |
|
391 | + if ($param->noName) { |
|
392 | + $param->noName = false; |
|
393 | + } |
|
394 | + |
|
395 | + switch ($param->name) { |
|
396 | + case 'ENCODING': |
|
397 | + // This value only existed in vCard 2.1, and should be |
|
398 | + // removed for anything else. |
|
399 | + if ('QUOTED-PRINTABLE' !== strtoupper($param->getValue())) { |
|
400 | + $newProperty->add($param->name, $param->getParts()); |
|
401 | + } |
|
402 | + break; |
|
403 | + |
|
404 | + /* |
|
405 | 405 | * Converting PREF=1 to TYPE=PREF. |
406 | 406 | * |
407 | 407 | * Any other PREF numbers we'll drop. |
408 | 408 | */ |
409 | - case 'PREF': |
|
410 | - if ('1' == $param->getValue()) { |
|
411 | - $newProperty->add('TYPE', 'PREF'); |
|
412 | - } |
|
413 | - break; |
|
414 | - |
|
415 | - default: |
|
416 | - $newProperty->add($param->name, $param->getParts()); |
|
417 | - break; |
|
418 | - } |
|
419 | - } |
|
420 | - } |
|
409 | + case 'PREF': |
|
410 | + if ('1' == $param->getValue()) { |
|
411 | + $newProperty->add('TYPE', 'PREF'); |
|
412 | + } |
|
413 | + break; |
|
414 | + |
|
415 | + default: |
|
416 | + $newProperty->add($param->name, $param->getParts()); |
|
417 | + break; |
|
418 | + } |
|
419 | + } |
|
420 | + } |
|
421 | 421 | } |
@@ -16,35 +16,35 @@ |
||
16 | 16 | */ |
17 | 17 | class ClientHttpException extends \Exception implements HttpException |
18 | 18 | { |
19 | - /** |
|
20 | - * Response object. |
|
21 | - * |
|
22 | - * @var ResponseInterface |
|
23 | - */ |
|
24 | - protected $response; |
|
19 | + /** |
|
20 | + * Response object. |
|
21 | + * |
|
22 | + * @var ResponseInterface |
|
23 | + */ |
|
24 | + protected $response; |
|
25 | 25 | |
26 | - /** |
|
27 | - * Constructor. |
|
28 | - */ |
|
29 | - public function __construct(ResponseInterface $response) |
|
30 | - { |
|
31 | - $this->response = $response; |
|
32 | - parent::__construct($response->getStatusText(), $response->getStatus()); |
|
33 | - } |
|
26 | + /** |
|
27 | + * Constructor. |
|
28 | + */ |
|
29 | + public function __construct(ResponseInterface $response) |
|
30 | + { |
|
31 | + $this->response = $response; |
|
32 | + parent::__construct($response->getStatusText(), $response->getStatus()); |
|
33 | + } |
|
34 | 34 | |
35 | - /** |
|
36 | - * The http status code for the error. |
|
37 | - */ |
|
38 | - public function getHttpStatus(): int |
|
39 | - { |
|
40 | - return $this->response->getStatus(); |
|
41 | - } |
|
35 | + /** |
|
36 | + * The http status code for the error. |
|
37 | + */ |
|
38 | + public function getHttpStatus(): int |
|
39 | + { |
|
40 | + return $this->response->getStatus(); |
|
41 | + } |
|
42 | 42 | |
43 | - /** |
|
44 | - * Returns the full response object. |
|
45 | - */ |
|
46 | - public function getResponse(): ResponseInterface |
|
47 | - { |
|
48 | - return $this->response; |
|
49 | - } |
|
43 | + /** |
|
44 | + * Returns the full response object. |
|
45 | + */ |
|
46 | + public function getResponse(): ResponseInterface |
|
47 | + { |
|
48 | + return $this->response; |
|
49 | + } |
|
50 | 50 | } |
@@ -17,204 +17,204 @@ |
||
17 | 17 | */ |
18 | 18 | class AWS extends AbstractAuth |
19 | 19 | { |
20 | - /** |
|
21 | - * The signature supplied by the HTTP client. |
|
22 | - * |
|
23 | - * @var string |
|
24 | - */ |
|
25 | - private $signature = null; |
|
26 | - |
|
27 | - /** |
|
28 | - * The accesskey supplied by the HTTP client. |
|
29 | - * |
|
30 | - * @var string |
|
31 | - */ |
|
32 | - private $accessKey = null; |
|
33 | - |
|
34 | - /** |
|
35 | - * An error code, if any. |
|
36 | - * |
|
37 | - * This value will be filled with one of the ERR_* constants |
|
38 | - * |
|
39 | - * @var int |
|
40 | - */ |
|
41 | - public $errorCode = 0; |
|
42 | - |
|
43 | - const ERR_NOAWSHEADER = 1; |
|
44 | - const ERR_MD5CHECKSUMWRONG = 2; |
|
45 | - const ERR_INVALIDDATEFORMAT = 3; |
|
46 | - const ERR_REQUESTTIMESKEWED = 4; |
|
47 | - const ERR_INVALIDSIGNATURE = 5; |
|
48 | - |
|
49 | - /** |
|
50 | - * Gathers all information from the headers. |
|
51 | - * |
|
52 | - * This method needs to be called prior to anything else. |
|
53 | - */ |
|
54 | - public function init(): bool |
|
55 | - { |
|
56 | - $authHeader = $this->request->getHeader('Authorization'); |
|
57 | - |
|
58 | - if (null === $authHeader) { |
|
59 | - $this->errorCode = self::ERR_NOAWSHEADER; |
|
60 | - |
|
61 | - return false; |
|
62 | - } |
|
63 | - $authHeader = explode(' ', $authHeader); |
|
64 | - |
|
65 | - if ('AWS' !== $authHeader[0] || !isset($authHeader[1])) { |
|
66 | - $this->errorCode = self::ERR_NOAWSHEADER; |
|
67 | - |
|
68 | - return false; |
|
69 | - } |
|
70 | - |
|
71 | - list($this->accessKey, $this->signature) = explode(':', $authHeader[1]); |
|
72 | - |
|
73 | - return true; |
|
74 | - } |
|
75 | - |
|
76 | - /** |
|
77 | - * Returns the username for the request. |
|
78 | - */ |
|
79 | - public function getAccessKey(): string |
|
80 | - { |
|
81 | - return $this->accessKey; |
|
82 | - } |
|
83 | - |
|
84 | - /** |
|
85 | - * Validates the signature based on the secretKey. |
|
86 | - */ |
|
87 | - public function validate(string $secretKey): bool |
|
88 | - { |
|
89 | - $contentMD5 = $this->request->getHeader('Content-MD5'); |
|
90 | - |
|
91 | - if ($contentMD5) { |
|
92 | - // We need to validate the integrity of the request |
|
93 | - $body = $this->request->getBody(); |
|
94 | - $this->request->setBody($body); |
|
95 | - |
|
96 | - if ($contentMD5 !== base64_encode(md5((string) $body, true))) { |
|
97 | - // content-md5 header did not match md5 signature of body |
|
98 | - $this->errorCode = self::ERR_MD5CHECKSUMWRONG; |
|
99 | - |
|
100 | - return false; |
|
101 | - } |
|
102 | - } |
|
103 | - |
|
104 | - if (!$requestDate = $this->request->getHeader('x-amz-date')) { |
|
105 | - $requestDate = $this->request->getHeader('Date'); |
|
106 | - } |
|
107 | - |
|
108 | - if (!$this->validateRFC2616Date((string) $requestDate)) { |
|
109 | - return false; |
|
110 | - } |
|
111 | - |
|
112 | - $amzHeaders = $this->getAmzHeaders(); |
|
113 | - |
|
114 | - $signature = base64_encode( |
|
115 | - $this->hmacsha1($secretKey, |
|
116 | - $this->request->getMethod()."\n". |
|
117 | - $contentMD5."\n". |
|
118 | - $this->request->getHeader('Content-type')."\n". |
|
119 | - $requestDate."\n". |
|
120 | - $amzHeaders. |
|
121 | - $this->request->getUrl() |
|
122 | - ) |
|
123 | - ); |
|
124 | - |
|
125 | - if ($this->signature !== $signature) { |
|
126 | - $this->errorCode = self::ERR_INVALIDSIGNATURE; |
|
127 | - |
|
128 | - return false; |
|
129 | - } |
|
130 | - |
|
131 | - return true; |
|
132 | - } |
|
133 | - |
|
134 | - /** |
|
135 | - * Returns an HTTP 401 header, forcing login. |
|
136 | - * |
|
137 | - * This should be called when username and password are incorrect, or not supplied at all |
|
138 | - */ |
|
139 | - public function requireLogin() |
|
140 | - { |
|
141 | - $this->response->addHeader('WWW-Authenticate', 'AWS'); |
|
142 | - $this->response->setStatus(401); |
|
143 | - } |
|
144 | - |
|
145 | - /** |
|
146 | - * Makes sure the supplied value is a valid RFC2616 date. |
|
147 | - * |
|
148 | - * If we would just use strtotime to get a valid timestamp, we have no way of checking if a |
|
149 | - * user just supplied the word 'now' for the date header. |
|
150 | - * |
|
151 | - * This function also makes sure the Date header is within 15 minutes of the operating |
|
152 | - * system date, to prevent replay attacks. |
|
153 | - */ |
|
154 | - protected function validateRFC2616Date(string $dateHeader): bool |
|
155 | - { |
|
156 | - $date = HTTP\parseDate($dateHeader); |
|
157 | - |
|
158 | - // Unknown format |
|
159 | - if (!$date) { |
|
160 | - $this->errorCode = self::ERR_INVALIDDATEFORMAT; |
|
161 | - |
|
162 | - return false; |
|
163 | - } |
|
164 | - |
|
165 | - $min = new \DateTime('-15 minutes'); |
|
166 | - $max = new \DateTime('+15 minutes'); |
|
167 | - |
|
168 | - // We allow 15 minutes around the current date/time |
|
169 | - if ($date > $max || $date < $min) { |
|
170 | - $this->errorCode = self::ERR_REQUESTTIMESKEWED; |
|
171 | - |
|
172 | - return false; |
|
173 | - } |
|
174 | - |
|
175 | - return true; |
|
176 | - } |
|
177 | - |
|
178 | - /** |
|
179 | - * Returns a list of AMZ headers. |
|
180 | - */ |
|
181 | - protected function getAmzHeaders(): string |
|
182 | - { |
|
183 | - $amzHeaders = []; |
|
184 | - $headers = $this->request->getHeaders(); |
|
185 | - foreach ($headers as $headerName => $headerValue) { |
|
186 | - if (0 === strpos(strtolower($headerName), 'x-amz-')) { |
|
187 | - $amzHeaders[strtolower($headerName)] = str_replace(["\r\n"], [' '], $headerValue[0])."\n"; |
|
188 | - } |
|
189 | - } |
|
190 | - ksort($amzHeaders); |
|
191 | - |
|
192 | - $headerStr = ''; |
|
193 | - foreach ($amzHeaders as $h => $v) { |
|
194 | - $headerStr .= $h.':'.$v; |
|
195 | - } |
|
196 | - |
|
197 | - return $headerStr; |
|
198 | - } |
|
199 | - |
|
200 | - /** |
|
201 | - * Generates an HMAC-SHA1 signature. |
|
202 | - */ |
|
203 | - private function hmacsha1(string $key, string $message): string |
|
204 | - { |
|
205 | - if (function_exists('hash_hmac')) { |
|
206 | - return hash_hmac('sha1', $message, $key, true); |
|
207 | - } |
|
208 | - |
|
209 | - $blocksize = 64; |
|
210 | - if (strlen($key) > $blocksize) { |
|
211 | - $key = pack('H*', sha1($key)); |
|
212 | - } |
|
213 | - $key = str_pad($key, $blocksize, chr(0x00)); |
|
214 | - $ipad = str_repeat(chr(0x36), $blocksize); |
|
215 | - $opad = str_repeat(chr(0x5c), $blocksize); |
|
216 | - $hmac = pack('H*', sha1(($key ^ $opad).pack('H*', sha1(($key ^ $ipad).$message)))); |
|
217 | - |
|
218 | - return $hmac; |
|
219 | - } |
|
20 | + /** |
|
21 | + * The signature supplied by the HTTP client. |
|
22 | + * |
|
23 | + * @var string |
|
24 | + */ |
|
25 | + private $signature = null; |
|
26 | + |
|
27 | + /** |
|
28 | + * The accesskey supplied by the HTTP client. |
|
29 | + * |
|
30 | + * @var string |
|
31 | + */ |
|
32 | + private $accessKey = null; |
|
33 | + |
|
34 | + /** |
|
35 | + * An error code, if any. |
|
36 | + * |
|
37 | + * This value will be filled with one of the ERR_* constants |
|
38 | + * |
|
39 | + * @var int |
|
40 | + */ |
|
41 | + public $errorCode = 0; |
|
42 | + |
|
43 | + const ERR_NOAWSHEADER = 1; |
|
44 | + const ERR_MD5CHECKSUMWRONG = 2; |
|
45 | + const ERR_INVALIDDATEFORMAT = 3; |
|
46 | + const ERR_REQUESTTIMESKEWED = 4; |
|
47 | + const ERR_INVALIDSIGNATURE = 5; |
|
48 | + |
|
49 | + /** |
|
50 | + * Gathers all information from the headers. |
|
51 | + * |
|
52 | + * This method needs to be called prior to anything else. |
|
53 | + */ |
|
54 | + public function init(): bool |
|
55 | + { |
|
56 | + $authHeader = $this->request->getHeader('Authorization'); |
|
57 | + |
|
58 | + if (null === $authHeader) { |
|
59 | + $this->errorCode = self::ERR_NOAWSHEADER; |
|
60 | + |
|
61 | + return false; |
|
62 | + } |
|
63 | + $authHeader = explode(' ', $authHeader); |
|
64 | + |
|
65 | + if ('AWS' !== $authHeader[0] || !isset($authHeader[1])) { |
|
66 | + $this->errorCode = self::ERR_NOAWSHEADER; |
|
67 | + |
|
68 | + return false; |
|
69 | + } |
|
70 | + |
|
71 | + list($this->accessKey, $this->signature) = explode(':', $authHeader[1]); |
|
72 | + |
|
73 | + return true; |
|
74 | + } |
|
75 | + |
|
76 | + /** |
|
77 | + * Returns the username for the request. |
|
78 | + */ |
|
79 | + public function getAccessKey(): string |
|
80 | + { |
|
81 | + return $this->accessKey; |
|
82 | + } |
|
83 | + |
|
84 | + /** |
|
85 | + * Validates the signature based on the secretKey. |
|
86 | + */ |
|
87 | + public function validate(string $secretKey): bool |
|
88 | + { |
|
89 | + $contentMD5 = $this->request->getHeader('Content-MD5'); |
|
90 | + |
|
91 | + if ($contentMD5) { |
|
92 | + // We need to validate the integrity of the request |
|
93 | + $body = $this->request->getBody(); |
|
94 | + $this->request->setBody($body); |
|
95 | + |
|
96 | + if ($contentMD5 !== base64_encode(md5((string) $body, true))) { |
|
97 | + // content-md5 header did not match md5 signature of body |
|
98 | + $this->errorCode = self::ERR_MD5CHECKSUMWRONG; |
|
99 | + |
|
100 | + return false; |
|
101 | + } |
|
102 | + } |
|
103 | + |
|
104 | + if (!$requestDate = $this->request->getHeader('x-amz-date')) { |
|
105 | + $requestDate = $this->request->getHeader('Date'); |
|
106 | + } |
|
107 | + |
|
108 | + if (!$this->validateRFC2616Date((string) $requestDate)) { |
|
109 | + return false; |
|
110 | + } |
|
111 | + |
|
112 | + $amzHeaders = $this->getAmzHeaders(); |
|
113 | + |
|
114 | + $signature = base64_encode( |
|
115 | + $this->hmacsha1($secretKey, |
|
116 | + $this->request->getMethod()."\n". |
|
117 | + $contentMD5."\n". |
|
118 | + $this->request->getHeader('Content-type')."\n". |
|
119 | + $requestDate."\n". |
|
120 | + $amzHeaders. |
|
121 | + $this->request->getUrl() |
|
122 | + ) |
|
123 | + ); |
|
124 | + |
|
125 | + if ($this->signature !== $signature) { |
|
126 | + $this->errorCode = self::ERR_INVALIDSIGNATURE; |
|
127 | + |
|
128 | + return false; |
|
129 | + } |
|
130 | + |
|
131 | + return true; |
|
132 | + } |
|
133 | + |
|
134 | + /** |
|
135 | + * Returns an HTTP 401 header, forcing login. |
|
136 | + * |
|
137 | + * This should be called when username and password are incorrect, or not supplied at all |
|
138 | + */ |
|
139 | + public function requireLogin() |
|
140 | + { |
|
141 | + $this->response->addHeader('WWW-Authenticate', 'AWS'); |
|
142 | + $this->response->setStatus(401); |
|
143 | + } |
|
144 | + |
|
145 | + /** |
|
146 | + * Makes sure the supplied value is a valid RFC2616 date. |
|
147 | + * |
|
148 | + * If we would just use strtotime to get a valid timestamp, we have no way of checking if a |
|
149 | + * user just supplied the word 'now' for the date header. |
|
150 | + * |
|
151 | + * This function also makes sure the Date header is within 15 minutes of the operating |
|
152 | + * system date, to prevent replay attacks. |
|
153 | + */ |
|
154 | + protected function validateRFC2616Date(string $dateHeader): bool |
|
155 | + { |
|
156 | + $date = HTTP\parseDate($dateHeader); |
|
157 | + |
|
158 | + // Unknown format |
|
159 | + if (!$date) { |
|
160 | + $this->errorCode = self::ERR_INVALIDDATEFORMAT; |
|
161 | + |
|
162 | + return false; |
|
163 | + } |
|
164 | + |
|
165 | + $min = new \DateTime('-15 minutes'); |
|
166 | + $max = new \DateTime('+15 minutes'); |
|
167 | + |
|
168 | + // We allow 15 minutes around the current date/time |
|
169 | + if ($date > $max || $date < $min) { |
|
170 | + $this->errorCode = self::ERR_REQUESTTIMESKEWED; |
|
171 | + |
|
172 | + return false; |
|
173 | + } |
|
174 | + |
|
175 | + return true; |
|
176 | + } |
|
177 | + |
|
178 | + /** |
|
179 | + * Returns a list of AMZ headers. |
|
180 | + */ |
|
181 | + protected function getAmzHeaders(): string |
|
182 | + { |
|
183 | + $amzHeaders = []; |
|
184 | + $headers = $this->request->getHeaders(); |
|
185 | + foreach ($headers as $headerName => $headerValue) { |
|
186 | + if (0 === strpos(strtolower($headerName), 'x-amz-')) { |
|
187 | + $amzHeaders[strtolower($headerName)] = str_replace(["\r\n"], [' '], $headerValue[0])."\n"; |
|
188 | + } |
|
189 | + } |
|
190 | + ksort($amzHeaders); |
|
191 | + |
|
192 | + $headerStr = ''; |
|
193 | + foreach ($amzHeaders as $h => $v) { |
|
194 | + $headerStr .= $h.':'.$v; |
|
195 | + } |
|
196 | + |
|
197 | + return $headerStr; |
|
198 | + } |
|
199 | + |
|
200 | + /** |
|
201 | + * Generates an HMAC-SHA1 signature. |
|
202 | + */ |
|
203 | + private function hmacsha1(string $key, string $message): string |
|
204 | + { |
|
205 | + if (function_exists('hash_hmac')) { |
|
206 | + return hash_hmac('sha1', $message, $key, true); |
|
207 | + } |
|
208 | + |
|
209 | + $blocksize = 64; |
|
210 | + if (strlen($key) > $blocksize) { |
|
211 | + $key = pack('H*', sha1($key)); |
|
212 | + } |
|
213 | + $key = str_pad($key, $blocksize, chr(0x00)); |
|
214 | + $ipad = str_repeat(chr(0x36), $blocksize); |
|
215 | + $opad = str_repeat(chr(0x5c), $blocksize); |
|
216 | + $hmac = pack('H*', sha1(($key ^ $opad).pack('H*', sha1(($key ^ $ipad).$message)))); |
|
217 | + |
|
218 | + return $hmac; |
|
219 | + } |
|
220 | 220 | } |
@@ -19,13 +19,13 @@ |
||
19 | 19 | */ |
20 | 20 | interface HttpException |
21 | 21 | { |
22 | - /** |
|
23 | - * The http status code for the error. |
|
24 | - * |
|
25 | - * This may either be just the number, or a number and a human-readable |
|
26 | - * message, separated by a space. |
|
27 | - * |
|
28 | - * @return string|null |
|
29 | - */ |
|
30 | - public function getHttpStatus(); |
|
22 | + /** |
|
23 | + * The http status code for the error. |
|
24 | + * |
|
25 | + * This may either be just the number, or a number and a human-readable |
|
26 | + * message, separated by a space. |
|
27 | + * |
|
28 | + * @return string|null |
|
29 | + */ |
|
30 | + public function getHttpStatus(); |
|
31 | 31 | } |
@@ -40,9 +40,9 @@ discard block |
||
40 | 40 | */ |
41 | 41 | function enum(Writer $writer, array $values) |
42 | 42 | { |
43 | - foreach ($values as $value) { |
|
44 | - $writer->writeElement($value); |
|
45 | - } |
|
43 | + foreach ($values as $value) { |
|
44 | + $writer->writeElement($value); |
|
45 | + } |
|
46 | 46 | } |
47 | 47 | |
48 | 48 | /** |
@@ -58,17 +58,17 @@ discard block |
||
58 | 58 | */ |
59 | 59 | function valueObject(Writer $writer, $valueObject, string $namespace) |
60 | 60 | { |
61 | - foreach (get_object_vars($valueObject) as $key => $val) { |
|
62 | - if (is_array($val)) { |
|
63 | - // If $val is an array, it has a special meaning. We need to |
|
64 | - // generate one child element for each item in $val |
|
65 | - foreach ($val as $child) { |
|
66 | - $writer->writeElement('{'.$namespace.'}'.$key, $child); |
|
67 | - } |
|
68 | - } elseif (null !== $val) { |
|
69 | - $writer->writeElement('{'.$namespace.'}'.$key, $val); |
|
70 | - } |
|
71 | - } |
|
61 | + foreach (get_object_vars($valueObject) as $key => $val) { |
|
62 | + if (is_array($val)) { |
|
63 | + // If $val is an array, it has a special meaning. We need to |
|
64 | + // generate one child element for each item in $val |
|
65 | + foreach ($val as $child) { |
|
66 | + $writer->writeElement('{'.$namespace.'}'.$key, $child); |
|
67 | + } |
|
68 | + } elseif (null !== $val) { |
|
69 | + $writer->writeElement('{'.$namespace.'}'.$key, $val); |
|
70 | + } |
|
71 | + } |
|
72 | 72 | } |
73 | 73 | |
74 | 74 | /** |
@@ -88,9 +88,9 @@ discard block |
||
88 | 88 | */ |
89 | 89 | function repeatingElements(Writer $writer, array $items, string $childElementName) |
90 | 90 | { |
91 | - foreach ($items as $item) { |
|
92 | - $writer->writeElement($childElementName, $item); |
|
93 | - } |
|
91 | + foreach ($items as $item) { |
|
92 | + $writer->writeElement($childElementName, $item); |
|
93 | + } |
|
94 | 94 | } |
95 | 95 | |
96 | 96 | /** |
@@ -152,57 +152,57 @@ discard block |
||
152 | 152 | */ |
153 | 153 | function standardSerializer(Writer $writer, $value) |
154 | 154 | { |
155 | - if (is_scalar($value)) { |
|
156 | - // String, integer, float, boolean |
|
157 | - $writer->text((string) $value); |
|
158 | - } elseif ($value instanceof XmlSerializable) { |
|
159 | - // XmlSerializable classes or Element classes. |
|
160 | - $value->xmlSerialize($writer); |
|
161 | - } elseif (is_object($value) && isset($writer->classMap[get_class($value)])) { |
|
162 | - // It's an object which class appears in the classmap. |
|
163 | - $writer->classMap[get_class($value)]($writer, $value); |
|
164 | - } elseif (is_callable($value)) { |
|
165 | - // A callback |
|
166 | - $value($writer); |
|
167 | - } elseif (is_array($value) && array_key_exists('name', $value)) { |
|
168 | - // if the array had a 'name' element, we assume that this array |
|
169 | - // describes a 'name' and optionally 'attributes' and 'value'. |
|
155 | + if (is_scalar($value)) { |
|
156 | + // String, integer, float, boolean |
|
157 | + $writer->text((string) $value); |
|
158 | + } elseif ($value instanceof XmlSerializable) { |
|
159 | + // XmlSerializable classes or Element classes. |
|
160 | + $value->xmlSerialize($writer); |
|
161 | + } elseif (is_object($value) && isset($writer->classMap[get_class($value)])) { |
|
162 | + // It's an object which class appears in the classmap. |
|
163 | + $writer->classMap[get_class($value)]($writer, $value); |
|
164 | + } elseif (is_callable($value)) { |
|
165 | + // A callback |
|
166 | + $value($writer); |
|
167 | + } elseif (is_array($value) && array_key_exists('name', $value)) { |
|
168 | + // if the array had a 'name' element, we assume that this array |
|
169 | + // describes a 'name' and optionally 'attributes' and 'value'. |
|
170 | 170 | |
171 | - $name = $value['name']; |
|
172 | - $attributes = isset($value['attributes']) ? $value['attributes'] : []; |
|
173 | - $value = isset($value['value']) ? $value['value'] : null; |
|
171 | + $name = $value['name']; |
|
172 | + $attributes = isset($value['attributes']) ? $value['attributes'] : []; |
|
173 | + $value = isset($value['value']) ? $value['value'] : null; |
|
174 | 174 | |
175 | - $writer->startElement($name); |
|
176 | - $writer->writeAttributes($attributes); |
|
177 | - $writer->write($value); |
|
178 | - $writer->endElement(); |
|
179 | - } elseif (is_array($value)) { |
|
180 | - foreach ($value as $name => $item) { |
|
181 | - if (is_int($name)) { |
|
182 | - // This item has a numeric index. We just loop through the |
|
183 | - // array and throw it back in the writer. |
|
184 | - standardSerializer($writer, $item); |
|
185 | - } elseif (is_string($name) && is_array($item) && isset($item['attributes'])) { |
|
186 | - // The key is used for a name, but $item has 'attributes' and |
|
187 | - // possibly 'value' |
|
188 | - $writer->startElement($name); |
|
189 | - $writer->writeAttributes($item['attributes']); |
|
190 | - if (isset($item['value'])) { |
|
191 | - $writer->write($item['value']); |
|
192 | - } |
|
193 | - $writer->endElement(); |
|
194 | - } elseif (is_string($name)) { |
|
195 | - // This was a plain key-value array. |
|
196 | - $writer->startElement($name); |
|
197 | - $writer->write($item); |
|
198 | - $writer->endElement(); |
|
199 | - } else { |
|
200 | - throw new InvalidArgumentException('The writer does not know how to serialize arrays with keys of type: '.gettype($name)); |
|
201 | - } |
|
202 | - } |
|
203 | - } elseif (is_object($value)) { |
|
204 | - throw new InvalidArgumentException('The writer cannot serialize objects of class: '.get_class($value)); |
|
205 | - } elseif (!is_null($value)) { |
|
206 | - throw new InvalidArgumentException('The writer cannot serialize values of type: '.gettype($value)); |
|
207 | - } |
|
175 | + $writer->startElement($name); |
|
176 | + $writer->writeAttributes($attributes); |
|
177 | + $writer->write($value); |
|
178 | + $writer->endElement(); |
|
179 | + } elseif (is_array($value)) { |
|
180 | + foreach ($value as $name => $item) { |
|
181 | + if (is_int($name)) { |
|
182 | + // This item has a numeric index. We just loop through the |
|
183 | + // array and throw it back in the writer. |
|
184 | + standardSerializer($writer, $item); |
|
185 | + } elseif (is_string($name) && is_array($item) && isset($item['attributes'])) { |
|
186 | + // The key is used for a name, but $item has 'attributes' and |
|
187 | + // possibly 'value' |
|
188 | + $writer->startElement($name); |
|
189 | + $writer->writeAttributes($item['attributes']); |
|
190 | + if (isset($item['value'])) { |
|
191 | + $writer->write($item['value']); |
|
192 | + } |
|
193 | + $writer->endElement(); |
|
194 | + } elseif (is_string($name)) { |
|
195 | + // This was a plain key-value array. |
|
196 | + $writer->startElement($name); |
|
197 | + $writer->write($item); |
|
198 | + $writer->endElement(); |
|
199 | + } else { |
|
200 | + throw new InvalidArgumentException('The writer does not know how to serialize arrays with keys of type: '.gettype($name)); |
|
201 | + } |
|
202 | + } |
|
203 | + } elseif (is_object($value)) { |
|
204 | + throw new InvalidArgumentException('The writer cannot serialize objects of class: '.get_class($value)); |
|
205 | + } elseif (!is_null($value)) { |
|
206 | + throw new InvalidArgumentException('The writer cannot serialize values of type: '.gettype($value)); |
|
207 | + } |
|
208 | 208 | } |
@@ -14,25 +14,25 @@ |
||
14 | 14 | */ |
15 | 15 | interface XmlDeserializable |
16 | 16 | { |
17 | - /** |
|
18 | - * The deserialize method is called during xml parsing. |
|
19 | - * |
|
20 | - * This method is called statically, this is because in theory this method |
|
21 | - * may be used as a type of constructor, or factory method. |
|
22 | - * |
|
23 | - * Often you want to return an instance of the current class, but you are |
|
24 | - * free to return other data as well. |
|
25 | - * |
|
26 | - * You are responsible for advancing the reader to the next element. Not |
|
27 | - * doing anything will result in a never-ending loop. |
|
28 | - * |
|
29 | - * If you just want to skip parsing for this element altogether, you can |
|
30 | - * just call $reader->next(); |
|
31 | - * |
|
32 | - * $reader->parseInnerTree() will parse the entire sub-tree, and advance to |
|
33 | - * the next element. |
|
34 | - * |
|
35 | - * @return mixed |
|
36 | - */ |
|
37 | - public static function xmlDeserialize(Reader $reader); |
|
17 | + /** |
|
18 | + * The deserialize method is called during xml parsing. |
|
19 | + * |
|
20 | + * This method is called statically, this is because in theory this method |
|
21 | + * may be used as a type of constructor, or factory method. |
|
22 | + * |
|
23 | + * Often you want to return an instance of the current class, but you are |
|
24 | + * free to return other data as well. |
|
25 | + * |
|
26 | + * You are responsible for advancing the reader to the next element. Not |
|
27 | + * doing anything will result in a never-ending loop. |
|
28 | + * |
|
29 | + * If you just want to skip parsing for this element altogether, you can |
|
30 | + * just call $reader->next(); |
|
31 | + * |
|
32 | + * $reader->parseInnerTree() will parse the entire sub-tree, and advance to |
|
33 | + * the next element. |
|
34 | + * |
|
35 | + * @return mixed |
|
36 | + */ |
|
37 | + public static function xmlDeserialize(Reader $reader); |
|
38 | 38 | } |
@@ -17,296 +17,296 @@ |
||
17 | 17 | */ |
18 | 18 | class Service |
19 | 19 | { |
20 | - /** |
|
21 | - * This is the element map. It contains a list of XML elements (in clark |
|
22 | - * notation) as keys and PHP class names as values. |
|
23 | - * |
|
24 | - * The PHP class names must implement Sabre\Xml\Element. |
|
25 | - * |
|
26 | - * Values may also be a callable. In that case the function will be called |
|
27 | - * directly. |
|
28 | - * |
|
29 | - * @var array |
|
30 | - */ |
|
31 | - public $elementMap = []; |
|
32 | - |
|
33 | - /** |
|
34 | - * This is a list of namespaces that you want to give default prefixes. |
|
35 | - * |
|
36 | - * You must make sure you create this entire list before starting to write. |
|
37 | - * They should be registered on the root element. |
|
38 | - * |
|
39 | - * @var array |
|
40 | - */ |
|
41 | - public $namespaceMap = []; |
|
42 | - |
|
43 | - /** |
|
44 | - * This is a list of custom serializers for specific classes. |
|
45 | - * |
|
46 | - * The writer may use this if you attempt to serialize an object with a |
|
47 | - * class that does not implement XmlSerializable. |
|
48 | - * |
|
49 | - * Instead it will look at this classmap to see if there is a custom |
|
50 | - * serializer here. This is useful if you don't want your value objects |
|
51 | - * to be responsible for serializing themselves. |
|
52 | - * |
|
53 | - * The keys in this classmap need to be fully qualified PHP class names, |
|
54 | - * the values must be callbacks. The callbacks take two arguments. The |
|
55 | - * writer class, and the value that must be written. |
|
56 | - * |
|
57 | - * function (Writer $writer, object $value) |
|
58 | - * |
|
59 | - * @var array |
|
60 | - */ |
|
61 | - public $classMap = []; |
|
62 | - |
|
63 | - /** |
|
64 | - * A bitmask of the LIBXML_* constants. |
|
65 | - * |
|
66 | - * @var int |
|
67 | - */ |
|
68 | - public $options = 0; |
|
69 | - |
|
70 | - /** |
|
71 | - * Returns a fresh XML Reader. |
|
72 | - */ |
|
73 | - public function getReader(): Reader |
|
74 | - { |
|
75 | - $r = new Reader(); |
|
76 | - $r->elementMap = $this->elementMap; |
|
77 | - |
|
78 | - return $r; |
|
79 | - } |
|
80 | - |
|
81 | - /** |
|
82 | - * Returns a fresh xml writer. |
|
83 | - */ |
|
84 | - public function getWriter(): Writer |
|
85 | - { |
|
86 | - $w = new Writer(); |
|
87 | - $w->namespaceMap = $this->namespaceMap; |
|
88 | - $w->classMap = $this->classMap; |
|
89 | - |
|
90 | - return $w; |
|
91 | - } |
|
92 | - |
|
93 | - /** |
|
94 | - * Parses a document in full. |
|
95 | - * |
|
96 | - * Input may be specified as a string or readable stream resource. |
|
97 | - * The returned value is the value of the root document. |
|
98 | - * |
|
99 | - * Specifying the $contextUri allows the parser to figure out what the URI |
|
100 | - * of the document was. This allows relative URIs within the document to be |
|
101 | - * expanded easily. |
|
102 | - * |
|
103 | - * The $rootElementName is specified by reference and will be populated |
|
104 | - * with the root element name of the document. |
|
105 | - * |
|
106 | - * @param string|resource $input |
|
107 | - * |
|
108 | - * @throws ParseException |
|
109 | - * |
|
110 | - * @return array|object|string |
|
111 | - */ |
|
112 | - public function parse($input, string $contextUri = null, string &$rootElementName = null) |
|
113 | - { |
|
114 | - if (is_resource($input)) { |
|
115 | - // Unfortunately the XMLReader doesn't support streams. When it |
|
116 | - // does, we can optimize this. |
|
117 | - $input = (string) stream_get_contents($input); |
|
118 | - } |
|
119 | - |
|
120 | - // If input is empty, then it's safe to throw an exception |
|
121 | - if (empty($input)) { |
|
122 | - throw new ParseException('The input element to parse is empty. Do not attempt to parse'); |
|
123 | - } |
|
124 | - |
|
125 | - $r = $this->getReader(); |
|
126 | - $r->contextUri = $contextUri; |
|
127 | - $r->XML($input, null, $this->options); |
|
128 | - |
|
129 | - $result = $r->parse(); |
|
130 | - $rootElementName = $result['name']; |
|
131 | - |
|
132 | - return $result['value']; |
|
133 | - } |
|
134 | - |
|
135 | - /** |
|
136 | - * Parses a document in full, and specify what the expected root element |
|
137 | - * name is. |
|
138 | - * |
|
139 | - * This function works similar to parse, but the difference is that the |
|
140 | - * user can specify what the expected name of the root element should be, |
|
141 | - * in clark notation. |
|
142 | - * |
|
143 | - * This is useful in cases where you expected a specific document to be |
|
144 | - * passed, and reduces the amount of if statements. |
|
145 | - * |
|
146 | - * It's also possible to pass an array of expected rootElements if your |
|
147 | - * code may expect more than one document type. |
|
148 | - * |
|
149 | - * @param string|string[] $rootElementName |
|
150 | - * @param string|resource $input |
|
151 | - * |
|
152 | - * @throws ParseException |
|
153 | - * |
|
154 | - * @return array|object|string |
|
155 | - */ |
|
156 | - public function expect($rootElementName, $input, string $contextUri = null) |
|
157 | - { |
|
158 | - if (is_resource($input)) { |
|
159 | - // Unfortunately the XMLReader doesn't support streams. When it |
|
160 | - // does, we can optimize this. |
|
161 | - $input = (string) stream_get_contents($input); |
|
162 | - } |
|
163 | - |
|
164 | - // If input is empty, then it's safe to throw an exception |
|
165 | - if (empty($input)) { |
|
166 | - throw new ParseException('The input element to parse is empty. Do not attempt to parse'); |
|
167 | - } |
|
168 | - |
|
169 | - $r = $this->getReader(); |
|
170 | - $r->contextUri = $contextUri; |
|
171 | - $r->XML($input, null, $this->options); |
|
172 | - |
|
173 | - $rootElementName = (array) $rootElementName; |
|
174 | - |
|
175 | - foreach ($rootElementName as &$rEl) { |
|
176 | - if ('{' !== $rEl[0]) { |
|
177 | - $rEl = '{}'.$rEl; |
|
178 | - } |
|
179 | - } |
|
180 | - |
|
181 | - $result = $r->parse(); |
|
182 | - if (!in_array($result['name'], $rootElementName, true)) { |
|
183 | - throw new ParseException('Expected '.implode(' or ', $rootElementName).' but received '.$result['name'].' as the root element'); |
|
184 | - } |
|
185 | - |
|
186 | - return $result['value']; |
|
187 | - } |
|
188 | - |
|
189 | - /** |
|
190 | - * Generates an XML document in one go. |
|
191 | - * |
|
192 | - * The $rootElement must be specified in clark notation. |
|
193 | - * The value must be a string, an array or an object implementing |
|
194 | - * XmlSerializable. Basically, anything that's supported by the Writer |
|
195 | - * object. |
|
196 | - * |
|
197 | - * $contextUri can be used to specify a sort of 'root' of the PHP application, |
|
198 | - * in case the xml document is used as a http response. |
|
199 | - * |
|
200 | - * This allows an implementor to easily create URI's relative to the root |
|
201 | - * of the domain. |
|
202 | - * |
|
203 | - * @param string|array|object|XmlSerializable $value |
|
204 | - * |
|
205 | - * @return string |
|
206 | - */ |
|
207 | - public function write(string $rootElementName, $value, string $contextUri = null) |
|
208 | - { |
|
209 | - $w = $this->getWriter(); |
|
210 | - $w->openMemory(); |
|
211 | - $w->contextUri = $contextUri; |
|
212 | - $w->setIndent(true); |
|
213 | - $w->startDocument(); |
|
214 | - $w->writeElement($rootElementName, $value); |
|
215 | - |
|
216 | - return $w->outputMemory(); |
|
217 | - } |
|
218 | - |
|
219 | - /** |
|
220 | - * Map an XML element to a PHP class. |
|
221 | - * |
|
222 | - * Calling this function will automatically set up the Reader and Writer |
|
223 | - * classes to turn a specific XML element to a PHP class. |
|
224 | - * |
|
225 | - * For example, given a class such as : |
|
226 | - * |
|
227 | - * class Author { |
|
228 | - * public $firstName; |
|
229 | - * public $lastName; |
|
230 | - * } |
|
231 | - * |
|
232 | - * and an XML element such as: |
|
233 | - * |
|
234 | - * <author xmlns="http://example.org/ns"> |
|
235 | - * <firstName>...</firstName> |
|
236 | - * <lastName>...</lastName> |
|
237 | - * </author> |
|
238 | - * |
|
239 | - * These can easily be mapped by calling: |
|
240 | - * |
|
241 | - * $service->mapValueObject('{http://example.org}author', 'Author'); |
|
242 | - */ |
|
243 | - public function mapValueObject(string $elementName, string $className) |
|
244 | - { |
|
245 | - list($namespace) = self::parseClarkNotation($elementName); |
|
246 | - |
|
247 | - $this->elementMap[$elementName] = function (Reader $reader) use ($className, $namespace) { |
|
248 | - return \Sabre\Xml\Deserializer\valueObject($reader, $className, $namespace); |
|
249 | - }; |
|
250 | - $this->classMap[$className] = function (Writer $writer, $valueObject) use ($namespace) { |
|
251 | - return \Sabre\Xml\Serializer\valueObject($writer, $valueObject, $namespace); |
|
252 | - }; |
|
253 | - $this->valueObjectMap[$className] = $elementName; |
|
254 | - } |
|
255 | - |
|
256 | - /** |
|
257 | - * Writes a value object. |
|
258 | - * |
|
259 | - * This function largely behaves similar to write(), except that it's |
|
260 | - * intended specifically to serialize a Value Object into an XML document. |
|
261 | - * |
|
262 | - * The ValueObject must have been previously registered using |
|
263 | - * mapValueObject(). |
|
264 | - * |
|
265 | - * @param object $object |
|
266 | - * |
|
267 | - * @throws \InvalidArgumentException |
|
268 | - */ |
|
269 | - public function writeValueObject($object, string $contextUri = null) |
|
270 | - { |
|
271 | - if (!isset($this->valueObjectMap[get_class($object)])) { |
|
272 | - throw new \InvalidArgumentException('"'.get_class($object).'" is not a registered value object class. Register your class with mapValueObject.'); |
|
273 | - } |
|
274 | - |
|
275 | - return $this->write( |
|
276 | - $this->valueObjectMap[get_class($object)], |
|
277 | - $object, |
|
278 | - $contextUri |
|
279 | - ); |
|
280 | - } |
|
281 | - |
|
282 | - /** |
|
283 | - * Parses a clark-notation string, and returns the namespace and element |
|
284 | - * name components. |
|
285 | - * |
|
286 | - * If the string was invalid, it will throw an InvalidArgumentException. |
|
287 | - * |
|
288 | - * @throws \InvalidArgumentException |
|
289 | - */ |
|
290 | - public static function parseClarkNotation(string $str): array |
|
291 | - { |
|
292 | - static $cache = []; |
|
293 | - |
|
294 | - if (!isset($cache[$str])) { |
|
295 | - if (!preg_match('/^{([^}]*)}(.*)$/', $str, $matches)) { |
|
296 | - throw new \InvalidArgumentException('\''.$str.'\' is not a valid clark-notation formatted string'); |
|
297 | - } |
|
298 | - |
|
299 | - $cache[$str] = [ |
|
300 | - $matches[1], |
|
301 | - $matches[2], |
|
302 | - ]; |
|
303 | - } |
|
304 | - |
|
305 | - return $cache[$str]; |
|
306 | - } |
|
307 | - |
|
308 | - /** |
|
309 | - * A list of classes and which XML elements they map to. |
|
310 | - */ |
|
311 | - protected $valueObjectMap = []; |
|
20 | + /** |
|
21 | + * This is the element map. It contains a list of XML elements (in clark |
|
22 | + * notation) as keys and PHP class names as values. |
|
23 | + * |
|
24 | + * The PHP class names must implement Sabre\Xml\Element. |
|
25 | + * |
|
26 | + * Values may also be a callable. In that case the function will be called |
|
27 | + * directly. |
|
28 | + * |
|
29 | + * @var array |
|
30 | + */ |
|
31 | + public $elementMap = []; |
|
32 | + |
|
33 | + /** |
|
34 | + * This is a list of namespaces that you want to give default prefixes. |
|
35 | + * |
|
36 | + * You must make sure you create this entire list before starting to write. |
|
37 | + * They should be registered on the root element. |
|
38 | + * |
|
39 | + * @var array |
|
40 | + */ |
|
41 | + public $namespaceMap = []; |
|
42 | + |
|
43 | + /** |
|
44 | + * This is a list of custom serializers for specific classes. |
|
45 | + * |
|
46 | + * The writer may use this if you attempt to serialize an object with a |
|
47 | + * class that does not implement XmlSerializable. |
|
48 | + * |
|
49 | + * Instead it will look at this classmap to see if there is a custom |
|
50 | + * serializer here. This is useful if you don't want your value objects |
|
51 | + * to be responsible for serializing themselves. |
|
52 | + * |
|
53 | + * The keys in this classmap need to be fully qualified PHP class names, |
|
54 | + * the values must be callbacks. The callbacks take two arguments. The |
|
55 | + * writer class, and the value that must be written. |
|
56 | + * |
|
57 | + * function (Writer $writer, object $value) |
|
58 | + * |
|
59 | + * @var array |
|
60 | + */ |
|
61 | + public $classMap = []; |
|
62 | + |
|
63 | + /** |
|
64 | + * A bitmask of the LIBXML_* constants. |
|
65 | + * |
|
66 | + * @var int |
|
67 | + */ |
|
68 | + public $options = 0; |
|
69 | + |
|
70 | + /** |
|
71 | + * Returns a fresh XML Reader. |
|
72 | + */ |
|
73 | + public function getReader(): Reader |
|
74 | + { |
|
75 | + $r = new Reader(); |
|
76 | + $r->elementMap = $this->elementMap; |
|
77 | + |
|
78 | + return $r; |
|
79 | + } |
|
80 | + |
|
81 | + /** |
|
82 | + * Returns a fresh xml writer. |
|
83 | + */ |
|
84 | + public function getWriter(): Writer |
|
85 | + { |
|
86 | + $w = new Writer(); |
|
87 | + $w->namespaceMap = $this->namespaceMap; |
|
88 | + $w->classMap = $this->classMap; |
|
89 | + |
|
90 | + return $w; |
|
91 | + } |
|
92 | + |
|
93 | + /** |
|
94 | + * Parses a document in full. |
|
95 | + * |
|
96 | + * Input may be specified as a string or readable stream resource. |
|
97 | + * The returned value is the value of the root document. |
|
98 | + * |
|
99 | + * Specifying the $contextUri allows the parser to figure out what the URI |
|
100 | + * of the document was. This allows relative URIs within the document to be |
|
101 | + * expanded easily. |
|
102 | + * |
|
103 | + * The $rootElementName is specified by reference and will be populated |
|
104 | + * with the root element name of the document. |
|
105 | + * |
|
106 | + * @param string|resource $input |
|
107 | + * |
|
108 | + * @throws ParseException |
|
109 | + * |
|
110 | + * @return array|object|string |
|
111 | + */ |
|
112 | + public function parse($input, string $contextUri = null, string &$rootElementName = null) |
|
113 | + { |
|
114 | + if (is_resource($input)) { |
|
115 | + // Unfortunately the XMLReader doesn't support streams. When it |
|
116 | + // does, we can optimize this. |
|
117 | + $input = (string) stream_get_contents($input); |
|
118 | + } |
|
119 | + |
|
120 | + // If input is empty, then it's safe to throw an exception |
|
121 | + if (empty($input)) { |
|
122 | + throw new ParseException('The input element to parse is empty. Do not attempt to parse'); |
|
123 | + } |
|
124 | + |
|
125 | + $r = $this->getReader(); |
|
126 | + $r->contextUri = $contextUri; |
|
127 | + $r->XML($input, null, $this->options); |
|
128 | + |
|
129 | + $result = $r->parse(); |
|
130 | + $rootElementName = $result['name']; |
|
131 | + |
|
132 | + return $result['value']; |
|
133 | + } |
|
134 | + |
|
135 | + /** |
|
136 | + * Parses a document in full, and specify what the expected root element |
|
137 | + * name is. |
|
138 | + * |
|
139 | + * This function works similar to parse, but the difference is that the |
|
140 | + * user can specify what the expected name of the root element should be, |
|
141 | + * in clark notation. |
|
142 | + * |
|
143 | + * This is useful in cases where you expected a specific document to be |
|
144 | + * passed, and reduces the amount of if statements. |
|
145 | + * |
|
146 | + * It's also possible to pass an array of expected rootElements if your |
|
147 | + * code may expect more than one document type. |
|
148 | + * |
|
149 | + * @param string|string[] $rootElementName |
|
150 | + * @param string|resource $input |
|
151 | + * |
|
152 | + * @throws ParseException |
|
153 | + * |
|
154 | + * @return array|object|string |
|
155 | + */ |
|
156 | + public function expect($rootElementName, $input, string $contextUri = null) |
|
157 | + { |
|
158 | + if (is_resource($input)) { |
|
159 | + // Unfortunately the XMLReader doesn't support streams. When it |
|
160 | + // does, we can optimize this. |
|
161 | + $input = (string) stream_get_contents($input); |
|
162 | + } |
|
163 | + |
|
164 | + // If input is empty, then it's safe to throw an exception |
|
165 | + if (empty($input)) { |
|
166 | + throw new ParseException('The input element to parse is empty. Do not attempt to parse'); |
|
167 | + } |
|
168 | + |
|
169 | + $r = $this->getReader(); |
|
170 | + $r->contextUri = $contextUri; |
|
171 | + $r->XML($input, null, $this->options); |
|
172 | + |
|
173 | + $rootElementName = (array) $rootElementName; |
|
174 | + |
|
175 | + foreach ($rootElementName as &$rEl) { |
|
176 | + if ('{' !== $rEl[0]) { |
|
177 | + $rEl = '{}'.$rEl; |
|
178 | + } |
|
179 | + } |
|
180 | + |
|
181 | + $result = $r->parse(); |
|
182 | + if (!in_array($result['name'], $rootElementName, true)) { |
|
183 | + throw new ParseException('Expected '.implode(' or ', $rootElementName).' but received '.$result['name'].' as the root element'); |
|
184 | + } |
|
185 | + |
|
186 | + return $result['value']; |
|
187 | + } |
|
188 | + |
|
189 | + /** |
|
190 | + * Generates an XML document in one go. |
|
191 | + * |
|
192 | + * The $rootElement must be specified in clark notation. |
|
193 | + * The value must be a string, an array or an object implementing |
|
194 | + * XmlSerializable. Basically, anything that's supported by the Writer |
|
195 | + * object. |
|
196 | + * |
|
197 | + * $contextUri can be used to specify a sort of 'root' of the PHP application, |
|
198 | + * in case the xml document is used as a http response. |
|
199 | + * |
|
200 | + * This allows an implementor to easily create URI's relative to the root |
|
201 | + * of the domain. |
|
202 | + * |
|
203 | + * @param string|array|object|XmlSerializable $value |
|
204 | + * |
|
205 | + * @return string |
|
206 | + */ |
|
207 | + public function write(string $rootElementName, $value, string $contextUri = null) |
|
208 | + { |
|
209 | + $w = $this->getWriter(); |
|
210 | + $w->openMemory(); |
|
211 | + $w->contextUri = $contextUri; |
|
212 | + $w->setIndent(true); |
|
213 | + $w->startDocument(); |
|
214 | + $w->writeElement($rootElementName, $value); |
|
215 | + |
|
216 | + return $w->outputMemory(); |
|
217 | + } |
|
218 | + |
|
219 | + /** |
|
220 | + * Map an XML element to a PHP class. |
|
221 | + * |
|
222 | + * Calling this function will automatically set up the Reader and Writer |
|
223 | + * classes to turn a specific XML element to a PHP class. |
|
224 | + * |
|
225 | + * For example, given a class such as : |
|
226 | + * |
|
227 | + * class Author { |
|
228 | + * public $firstName; |
|
229 | + * public $lastName; |
|
230 | + * } |
|
231 | + * |
|
232 | + * and an XML element such as: |
|
233 | + * |
|
234 | + * <author xmlns="http://example.org/ns"> |
|
235 | + * <firstName>...</firstName> |
|
236 | + * <lastName>...</lastName> |
|
237 | + * </author> |
|
238 | + * |
|
239 | + * These can easily be mapped by calling: |
|
240 | + * |
|
241 | + * $service->mapValueObject('{http://example.org}author', 'Author'); |
|
242 | + */ |
|
243 | + public function mapValueObject(string $elementName, string $className) |
|
244 | + { |
|
245 | + list($namespace) = self::parseClarkNotation($elementName); |
|
246 | + |
|
247 | + $this->elementMap[$elementName] = function (Reader $reader) use ($className, $namespace) { |
|
248 | + return \Sabre\Xml\Deserializer\valueObject($reader, $className, $namespace); |
|
249 | + }; |
|
250 | + $this->classMap[$className] = function (Writer $writer, $valueObject) use ($namespace) { |
|
251 | + return \Sabre\Xml\Serializer\valueObject($writer, $valueObject, $namespace); |
|
252 | + }; |
|
253 | + $this->valueObjectMap[$className] = $elementName; |
|
254 | + } |
|
255 | + |
|
256 | + /** |
|
257 | + * Writes a value object. |
|
258 | + * |
|
259 | + * This function largely behaves similar to write(), except that it's |
|
260 | + * intended specifically to serialize a Value Object into an XML document. |
|
261 | + * |
|
262 | + * The ValueObject must have been previously registered using |
|
263 | + * mapValueObject(). |
|
264 | + * |
|
265 | + * @param object $object |
|
266 | + * |
|
267 | + * @throws \InvalidArgumentException |
|
268 | + */ |
|
269 | + public function writeValueObject($object, string $contextUri = null) |
|
270 | + { |
|
271 | + if (!isset($this->valueObjectMap[get_class($object)])) { |
|
272 | + throw new \InvalidArgumentException('"'.get_class($object).'" is not a registered value object class. Register your class with mapValueObject.'); |
|
273 | + } |
|
274 | + |
|
275 | + return $this->write( |
|
276 | + $this->valueObjectMap[get_class($object)], |
|
277 | + $object, |
|
278 | + $contextUri |
|
279 | + ); |
|
280 | + } |
|
281 | + |
|
282 | + /** |
|
283 | + * Parses a clark-notation string, and returns the namespace and element |
|
284 | + * name components. |
|
285 | + * |
|
286 | + * If the string was invalid, it will throw an InvalidArgumentException. |
|
287 | + * |
|
288 | + * @throws \InvalidArgumentException |
|
289 | + */ |
|
290 | + public static function parseClarkNotation(string $str): array |
|
291 | + { |
|
292 | + static $cache = []; |
|
293 | + |
|
294 | + if (!isset($cache[$str])) { |
|
295 | + if (!preg_match('/^{([^}]*)}(.*)$/', $str, $matches)) { |
|
296 | + throw new \InvalidArgumentException('\''.$str.'\' is not a valid clark-notation formatted string'); |
|
297 | + } |
|
298 | + |
|
299 | + $cache[$str] = [ |
|
300 | + $matches[1], |
|
301 | + $matches[2], |
|
302 | + ]; |
|
303 | + } |
|
304 | + |
|
305 | + return $cache[$str]; |
|
306 | + } |
|
307 | + |
|
308 | + /** |
|
309 | + * A list of classes and which XML elements they map to. |
|
310 | + */ |
|
311 | + protected $valueObjectMap = []; |
|
312 | 312 | } |
@@ -37,64 +37,64 @@ |
||
37 | 37 | */ |
38 | 38 | class Elements implements Xml\Element |
39 | 39 | { |
40 | - /** |
|
41 | - * Value to serialize. |
|
42 | - * |
|
43 | - * @var array |
|
44 | - */ |
|
45 | - protected $value; |
|
40 | + /** |
|
41 | + * Value to serialize. |
|
42 | + * |
|
43 | + * @var array |
|
44 | + */ |
|
45 | + protected $value; |
|
46 | 46 | |
47 | - /** |
|
48 | - * Constructor. |
|
49 | - */ |
|
50 | - public function __construct(array $value = []) |
|
51 | - { |
|
52 | - $this->value = $value; |
|
53 | - } |
|
47 | + /** |
|
48 | + * Constructor. |
|
49 | + */ |
|
50 | + public function __construct(array $value = []) |
|
51 | + { |
|
52 | + $this->value = $value; |
|
53 | + } |
|
54 | 54 | |
55 | - /** |
|
56 | - * The xmlSerialize method is called during xml writing. |
|
57 | - * |
|
58 | - * Use the $writer argument to write its own xml serialization. |
|
59 | - * |
|
60 | - * An important note: do _not_ create a parent element. Any element |
|
61 | - * implementing XmlSerializable should only ever write what's considered |
|
62 | - * its 'inner xml'. |
|
63 | - * |
|
64 | - * The parent of the current element is responsible for writing a |
|
65 | - * containing element. |
|
66 | - * |
|
67 | - * This allows serializers to be re-used for different element names. |
|
68 | - * |
|
69 | - * If you are opening new elements, you must also close them again. |
|
70 | - */ |
|
71 | - public function xmlSerialize(Xml\Writer $writer) |
|
72 | - { |
|
73 | - Serializer\enum($writer, $this->value); |
|
74 | - } |
|
55 | + /** |
|
56 | + * The xmlSerialize method is called during xml writing. |
|
57 | + * |
|
58 | + * Use the $writer argument to write its own xml serialization. |
|
59 | + * |
|
60 | + * An important note: do _not_ create a parent element. Any element |
|
61 | + * implementing XmlSerializable should only ever write what's considered |
|
62 | + * its 'inner xml'. |
|
63 | + * |
|
64 | + * The parent of the current element is responsible for writing a |
|
65 | + * containing element. |
|
66 | + * |
|
67 | + * This allows serializers to be re-used for different element names. |
|
68 | + * |
|
69 | + * If you are opening new elements, you must also close them again. |
|
70 | + */ |
|
71 | + public function xmlSerialize(Xml\Writer $writer) |
|
72 | + { |
|
73 | + Serializer\enum($writer, $this->value); |
|
74 | + } |
|
75 | 75 | |
76 | - /** |
|
77 | - * The deserialize method is called during xml parsing. |
|
78 | - * |
|
79 | - * This method is called statically, this is because in theory this method |
|
80 | - * may be used as a type of constructor, or factory method. |
|
81 | - * |
|
82 | - * Often you want to return an instance of the current class, but you are |
|
83 | - * free to return other data as well. |
|
84 | - * |
|
85 | - * Important note 2: You are responsible for advancing the reader to the |
|
86 | - * next element. Not doing anything will result in a never-ending loop. |
|
87 | - * |
|
88 | - * If you just want to skip parsing for this element altogether, you can |
|
89 | - * just call $reader->next(); |
|
90 | - * |
|
91 | - * $reader->parseSubTree() will parse the entire sub-tree, and advance to |
|
92 | - * the next element. |
|
93 | - * |
|
94 | - * @return mixed |
|
95 | - */ |
|
96 | - public static function xmlDeserialize(Xml\Reader $reader) |
|
97 | - { |
|
98 | - return Deserializer\enum($reader); |
|
99 | - } |
|
76 | + /** |
|
77 | + * The deserialize method is called during xml parsing. |
|
78 | + * |
|
79 | + * This method is called statically, this is because in theory this method |
|
80 | + * may be used as a type of constructor, or factory method. |
|
81 | + * |
|
82 | + * Often you want to return an instance of the current class, but you are |
|
83 | + * free to return other data as well. |
|
84 | + * |
|
85 | + * Important note 2: You are responsible for advancing the reader to the |
|
86 | + * next element. Not doing anything will result in a never-ending loop. |
|
87 | + * |
|
88 | + * If you just want to skip parsing for this element altogether, you can |
|
89 | + * just call $reader->next(); |
|
90 | + * |
|
91 | + * $reader->parseSubTree() will parse the entire sub-tree, and advance to |
|
92 | + * the next element. |
|
93 | + * |
|
94 | + * @return mixed |
|
95 | + */ |
|
96 | + public static function xmlDeserialize(Xml\Reader $reader) |
|
97 | + { |
|
98 | + return Deserializer\enum($reader); |
|
99 | + } |
|
100 | 100 | } |