Auth_Yadis_XRDS Class Reference

List of all members.

---

Detailed Description

This class performs parsing of XRDS documents.

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

  $xrds = Auth_Yadis_XRDS.parseXRDS($xml_string);

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.

Definition at line 252 of file XRDS.php.

Public Member Functions
	Auth_Yadis_XRDS (&$xmlParser, &$xrdNodes)
&	parseXRDS ($xml_string, $extra_ns_map=null)
	_addService ($priority, $service)
	_parse ()
	services ($filters=null, $filter_mode=SERVICES_YADIS_MATCH_ANY)

---

Member Function Documentation

Auth_Yadis_XRDS.Auth_Yadis_XRDS	(	&$	xmlParser,
		&$	xrdNodes
	)

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

Definition at line 258 of file XRDS.php.

& Auth_Yadis_XRDS.parseXRDS	(	$	xml_string,
		$	extra_ns_map = null
	)

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

Parameters:

string

$xml_string An XRDS XML string.

Returns:

mixed $xrds An instance of Auth_Yadis_XRDS or null, depending on the validity of $xml_string

Definition at line 276 of file XRDS.php.

Auth_Yadis_XRDS._addService	(	$	priority,
		$	service
	)

private

Definition at line 331 of file XRDS.php.

Auth_Yadis_XRDS._parse

(

)

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

private

Definition at line 348 of file XRDS.php.

Auth_Yadis_XRDS.services	(	$	filters = null,
		$	filter_mode = SERVICES_YADIS_MATCH_ANY
	)

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 Auth_Yadis_Yadis for detailed usage information on filter functions.

Parameters:

	mixed	$filters An array of callbacks to filter the returned services, or null if all services are to be returned.
	integer	$filter_mode SERVICES_YADIS_MATCH_ALL or SERVICES_YADIS_MATCH_ANY, depending on whether the returned services should match ALL or ANY of the specified filters, respectively.

Returns:

mixed $services An array of Auth_Yadis_Service objects if $filter_mode is a valid mode; null if $filter_mode is an invalid mode (i.e., not SERVICES_YADIS_MATCH_ANY or SERVICES_YADIS_MATCH_ALL).

Definition at line 393 of file XRDS.php.

---

The documentation for this class was generated from the following file:

• core/openid/Auth/Yadis/XRDS.php