PHP Class Auth_Yadis_Service

Objects of this type are returned by Auth_Yadis_XRDS::services() and Auth_Yadis_Yadis::services(). Each object corresponds directly to a 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.

Mostrar archivo Open project: openid/php-openid Class Usage Examples

Public Methods

Method	Description
__construct ( )	Creates an empty service object.
getElements ( string $name ) : array	Used to get XML elements from this object's element.
getPriority ( ) : mixed	Returns the "priority" attribute value of this element, if the attribute is present. Returns null if not.
getTypes ( ) : array	Return the URIs in the "Type" elements, if any, of this Service element.
getURIs ( ) : array	Return the URIs in the "URI" elements, if any, of this Service element. The URIs are returned sorted in priority order.
matchTypes ( $type_uris )

Method Details

__construct() public method

Creates an empty service object.

public __construct ( )

getElements() public method

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 element for this object.

public getElements ( string $name ) : array
$name	string	The name of the element to look for
return	array	$list An array of elements with the specified name which are direct children of the element. The nodes returned by this function can be passed to $this->parser methods (see {@link Auth_Yadis_XMLParser}).

getPriority() public method

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

public getPriority ( ) : mixed
return	mixed	$result Null or integer, depending on whether this Service element has a 'priority' attribute.

getTypes() public method

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

public getTypes ( ) : array
return	array	$type_uris An array of Type URI strings.

getURIs() public method

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

public getURIs ( ) : array
return	array	$uris An array of URI strings.

matchTypes() public method

public matchTypes ( $type_uris )