Docs For Class OpenID_Auth

Description

Creates an OpenID authorization request of type "checkid_setup" or "checkid_immediate".

Example:

// First perform discovery on the user supplied identifier
$discover = new OpenID_Discover($identifier);
$discover->discover();
// Optionally get association (from cache in this example)
$opEndpointURL = array_shift($discover->services[0]->getURIs());
$assocHandle = OpenID::getStore()->getAssociation($opEndpointURL)->assocHandle;
// Now create the auth request object
$auth = new OpenID_Auth_Request($discover, // OpenID_Discover object
$returnTo, // openid.return_to
$realm, // openid.realm
$assocHandle); // openid.assoc_handle
// Optionally add an extension
$sreg = new OpenID_Extension_SREG11(OpenID_Extension::REQUEST);
$sreg->set('required', 'email');
$sreg->set('optional', 'nickname,gender,dob');
// Add it to an existing instance of OpenID_Auth_Request
$auth->addExtension($sreg);
// Optionally make this a checkid_immediate request
$auth->setMode(OpenID::MODE_CHECKID_IMMEDIATE);
// Send user to the OP
header('Location: ' . $auth->getAuthorizeURL());

author: Bill Shupp <hostmaster@shupp.org>
copyright: 2009 Bill Shupp
link: http://pearopenid.googlecode.com
license: FreeBSD

Located in /OpenID/Auth/Request.php (line 66)

Variable Summary

string $identifier

OpenID_Message $message

OpenID_Nonce $nonce

OpenID_ServiceEndpoint $serviceEndpoint

Method Summary

void __construct (OpenID_Discover $discover, string $returnTo, string $realm, [string $assocHandle = null])

void addExtension (OpenID_Extension $extension)

void addNonce ()

string getAuthorizeURL ()

string getMode ()

OpenID_Nonce getNonce ()

void setMode (mixed $mode)

void setNonce (OpenID_Nonce $nonce)

Variables

string $identifier = null (line 73)

The normalized identifier

access: protected

OpenID_Message $message = null (line 80)

The request message

access: protected

OpenID_Nonce $nonce = null (line 94)

Nonce class in case we are in 1.1 mode and need to embed it in the return_to

access: protected

OpenID_ServiceEndpoint $serviceEndpoint = null (line 87)

The OP Endpoint we are communicating with

access: protected

Methods

Constructor __construct (line 107)

Sets the basic information used in the message.

access: public

void __construct (OpenID_Discover $discover, string $returnTo, string $realm, [string $assocHandle = null])

OpenID_Discover $discover: Discover object
string $returnTo: The return_to URL
string $realm: The realm
string $assocHandle: The optional association handle

addExtension (line 139)

Adds an extension to the message.

access: public

void addExtension (OpenID_Extension $extension)

OpenID_Extension $extension: Extension instance

addNonce (line 246)

Adds a nonce to the openid.return_to URL parameter. Only used in OpenID 1.1

access: protected

void addNonce ()

getAuthorizeURL (line 183)

Gets the auth request message in a URL format suitable for redirection. The decision about whether to use directed identity or not id done here.

return: The URL to redirect the User-Agent to
access: public

string getAuthorizeURL ()

getMode (line 172)

Gets the current openid.mode value

access: public

string getMode ()

getNonce (line 233)

Gets the OpenID_Nonce instance if set, otherwise instantiates one.

access: protected

OpenID_Nonce getNonce ()

setMode (line 153)

Sets the openid.mode parameter. Can be either "checkid_setup" or "checkid_immediate"

throws: OpenID_Auth_Exception on an invalid mode
access: public

void setMode (mixed $mode)

mixed $mode: Value for 'openid.mode'

setNonce (line 223)

Sets the instance of OpenID_Nonce for use with 1.1 return_to nonces

access: public

void setNonce (OpenID_Nonce $nonce)

OpenID_Nonce $nonce: Custom instance of OpenID_Nonce

Class OpenID_Auth_Request