Auth_OpenID_FailureResponse
extends Auth_OpenID_ConsumerResponse
in package
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:
claimed_id - The identity URL for which authentication was attempted, if it can be determined. Otherwise, null.
message - A message indicating why the request failed, if one is supplied. Otherwise, null.
status - Auth_OpenID_FAILURE.
Table of Contents
- $contact : mixed
- $endpoint : Auth_OpenID_ServiceEndpoint
- $identity_url : null|string
- $message : string
- $reference : mixed
- $status : mixed
- __construct() : mixed
- getDisplayIdentifier() : mixed
- Return the display identifier for this response.
- setEndpoint() : mixed
Properties
$contact
public
mixed
$contact
$endpoint
public
Auth_OpenID_ServiceEndpoint
$endpoint
$identity_url
public
null|string
$identity_url
= \null
$message
public
string
$message
$reference
public
mixed
$reference
$status
public
mixed
$status
= \Auth_OpenID_FAILURE
Methods
__construct()
public
__construct(mixed $endpoint[, mixed $message = null ][, mixed $contact = null ][, mixed $reference = null ]) : mixed
Parameters
- $endpoint : mixed
- $message : mixed = null
- $contact : mixed = null
- $reference : mixed = null
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