[ Index ]

PHP Cross Reference of Joomla 1.5.26 DE

title

Body

[close]

/libraries/openid/Auth/Yadis/ -> XML.php (summary)

[Source view] [Print] [Project Stats]

XML-parsing classes to wrap the domxml and DOM extensions for PHP 4 and 5, respectively.

File Size: 377 lines (10 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 3 classes

Auth_Yadis_XMLParser:: (6 methods):
  init()
  registerNamespace()
  setXML()
  evalXPath()
  content()
  attributes()

Auth_Yadis_domxml:: (6 methods):
  Auth_Yadis_domxml()
  setXML()
  registerNamespace()
  evalXPath()
  content()
  attributes()

Auth_Yadis_dom:: (9 methods):
  Auth_Yadis_dom()
  setXML()
  registerNamespace()
  evalXPath()
  content()
  attributes()
  Auth_Yadis_setDefaultParser()
  Auth_Yadis_getSupportedExtensions()
  Auth_Yadis_getXMLParser()


Class: Auth_Yadis_XMLParser  - X-Ref

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.

init($xml_string, $namespace_map)   X-Ref
Initialize an instance of Auth_Yadis_XMLParser with some
XML and namespaces.  This SHOULD NOT be overridden by
subclasses.

param: string $xml_string A string of XML to be parsed.
param: array $namespace_map An array of ($ns_name => $ns_uri)
return: boolean $result True if the initialization and

registerNamespace($prefix, $uri)   X-Ref
Register a namespace with the XML parser.  This should be
overridden by subclasses.

param: string $prefix The namespace prefix to appear in XML tag
param: string $uri The namespace URI to be used to identify the
return: boolean $result True if the registration succeeded;

setXML($xml_string)   X-Ref
Set this parser object's XML payload.  This should be
overridden by subclasses.

param: string $xml_string The XML string to pass to this
return: boolean $result True if the initialization succeeded;

evalXPath($xpath, $node = null)   X-Ref
Evaluate an XPath expression and return the resulting node
list.  This should be overridden by subclasses.

param: string $xpath The XPath expression to be evaluated.
param: mixed $node A node object resulting from a previous
return: array $node_list An array of matching opaque node

content($node)   X-Ref
Return the textual content of a specified node.

param: mixed $node A node object from a previous call to
return: string $content The content of this node.

attributes($node)   X-Ref
Return the attributes of a specified node.

param: mixed $node A node object from a previous call to
return: array $attrs An array mapping attribute names to

Class: Auth_Yadis_domxml  - X-Ref

This concrete implementation of Auth_Yadis_XMLParser implements
the appropriate API for the 'domxml' extension which is typically
packaged with PHP 4.  This class will be used whenever the 'domxml'
extension is detected.  See the Auth_Yadis_XMLParser class for
details on this class's methods.

Auth_Yadis_domxml()   X-Ref
No description

setXML($xml_string)   X-Ref
No description

registerNamespace($prefix, $uri)   X-Ref
No description

evalXPath($xpath, $node = null)   X-Ref
No description

content($node)   X-Ref
No description

attributes($node)   X-Ref
No description

Class: Auth_Yadis_dom  - X-Ref

This concrete implementation of Auth_Yadis_XMLParser implements
the appropriate API for the 'dom' extension which is typically
packaged with PHP 5.  This class will be used whenever the 'dom'
extension is detected.  See the Auth_Yadis_XMLParser class for
details on this class's methods.

Auth_Yadis_dom()   X-Ref
No description

setXML($xml_string)   X-Ref
No description

registerNamespace($prefix, $uri)   X-Ref
No description

evalXPath($xpath, $node = null)   X-Ref
No description

content($node)   X-Ref
No description

attributes($node)   X-Ref
No description

Auth_Yadis_setDefaultParser(&$parser)   X-Ref
Set a default parser to override the extension-driven selection of
available parser classes.  This is helpful in a test environment or
one in which multiple parsers can be used but one is more
desirable.

param: Auth_Yadis_XMLParser $parser An instance of a

Auth_Yadis_getSupportedExtensions()   X-Ref
No description

Auth_Yadis_getXMLParser()   X-Ref
Returns an instance of a Auth_Yadis_XMLParser subclass based on
the availability of PHP extensions for XML parsing.  If
Auth_Yadis_setDefaultParser has been called, the parser used in
that call will be returned instead.



Generated: Wed Mar 28 15:54:07 2012 Cross-referenced by PHPXref 0.7.1