Class SaxParser

---

Object
   |
   --XmlParser
      |
      --SaxParser

• Package: xml
• Since: Japha 1.0
• Author: Ryan Gantt @

Class Variable Summary

Inherited Class Variable Summary

Method Summary

• void parse()
  
• void parseFile()
  
• void parserCreate()
  
• void parserFree()
  
• void setCharacterDataHandler()
  
• void setElementHandler()
  
• void setObject()
  
• void setOption()
  
• void __construct()
  

Inherited Method Summary

Inherited From Class XmlParser

• parserCreate()
  
• __construct()
  

Inherited From Class Object

• clone()
  
• equals()
  
• equalsIgnoreCase()
  
• finalize()
  
• getClass()
  
• toString()
  
• wait()
  

Variable Detail

Method Detail

• void parse()
  
  Usage: parse ( $data, $end )
  
  

  Parses a part of an xml file... Namely the part before the !end flag

  Parameters

  • data $data - the data to parse over @
  • end $end - the flag on which to end parsing

  Info

  • Access: public
  
  
• void parseFile()
  
  Usage: parseFile ( )
  
  

  Parses the entire contents of an xml file

  Parameters

  Info

  • Access: public
  
  
• void parserCreate()
  
  Usage: parserCreate ( )
  
  

  Overrides: XmlParser::parserCreate()

  Creates a new instance of the Sax Parser

  Parameters

  Info

  • Throws: ParserAlreadyExistsException if there is already an instance of the parser
  • Access: public
  
  
• void parserFree()
  
  Usage: parserFree ( )
  
  

  Delets (frees) the current instance of the parser

  Parameters

  Info

  • Throws: ParserNotCreatedException if no parser has been instantiated
  • Access: public
  
  
• void setCharacterDataHandler()
  
  Usage: setCharacterDataHandler ( $function )
  
  

  Sets the method of the default character data handler

  Parameters

  • function $function - the character data handling function

  Info

  • Access: public
  
  
• void setElementHandler()
  
  Usage: setElementHandler ( $sFunction, $eFunction )
  
  

  Sets the method of the default element tag handler

  Parameters

  • sFunction $sFunction - the starting function handler @
  • eFunction $eFunction - the ending function handler

  Info

  • Access: public
  
  
• void setObject()
  
  Usage: setObject ( $obj )
  
  

  Parameters

  Info

  
  
• void setOption()
  
  Usage: setOption ( $option, $bool )
  
  

  Sets a boolean option on the parser

  Parameters

  • option $option - the text of the option to set @
  • bool $bool - the boolean answer of the option, ex// true or false.. duh

  Info

  • Throws: ParserNotCreatedException if there is no instance of the xml parser @
  • Access: public
  
  
• void __construct()
  
  Usage: __construct ( $fileName )
  
  

  Overrides: XmlParser::__construct()

  Creates a new instance of the XML parser on the passed file path

  Parameters

  • fileName $fileName - the path/filename to the file that will be parsed

  Info

  • Access: public