Auth_Yadis_DiscoveryResult Class Reference

Collaboration diagram for Auth_Yadis_DiscoveryResult:

Public Member Functions
	Auth_Yadis_DiscoveryResult ($request_uri)
	fail ()
	isFailure ()
	services ()
	Returns the list of service objects as described by the XRDS document, if this yadis object represents a successful Yadis discovery.
	usedYadisLocation ()
	isXRDS ()

Data Fields
	$request_uri = null
	$normalized_uri = null
	$xrds_uri = null
	$xrds = null
	$content_type = null
	$response_text = null
	$failed = false

Detailed Description

Definition at line 48 of file Yadis.php.

Member Function Documentation

Auth_Yadis_DiscoveryResult::Auth_Yadis_DiscoveryResult

(

$request_uri

)

Definition at line 71 of file Yadis.php.

References $request_uri.

    {
        // Initialize the state of the object
        // sets all attributes to None except the request_uri
        $this->request_uri = $request_uri;
    }

Auth_Yadis_DiscoveryResult::fail

(

)

Definition at line 78 of file Yadis.php.

    {
        $this->failed = true;
    }

Auth_Yadis_DiscoveryResult::isFailure

(

)

Definition at line 83 of file Yadis.php.

References $failed.

    {
        return $this->failed;
    }

Auth_Yadis_DiscoveryResult::isXRDS

(

)

Definition at line 111 of file Yadis.php.

References Auth_Yadis_CONTENT_TYPE, and usedYadisLocation().

    {
        // Is the response text supposed to be an XRDS document?
        return ($this->usedYadisLocation() ||
                $this->content_type == Auth_Yadis_CONTENT_TYPE);
    }

Here is the call graph for this function:

Auth_Yadis_DiscoveryResult::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 Auth_Yadis_Service objects

Definition at line 96 of file Yadis.php.

    {
        if ($this->xrds) {
            return $this->xrds->services();
        }

        return null;
    }

Auth_Yadis_DiscoveryResult::usedYadisLocation

(

)

Definition at line 105 of file Yadis.php.

Referenced by isXRDS().

    {
        // Was the Yadis protocol's indirection used?
        return ($this->xrds_uri && $this->normalized_uri != $this->xrds_uri);
    }

Here is the caller graph for this function:

Field Documentation

Auth_Yadis_DiscoveryResult::$content_type = null

Definition at line 63 of file Yadis.php.

Auth_Yadis_DiscoveryResult::$failed = false

Definition at line 69 of file Yadis.php.

Referenced by isFailure().

Auth_Yadis_DiscoveryResult::$normalized_uri = null

Definition at line 54 of file Yadis.php.

Auth_Yadis_DiscoveryResult::$request_uri = null

Definition at line 51 of file Yadis.php.

Referenced by Auth_Yadis_DiscoveryResult().

Auth_Yadis_DiscoveryResult::$response_text = null

Definition at line 66 of file Yadis.php.

Auth_Yadis_DiscoveryResult::$xrds = null

Definition at line 60 of file Yadis.php.

Auth_Yadis_DiscoveryResult::$xrds_uri = null

Definition at line 58 of file Yadis.php.

---

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

• Services/OpenId/lib/Auth/Yadis/Yadis.php