Class Auth_Yadis_XMLParser
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.
Methods summary
public
boolean
|
#
init( string $xml_string, array $namespace_map )
Initialize an instance of Auth_Yadis_XMLParser with some
XML and namespaces. This SHOULD NOT be overridden by
subclasses.
Initialize an instance of Auth_Yadis_XMLParser with some
XML and namespaces. This SHOULD NOT be overridden by
subclasses.
Parameters
- $xml_string
- A string of XML to be parsed.
- $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.
|
public
boolean
|
#
registerNamespace( string $prefix, string $uri )
Register a namespace with the XML parser. This should be
overridden by subclasses.
Register a namespace with the XML parser. This should be
overridden by subclasses.
Parameters
- $prefix
The namespace prefix to appear in XML tag
names. - $uri
The namespace URI to be used to identify the
namespace in the XML. Returns
boolean $result True if the registration succeeded;
false otherwise.
|
public
boolean
|
#
setXML( string $xml_string )
Set this parser object's XML payload. This should be
overridden by subclasses.
Set this parser object's XML payload. This should be
overridden by subclasses.
Parameters
- $xml_string
The XML string to pass to this
object's XML parser. Returns
boolean $result True if the initialization succeeded;
false otherwise.
|
public
array
&
|
#
evalXPath( string $xpath, mixed $node = null )
Evaluate an XPath expression and return the resulting node
list. This should be overridden by subclasses.
Evaluate an XPath expression and return the resulting node
list. This should be overridden by subclasses.
Parameters
- $xpath
- The XPath expression to be evaluated.
- $node
A node object resulting from a previous
evalXPath call. This node, if specified, provides the context
for the evaluation of this xpath expression. Returns
array $node_list An array of matching opaque node
objects to be used with other methods of this parser class.
|
public
string
|
#
content( mixed $node )
Return the textual content of a specified node.
Return the textual content of a specified node.
Parameters
- $node
A node object from a previous call to
$this->evalXPath(). Returns
string
$content The content of this node.
|
public
array
|
#
attributes( mixed $node )
Return the attributes of a specified node.
Return the attributes of a specified node.
Parameters
- $node
A node object from a previous call to
$this->evalXPath(). Returns
array $attrs An array mapping attribute names to
values.
|