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

Class: Auth_Yadis_XMLParser

Source Location: /zp-extensions/federated_logon/Auth/Yadis/XML.php

Class Auth_Yadis_XMLParser

Class Overview

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.

Located in /zp-extensions/federated_logon/Auth/Yadis/XML.php [line 21]



		
		
		
		

Methods

[ Top ]
Descendants
Child Class Description
Auth_Yadis_domxml This concrete implementation of Auth_Yadis_XMLParser implements
Auth_Yadis_dom This concrete implementation of Auth_Yadis_XMLParser implements

[ Top ]
Method Summary
array   attributes()   Return the attributes of a specified node.
string   content()   Return the textual content of a specified node.
array   &evalXPath()   Evaluate an XPath expression and return the resulting node list. This should be overridden by subclasses.
boolean   init()   Initialize an instance of Auth_Yadis_XMLParser with some XML and namespaces. This SHOULD NOT be overridden by subclasses.
boolean   registerNamespace()   Register a namespace with the XML parser. This should be overridden by subclasses.
boolean   setXML()   Set this parser object's XML payload. This should be overridden by subclasses.

[ Top ]
Methods
attributes  [line 121]

  array attributes( mixed $node  )

Return the attributes of a specified node.

Parameters:
mixed   $node:  A node object from a previous call to $this->evalXPath().

API Tags:
Return:  An array mapping attribute names to values.


Redefined in descendants as:

[ Top ]
content  [line 107]

  string content( mixed $node  )

Return the textual content of a specified node.

Parameters:
mixed   $node:  A node object from a previous call to $this->evalXPath().

API Tags:
Return:  The content of this node.


Redefined in descendants as:

[ Top ]
evalXPath  [line 94]

  array &evalXPath( string $xpath, [mixed $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.

API Tags:
Return:  An array of matching opaque node objects to be used with other methods of this parser class.


Redefined in descendants as:

[ Top ]
init  [line 33]

  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.

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.

API Tags:
Return:  True if the initialization and namespace registration(s) succeeded; false otherwise.


[ Top ]
registerNamespace  [line 61]

  boolean registerNamespace( string $prefix, string $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.

API Tags:
Return:  True if the registration succeeded; false otherwise.


Redefined in descendants as:

[ Top ]
setXML  [line 76]

  boolean setXML( string $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.

API Tags:
Return:  True if the initialization succeeded; false otherwise.


Redefined in descendants as:

[ Top ]

Documentation generated on Tue, 20 Dec 2011 16:08:22 +0100 by phpDocumentor 1.4.3