

[ class tree: OpenID ] [ index: OpenID ] [ all elements ]

Class: Auth_OpenID_CheckIDRequest

Source Location: /zp-extensions/federated_logon/Auth/OpenID/Server.php

Class Auth_OpenID_CheckIDRequest

Class Overview

A request to confirm the identity of a user.

Located in /zp-extensions/federated_logon/Auth/OpenID/Server.php [line 709]

Auth_OpenID_Request
   |
   --Auth_OpenID_CheckIDRequest

Properties

Methods

[ Top ]

Property Summary

mixed	$immediate	Whether this request is for immediate mode.
mixed	$mode	The mode of this request.
mixed	$namespace	The OpenID namespace for this request.
mixed	$trust_root	The trust_root value for this request.
mixed	$verifyReturnTo	Return-to verification callback. Default is Auth_OpenID_verifyReturnTo from TrustRoot.php.

[ Top ]

Method Summary

static void	fromMessage()
static void	make()
Auth_OpenID_CheckIDRequest	Auth_OpenID_CheckIDRequest()
mixed	answer()	Respond to this request. Return either an Auth_OpenID_ServerResponse or Auth_OpenID_ServerError.
void	encodeToURL()
void	equals()
void	getCancelURL()
void	idSelect()
void	returnToVerified()
void	trustRootValid()

[ Top ]

Properties

mixed $immediate = false [line 724]

Whether this request is for immediate mode.

[ Top ]

mixed $mode = "checkid_setup" [line 719]

The mode of this request.

Redefinition of:

Auth_OpenID_Request::$mode

[ Top ]

mixed $namespace [line 735]

The OpenID namespace for this request.

deprecated since version 2.0.2

[ Top ]

mixed $trust_root = null [line 729]

The trust_root value for this request.

[ Top ]

mixed $verifyReturnTo = 'Auth_OpenID_verifyReturnTo' [line 714]

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

[ Top ]

Methods

static method fromMessage [line 825]

static void fromMessage(

$message, 
$server 
)

Parameters:

	$message:
	$server:

[ Top ]

static method make [line 737]

static void make(

$message, 
$identity, 
$return_to, [
$trust_root = null], [
$immediate = false], [
$assoc_handle = null], [
$server = null] 
)

Parameters:

	$message:
	$identity:
	$return_to:
	$trust_root:
	$immediate:
	$assoc_handle:
	$server:

[ Top ]

Constructor Auth_OpenID_CheckIDRequest [line 766]

Auth_OpenID_CheckIDRequest Auth_OpenID_CheckIDRequest(

$identity, 
$return_to, [
$trust_root = null], [
$immediate = false], [
$assoc_handle = null], [
$server = null], [
$claimed_id = null] 
)

Parameters:

	$identity:
	$return_to:
	$trust_root:
	$immediate:
	$assoc_handle:
	$server:
	$claimed_id:

[ Top ]

answer [line 974]

mixed answer(
bool
$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.

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.
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.

[ Top ]

encodeToURL [line 1126]

void encodeToURL(

$server_url 
)

Parameters:

$server_url:

[ Top ]

equals [line 792]

void equals(

$other 
)

Parameters:

$other:

[ Top ]

getCancelURL [line 1160]

void getCancelURL(
)

[ Top ]

idSelect [line 908]

void idSelect(
)

[ Top ]

returnToVerified [line 818]

void returnToVerified(
)

[ Top ]

trustRootValid [line 915]

void trustRootValid(
)

[ Top ]

OpenID

Packages:

core
admin
classes
functions
GoogleMapAPI
JSMin
OpenID
PHPMailer
plugins
Services_JSON

Files:

Classes:

Documentation generated on Tue, 20 Dec 2011 16:08:05 +0100 by phpDocumentor 1.4.3

RSS feeds!

Social networks

Join the Google Groups!

zenphoto-announce
Release announcements and security alerts only (no support)
Subscribe right here:

Email:
Zenphoto Translate
Support and discussion for translators only

Zenphoto

Class: Auth_OpenID_CheckIDRequest