XOOPS  2.6.0
Public Member Functions | Public Attributes | Private Member Functions | List of all members
SaxParser Class Reference
Inheritance diagram for SaxParser:
Inheritance graph

Public Member Functions

 __construct (&$input)
 
 addTagHandler (XmlTagHandler &$tagHandler)
 
 free ()
 
 getCurrentLevel ()
 
 getCurrentTag ()
 
 getErrors ($ashtml=true)
 
 getParentTag ()
 
 handleBeginElement ($parser, $tagName, $attributesArray)
 
 handleBeginElementDefault ($parser, $tagName, $attributesArray)
 
 handleCharacterData ($parser, $data)
 
 handleCharacterDataDefault ($parser, $data)
 
 handleDefault ($parser, $data)
 
 handleEndElement ($parser, $tagName)
 
 handleEndElementDefault ($parser, $tagName)
 
 handleExternalEntityRef ($parser, $openEntityNames, $base, $systemId, $publicId)
 
 handleNotationDecl ($parser, $notationName, $base, $systemId, $publicId)
 
 handleProcessingInstruction ($parser, &$target, &$data)
 
 handleUnparsedEntityDecl ($parser, $entityName, $base, $systemId, $publicId, $notationName)
 
 parse ()
 
 setCaseFolding ($isCaseFolding)
 
 setErrors ($error)
 
 useAsciiEncoding ()
 
 useIsoEncoding ()
 
 useUtfEncoding ()
 

Public Attributes

 $errors = array()
 
 $isCaseFolding
 
 $level
 
 $parser
 
 $tagHandlers = array()
 
 $tags = array()
 
 $targetEncoding
 
 $xmlInput
 

Private Member Functions

 getXmlError ()
 

Detailed Description

Definition at line 16 of file saxparser.php.

Constructor & Destructor Documentation

SaxParser::__construct ( &  $input)

Creates a SaxParser object using a FileInput to represent the stream of XML data to parse. Use the static methods createFileInput or createStringInput to construct xml input source objects to supply to the constructor, or the implementor can construct them individually.

Parameters
$input

Definition at line 43 of file saxparser.php.

References setCaseFolding(), and useUtfEncoding().

Here is the call graph for this function:

Member Function Documentation

SaxParser::addTagHandler ( XmlTagHandler &  $tagHandler)

Adds a callback function to be called when a tag is encountered.

Parameters
XmlTagHandler$tagHandler
Returns
void

Definition at line 192 of file saxparser.php.

References $name, and XmlTagHandler\getName().

Referenced by XoopsXmlRss2Parser\__construct(), XoopsThemeSetParser\__construct(), and XoopsXmlRpcParser\__construct().

Here is the call graph for this function:

Here is the caller graph for this function:

SaxParser::free ( )

Definition at line 163 of file saxparser.php.

SaxParser::getCurrentLevel ( )

Definition at line 64 of file saxparser.php.

References $level.

Referenced by XoopsXmlRpcParser\setWorkingLevel().

Here is the caller graph for this function:

SaxParser::getCurrentTag ( )

Definition at line 115 of file saxparser.php.

Referenced by handleCharacterData(), and RpcValueHandler\handleEndElement().

Here is the caller graph for this function:

SaxParser::getErrors (   $ashtml = true)

Gets all the error messages

Parameters
$ashtmlbool return as html?
Returns
mixed

Definition at line 381 of file saxparser.php.

References $error, and $errors.

SaxParser::getParentTag ( )

Definition at line 120 of file saxparser.php.

Referenced by ThemeSetDateCreatedHandler\handleCharacterData(), ThemeSetDescriptionHandler\handleCharacterData(), ThemeSetGeneratorHandler\handleCharacterData(), ThemeSetNameHandler\handleCharacterData(), ThemeSetEmailHandler\handleCharacterData(), ThemeSetLinkHandler\handleCharacterData(), ThemeSetModuleHandler\handleCharacterData(), ThemeSetFileTypeHandler\handleCharacterData(), RpcNameHandler\handleCharacterData(), ThemeSetTagHandler\handleCharacterData(), and RpcValueHandler\handleCharacterData().

Here is the caller graph for this function:

SaxParser::getXmlError ( )
private
Returns
string

Definition at line 178 of file saxparser.php.

Referenced by parse().

Here is the caller graph for this function:

SaxParser::handleBeginElement (   $parser,
  $tagName,
  $attributesArray 
)

Definition at line 219 of file saxparser.php.

References handleBeginElementDefault().

Here is the call graph for this function:

SaxParser::handleBeginElementDefault (   $parser,
  $tagName,
  $attributesArray 
)

The default tag handler method for a tag with no handler

Parameters
$parser
$tagName
$attributesArray
Returns
void

Definition at line 337 of file saxparser.php.

Referenced by handleBeginElement().

Here is the caller graph for this function:

SaxParser::handleCharacterData (   $parser,
  $data 
)

Definition at line 256 of file saxparser.php.

References getCurrentTag(), and handleCharacterDataDefault().

Here is the call graph for this function:

SaxParser::handleCharacterDataDefault (   $parser,
  $data 
)

The default tag handler method for a tag with no handler

Parameters
$parser
$data
Returns
void

Definition at line 361 of file saxparser.php.

Referenced by handleCharacterData().

Here is the caller graph for this function:

SaxParser::handleDefault (   $parser,
  $data 
)
Parameters
$parser
$data
Returns
void

Definition at line 284 of file saxparser.php.

SaxParser::handleEndElement (   $parser,
  $tagName 
)

Definition at line 238 of file saxparser.php.

References handleEndElementDefault().

Here is the call graph for this function:

SaxParser::handleEndElementDefault (   $parser,
  $tagName 
)

The default tag handler method for a tag with no handler

Parameters
$parser
$tagName
Returns
void

Definition at line 348 of file saxparser.php.

Referenced by handleEndElement().

Here is the caller graph for this function:

SaxParser::handleExternalEntityRef (   $parser,
  $openEntityNames,
  $base,
  $systemId,
  $publicId 
)
Parameters
$parser
$openEntityNames
$base
$systemId
$publicId
Returns
void

Definition at line 324 of file saxparser.php.

SaxParser::handleNotationDecl (   $parser,
  $notationName,
  $base,
  $systemId,
  $publicId 
)
Parameters
$parser
$notationName
$base
$systemId
$publicId
Returns
void

Definition at line 311 of file saxparser.php.

SaxParser::handleProcessingInstruction (   $parser,
&  $target,
&  $data 
)
Parameters
$parserint. The handle to the parser.
$target
$data
Returns
void

Definition at line 272 of file saxparser.php.

SaxParser::handleUnparsedEntityDecl (   $parser,
  $entityName,
  $base,
  $systemId,
  $publicId,
  $notationName 
)
Parameters
$parser
$entityName
$base
$systemId
$publicId
$notationName
Returns
void

Definition at line 298 of file saxparser.php.

SaxParser::parse ( )
Returns
bool

Definition at line 136 of file saxparser.php.

References getXmlError(), and setErrors().

Here is the call graph for this function:

SaxParser::setCaseFolding (   $isCaseFolding)
Parameters
boolean$isCaseFolding

Definition at line 76 of file saxparser.php.

References $isCaseFolding.

Referenced by __construct().

Here is the caller graph for this function:

SaxParser::setErrors (   $error)

Sets error messages

Parameters
string$errorstring an error message

Definition at line 370 of file saxparser.php.

References $error.

Referenced by parse().

Here is the caller graph for this function:

SaxParser::useAsciiEncoding ( )

Definition at line 96 of file saxparser.php.

SaxParser::useIsoEncoding ( )

Definition at line 87 of file saxparser.php.

SaxParser::useUtfEncoding ( )

Definition at line 105 of file saxparser.php.

Referenced by __construct(), and XoopsXmlRss2Parser\__construct().

Here is the caller graph for this function:

Member Data Documentation

SaxParser::$errors = array()

Definition at line 33 of file saxparser.php.

Referenced by getErrors().

SaxParser::$isCaseFolding

Definition at line 21 of file saxparser.php.

Referenced by setCaseFolding().

SaxParser::$level

Definition at line 18 of file saxparser.php.

Referenced by getCurrentLevel().

SaxParser::$parser

Definition at line 19 of file saxparser.php.

SaxParser::$tagHandlers = array()

Definition at line 25 of file saxparser.php.

SaxParser::$tags = array()

Definition at line 28 of file saxparser.php.

SaxParser::$targetEncoding

Definition at line 22 of file saxparser.php.

SaxParser::$xmlInput

Definition at line 31 of file saxparser.php.

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