Class: XML_Parser2_Simple

Source Location: /XML_Parser2-0.1.0/XML/Parser2/Simple.php

Class Overview

XML_Parser2
   |
   --XML_Parser2_Simple

Simple XML parser class.

Author(s):

Stephan Schmidt <schst at php.net>

Version:

Release: @package_version@

Copyright:

2004-2008 The PHP Group

Variables

$handler

Methods

Child classes:

: Simple XML parser class.

myParser2: Simple XML parser class.

Inherited Variables

Class: XML_Parser2

XML_Parser2::$folding
XML_Parser2::$fp
XML_Parser2::$mode
XML_Parser2::$parser
XML_Parser2::$srcenc
XML_Parser2::$tgtenc

Inherited Methods

Class: XML_Parser2

XML_Parser2::__construct(): PHP5 constructor
XML_Parser2::endHandler(): abstract method signature for End Handler
XML_Parser2::free(): XML_Parser2::free()
XML_Parser2::funcEndHandler(): derives and calls the End Handler function
XML_Parser2::funcStartHandler(): derives and calls the Start Handler function
XML_Parser2::parse(): Central parsing function.
XML_Parser2::parseString(): XML_Parser2::parseString()
XML_Parser2::reset(): Reset the parser.
XML_Parser2::setHandlerObj(): Sets the object, that will handle the XML events
XML_Parser2::setInput(): Sets the file handle to use with parse().
XML_Parser2::setInputFile(): Sets the input xml file to be parsed
XML_Parser2::setInputString(): XML_Parser2::setInputString()
XML_Parser2::setMode(): Sets the mode of the parser.
XML_Parser2::startHandler(): abstract method signature for Start Handler

Class Details

[line 92]
Simple XML parser class.

This class is a simplified version of XML_Parser2. In most XML applications the real action is executed, when a closing tag is found.

XML_Parser2_Simple allows you to just implement one callback for each tag that will receive the tag with its attributes and CData.

 require_once '../Parser/Simple.php';

 
 class myParser extends XML_Parser2_Simple
 {
 
    function handleElement($name, $attribs, $data)
     {
         printf('handle %s<br>', $name);
     }
 }
 
 $p = new myParser();
 
 $result = $p->setInputFile('myDoc.xml');
 $result = $p->parse();

Author: Stephan Schmidt <schst@php.net>
Version: Release: @package_version@
Copyright: 2004-2008 The PHP Group
Link: http://pear.php.net/package/XML_Parser2
License: New BSD License

[ Top ]

Class Variables

$handler = array(
        'default_handler'                   => 'defaultHandler',
        'processing_instruction_handler'    => 'piHandler',
        'unparsed_entity_decl_handler'      => 'unparsedHandler',
        'notation_decl_handler'             => 'notationHandler',
        'external_entity_ref_handler'       => 'entityrefHandler'
    )

[line 123]

Mapping from expat handler function to class method.

Type:	array
Overrides:	Array

[ Top ]

Method Detail

addToData [line 296]

void addToData(
string
$data)

add some string to the current ddata.

This is commonly needed, when a document is parsed recursively.

Access: public

Parameters:

string $data — data to add

[ Top ]

getCurrentDepth [line 281]

integer getCurrentDepth(
)

get the current tag depth

The root tag is in depth 0.

Access: public

[ Top ]

handleElement [line 269]

void handleElement(
string
$name, array
$attribs, string
$data)

handle a tag

Implement this in your parser

Abstract:
Access: public

Parameters:

string	`$name`	—	element name
array	`$attribs`	—	attributes
string	`$data`	—	character data

[ Top ]

reset [line 173]

boolean|object reset(
)

Reset the parser.

This allows you to use one parser instance to parse multiple XML documents.

Return: true on success, PEAR_Error otherwise
Access: public

Overrides XML_Parser2::reset() (Reset the parser.)

[ Top ]

Class: XML_Parser2_Simple

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Child classes:

Inherited Variables

Class: XML_Parser2

Inherited Methods

Class: XML_Parser2

Class Details

Class Variables

$handler = array( 'default_handler' => 'defaultHandler', 'processing_instruction_handler' => 'piHandler', 'unparsed_entity_decl_handler' => 'unparsedHandler', 'notation_decl_handler' => 'notationHandler', 'external_entity_ref_handler' => 'entityrefHandler' )

Method Detail

addToData [line 296]

Parameters:

getCurrentDepth [line 281]

handleElement [line 269]

Parameters:

reset [line 173]

$handler = array(
'default_handler' => 'defaultHandler',
'processing_instruction_handler' => 'piHandler',
'unparsed_entity_decl_handler' => 'unparsedHandler',
'notation_decl_handler' => 'notationHandler',
'external_entity_ref_handler' => 'entityrefHandler'
)