Class: Auth_OpenID_ConsumerResponse

Source Location: /libraries/openid/Auth/OpenID/Consumer.php

Class Auth_OpenID_ConsumerResponse

Class Overview

The base class for responses from the Auth_OpenID_Consumer.

Located in /libraries/openid/Auth/OpenID/Consumer.php [line 1972]

Properties

$status

Methods

[ Top ]

Descendants

Child Class	Description
Auth_OpenID_SuccessResponse	A response with a status of Auth_OpenID_SUCCESS. Indicates that
Auth_OpenID_FailureResponse	A response with a status of Auth_OpenID_FAILURE. Indicates that the OpenID protocol has failed. This could be locally or remotely triggered. This has three relevant attributes:
Auth_OpenID_CancelResponse	A response with a status of Auth_OpenID_CANCEL. Indicates that the user cancelled the OpenID authentication request. This has two relevant attributes:
Auth_OpenID_SetupNeededResponse	A response with a status of Auth_OpenID_SETUP_NEEDED. Indicates that the request was in immediate mode, and the server is unable to authenticate the user without further interaction.

[ Top ]

Property Summary

mixed

$status

[ Top ]

Method Summary

void	getDisplayIdentifier()	Return the display identifier for this response.
void	setEndpoint()

[ Top ]

Properties

mixed $status = null [line 1973]

Redefined in descendants as:

[ Top ]

Methods

getDisplayIdentifier [line 2002]

void 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.

[ Top ]

setEndpoint [line 1975]

void setEndpoint(

$endpoint 
)

Parameters:

$endpoint:

[ Top ]

The site fititnt.org is not affiliated with or endorsed by the Joomla! Project or Open Source Matters. If you are looking for official documentation, visit api.joomla.org and docs.joomla.org.

Documentation generated on Mon, 26 Oct 2009 22:03:32 -0200 by phpDocumentor 1.4.3

Visit fititnt.org, and look for some extension or more Joomla Framework info	OpenID

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