Auth_Yadis_XMLParser Class Reference

Inheritance diagram for Auth_Yadis_XMLParser:

Detailed Description

XML-parsing classes to wrap the domxml and DOM extensions for PHP 4 and 5, respectively. The base class for wrappers for available PHP XML-parsing extensions. To work with this Yadis library, subclasses of this class MUST implement the API as defined in the remarks for this class. Subclasses of Auth_Yadis_XMLParser are used to wrap particular PHP XML extensions such as 'domxml'. These are used internally by the library depending on the availability of supported PHP XML extensions.

Definition at line 21 of file XML.php.


Public Member Functions
	init ($xml_string, $namespace_map)
	registerNamespace ($prefix, $uri)
	setXML ($xml_string)
	evalXPath ($xpath, $node=null)
	content ($node)
	attributes ($node)

Member Function Documentation

Auth_Yadis_XMLParser.init	(	$	xml_string,
		$	namespace_map
	)

Initialize an instance of Auth_Yadis_XMLParser with some XML and namespaces. This SHOULD NOT be overridden by subclasses.

Parameters:

	string	$xml_string A string of XML to be parsed.
	array	$namespace_map An array of ($ns_name => $ns_uri) to be registered with the XML parser. May be empty.

Returns:: boolean $result True if the initialization and namespace registration(s) succeeded; false otherwise.

Definition at line 33 of file XML.php.

Auth_Yadis_XMLParser.registerNamespace	(	$	prefix,
		$	uri
	)

Register a namespace with the XML parser. This should be overridden by subclasses.

Parameters:

	string	$prefix The namespace prefix to appear in XML tag names.
	string	$uri The namespace URI to be used to identify the namespace in the XML.

Returns:: boolean $result True if the registration succeeded; false otherwise.

Reimplemented in Auth_Yadis_domxml, and Auth_Yadis_dom.

Definition at line 61 of file XML.php.

Auth_Yadis_XMLParser.setXML ( $ xml_string )

Set this parser object's XML payload. This should be overridden by subclasses.

Parameters:

string

$xml_string The XML string to pass to this object's XML parser.

Returns:: boolean $result True if the initialization succeeded; false otherwise.

Reimplemented in Auth_Yadis_domxml, and Auth_Yadis_dom.

Definition at line 76 of file XML.php.

Auth_Yadis_XMLParser.evalXPath	(	$	xpath,
		$	node = `null`
	)

Evaluate an XPath expression and return the resulting node list. This should be overridden by subclasses.

Parameters:

	string	$xpath The XPath expression to be evaluated.
	mixed	$node A node object resulting from a previous evalXPath call. This node, if specified, provides the context for the evaluation of this xpath expression.