Auth_OpenID_CheckIDRequest Class Reference

Inheritance diagram for Auth_OpenID_CheckIDRequest:

Public Member Functions
	Auth_OpenID_CheckIDRequest ($identity, $return_to, $trust_root=null, $immediate=false, $assoc_handle=null, $server=null, $claimed_id=null)
	equals ($other)
	returnToVerified ()
	idSelect ()
	trustRootValid ()
	answer ($allow, $server_url=null, $identity=null, $claimed_id=null)
	encodeToURL ($server_url)
	getCancelURL ()

Static Public Member Functions
static	make ($message, $identity, $return_to, $trust_root=null, $immediate=false, $assoc_handle=null, $server=null)
static	fromMessage ($message, $server)

Public Attributes
	$verifyReturnTo = 'Auth_OpenID_verifyReturnTo'
	$mode = "checkid_setup"
	$immediate = false
	$trust_root = null
	$namespace
Public Attributes inherited from Auth_OpenID_Request
	$mode = null

Detailed Description

Definition at line 709 of file Server.php.

Member Function Documentation

answer()

Auth_OpenID_CheckIDRequest::answer	(		$allow,
			$server_url = null,
			$identity = null,
			$claimed_id = null
	)

Respond to this request. Return either an Auth_OpenID_ServerResponse or Auth_OpenID_ServerError.

Parameters

bool	$allow	Allow this user to claim this identity, and allow the consumer to have this information?
string	$server_url	DEPRECATED. Passing $op_endpoint to the Auth_OpenID_Server 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.

Optional for requests where $immediate is false or $allow is true.

Parameters

string	$identity	The OP-local identifier to answer with. Only for use when the relying party requested identifier selection.
string	$claimed_id	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.

Returns

mixed

Definition at line 974 of file Server.php.

References Auth_OpenID_IDENTIFIER_SELECT, Auth_OpenID_mkNonce(), Auth_OpenID_OPENID_NS, and Auth_OpenID_ServerError\Auth_OpenID_ServerError().

Auth_OpenID_CheckIDRequest()

Auth_OpenID_CheckIDRequest::Auth_OpenID_CheckIDRequest	(		$identity,
			$return_to,
			$trust_root = null,
			$immediate = false,
			$assoc_handle = null,
			$server = null,
			$claimed_id = null
	)

Definition at line 766 of file Server.php.

References Auth_OpenID_OPENID2_NS.

encodeToURL()

Auth_OpenID_CheckIDRequest::encodeToURL

(

$server_url

)

Definition at line 1126 of file Server.php.

References Auth_OpenID_OPENID_NS, and Auth_OpenID_Message\updateArgs().

equals()

Auth_OpenID_CheckIDRequest::equals

(

$other

)

Definition at line 792 of file Server.php.

fromMessage()

static Auth_OpenID_CheckIDRequest::fromMessage (   $message,   $server  )

static

Definition at line 825 of file Server.php.

References Auth_OpenID_OPENID_NS, Auth_OpenID_ServerError\Auth_OpenID_ServerError(), and make().

getCancelURL()

Auth_OpenID_CheckIDRequest::getCancelURL

(

)

Definition at line 1160 of file Server.php.

References Auth_OpenID_OPENID_NS, Auth_OpenID_ServerError\Auth_OpenID_ServerError(), and Auth_OpenID_Message\setArg().

idSelect()

Auth_OpenID_CheckIDRequest::idSelect

(

)

Definition at line 908 of file Server.php.

References Auth_OpenID_IDENTIFIER_SELECT.

make()

static Auth_OpenID_CheckIDRequest::make (   $message,   $identity,   $return_to,   $trust_root = null,   $immediate = false,   $assoc_handle = null,   $server = null  )

static

Definition at line 737 of file Server.php.

References Auth_OpenID_TrustRoot\_parse(), and Auth_OpenID_ServerError\Auth_OpenID_ServerError().

Referenced by fromMessage().

returnToVerified()

Auth_OpenID_CheckIDRequest::returnToVerified

(

)

Definition at line 818 of file Server.php.

References Auth_Yadis_Yadis\getHTTPFetcher().

trustRootValid()

Auth_OpenID_CheckIDRequest::trustRootValid

(

)

Definition at line 915 of file Server.php.

References Auth_OpenID_TrustRoot\_parse(), and Auth_OpenID_TrustRoot\match().

Member Data Documentation

$immediate

Auth_OpenID_CheckIDRequest::$immediate = false

Whether this request is for immediate mode.

Definition at line 724 of file Server.php.

$mode

Auth_OpenID_CheckIDRequest::$mode = "checkid_setup"

The mode of this request.

Definition at line 719 of file Server.php.

$namespace

Auth_OpenID_CheckIDRequest::$namespace

The OpenID namespace for this request. deprecated since version 2.0.2

Definition at line 735 of file Server.php.

$trust_root

Auth_OpenID_CheckIDRequest::$trust_root = null

The trust_root value for this request.

Definition at line 729 of file Server.php.

$verifyReturnTo

Auth_OpenID_CheckIDRequest::$verifyReturnTo = 'Auth_OpenID_verifyReturnTo'

Return-to verification callback. Default is Auth_OpenID_verifyReturnTo from TrustRoot.php.

Definition at line 714 of file Server.php.