From 00701cba8d39ca4dfe83ac0420d637d555656449 Mon Sep 17 00:00:00 2001
From: Nicolas Grekas <nicolas.grekas@gmail.com>
Date: Wed, 18 Mar 2015 10:02:18 +0100
Subject: [PATCH] [VarDumper] Add Caster for XML-parser resources

---
 .../VarDumper/Caster/XmlResourceCaster.php    | 61 +++++++++++++++++++
 .../VarDumper/Cloner/AbstractCloner.php       |  1 +
 .../VarDumper/Tests/CliDumperTest.php         | 34 +++++++++++
 3 files changed, 96 insertions(+)
 create mode 100644 src/Symfony/Component/VarDumper/Caster/XmlResourceCaster.php

diff --git a/src/Symfony/Component/VarDumper/Caster/XmlResourceCaster.php b/src/Symfony/Component/VarDumper/Caster/XmlResourceCaster.php
new file mode 100644
index 000000000000..5d0207ee81da
--- /dev/null
+++ b/src/Symfony/Component/VarDumper/Caster/XmlResourceCaster.php
@@ -0,0 +1,61 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\VarDumper\Caster;
+
+use Symfony\Component\VarDumper\Cloner\Stub;
+
+/**
+ * Casts XML resources to array representation.
+ *
+ * @author Nicolas Grekas <p@tchwork.com>
+ */
+class XmlResourceCaster
+{
+    private static $xmlErrors = array(
+        XML_ERROR_NONE => 'XML_ERROR_NONE',
+        XML_ERROR_NO_MEMORY => 'XML_ERROR_NO_MEMORY',
+        XML_ERROR_SYNTAX => 'XML_ERROR_SYNTAX',
+        XML_ERROR_NO_ELEMENTS => 'XML_ERROR_NO_ELEMENTS',
+        XML_ERROR_INVALID_TOKEN => 'XML_ERROR_INVALID_TOKEN',
+        XML_ERROR_UNCLOSED_TOKEN => 'XML_ERROR_UNCLOSED_TOKEN',
+        XML_ERROR_PARTIAL_CHAR => 'XML_ERROR_PARTIAL_CHAR',
+        XML_ERROR_TAG_MISMATCH => 'XML_ERROR_TAG_MISMATCH',
+        XML_ERROR_DUPLICATE_ATTRIBUTE => 'XML_ERROR_DUPLICATE_ATTRIBUTE',
+        XML_ERROR_JUNK_AFTER_DOC_ELEMENT => 'XML_ERROR_JUNK_AFTER_DOC_ELEMENT',
+        XML_ERROR_PARAM_ENTITY_REF => 'XML_ERROR_PARAM_ENTITY_REF',
+        XML_ERROR_UNDEFINED_ENTITY => 'XML_ERROR_UNDEFINED_ENTITY',
+        XML_ERROR_RECURSIVE_ENTITY_REF => 'XML_ERROR_RECURSIVE_ENTITY_REF',
+        XML_ERROR_ASYNC_ENTITY => 'XML_ERROR_ASYNC_ENTITY',
+        XML_ERROR_BAD_CHAR_REF => 'XML_ERROR_BAD_CHAR_REF',
+        XML_ERROR_BINARY_ENTITY_REF => 'XML_ERROR_BINARY_ENTITY_REF',
+        XML_ERROR_ATTRIBUTE_EXTERNAL_ENTITY_REF => 'XML_ERROR_ATTRIBUTE_EXTERNAL_ENTITY_REF',
+        XML_ERROR_MISPLACED_XML_PI => 'XML_ERROR_MISPLACED_XML_PI',
+        XML_ERROR_UNKNOWN_ENCODING => 'XML_ERROR_UNKNOWN_ENCODING',
+        XML_ERROR_INCORRECT_ENCODING => 'XML_ERROR_INCORRECT_ENCODING',
+        XML_ERROR_UNCLOSED_CDATA_SECTION => 'XML_ERROR_UNCLOSED_CDATA_SECTION',
+        XML_ERROR_EXTERNAL_ENTITY_HANDLING => 'XML_ERROR_EXTERNAL_ENTITY_HANDLING',
+    );
+
+    public static function castXml($h, array $a, Stub $stub, $isNested)
+    {
+        $a['current_byte_index'] = xml_get_current_byte_index($h);
+        $a['current_column_number'] = xml_get_current_column_number($h);
+        $a['current_line_number'] = xml_get_current_line_number($h);
+        $a['error_code'] = xml_get_error_code($h);
+
+        if (isset(self::$xmlErrors[$a['error_code']])) {
+            $a['error_code'] = new ConstStub(self::$xmlErrors[$a['error_code']], $a['error_code']);
+        }
+
+        return $a;
+    }
+}
diff --git a/src/Symfony/Component/VarDumper/Cloner/AbstractCloner.php b/src/Symfony/Component/VarDumper/Cloner/AbstractCloner.php
index 63e683cb15b5..1a1e5f0cc300 100644
--- a/src/Symfony/Component/VarDumper/Cloner/AbstractCloner.php
+++ b/src/Symfony/Component/VarDumper/Cloner/AbstractCloner.php
@@ -78,6 +78,7 @@ abstract class AbstractCloner implements ClonerInterface
         ':process' => 'Symfony\Component\VarDumper\Caster\ResourceCaster::castProcess',
         ':stream' => 'Symfony\Component\VarDumper\Caster\ResourceCaster::castStream',
         ':stream-context' => 'Symfony\Component\VarDumper\Caster\ResourceCaster::castStreamContext',
+        ':xml' => 'Symfony\Component\VarDumper\Caster\XmlResourceCaster::castXml',
     );
 
     protected $maxItems = 2500;
diff --git a/src/Symfony/Component/VarDumper/Tests/CliDumperTest.php b/src/Symfony/Component/VarDumper/Tests/CliDumperTest.php
index bba30256b411..046c2c78b705 100644
--- a/src/Symfony/Component/VarDumper/Tests/CliDumperTest.php
+++ b/src/Symfony/Component/VarDumper/Tests/CliDumperTest.php
@@ -102,6 +102,40 @@ public function testGet()
   b"bin-key-é" => ""
 ]
 
+EOTXT
+            ,
+            $out
+        );
+    }
+
+    public function testXmlResource()
+    {
+        if (!extension_loaded('xml')) {
+            $this->markTestSkipped('xml extension is required');
+        }
+
+        $var = xml_parser_create();
+        $ref = (int) $var;
+
+        $dumper = new CliDumper();
+        $dumper->setColors(false);
+        $cloner = new VarCloner();
+
+        $data = $cloner->cloneVar($var);
+        $out = fopen('php://memory', 'r+b');
+        $dumper->dump($data, $out);
+        rewind($out);
+        $out = stream_get_contents($out);
+
+        $this->assertSame(
+            <<<EOTXT
+:xml {@{$ref}
+  current_byte_index: 0
+  current_column_number: 1
+  current_line_number: 1
+  error_code: XML_ERROR_NONE
+}
+
 EOTXT
             ,
             $out