Auth_OpenID_ConsumerResponse Class Reference

Inheritance diagram for Auth_OpenID_ConsumerResponse:

Collaboration diagram for Auth_OpenID_ConsumerResponse:

Public Member Functions
	setEndpoint ($endpoint)
	getDisplayIdentifier ()
	Return the display identifier for this response.

Data Fields
	$status = null

Detailed Description

Definition at line 1970 of file Consumer.php.

Member Function Documentation

Auth_OpenID_ConsumerResponse::getDisplayIdentifier

(

)

Return the display identifier for this response.

The display identifier is related to the Claimed Identifier, but the two are not always identical. The display identifier is something the user should recognize as what they entered, whereas the response's claimed identifier (in the identity_url attribute) may have extra information for better persistence.

URLs will be stripped of their fragments for display. XRIs will display the human-readable identifier (i-name) instead of the persistent identifier (i-number).

Use the display identifier in your user interface. Use identity_url for querying your database or authorization server.

Definition at line 2000 of file Consumer.php.

    {
        if ($this->endpoint !== null) {
            return $this->endpoint->getDisplayIdentifier();
        }
        return null;
    }

Auth_OpenID_ConsumerResponse::setEndpoint

(

$endpoint

)

Definition at line 1973 of file Consumer.php.

Referenced by Auth_OpenID_CancelResponse\Auth_OpenID_CancelResponse(), Auth_OpenID_FailureResponse\Auth_OpenID_FailureResponse(), and Auth_OpenID_SetupNeededResponse\Auth_OpenID_SetupNeededResponse().

    {
        $this->endpoint = $endpoint;
        if ($endpoint === null) {
            $this->identity_url = null;
        } else {
            $this->identity_url = $endpoint->claimed_id;
        }
    }

Here is the caller graph for this function:

Field Documentation

Auth_OpenID_ConsumerResponse::$status = null

Definition at line 1971 of file Consumer.php.

---

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

• Services/OpenId/lib/Auth/OpenID/Consumer.php