[ class tree: OpenID ] [ index: OpenID ] [ all elements ]

Class: Auth_Yadis_Service

Source Location: /zp-extensions/federated_logon/Auth/Yadis/XRDS.php

Class Auth_Yadis_Service

Class Overview

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.

Located in /zp-extensions/federated_logon/Auth/Yadis/XRDS.php [line 83]



		
		
		
		

Methods

[ Top ]
Method Summary
Auth_Yadis_Service   Auth_Yadis_Service()   Creates an empty service object.
array   getElements()   Used to get XML elements from this object's <Service> element.
mixed   getPriority()   Returns the "priority" attribute value of this <Service> element, if the attribute is present. Returns null if not.
array   getTypes()   Return the URIs in the "Type" elements, if any, of this Service element.
array   getURIs()   Return the URIs in the "URI" elements, if any, of this Service element. The URIs are returned sorted in priority order.
void   matchTypes()  

[ Top ]
Methods
Constructor Auth_Yadis_Service  [line 88]

  Auth_Yadis_Service Auth_Yadis_Service( )

Creates an empty service object.



[ Top ]
getElements  [line 201]

  array getElements( string $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

API Tags:
Return:  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).


[ Top ]
getPriority  [line 175]

  mixed getPriority( )

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


API Tags:
Return:  Null or integer, depending on whether this Service element has a 'priority' attribute.


[ Top ]
getTypes  [line 100]

  array getTypes( )

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


API Tags:
Return:  An array of Type URI strings.


[ Top ]
getURIs  [line 131]

  array getURIs( )

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


API Tags:
Return:  An array of URI strings.


[ Top ]
matchTypes  [line 112]

  void matchTypes( $type_uris  )

Parameters:
   $type_uris: 


[ Top ]

Documentation generated on Sat, 05 Jan 2013 15:51:30 +0100 by phpDocumentor 1.4.3