Auth_OpenID_AuthRequest Class Reference

Public Member Functions
	Auth_OpenID_AuthRequest ($endpoint, $assoc)
	addExtension ($extension_request)
	addExtensionArg ($namespace, $key, $value)
	setAnonymous ($is_anonymous)
	getMessage ($realm, $return_to=null, $immediate=false)
	redirectURL ($realm, $return_to=null, $immediate=false)
	formMarkup ($realm, $return_to=null, $immediate=false, $form_tag_attrs=null)
	htmlMarkup ($realm, $return_to=null, $immediate=false, $form_tag_attrs=null)
	shouldSendRedirect ()

Detailed Description

Definition at line 1750 of file Consumer.php.

Member Function Documentation

addExtension()

Auth_OpenID_AuthRequest::addExtension

(

$extension_request

)

Add an extension to this checkid request.

$extension_request: An object that implements the extension request interface for adding arguments to an OpenID message.

Definition at line 1776 of file Consumer.php.

addExtensionArg()

Auth_OpenID_AuthRequest::addExtensionArg	(		$namespace,
			$key,
			$value
	)

Add an extension argument to this OpenID authentication request.

Use caution when adding arguments, because they will be URL-escaped and appended to the redirect URL, which can easily get quite long.

Parameters

string	$namespace	The namespace for the extension. For example, the simple registration extension uses the namespace 'sreg'.
string	$key	The key within the extension namespace. For example, the nickname field in the simple registration extension's key is 'nickname'.
string	$value	The value to provide to the server for this argument.

Definition at line 1800 of file Consumer.php.

Auth_OpenID_AuthRequest()

Auth_OpenID_AuthRequest::Auth_OpenID_AuthRequest	(		$endpoint,
			$assoc
	)

Initialize an authentication request with the specified token, association, and endpoint.

Users of this library should not create instances of this class. Instances of this class are created by the library when needed.

Definition at line 1760 of file Consumer.php.

formMarkup()

Auth_OpenID_AuthRequest::formMarkup	(		$realm,
			$return_to = null,
			$immediate = false,
			$form_tag_attrs = null
	)

Get html for a form to submit this request to the IDP.

form_tag_attrs: An array of attributes to be added to the form tag. 'accept-charset' and 'enctype' have defaults that can be overridden. If a value is supplied for 'action' or 'method', it will be replaced.

Definition at line 1937 of file Consumer.php.

References Auth_OpenID\isFailure().

getMessage()

Auth_OpenID_AuthRequest::getMessage	(		$realm,
			$return_to = null,
			$immediate = false
	)

Produce a Auth_OpenID_Message representing this request.

Parameters

string	$realm	The URL (or URL pattern) that identifies your web site to the user when she is authorizing it.
string	$return_to	The URL that the OpenID provider will send the user back to after attempting to verify her identity.

Not specifying a return_to URL means that the user will not be returned to the site issuing the request upon its completion.

Parameters

bool

$immediate

If true, the OpenID provider is to send back a response immediately, useful for behind-the-scenes authentication attempts. Otherwise the OpenID provider may engage the user before providing a response. This is the default case, as the user may need to provide credentials or approve the request before a positive response can be sent.

Definition at line 1844 of file Consumer.php.

References Auth_OpenID\appendArgs(), Auth_OpenID_IDENTIFIER_SELECT, Auth_OpenID_OPENID2_NS, and Auth_OpenID_OPENID_NS.

htmlMarkup()

Auth_OpenID_AuthRequest::htmlMarkup	(		$realm,
			$return_to = null,
			$immediate = false,
			$form_tag_attrs = null
	)

Get a complete html document that will autosubmit the request to the IDP.

Wraps formMarkup. See the documentation for that function.

Definition at line 1956 of file Consumer.php.

References Auth_OpenID\autoSubmitHTML(), and Auth_OpenID\isFailure().

redirectURL()

Auth_OpenID_AuthRequest::redirectURL	(		$realm,
			$return_to = null,
			$immediate = false
	)

Definition at line 1917 of file Consumer.php.

References Auth_OpenID\isFailure().

setAnonymous()

Auth_OpenID_AuthRequest::setAnonymous

(

$is_anonymous

)

Set whether this request should be made anonymously. If a request is anonymous, the identifier will not be sent in the request. This is only useful if you are making another kind of request with an extension in this request.

Anonymous requests are not allowed when the request is made with OpenID 1.

Definition at line 1814 of file Consumer.php.

shouldSendRedirect()

Auth_OpenID_AuthRequest::shouldSendRedirect

(

)

Definition at line 1968 of file Consumer.php.