├── CHANGELOG.md
├── LICENSE.md
├── README.md
├── composer.json
└── src
    ├── Exception
        ├── ExceptionInterface.php
        ├── RecursionException.php
        └── RuntimeException.php
    └── Xml2Json.php


/CHANGELOG.md:
--------------------------------------------------------------------------------
  1 | # Changelog
  2 | 
  3 | All notable changes to this project will be documented in this file, in reverse chronological order by release.
  4 | 
  5 | ## 3.1.3 - TBD
  6 | 
  7 | ### Added
  8 | 
  9 | - Nothing.
 10 | 
 11 | ### Changed
 12 | 
 13 | - Nothing.
 14 | 
 15 | ### Deprecated
 16 | 
 17 | - Nothing.
 18 | 
 19 | ### Removed
 20 | 
 21 | - Nothing.
 22 | 
 23 | ### Fixed
 24 | 
 25 | - Nothing.
 26 | 
 27 | ## 3.1.2 - 2019-10-16
 28 | 
 29 | ### Added
 30 | 
 31 | - [#10](https://github.com/zendframework/zend-xml2json/pull/10) adds support for PHP 7.3.
 32 | 
 33 | ### Changed
 34 | 
 35 | - Nothing.
 36 | 
 37 | ### Deprecated
 38 | 
 39 | - Nothing.
 40 | 
 41 | ### Removed
 42 | 
 43 | - Nothing.
 44 | 
 45 | ### Fixed
 46 | 
 47 | - Nothing.
 48 | 
 49 | ## 3.1.1 - 2018-04-30
 50 | 
 51 | ### Added
 52 | 
 53 | - Nothing.
 54 | 
 55 | ### Changed
 56 | 
 57 | - [#8](https://github.com/zendframework/zend-xml2json/pull/8) ensures that tests against PHP 7.2 are not allowed to fail.
 58 | 
 59 | ### Deprecated
 60 | 
 61 | - Nothing.
 62 | 
 63 | ### Removed
 64 | 
 65 | - Nothing.
 66 | 
 67 | ### Fixed
 68 | 
 69 | - Nothing.
 70 | 
 71 | ## 3.1.0 - 2017-10-16
 72 | 
 73 | ### Added
 74 | 
 75 | - [#5](https://github.com/zendframework/zend-xml2json/pull/5) adds support for
 76 |   PHP 7.1 and 7.2.
 77 | 
 78 | ### Changed
 79 | 
 80 | - Nothing.
 81 | 
 82 | ### Deprecated
 83 | 
 84 | - Nothing.
 85 | 
 86 | ### Removed
 87 | 
 88 | - [#1](https://github.com/zendframework/zend-xml2json/pull/1) removes an
 89 |   obsolete `@deprecated` annotation.
 90 | 
 91 | - [#5](https://github.com/zendframework/zend-xml2json/pull/5) removes support
 92 |   for PHP 5.5. The code likely still runs on that version, but we no longer
 93 |   support it.
 94 | 
 95 | - [#5](https://github.com/zendframework/zend-xml2json/pull/5) removes support
 96 |   for HHVM.
 97 | 
 98 | ### Fixed
 99 | 
100 | - Nothing.
101 | 
102 | ## 3.0.0 - 2016-03-31
103 | 
104 | First release as a standalone component. Previous versions were shipped as
105 | `Zend\Json\Json::toXml()` within the [zend-json](https://github.com/zendframework/zend-json)
106 | package.
107 | 
108 | ### Added
109 | 
110 | - Nothing.
111 | 
112 | ### Deprecated
113 | 
114 | - Nothing.
115 | 
116 | ### Removed
117 | 
118 | - Nothing.
119 | 
120 | ### Fixed
121 | 
122 | - Nothing.
123 | 


--------------------------------------------------------------------------------
/LICENSE.md:
--------------------------------------------------------------------------------
 1 | Copyright (c) 2005-2019, Zend Technologies USA, Inc.
 2 | All rights reserved.
 3 | 
 4 | Redistribution and use in source and binary forms, with or without modification,
 5 | are permitted provided that the following conditions are met:
 6 | 
 7 | - Redistributions of source code must retain the above copyright notice, this
 8 |   list of conditions and the following disclaimer.
 9 | 
10 | - Redistributions in binary form must reproduce the above copyright notice, this
11 |   list of conditions and the following disclaimer in the documentation and/or
12 |   other materials provided with the distribution.
13 | 
14 | - Neither the name of Zend Technologies USA, Inc. nor the names of its
15 |   contributors may be used to endorse or promote products derived from this
16 |   software without specific prior written permission.
17 | 
18 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
19 | ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20 | WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21 | DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
22 | ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23 | (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24 | LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
25 | ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 | (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27 | SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # zend-xml2json
 2 | 
 3 | > ## Repository abandoned 2019-12-31
 4 | >
 5 | > This repository has moved to [laminas/laminas-xml2json](https://github.com/laminas/laminas-xml2json).
 6 | 
 7 | [![Build Status](https://secure.travis-ci.org/zendframework/zend-xml2json.svg?branch=master)](https://secure.travis-ci.org/zendframework/zend-xml2json)
 8 | [![Coverage Status](https://coveralls.io/repos/github/zendframework/zend-xml2json/badge.svg?branch=master)](https://coveralls.io/github/zendframework/zend-xml2json?branch=master)
 9 | 
10 | zend-xml2json provides functionality for converting XML structures to JSON.
11 | 
12 | ## Installation
13 | 
14 | Run the following to install this library:
15 | 
16 | ```bash
17 | $ composer require zendframework/zend-xml2json
18 | ```
19 | 
20 | ## Documentation
21 | 
22 | Browse the documentation online at https://docs.zendframework.com/zend-xml2json/
23 | 
24 | ## Support
25 | 
26 | * [Issues](https://github.com/zendframework/zend-xml2json/issues/)
27 | * [Chat](https://zendframework-slack.herokuapp.com/)
28 | * [Forum](https://discourse.zendframework.com/)
29 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "zendframework/zend-xml2json",
 3 |     "description": "Provides functionality for converting XML to JSON, optionally including XML attributes",
 4 |     "license": "BSD-3-Clause",
 5 |     "keywords": [
 6 |         "zf",
 7 |         "zendframework",
 8 |         "json",
 9 |         "xml"
10 |     ],
11 |     "support": {
12 |         "docs": "https://docs.zendframework.com/zend-xml2json/",
13 |         "issues": "https://github.com/zendframework/zend-xml2json/issues",
14 |         "source": "https://github.com/zendframework/zend-xml2json",
15 |         "rss": "https://github.com/zendframework/zend-xml2json/releases.atom",
16 |         "chat": "https://zendframework-slack.herokuapp.com",
17 |         "forum": "https://discourse.zendframework.com/c/questions/components"
18 |     },
19 |     "require": {
20 |         "php": "^5.6 || ^7.0",
21 |         "zendframework/zend-json": "^2.6.1 || ^3.0",
22 |         "zendframework/zendxml": "^1.0.2"
23 |     },
24 |     "require-dev": {
25 |         "phpunit/phpunit": "^5.7.27 || ^6.5.8 || ^7.1.4",
26 |         "zendframework/zend-coding-standard": "~1.0.0"
27 |     },
28 |     "autoload": {
29 |         "psr-4": {
30 |             "Zend\\Xml2Json\\": "src/"
31 |         }
32 |     },
33 |     "autoload-dev": {
34 |         "psr-4": {
35 |             "ZendTest\\Xml2Json\\": "test/"
36 |         }
37 |     },
38 |     "config": {
39 |         "sort-packages": true
40 |     },
41 |     "extra": {
42 |         "branch-alias": {
43 |             "dev-master": "3.1.x-dev",
44 |             "dev-develop": "3.2.x-dev"
45 |         }
46 |     },
47 |     "scripts": {
48 |         "check": [
49 |             "@cs-check",
50 |             "@test"
51 |         ],
52 |         "cs-check": "phpcs",
53 |         "cs-fix": "phpcbf",
54 |         "test": "phpunit --colors=always",
55 |         "test-coverage": "phpunit --colors=always --coverage-clover clover.xml"
56 |     }
57 | }
58 | 


--------------------------------------------------------------------------------
/src/Exception/ExceptionInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * @see       https://github.com/zendframework/zend-xml2json for the canonical source repository
 4 |  * @copyright Copyright (c) 2005-2018 Zend Technologies USA Inc. (https://www.zend.com)
 5 |  * @license   https://github.com/zendframework/zend-xml2json/blob/master/LICENSE.md New BSD License
 6 |  */
 7 | 
 8 | namespace Zend\Xml2Json\Exception;
 9 | 
10 | interface ExceptionInterface
11 | {
12 | }
13 | 


--------------------------------------------------------------------------------
/src/Exception/RecursionException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * @see       https://github.com/zendframework/zend-xml2json for the canonical source repository
 4 |  * @copyright Copyright (c) 2005-2018 Zend Technologies USA Inc. (https://www.zend.com)
 5 |  * @license   https://github.com/zendframework/zend-xml2json/blob/master/LICENSE.md New BSD License
 6 |  */
 7 | 
 8 | namespace Zend\Xml2Json\Exception;
 9 | 
10 | class RecursionException extends RuntimeException
11 | {
12 | }
13 | 


--------------------------------------------------------------------------------
/src/Exception/RuntimeException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * @see       https://github.com/zendframework/zend-xml2json for the canonical source repository
 4 |  * @copyright Copyright (c) 2005-2018 Zend Technologies USA Inc. (https://www.zend.com)
 5 |  * @license   https://github.com/zendframework/zend-xml2json/blob/master/LICENSE.md New BSD License
 6 |  */
 7 | 
 8 | namespace Zend\Xml2Json\Exception;
 9 | 
10 | class RuntimeException extends \RuntimeException implements ExceptionInterface
11 | {
12 | }
13 | 


--------------------------------------------------------------------------------
/src/Xml2Json.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * @see       https://github.com/zendframework/zend-xml2json for the canonical source repository
  4 |  * @copyright Copyright (c) 2005-2018 Zend Technologies USA Inc. (https://www.zend.com)
  5 |  * @license   https://github.com/zendframework/zend-xml2json/blob/master/LICENSE.md New BSD License
  6 |  */
  7 | 
  8 | namespace Zend\Xml2Json;
  9 | 
 10 | use SimpleXMLElement;
 11 | use Zend\Json\Json;
 12 | use ZendXml\Security as XmlSecurity;
 13 | 
 14 | /**
 15 |  * Class for translating XML to JSON.
 16 |  */
 17 | class Xml2Json
 18 | {
 19 |      /**
 20 |       * Maximum allowed nesting depth when performing xml2json conversion.
 21 |       *
 22 |       * @var int
 23 |       */
 24 |     public static $maxRecursionDepthAllowed = 25;
 25 | 
 26 |     /**
 27 |      * Converts XML to JSON.
 28 |      *
 29 |      * Converts an XML formatted string into a JSON formatted string.
 30 |      *
 31 |      * The caller of this function needs to provide only the first parameter,
 32 |      * which is an XML formatted string.
 33 |      *
 34 |      * The second parameter, also optional, allows the user to select if the
 35 |      * XML attributes in the input XML string should be included or ignored
 36 |      * during the conversion.
 37 |      *
 38 |      * This function converts the XML formatted string into a PHP array via a
 39 |      * recursive function; it then converts that array to json via
 40 |      * Json::encode().
 41 |      *
 42 |      * NOTE: Encoding native javascript expressions via Zend\Json\Expr is not
 43 |      * possible.
 44 |      *
 45 |      * @param string $xmlStringContents XML String to be converted.
 46 |      * @param  bool $ignoreXmlAttributes Include or exclude XML attributes in
 47 |      *     the conversion process.
 48 |      * @return string JSON formatted string on success.
 49 |      * @throws Exception\RuntimeException If the input not a XML formatted string.
 50 |      */
 51 |     public static function fromXml($xmlStringContents, $ignoreXmlAttributes = true)
 52 |     {
 53 |         // Load the XML formatted string into a Simple XML Element object.
 54 |         $simpleXmlElementObject = XmlSecurity::scan($xmlStringContents);
 55 | 
 56 |         // If it is not a valid XML content, throw an exception.
 57 |         if (! $simpleXmlElementObject) {
 58 |             throw new Exception\RuntimeException('Function fromXml was called with invalid XML');
 59 |         }
 60 | 
 61 |         // Call the recursive function to convert the XML into a PHP array.
 62 |         $resultArray = static::processXml($simpleXmlElementObject, $ignoreXmlAttributes);
 63 | 
 64 |         // Convert the PHP array to JSON using Json::encode.
 65 |         return Json::encode($resultArray);
 66 |     }
 67 | 
 68 |     /**
 69 |      * Return the value of an XML attribute text or the text between the XML tags.
 70 |      *
 71 |      * In order to allow Zend\Json\Expr from XML, we check if the node matches
 72 |      * the pattern, and, if so, we return a new Zend\Json\Expr instead of a
 73 |      * text node.
 74 |      *
 75 |      * @param SimpleXMLElement $simpleXmlElementObject
 76 |      * @return Expr|string
 77 |      */
 78 |     protected static function getXmlValue($simpleXmlElementObject)
 79 |     {
 80 |         $pattern   = '/^[\s]*new Zend[_\\]Json[_\\]Expr[\s]*\([\s]*[\"\']{1}(.*)[\"\']{1}[\s]*\)[\s]*$/';
 81 |         $matchings = [];
 82 |         $match     = preg_match($pattern, $simpleXmlElementObject, $matchings);
 83 | 
 84 |         if ($match) {
 85 |             return new Expr($matchings[1]);
 86 |         }
 87 | 
 88 |         return (trim(strval($simpleXmlElementObject)));
 89 |     }
 90 | 
 91 |     /**
 92 |      * processXml - Contains the logic for fromJson()
 93 |      *
 94 |      * The logic in this function is a recursive one.
 95 |      *
 96 |      * The main caller of this function (fromXml) needs to provide only the
 97 |      * first two parameters (the SimpleXMLElement object and the flag for
 98 |      * indicating whether or not to ignore XML attributes).
 99 |      *
100 |      * The third parameter will be used internally within this function during
101 |      * the recursive calls.
102 |      *
103 |      * This function converts a SimpleXMLElement object into a PHP array by
104 |      * calling a recursive function in this class; once all XML elements are
105 |      * stored to a PHP array, it is returned to the caller.
106 |      *
107 |      * @param SimpleXMLElement $simpleXmlElementObject
108 |      * @param bool $ignoreXmlAttributes
109 |      * @param int $recursionDepth
110 |      * @return array
111 |      * @throws Exception\RecursionException if the XML tree is deeper than the
112 |      *     allowed limit.
113 |      */
114 |     protected static function processXml($simpleXmlElementObject, $ignoreXmlAttributes, $recursionDepth = 0)
115 |     {
116 |         // Keep an eye on how deeply we are involved in recursion.
117 |         if ($recursionDepth > static::$maxRecursionDepthAllowed) {
118 |             // XML tree is too deep. Exit now by throwing an exception.
119 |             throw new Exception\RecursionException(sprintf(
120 |                 'Function processXml exceeded the allowed recursion depth of %d',
121 |                 static::$maxRecursionDepthAllowed
122 |             ));
123 |         }
124 | 
125 |         $children   = $simpleXmlElementObject->children();
126 |         $name       = $simpleXmlElementObject->getName();
127 |         $value      = static::getXmlValue($simpleXmlElementObject);
128 |         $attributes = (array) $simpleXmlElementObject->attributes();
129 | 
130 |         if (! $children) {
131 |             if (! empty($attributes) && ! $ignoreXmlAttributes) {
132 |                 foreach ($attributes['@attributes'] as $k => $v) {
133 |                     $attributes['@attributes'][$k] = static::getXmlValue($v);
134 |                 }
135 | 
136 |                 if (! empty($value)) {
137 |                     $attributes['@text'] = $value;
138 |                 }
139 | 
140 |                 return [$name => $attributes];
141 |             }
142 | 
143 |             return [$name => $value];
144 |         }
145 | 
146 |         $childArray = [];
147 |         foreach ($children as $child) {
148 |             $childname = $child->getName();
149 |             $element   = static::processXml($child, $ignoreXmlAttributes, $recursionDepth + 1);
150 | 
151 |             if (! array_key_exists($childname, $childArray)) {
152 |                 $childArray[$childname] = $element[$childname];
153 |                 continue;
154 |             }
155 | 
156 |             if (empty($subChild[$childname])) {
157 |                 $childArray[$childname] = [$childArray[$childname]];
158 |                 $subChild[$childname]   = true;
159 |             }
160 | 
161 |             $childArray[$childname][] = $element[$childname];
162 |         }
163 | 
164 |         if (! empty($attributes) && ! $ignoreXmlAttributes) {
165 |             foreach ($attributes['@attributes'] as $k => $v) {
166 |                 $attributes['@attributes'][$k] = static::getXmlValue($v);
167 |             }
168 |             $childArray['@attributes'] = $attributes['@attributes'];
169 |         }
170 | 
171 |         if (! empty($value)) {
172 |             $childArray['@text'] = $value;
173 |         }
174 | 
175 |         return [$name => $childArray];
176 |     }
177 | }
178 | 


--------------------------------------------------------------------------------