Auth_Yadis_Service Class Reference
List of all members.
Detailed Description
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
Auth_Yadis_Yadis for more information on the role this class plays in Yadis discovery.
Definition at line 83 of file XRDS.php.
Member Function Documentation
| Auth_Yadis_Service.Auth_Yadis_Service |
( |
|
) |
|
Creates an empty service object.
Definition at line 88 of file XRDS.php.
| Auth_Yadis_Service.getTypes |
( |
|
) |
|
Return the URIs in the "Type" elements, if any, of this Service element.
- Returns:
- array $type_uris An array of Type URI strings.
Definition at line 100 of file XRDS.php.
| Auth_Yadis_Service.matchTypes |
( |
$ |
type_uris |
) |
|
| Auth_Yadis_Service.getURIs |
( |
|
) |
|
Return the URIs in the "URI" elements, if any, of this Service element. The URIs are returned sorted in priority order.
- Returns:
- array $uris An array of URI strings.
Definition at line 131 of file XRDS.php.
| Auth_Yadis_Service.getPriority |
( |
|
) |
|
Returns the "priority" attribute value of this <Service> element, if the attribute is present. Returns null if not.
- Returns:
- mixed $result Null or integer, depending on whether this Service element has a 'priority' attribute.
Definition at line 175 of file XRDS.php.
| Auth_Yadis_Service.getElements |
( |
$ |
name |
) |
|
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.
- Parameters:
-
| string | $name The name of the element to look for |
- Returns:
- array $list An array of elements with the specified name which are direct children of the <Service> element. The nodes returned by this function can be passed to $this->parser methods (see Auth_Yadis_XMLParser).
Definition at line 201 of file XRDS.php.
The documentation for this class was generated from the following file:
