Class Auth_OpenID_CheckIDRequest

A request to confirm the identity of a user.

Auth_OpenID_CheckIDRequest

Package: OpenID
Copyright: 2005-2008 Janrain, Inc.
License: Apache
Author: JanRain, Inc. openid@janrain.com
Located at zp-extensions/federated_logon/Auth/OpenID/Server.php

Methods summary
`public static`	# `make( $message, $identity, $return_to, $trust_root = null, $immediate = false, $assoc_handle = null, $server = null )`
`public`	# `Auth_OpenID_CheckIDRequest( $identity, $return_to, $trust_root = null, $immediate = false, $assoc_handle = null, $server = null, $claimed_id = null )`
`public`	# `equals( $other )`
`public`	# `returnToVerified( )`
`public static`	# `fromMessage( $message, $server )`
`public`	# `idSelect( )`
`public`	# `trustRootValid( )`
`public mixed`	# `answer( boolean $allow, string $server_url = null, string $identity = null, string $claimed_id = null )` Respond to this request. Return either an `Auth_OpenID_ServerResponse` or `Auth_OpenID_ServerError`. Respond to this request. Return either an `Auth_OpenID_ServerResponse` or `Auth_OpenID_ServerError`. Parameters `$allow` Allow this user to claim this identity, and allow the consumer to have this information? `$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 `Auth_OpenID_CheckIDRequest::$immediate` is false or $allow is true. `$identity` The OP-local identifier to answer with. Only for use when the relying party requested identifier selection. `$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
`public`	# `encodeToURL( $server_url )`
`public`	# `getCancelURL( )`

Properties summary
`public string`	`$verifyReturnTo` Return-to verification callback. Default is Auth_OpenID_verifyReturnTo from TrustRoot.php. Return-to verification callback. Default is Auth_OpenID_verifyReturnTo from TrustRoot.php.	# `'Auth_OpenID_verifyReturnTo'`
`public string`	`$mode` The mode of this request. The mode of this request.	# `"checkid_setup"`
`public boolean`	`$immediate` Whether this request is for immediate mode. Whether this request is for immediate mode.	# `false`
`public`	`$trust_root` The trust_root value for this request. The trust_root value for this request.	# `null`
`public`	`$namespace` The OpenID namespace for this request. deprecated since version 2.0.2 The OpenID namespace for this request. deprecated since version 2.0.2	#

Packages

Classes

Functions

Class Auth_OpenID_CheckIDRequest

Parameters

Returns