Auth_OpenID_SuccessResponse
extends Auth_OpenID_ConsumerResponse
in package
A response with a status of Auth_OpenID_SUCCESS. Indicates that this request is a successful acknowledgement from the OpenID server that the supplied URL is, indeed controlled by the requesting agent. This has three relevant attributes:
claimed_id - The identity URL that has been authenticated
signed_args - The arguments in the server's response that were signed and verified.
status - Auth_OpenID_SUCCESS.
Table of Contents
- $endpoint : Auth_OpenID_ServiceEndpoint
- $identity_url : null|string
- $message : Auth_OpenID_Message
- $signed_args : array<string|int, mixed>
- $status : mixed
- __construct() : mixed
- getDisplayIdentifier() : mixed
- Return the display identifier for this response.
- getReturnTo() : string
- Get the openid.return_to argument from this response.
- getSigned() : mixed
- getSignedNS() : mixed
- isOpenID1() : mixed
- isSigned() : mixed
- setEndpoint() : mixed
Properties
$endpoint
public
Auth_OpenID_ServiceEndpoint
$endpoint
$identity_url
public
null|string
$identity_url
= \null
$message
public
Auth_OpenID_Message
$message
$signed_args
public
array<string|int, mixed>
$signed_args
= []
$status
public
mixed
$status
= \Auth_OpenID_SUCCESS
Methods
__construct()
public
__construct(Auth_OpenID_ServiceEndpoint $endpoint, Auth_OpenID_Message $message[, array<string|int, mixed>|null $signed_args = null ]) : mixed
Parameters
- $endpoint : Auth_OpenID_ServiceEndpoint
- $message : Auth_OpenID_Message
- $signed_args : array<string|int, mixed>|null = null
Tags
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 —getReturnTo()
Get the openid.return_to argument from this response.
public
getReturnTo() : string
This is useful for verifying that this request was initiated by this consumer.
Return values
string —$return_to The return_to URL supplied to the server on the initial request, or null if the response did not contain an 'openid.return_to' argument.
getSigned()
public
getSigned(mixed $ns_uri, mixed $ns_key[, mixed $default = null ]) : mixed
Parameters
- $ns_uri : mixed
- $ns_key : mixed
- $default : mixed = null
Return values
mixed —getSignedNS()
public
getSignedNS(mixed $ns_uri) : mixed
Parameters
- $ns_uri : mixed
Return values
mixed —isOpenID1()
public
isOpenID1() : mixed
Return values
mixed —isSigned()
public
isSigned(mixed $ns_uri, mixed $ns_key) : mixed
Parameters
- $ns_uri : mixed
- $ns_key : mixed
Return values
mixed —setEndpoint()
public
setEndpoint(Auth_OpenID_ServiceEndpoint|null $endpoint) : mixed
Parameters
- $endpoint : Auth_OpenID_ServiceEndpoint|null