2008-05-30 11:40:08 +00:00
|
|
|
<?php
|
|
|
|
/**
|
|
|
|
* XML handling for Cake.
|
|
|
|
*
|
|
|
|
* The methods in these classes enable the datasources that use XML to work.
|
|
|
|
*
|
2010-07-27 00:31:39 +00:00
|
|
|
* PHP 5
|
2008-05-30 11:40:08 +00:00
|
|
|
*
|
2009-11-06 06:46:59 +00:00
|
|
|
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
|
2010-01-26 19:18:20 +00:00
|
|
|
* Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org)
|
2008-05-30 11:40:08 +00:00
|
|
|
*
|
|
|
|
* Licensed under The MIT License
|
|
|
|
* Redistributions of files must retain the above copyright notice.
|
|
|
|
*
|
2010-01-26 19:18:20 +00:00
|
|
|
* @copyright Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org)
|
2009-11-06 06:00:11 +00:00
|
|
|
* @link http://cakephp.org CakePHP(tm) Project
|
2008-10-30 17:30:26 +00:00
|
|
|
* @package cake
|
|
|
|
* @subpackage cake.cake.libs
|
|
|
|
* @since CakePHP v .0.10.3.1400
|
2009-11-06 06:51:51 +00:00
|
|
|
* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
|
2008-05-30 11:40:08 +00:00
|
|
|
*/
|
2009-07-24 19:18:37 +00:00
|
|
|
|
2010-07-27 00:31:39 +00:00
|
|
|
class Xml {
|
2009-07-24 19:18:37 +00:00
|
|
|
|
2008-08-26 01:18:15 +00:00
|
|
|
/**
|
2010-07-27 02:42:05 +00:00
|
|
|
* Initialize SimpleXMLElement from a given XML string, file path, URL or array.
|
2008-08-26 01:18:15 +00:00
|
|
|
*
|
2010-07-27 02:42:05 +00:00
|
|
|
* @param mixed $input XML string, a path to a file, an URL or an array
|
2010-07-27 00:31:39 +00:00
|
|
|
* @return object SimpleXMLElement
|
2008-08-26 01:18:15 +00:00
|
|
|
*/
|
2010-07-27 00:31:39 +00:00
|
|
|
public static function build($input) {
|
|
|
|
if (is_array($input) || is_object($input)) {
|
|
|
|
return self::fromArray((array)$input);
|
|
|
|
} elseif (strstr($input, "<")) {
|
|
|
|
return new SimpleXMLElement($input);
|
|
|
|
} elseif (file_exists($input) || strpos($input, 'http://') === 0 || strpos($input, 'https://') === 0 ) {
|
|
|
|
return new SimpleXMLElement($input, null, true);
|
|
|
|
} elseif (!is_string($input)) {
|
|
|
|
throw new Exception(__('Invalid input.'));
|
2008-08-26 01:18:15 +00:00
|
|
|
}
|
2010-07-27 00:31:39 +00:00
|
|
|
throw new Exception(__('XML cannot be read.'));
|
2008-05-30 11:40:08 +00:00
|
|
|
}
|
2009-07-24 19:18:37 +00:00
|
|
|
|
2010-07-27 02:42:05 +00:00
|
|
|
/**
|
|
|
|
* Transform an array in a SimpleXMLElement
|
|
|
|
*
|
|
|
|
* @param array $input Array with data
|
|
|
|
* @param string $format If create childs ('tags') or attributes ('attribute')
|
|
|
|
* @return object SimpleXMLElement
|
|
|
|
*/
|
2010-07-27 00:31:39 +00:00
|
|
|
public static function fromArray($input, $format = 'attribute') {
|
|
|
|
if (!is_array($input) || count($input) !== 1) {
|
|
|
|
throw new Exception(__('Invalid input.'));
|
2008-05-30 11:40:08 +00:00
|
|
|
}
|
2010-07-27 00:31:39 +00:00
|
|
|
$key = key($input);
|
|
|
|
if (is_integer($key)) {
|
|
|
|
throw new Exception(__('The key of input must be alphanumeric'));
|
2008-05-30 11:40:08 +00:00
|
|
|
}
|
2010-07-27 00:31:39 +00:00
|
|
|
if (is_array($input[$key])) {
|
|
|
|
$simpleXml = new SimpleXMLElement('<' . '?xml version="1.0"?' . '><' . $key . ' />');
|
|
|
|
self::_fromArrayRecursive($simpleXml, $input[$key], $format);
|
2008-05-30 11:40:08 +00:00
|
|
|
} else {
|
2010-07-27 00:31:39 +00:00
|
|
|
$simpleXml = new SimpleXMLElement('<' . '?xml version="1.0"?' . '><' . $key . '>' . $input[$key] . '</' . $key . '>');
|
2008-05-30 11:40:08 +00:00
|
|
|
}
|
2010-07-27 00:31:39 +00:00
|
|
|
return $simpleXml;
|
2008-05-30 11:40:08 +00:00
|
|
|
}
|
2009-07-24 19:18:37 +00:00
|
|
|
|
2010-07-27 02:42:05 +00:00
|
|
|
/**
|
|
|
|
* Recursive method to create SimpleXMLElement from array
|
|
|
|
*
|
|
|
|
* @param object $node Handler to SimpleXMLElement
|
|
|
|
* @param array $array
|
|
|
|
* @param string $format
|
|
|
|
* @return void
|
|
|
|
*/
|
2010-07-27 00:31:39 +00:00
|
|
|
protected static function _fromArrayRecursive(&$node, &$array, $format = 'attribute') {
|
|
|
|
if (empty($array) || !is_array($array)) {
|
2008-05-30 11:40:08 +00:00
|
|
|
return;
|
|
|
|
}
|
2010-07-27 00:31:39 +00:00
|
|
|
foreach ($array as $key => $value) {
|
|
|
|
if (is_string($key)) {
|
|
|
|
if (!is_array($value)) {
|
|
|
|
if (is_bool($value)) {
|
|
|
|
$value = (int)$value;
|
|
|
|
} elseif ($value === null) {
|
|
|
|
$value = '';
|
|
|
|
}
|
|
|
|
if ($format === 'tags') {
|
|
|
|
$node->addChild($key, $value);
|
|
|
|
} else {
|
|
|
|
$node->addAttribute($key, $value);
|
2008-06-03 18:41:04 +00:00
|
|
|
}
|
|
|
|
} else {
|
2010-07-27 00:31:39 +00:00
|
|
|
if (array_keys($value) === range(0, count($value) - 1)) { // List
|
|
|
|
foreach ($value as $item) {
|
|
|
|
$child = $node->addChild($key);
|
|
|
|
self::_fromArrayRecursive($child, $item, $format);
|
|
|
|
}
|
|
|
|
} else { // Struct
|
|
|
|
$child = $node->addChild($key);
|
|
|
|
self::_fromArrayRecursive($child, $value, $format);
|
2008-05-30 11:40:08 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
} else {
|
2010-07-27 00:31:39 +00:00
|
|
|
throw new Exception(__('Invalid array'));
|
2008-05-30 11:40:08 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
2009-07-24 19:18:37 +00:00
|
|
|
|
2008-05-30 11:40:08 +00:00
|
|
|
/**
|
2010-07-27 00:31:39 +00:00
|
|
|
* Returns this XML structure as a array.
|
2008-05-30 11:40:08 +00:00
|
|
|
*
|
2010-07-27 02:42:05 +00:00
|
|
|
* @param object $simpleXML SimpleXMLElement instance
|
2010-07-27 00:31:39 +00:00
|
|
|
* @return array Array representation of the XML structure.
|
2008-05-30 11:40:08 +00:00
|
|
|
*/
|
2010-07-27 00:31:39 +00:00
|
|
|
public static function toArray($simpleXML) {
|
|
|
|
if (!($simpleXML instanceof SimpleXMLElement)) {
|
|
|
|
throw new Exception(__('The input is not instance of SimpleXMLElement.'));
|
2008-05-30 11:40:08 +00:00
|
|
|
}
|
2010-07-27 00:31:39 +00:00
|
|
|
$result = array();
|
2010-07-28 22:46:35 +00:00
|
|
|
$namespaces = array_merge(array('' => ''), $simpleXML->getNamespaces(true));
|
|
|
|
self::_toArray($simpleXML, $result, array_keys($namespaces));
|
2010-07-27 00:31:39 +00:00
|
|
|
return $result;
|
2008-05-30 11:40:08 +00:00
|
|
|
}
|
2009-07-24 19:18:37 +00:00
|
|
|
|
2010-07-27 02:42:05 +00:00
|
|
|
/**
|
|
|
|
* Recursive method to toArray
|
|
|
|
*
|
|
|
|
* @param object $xml SimpleXMLElement object
|
|
|
|
* @param array $parentData Parent array with data
|
2010-07-28 22:46:35 +00:00
|
|
|
* @param array $namespaces List of namespaces in XML
|
2010-07-27 02:42:05 +00:00
|
|
|
* @return void
|
|
|
|
*/
|
2010-07-28 22:46:35 +00:00
|
|
|
protected static function _toArray($xml, &$parentData, $namespaces) {
|
2010-07-27 00:31:39 +00:00
|
|
|
$data = array();
|
2009-07-24 19:18:37 +00:00
|
|
|
|
2010-07-28 22:46:35 +00:00
|
|
|
foreach ($namespaces as $namespace) {
|
|
|
|
foreach ($xml->attributes($namespace, true) as $key => $value) {
|
|
|
|
$data[$key] = (string)$value;
|
|
|
|
}
|
2008-06-21 15:23:58 +00:00
|
|
|
|
2010-07-28 22:46:35 +00:00
|
|
|
foreach ($xml->children($namespace, true) as $child) {
|
|
|
|
self::_toArray($child, $data, $namespaces);
|
|
|
|
}
|
2008-05-30 11:40:08 +00:00
|
|
|
}
|
|
|
|
|
2010-07-28 21:53:36 +00:00
|
|
|
$asString = trim((string)$xml);
|
2010-07-27 00:31:39 +00:00
|
|
|
if (empty($data)) {
|
2010-07-28 21:53:36 +00:00
|
|
|
$data = $asString;
|
|
|
|
} elseif (!empty($asString)) {
|
|
|
|
$data['value'] = $asString;
|
2008-05-30 11:40:08 +00:00
|
|
|
}
|
2008-11-26 18:21:21 +00:00
|
|
|
|
2010-07-27 00:31:39 +00:00
|
|
|
$name = $xml->getName();
|
|
|
|
if (isset($parentData[$name])) {
|
|
|
|
if (!is_array($parentData[$name]) || !isset($parentData[$name][0])) {
|
|
|
|
$parentData[$name] = array($parentData[$name]);
|
2008-08-10 16:26:43 +00:00
|
|
|
}
|
2010-07-27 00:31:39 +00:00
|
|
|
$parentData[$name][] = $data;
|
|
|
|
} else {
|
|
|
|
$parentData[$name] = $data;
|
2008-08-10 16:26:43 +00:00
|
|
|
}
|
2008-08-26 01:18:15 +00:00
|
|
|
}
|
2009-07-24 19:18:37 +00:00
|
|
|
|
2010-07-27 00:31:39 +00:00
|
|
|
}
|