PHP Class Auth_Yadis_XRDS

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.

Show file Open project: openid/php-openid Class Usage Examples

Public Methods

Method	Description
__construct ( $xmlParser, $xrdNodes )	Instantiate a Auth_Yadis_XRDS object. Requires an XPath instance which has been used to parse a valid XRDS document.
_addService ( $priority, $service )
_parse ( )	Creates the service list using nodes from the XRDS XML document.
parseXRDS ( string $xml_string, $extra_ns_map = null ) : mixed	Parse an XML string (XRDS document) and return either a Auth_Yadis_XRDS object or null, depending on whether the XRDS XML is valid.
services ( mixed $filters = null, integer $filter_mode = SERVICES_YADIS_MATCH_ANY ) : mixed	Returns a list of service objects which correspond to elements in the XRDS XML document for this object.

Method Details

__construct() public method

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

public __construct ( $xmlParser, $xrdNodes )

_addService() public method

public _addService ( $priority, $service )

_parse() public method

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

public _parse ( )

parseXRDS() static public method

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

static public parseXRDS ( string $xml_string, $extra_ns_map = null ) : mixed
$xml_string	string	An XRDS XML string.
return	mixed	$xrds An instance of Auth_Yadis_XRDS or null, depending on the validity of $xml_string

services() public method

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.

public services ( mixed $filters = null, integer $filter_mode = SERVICES_YADIS_MATCH_ANY ) : mixed
$filters	mixed	An array of callbacks to filter the returned services, or null if all services are to be returned.
$filter_mode	integer	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.
return	mixed	$services An array of {@link 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).