mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-04-19 07:25:30 +02:00
Code Issues Projects Releases Wiki Activity

MDL-13435 xmlize - now throwing exceptions on parsing error. Credit goes to Tim/Mahmoud

Browse Source
This commit is contained in:
Eloy Lafuente 2010-09-27 21:10:00 +00:00
parent 9384419a4f
commit 5423b5f5b1
2 changed files with 51 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
lang/en/error.php
View File

@ -212,6 +212,7 @@ $string['errorcreatingfile'] = 'Error creating file "{$a}"';
$string['errorcreatingrole'] = 'Error creating role';
$string['errorfetchingrssfeed'] = 'Error fetching RSS feed.';
$string['erroronline'] = 'Error on line {$a}';
$string['errorparsingxml'] = 'Error parsing XML: {$a->errorstring} at line {$a->errorline}, char {$a->errorchar}';
$string['errorreadingfile'] = 'Error reading file "{$a}"';
$string['errorsavingrequest'] = 'An error occurred when trying to save your request.';
$string['errorsettinguserpref'] = 'Error setting user preference';

68
lib/xmlize.php
View File

@ -9,7 +9,8 @@
* on my part is to blame for the credit these people aren't receiving.
* None of the code was copyrighted, though.
*
* @package moodlecore
* @package core
* @subpackage lib
* @author Hans Anderson
* @version This is a stable release, 1.0. I don't foresee any changes, but you
* might check {@link http://www.hansanderson.com/php/xml/} to see
@ -18,9 +19,32 @@
*/
/**
* Create xml formatted output from an array.
* Exception thrown when there is an error parsing an XML file.
*
* usage:<br>
* @copyright 2010 The Open University
*/
class xml_format_exception extends moodle_exception {
/** @var string */
public $errorstring;
public $line;
public $char;
function __construct($errorstring, $line, $char, $link = '') {
$this->errorstring = $errorstring;
$this->line = $line;
$this->char = $char;
$a = new stdClass();
$a->errorstring = $errorstring;
$a->errorline = $line;
$a->errorchar = $char;
parent::__construct('errorparsingxml', 'error', $link, $a);
}
}
/**
* Create an array structure from an XML string.
*
* Usage:<br>
* <code>
* $xml = xmlize($array);
* </code>
@ -38,33 +62,44 @@
* {@link http://bugs.php.net/bug.php?id=29711}
* Ciao, Eloy :-)
*
*
* @author Hans Anderson
* @param array $data The array to be converted
* @param int $WHITE If set to 1 allows the parser to skip "space" characters in xml document. Default is 1
* @param string $data The XML source to parse.
* @param int $whitespace If set to 1 allows the parser to skip "space" characters in xml document. Default is 1
* @param string $encoding Specify an OUTPUT encoding. If not specified, it defaults to UTF-8.
* @return array
* @param bool $reporterrors if set to true, then a {@link xml_format_exception}
* exception will be thrown if the XML is not well-formed. Otherwise errors are ignored.
* @return array representation of the parsed XML.
*/
function xmlize($data, $WHITE=1, $encoding='UTF-8') {
function xmlize($data, $whitespace = 1, $encoding = 'UTF-8', $reporterrors = false) {
$data = trim($data);
$vals = $index = $array = array();
$vals = array();
$parser = xml_parser_create($encoding);
xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, 0);
xml_parser_set_option($parser, XML_OPTION_SKIP_WHITE, $WHITE);
xml_parse_into_struct($parser, $data, $vals, $index);
xml_parser_set_option($parser, XML_OPTION_SKIP_WHITE, $whitespace);
xml_parse_into_struct($parser, $data, $vals);
// Error handling when the xml file is not well-formed
if ($reporterrors) {
$errorcode = xml_get_error_code($parser);
if ($errorcode) {
$exception = new xml_format_exception(xml_error_string($errorcode),
xml_get_current_line_number($parser),
xml_get_current_column_number($parser));
xml_parser_free($parser);
throw $exception;
}
}
xml_parser_free($parser);
$i = 0;
if (empty($vals)) {
// XML file is invalid or empty, return false
return false;
}
$array = array();
$tagname = $vals[$i]['tag'];
if ( isset ($vals[$i]['attributes'] ) )
{
if (isset($vals[$i]['attributes'])) {
$array[$tagname]['@'] = $vals[$i]['attributes'];
} else {
$array[$tagname]['@'] = array();
@ -72,7 +107,6 @@ function xmlize($data, $WHITE=1, $encoding='UTF-8') {
$array[$tagname]["#"] = xml_depth($vals, $i);
return $array;
}
@ -192,5 +226,3 @@ function traverse_xmlize($array, $arrName = 'array', $level = 0) {
return 1;
}
?>