PEAR_XMLParser Class Reference

Inheritance diagram for PEAR_XMLParser:

Public Member Functions
	cdataHandler ($parser, $cdata)
	endHandler ($parser, $element)
	getData ()
	parse ($data)
	postProcess ($data, $element)
	startHandler ($parser, $element, $attribs)

Data Fields
	$_dataStack = array()
	$_depth = 0
	$_root = null
	$_unserializedData = null
	$_valStack = array()
	$encoding = 'ISO-8859-1'

Detailed Description

Definition at line 29 of file XMLParser.php.

Member Function Documentation

cdataHandler()

cdataHandler	(		$parser,
			$cdata )

Handler for character data

@access private

Parameters

object	XML parser object
string	CDATA

Returns

void

Definition at line 243 of file XMLParser.php.

    {
        $this->_dataStack[$this->_depth] .= $cdata;
    }

References $_depth.

endHandler()

endHandler	(		$parser,
			$element )

End element handler for XML parser

@access private

Parameters

object	XML parser object
string

Returns

void

Definition at line 163 of file XMLParser.php.

    {
        $value = array_pop($this->_valStack);
        $data  = $this->postProcess($this->_dataStack[$this->_depth], $element);
 
        // adjust type of the value
        switch (strtolower($value['type'])) {
            // unserialize an array
            case 'array':
                if ($data !== '') {
                    $value['children']['_content'] = $data;
                }
 
                $value['value'] = isset($value['children']) ? $value['children'] : array();
                break;
 
            /*
             * unserialize a null value
             */
            case 'null':
                $data = null;
                break;
 
            /*
             * unserialize any scalar value
             */
            default:
                settype($data, $value['type']);
                $value['value'] = $data;
                break;
        }
 
        $parent = array_pop($this->_valStack);
        if ($parent === null) {
            $this->_unserializedData = &$value['value'];
            $this->_root = &$value['name'];
            return true;
        }
 
        // parent has to be an array
        if (!isset($parent['children']) || !is_array($parent['children'])) {
            $parent['children'] = array();
            if ($parent['type'] != 'array') {
                $parent['type'] = 'array';
            }
        }
 
        if (!empty($value['name'])) {
            // there already has been a tag with this name
            if (in_array($value['name'], $parent['childrenKeys'])) {
                // no aggregate has been created for this tag
                if (!in_array($value['name'], $parent['aggregKeys'])) {
                    if (isset($parent['children'][$value['name']])) {
                        $parent['children'][$value['name']] = array($parent['children'][$value['name']]);
                    } else {
                        $parent['children'][$value['name']] = array();
                    }
                    array_push($parent['aggregKeys'], $value['name']);
                }
                array_push($parent['children'][$value['name']], $value['value']);
            } else {
                $parent['children'][$value['name']] = &$value['value'];
                array_push($parent['childrenKeys'], $value['name']);
            }
        } else {
            array_push($parent['children'],$value['value']);
        }
        array_push($this->_valStack, $parent);
 
        $this->_depth--;
    }

References postProcess().

Here is the call graph for this function:

getData()

getData

(

)

Returns

array

Definition at line 70 of file XMLParser.php.

    {
        return $this->_unserializedData;
    }

References $_unserializedData.

parse()

parse

(

$data

)

Parameters

string

xml content

Returns

true|PEAR_Error

Definition at line 79 of file XMLParser.php.

    {
        if (!extension_loaded('xml')) {
            include_once 'PEAR.php';
            return PEAR::raiseError("XML Extension not found", 1);
        }
        $this->_dataStack =  $this->_valStack = array();
        $this->_depth = 0;
 
        if (
            strpos($data, 'encoding="UTF-8"')
            || strpos($data, 'encoding="utf-8"')
            || strpos($data, "encoding='UTF-8'")
            || strpos($data, "encoding='utf-8'")
        ) {
            $this->encoding = 'UTF-8';
        }
 
        $xp = xml_parser_create($this->encoding);
        xml_parser_set_option($xp, XML_OPTION_CASE_FOLDING, 0);
        xml_set_object($xp, $this);
        xml_set_element_handler($xp, 'startHandler', 'endHandler');
        xml_set_character_data_handler($xp, 'cdataHandler');
        if (!xml_parse($xp, $data)) {
            $msg = xml_error_string(xml_get_error_code($xp));
            $line = xml_get_current_line_number($xp);
            xml_parser_free($xp);
            include_once 'PEAR.php';
            return PEAR::raiseError("XML Error: '$msg' on line '$line'", 2);
        }
        xml_parser_free($xp);
        return true;
    }

Referenced by PEAR_REST\retrieveData().

Here is the caller graph for this function:

postProcess()

postProcess	(		$data,
			$element )

post-process data

Parameters

string	$data
string	$element	element name

Reimplemented in PEAR_PackageFile_Parser_v2.

Definition at line 150 of file XMLParser.php.

    {
        return trim($data);
    }

Referenced by endHandler().

Here is the caller graph for this function:

startHandler()

startHandler	(		$parser,
			$element,
			$attribs )

Start element handler for XML parser

@access private

Parameters

object	$parser	XML parser object
string	$element	XML element
array	$attribs	attributes of XML tag

Returns

void

Definition at line 122 of file XMLParser.php.

    {
        $this->_depth++;
        $this->_dataStack[$this->_depth] = null;
 
        $val = array(
            'name'         => $element,
            'value'        => null,
            'type'         => 'string',
            'childrenKeys' => array(),
            'aggregKeys'   => array()
       );
 
        if (count($attribs) > 0) {
            $val['children'] = array();
            $val['type'] = 'array';
            $val['children']['attribs'] = $attribs;
        }
 
        array_push($this->_valStack, $val);
    }

References $_depth.

Field Documentation

$_dataStack

$_dataStack = array()

stack for all data that is found

Definition at line 47 of file XMLParser.php.

$_depth

$_depth = 0

current tag depth

Definition at line 59 of file XMLParser.php.

Referenced by cdataHandler(), and startHandler().

$_root

$_root = null

name of the root tag

Definition at line 41 of file XMLParser.php.

$_unserializedData

$_unserializedData = null

Definition at line 35 of file XMLParser.php.

Referenced by getData().

$_valStack

$_valStack = array()

stack for all values that are generated

Definition at line 53 of file XMLParser.php.

$encoding

$encoding = 'ISO-8859-1'

The XML encoding to use

Definition at line 65 of file XMLParser.php.

Referenced by PEAR_PackageFile_Parser_v2\parse().

---

The documentation for this class was generated from the following file:

• E:/Bearsampp-development/sandbox/core/libs/php/pear/pear/PEAR/XMLParser.php