Public Member Functions

Services_Yadis_Yadis Class Reference

Public Member Functions

 getHTTPFetcher ($timeout=20)
 _getHeader ($header_list, $names)
 _getContentType ($content_type_header)
 discover ($uri, &$http_response, &$fetcher, $extra_ns_map=null, $timeout=20)
 Services_Yadis_Yadis ()
 services ()

Detailed Description

Definition at line 114 of file Yadis.php.


Member Function Documentation

_getContentType ( content_type_header  ) 

private

Definition at line 152 of file Yadis.php.

_getHeader ( header_list,
names 
)

private

Definition at line 136 of file Yadis.php.

discover ( uri,
&$  http_response,
&$  fetcher,
extra_ns_map = null,
timeout = 20 
)

This should be called statically and will build a Yadis instance if the discovery process succeeds. This implements Yadis discovery as specified in the Yadis specification.

Parameters:
string $uri The URI on which to perform Yadis discovery.
array $http_response An array reference where the HTTP response object will be stored (see Services_Yadis_HTTPResponse.
Services_Yadis_HTTPFetcher $fetcher An instance of a Services_Yadis_HTTPFetcher subclass.
array $extra_ns_map An array which maps namespace names to namespace URIs to be used when parsing the Yadis XRDS document.
integer $timeout An optional fetcher timeout, in seconds.
Returns:
mixed $obj Either null or an instance of Services_Yadis_Yadis, depending on whether the discovery succeeded.

Definition at line 184 of file Yadis.php.

getHTTPFetcher ( timeout = 20  ) 

Returns an HTTP fetcher object. If the CURL extension is present, an instance of Services_Yadis_ParanoidHTTPFetcher is returned. If not, an instance of Services_Yadis_PlainHTTPFetcher is returned.

Definition at line 122 of file Yadis.php.

services (  ) 

Returns the list of service objects as described by the XRDS document, if this yadis object represents a successful Yadis discovery.

Returns:
array $services An array of Services_Yadis_Service objects

Definition at line 299 of file Yadis.php.

Instantiates an empty Services_Yadis_Yadis object. This constructor should not be used by any user of the library. This constructor results in a completely useless object which must be populated with valid discovery information. Instead of using this constructor, call Services_Yadis_Yadis::discover($uri).

Definition at line 281 of file Yadis.php.


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