Auth_OpenID_CancelResponse
extends Auth_OpenID_ConsumerResponse
in package
A response with a status of Auth_OpenID_CANCEL. Indicates that the user cancelled the OpenID authentication request. This has two relevant attributes:
claimed_id - The identity URL for which authentication was attempted, if it can be determined. Otherwise, null.
status - Auth_OpenID_SUCCESS.
Table of Contents
- $endpoint : Auth_OpenID_ServiceEndpoint
- $identity_url : null|string
- $status : mixed
- __construct() : mixed
- Auth_OpenID_CancelResponse constructor.
- getDisplayIdentifier() : mixed
- Return the display identifier for this response.
- setEndpoint() : mixed
Properties
$endpoint
public
Auth_OpenID_ServiceEndpoint
$endpoint
$identity_url
public
null|string
$identity_url
= \null
$status
public
mixed
$status
= \Auth_OpenID_CANCEL
Methods
__construct()
Auth_OpenID_CancelResponse constructor.
public
__construct(Auth_OpenID_ServiceEndpoint $endpoint) : mixed
Parameters
- $endpoint : Auth_OpenID_ServiceEndpoint
Return values
mixed —getDisplayIdentifier()
Return the display identifier for this response.
public
getDisplayIdentifier() : mixed
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.
Return values
mixed —setEndpoint()
public
setEndpoint(Auth_OpenID_ServiceEndpoint|null $endpoint) : mixed
Parameters
- $endpoint : Auth_OpenID_ServiceEndpoint|null