XML_SaxFilters
[ class tree: XML_SaxFilters ] [ index: XML_SaxFilters ] [ all elements ]

Class: XML_SaxFilters_AbstractParser

Source Location: /XML_SaxFilters-0.3.0/SaxFilters/AbstractParser.php

Class Overview


Base class for Sax Parsers to extend.


Author(s):

Methods


Child classes:

XML_SaxFilters_HtmlSaxParser
HtmlSaxParser adapts XML_HTMLSax parser to allow filtering
XML_SaxFilters_ExpatParser
ExpatParser for the native PHP SAX XML extension

Inherited Variables

Inherited Methods


Class Details

[line 32]
Base class for Sax Parsers to extend.
  • Abstract:
  • Access: public


[ Top ]


Method Detail

XML_SaxFilters_AbstractParser (Constructor)   [line 64]

XML_SaxFilters_AbstractParser XML_SaxFilters_AbstractParser( object class &$reader)

Constructs AbstractParser

Parameters:

object class   &$reader   —  implementing ReaderInterface

[ Top ]

close   [line 134]

void close( object instance $parser, string &$tag)

Sax end element handler
  • Access: public

Overridden in child classes as:

XML_SaxFilters_HtmlSaxParser::close()
Sax end element handler - note leakiness of second argument

Parameters:

object instance   $parser   —  of the parser
string   &$tag   —  element tag name

[ Top ]

data   [line 149]

void data( object instance $parser, string &$data)

Sax character data handler
  • Access: public

Parameters:

object instance   $parser   —  of the parser
string   &$data   —  contents of element

[ Top ]

endDoc   [line 178]

void endDoc( )

Handler called when parsing finishes
  • Access: public

[ Top ]

getError   [line 93]

mixed getError( )

Returns the error if there are any.
  • Return: PEAR_Error or NULL if no errors
  • Access: public

[ Top ]

open   [line 119]

void open( object instance $parser, string &$tag, array &$attribs)

Sax start element handler
  • Access: public

Overridden in child classes as:

XML_SaxFilters_HtmlSaxParser::open()
Sax start element handler - note leakiness of fourth argument

Parameters:

object instance   $parser   —  of the parser
string   &$tag   —  element tag name
array   &$attribs   —  element attributes

[ Top ]

pi   [line 165]

void pi( object instance $parser, string &$target, string &$instruction)

Sax processing instruction handler
  • Access: public

Parameters:

object instance   $parser   —  of the parser
string   &$target   —  target processor
string   &$instruction   —  instruction to processor

[ Top ]

setChild   [line 74]

void setChild( object class &$child)

Sets the child

Parameters:

object class   &$child   —  or subclass of AbstractFilter

[ Top ]

startDoc   [line 103]

void startDoc( )

Handler called when parsing begins
  • Access: public

[ Top ]

unsetChild   [line 83]

void unsetChild( )

Unsets the child

[ Top ]


Documentation generated on Mon, 11 Mar 2019 10:15:10 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.