Auth_OpenID_CheckIDRequest Class Reference

Inheritance diagram for Auth_OpenID_CheckIDRequest:

[legend]

Collaboration diagram for Auth_OpenID_CheckIDRequest:

[legend]

List of all members.

---

Detailed Description

A request to confirm the identity of a user.

Definition at line 709 of file Server.php.

Public Member Functions
	make (&$message, $identity, $return_to, $trust_root=null, $immediate=false, $assoc_handle=null, $server=null)
	Auth_OpenID_CheckIDRequest ($identity, $return_to, $trust_root=null, $immediate=false, $assoc_handle=null, $server=null, $claimed_id=null)
	equals ($other)
	returnToVerified ()
	fromMessage (&$message, $server)
	idSelect ()
	trustRootValid ()
	answer ($allow, $server_url=null, $identity=null, $claimed_id=null)
	encodeToURL ($server_url)
	getCancelURL ()
Public Attributes
	$verifyReturnTo = 'Auth_OpenID_verifyReturnTo'
	$mode = "checkid_setup"
	$immediate = false
	$trust_root = null
	$namespace

---

Member Function Documentation

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

Definition at line 737 of file Server.php.

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.

Auth_OpenID_CheckIDRequest.equals

(

$

other

)

Definition at line 792 of file Server.php.

Auth_OpenID_CheckIDRequest.returnToVerified

(

)

Definition at line 818 of file Server.php.

Auth_OpenID_CheckIDRequest.fromMessage	(	&$	message,
		$	server
	)

Definition at line 824 of file Server.php.

Auth_OpenID_CheckIDRequest.idSelect

(

)

Definition at line 907 of file Server.php.

Auth_OpenID_CheckIDRequest.trustRootValid

(

)

Definition at line 914 of file Server.php.

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 immediateisfalseor$allowistrue.@paramstring$identityTheOP-localidentifiertoanswerwith.Onlyforusewhentherelyingpartyrequestedidentifierselection.@paramstring$claimed_idTheclaimedidentifiertoanswerwith,forusewithidentifierselectioninthecasewheretheclaimedidentifierandtheOP-localidentifierdiffer,i.e.whentheclaimed_idusesdelegation.If$identityisprovidedbutthisisnot,$claimed_idwilldefaulttothevalueof$identity.Whenansweringrequeststhatdidnotaskforidentifierselection,theresponse$claimed_idwilldefaulttothatoftherequest.ThisparameterisnewinOpenID2.0.@returnmixed

Definition at line 973 of file Server.php.

Auth_OpenID_CheckIDRequest.encodeToURL

(

$

server_url

)

Definition at line 1125 of file Server.php.

Auth_OpenID_CheckIDRequest.getCancelURL

(

)

Definition at line 1159 of file Server.php.

---

Member Data Documentation

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.

Auth_OpenID_CheckIDRequest.$mode = "checkid_setup"

The mode of this request.

Reimplemented from Auth_OpenID_Request.

Definition at line 719 of file Server.php.

Auth_OpenID_CheckIDRequest.$immediate = false

Whether this request is for immediate mode.

Definition at line 724 of file Server.php.

Auth_OpenID_CheckIDRequest.$trust_root = null

The trust_root value for this request.

Definition at line 729 of file Server.php.

Auth_OpenID_CheckIDRequest.$namespace

The OpenID namespace for this request. deprecated since version 2.0.2

Definition at line 735 of file Server.php.

---

The documentation for this class was generated from the following file:

• core/openid/Auth/OpenID/Server.php