PHPXRef 0.7.1 : Joomla 1.5.26 DE : Detail view of XRDS.php

This module contains the XRDS parsing code. PHP versions 4 and 5

Author:	JanRain, Inc. <openid@janrain.com>
Copyright:	2005-2008 Janrain, Inc.
License:	http://www.apache.org/licenses/LICENSE-2.0 Apache
File Size:	481 lines (14 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 2 classes

Auth_Yadis_Service:: (7 methods):
  Auth_Yadis_Service()
  getTypes()
  matchTypes()
  getURIs()
  getPriority()
  getElements()
  Auth_Yadis_getXRDExpiration()

Auth_Yadis_XRDS:: (5 methods):
  Auth_Yadis_XRDS()
  parseXRDS()
  _addService()
  _parse()
  services()

Defines 5 functions

Auth_Yadis_getNSMap()
Auth_Yadis_array_scramble()

Class: Auth_Yadis_Service - X-Ref

This class represents a <Service> element in an XRDS document.
Objects of this type are returned by
Auth_Yadis_XRDS::services() and
Auth_Yadis_Yadis::services(). Each object corresponds directly
to a <Service> element in the XRDS and supplies a
getElements($name) method which you should use to inspect the
element's contents. See {@link Auth_Yadis_Yadis} for more
information on the role this class plays in Yadis discovery.

Auth_Yadis_Service() X-Ref

Creates an empty service object.

getTypes() X-Ref

Return the URIs in the "Type" elements, if any, of this Service
element.

return: array $type_uris An array of Type URI strings.

matchTypes($type_uris) X-Ref

No description

getURIs() X-Ref

Return the URIs in the "URI" elements, if any, of this Service
element. The URIs are returned sorted in priority order.

return: array $uris An array of URI strings.

getPriority() X-Ref

Returns the "priority" attribute value of this <Service>
element, if the attribute is present. Returns null if not.

return: mixed $result Null or integer, depending on whether

getElements($name) X-Ref

Used to get XML elements from this object's <Service> element.

This is what you should use to get all custom information out
of this element. This is used by service filter functions to
determine whether a service element contains specific tags,
etc. NOTE: this only considers elements which are direct
children of the <Service> element for this object.

param: string $name The name of the element to look for
return: array $list An array of elements with the specified

Auth_Yadis_getXRDExpiration($xrd_element, $default=null) X-Ref

No description

Class: Auth_Yadis_XRDS - X-Ref

This class performs parsing of XRDS documents.

You should not instantiate this class directly; rather, call
parseXRDS statically:

<pre>  $xrds = Auth_Yadis_XRDS::parseXRDS($xml_string);</pre>

If the XRDS can be parsed and is valid, an instance of
Auth_Yadis_XRDS will be returned.  Otherwise, null will be
returned.  This class is used by the Auth_Yadis_Yadis::discover
method.

Auth_Yadis_XRDS(&$xmlParser, &$xrdNodes) X-Ref

Instantiate a Auth_Yadis_XRDS object. Requires an XPath
instance which has been used to parse a valid XRDS document.

parseXRDS($xml_string, $extra_ns_map = null) X-Ref

Parse an XML string (XRDS document) and return either a
Auth_Yadis_XRDS object or null, depending on whether the
XRDS XML is valid.

param: string $xml_string An XRDS XML string.
return: mixed $xrds An instance of Auth_Yadis_XRDS or null,

_addService($priority, $service) X-Ref

_parse() X-Ref

Creates the service list using nodes from the XRDS XML
document.

services($filters = null,$filter_mode = SERVICES_YADIS_MATCH_ANY) X-Ref

Returns a list of service objects which correspond to <Service>
elements in the XRDS XML document for this object.

Optionally, an array of filter callbacks may be given to limit
the list of returned service objects. Furthermore, the default
mode is to return all service objects which match ANY of the
specified filters, but $filter_mode may be
SERVICES_YADIS_MATCH_ALL if you want to be sure that the
returned services match all the given filters. See {@link
Auth_Yadis_Yadis} for detailed usage information on filter
functions.

param: mixed $filters An array of callbacks to filter the
param: integer $filter_mode SERVICES_YADIS_MATCH_ALL or
return: mixed $services An array of {@link

Functions

Functions that are not part of a class:

Auth_Yadis_getNSMap() X-Ref

XRDS XML namespace

Auth_Yadis_array_scramble($arr) X-Ref

PHP Cross Reference of Joomla 1.5.26 DE

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

Defines 2 classes

Defines 5 functions