Auth_OpenID_CheckIDRequest
extends Auth_OpenID_Request
in package
A request to confirm the identity of a user.
Table of Contents
- $assoc_handle : mixed
- $identity : mixed
- $immediate : mixed
- Whether this request is for immediate mode.
- $message : Auth_OpenID_Message|null
- $mode : mixed
- The mode of this request.
- $namespace : mixed
- The OpenID namespace for this request.
- $return_to : string
- $trust_root : mixed
- The trust_root value for this request.
- $verifyReturnTo : mixed
- Return-to verification callback. Default is Auth_OpenID_verifyReturnTo from TrustRoot.php.
- $claimed_id : mixed
- $server : Auth_OpenID_Server
- __construct() : mixed
- Auth_OpenID_CheckIDRequest constructor.
- answer() : mixed
- Respond to this request. Return either an {@link Auth_OpenID_ServerResponse} or {@link Auth_OpenID_ServerError}.
- encodeToURL() : mixed
- equals() : bool
- fromMessage() : Auth_OpenID_CheckIDRequest|Auth_OpenID_MalformedReturnURL|Auth_OpenID_ServerError|Auth_OpenID_UntrustedReturnURL
- getCancelURL() : mixed
- idSelect() : mixed
- make() : Auth_OpenID_CheckIDRequest|Auth_OpenID_MalformedReturnURL|Auth_OpenID_ServerError|Auth_OpenID_UntrustedReturnURL
- returnToVerified() : mixed
- trustRootValid() : mixed
Properties
$assoc_handle
public
mixed
$assoc_handle
= ''
$identity
public
mixed
$identity
= ''
$immediate
Whether this request is for immediate mode.
public
mixed
$immediate
= \false
$message
public
Auth_OpenID_Message|null
$message
= \null
$mode
The mode of this request.
public
mixed
$mode
= "checkid_setup"
$namespace
The OpenID namespace for this request.
public
mixed
$namespace
= ''
deprecated since version 2.0.2
$return_to
public
string
$return_to
= ''
$trust_root
The trust_root value for this request.
public
mixed
$trust_root
= \null
$verifyReturnTo
Return-to verification callback. Default is Auth_OpenID_verifyReturnTo from TrustRoot.php.
public
mixed
$verifyReturnTo
= 'Auth_OpenID_verifyReturnTo'
$claimed_id
private
mixed
$claimed_id
= ''
$server
private
Auth_OpenID_Server
$server
Methods
__construct()
Auth_OpenID_CheckIDRequest constructor.
public
__construct( $identity, $return_to[, string $trust_root = null ][, bool $immediate = false ][, string $assoc_handle = null ][, Auth_OpenID_Server $server = null ][, string $claimed_id = null ]) : mixed
Parameters
- $identity :
- $return_to :
- $trust_root : string = null
- $immediate : bool = false
- $assoc_handle : string = null
- $server : Auth_OpenID_Server = null
- $claimed_id : string = null
Return values
mixed —answer()
Respond to this request. Return either an {@link Auth_OpenID_ServerResponse} or {@link Auth_OpenID_ServerError}.
public
answer(bool $allow[, string $server_url = null ][, string $identity = null ][, string $claimed_id = null ]) : mixed
Parameters
- $allow : bool
-
Allow this user to claim this identity, and allow the consumer to have this information?
- $server_url : string = null
-
DEPRECATED. Passing $op_endpoint to the constructor makes this optional.
When an OpenID 1.x immediate mode request does not succeed, it gets back a URL where the request may be carried out in a not-so-immediate fashion. Pass my URL in here (the fully qualified address of this server's endpoint, i.e. http://example.com/server), and I will use it as a base for the URL for a new request.
- $identity : string = null
-
The OP-local identifier to answer with. Only for use when the relying party requested identifier selection.
- $claimed_id : string = null
-
The claimed identifier to answer with, for use with identifier selection in the case where the claimed identifier and the OP-local identifier differ, i.e. when the claimed_id uses delegation.
If $identity is provided but this is not, $claimed_id will default to the value of $identity. When answering requests that did not ask for identifier selection, the response $claimed_id will default to that of the request.
This parameter is new in OpenID 2.0.
Return values
mixed —encodeToURL()
public
encodeToURL(mixed $server_url) : mixed
Parameters
- $server_url : mixed
Return values
mixed —equals()
public
equals(Auth_OpenID_CheckIDRequest $other) : bool
Parameters
- $other : Auth_OpenID_CheckIDRequest
Return values
bool —fromMessage()
public
static fromMessage(Auth_OpenID_Message $message, Auth_OpenID_Server $server) : Auth_OpenID_CheckIDRequest|Auth_OpenID_MalformedReturnURL|Auth_OpenID_ServerError|Auth_OpenID_UntrustedReturnURL
Parameters
- $message : Auth_OpenID_Message
- $server : Auth_OpenID_Server
Return values
Auth_OpenID_CheckIDRequest|Auth_OpenID_MalformedReturnURL|Auth_OpenID_ServerError|Auth_OpenID_UntrustedReturnURL —getCancelURL()
public
getCancelURL() : mixed
Return values
mixed —idSelect()
public
idSelect() : mixed
Return values
mixed —make()
public
static make(Auth_OpenID_Message $message, string $identity, string $return_to[, string $trust_root = null ][, bool $immediate = false ][, string $assoc_handle = null ][, Auth_OpenID_Server $server = null ]) : Auth_OpenID_CheckIDRequest|Auth_OpenID_MalformedReturnURL|Auth_OpenID_ServerError|Auth_OpenID_UntrustedReturnURL
Parameters
- $message : Auth_OpenID_Message
- $identity : string
- $return_to : string
- $trust_root : string = null
- $immediate : bool = false
- $assoc_handle : string = null
- $server : Auth_OpenID_Server = null
Return values
Auth_OpenID_CheckIDRequest|Auth_OpenID_MalformedReturnURL|Auth_OpenID_ServerError|Auth_OpenID_UntrustedReturnURL —returnToVerified()
public
returnToVerified() : mixed
Return values
mixed —trustRootValid()
public
trustRootValid() : mixed