Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
59.46% covered (warning)
59.46%
22 / 37
60.00% covered (warning)
60.00%
3 / 5
 CRAP
0.00% covered (danger)
0.00%
0 / 1
tao_helpers_Xml
59.46% covered (warning)
59.46%
22 / 37
60.00% covered (warning)
60.00%
3 / 5
 29.99
0.00% covered (danger)
0.00%
0 / 1
 from_array
0.00% covered (danger)
0.00%
0 / 5
0.00% covered (danger)
0.00%
0 / 1
 2
 array_to_xml
0.00% covered (danger)
0.00%
0 / 10
0.00% covered (danger)
0.00%
0 / 1
 56
 to_array
100.00% covered (success)
100.00%
2 / 2
100.00% covered (success)
100.00%
1 / 1
 1
 getSimpleXml
100.00% covered (success)
100.00%
10 / 10
100.00% covered (success)
100.00%
1 / 1
 3
 extractElements
100.00% covered (success)
100.00%
10 / 10
100.00% covered (success)
100.00%
1 / 1
 3
1<?php
2
3/**
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License
6 * as published by the Free Software Foundation; under version 2
7 * of the License (non-upgradable).
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
17 *
18 * Copyright (c) 2019  (original work) Open Assessment Technologies SA;
19 */
20
21/**
22 * Utilities on XML
23 *
24 * Class tao_helpers_Xml
25 */
26class tao_helpers_Xml
27{
28    /**
29     * Returns XML from the array
30     * @param mixed
31     * @return string xml
32     *
33     * phpcs:disable PSR1.Methods.CamelCapsMethodName
34     */
35    public static function from_array($obj = [])
36    {
37        $simpleElementXml = new SimpleXMLElement("<?xml version=\"1.0\"?><root></root>");
38        self::array_to_xml($obj, $simpleElementXml);
39
40        //for formatting ...
41        $dom = dom_import_simplexml($simpleElementXml)->ownerDocument;
42        $dom->formatOutput = true;
43
44        return $dom->saveXML();
45    }
46    // phpcs:enable PSR1.Methods.CamelCapsMethodName
47
48    /**
49     * Convert array to xml
50     * @param array $data
51     * @param $xml_data
52     *
53     * phpcs:disable PSR1.Methods.CamelCapsMethodName,PEAR.Functions.ValidDefaultValue
54     */
55    private static function array_to_xml($data = [], &$xml_data)
56    {
57        foreach ($data as $key => $value) {
58            if (is_array($value) or (is_object($value))) {
59                if (!is_numeric($key)) {
60                    $subnode = $xml_data->addChild("$key");
61                    self::array_to_xml($value, $subnode);
62                } else {
63                    $subnode = $xml_data->addChild("element");
64                    self::array_to_xml($value, $subnode);
65                }
66            } else {
67                if (is_bool($value)) {
68                    $value = $value ? "true" : "false";
69                }
70                $xml_data->addChild("$key", "$value");
71            }
72        }
73    }
74    // phpcs:enable PSR1.Methods.CamelCapsMethodName,PEAR.Functions.ValidDefaultValue
75
76    /**
77     * Convert xml to array
78     * @param string $xml
79     * @return mixed
80     * @throws common_exception_Error
81     *
82     * phpcs:disable PSR1.Methods.CamelCapsMethodName
83     */
84    public static function to_array($xml)
85    {
86        $json = json_encode(self::getSimpleXml($xml));
87        return json_decode($json, true);
88    }
89    // phpcs:enable PSR1.Methods.CamelCapsMethodName
90
91    /**
92     * @param $xml
93     * @return SimpleXMLElement
94     * @throws common_exception_Error
95     */
96    public static function getSimpleXml($xml)
97    {
98        libxml_use_internal_errors(true);
99
100        $xml = simplexml_load_string($xml);
101        if ($xml === false) {
102            $report = [];
103            $errors = libxml_get_errors();
104            /** @var LibXMLError $error */
105            foreach ($errors as $error) {
106                $report[] = trim($error->message) . ' [' . $error->line . ']';
107            }
108            libxml_clear_errors();
109            throw new common_exception_Error(implode("\n", $report));
110        }
111        return $xml;
112    }
113
114    /**
115     * Extract elements from the xml (xpath) with namespace dependency
116     * @param $tagName
117     * @param $xml
118     * @param string $namespace
119     * @return array
120     * @throws common_exception_Error
121     */
122    public static function extractElements($tagName, $xml, $namespace = '')
123    {
124        $elements = [];
125        $simpleXml = self::getSimpleXml($xml);
126        $ns = '';
127        if ($namespace) {
128            $simpleXml->registerXPathNamespace('ns', $namespace);
129            $ns = 'ns:';
130        }
131        $tagName = $ns . $tagName;
132        foreach ($simpleXml->xpath('//' . $tagName) as $item) {
133            $elements [] = current($item);
134        }
135        return $elements;
136    }
137}