## Class Auth_OpenID_AuthRequest

Description

This class represents an authentication request from a consumer to an OpenID server.

Located in /Auth/OpenID/Consumer.php (line 1741)

Method Summary
Auth_OpenID_AuthRequest Auth_OpenID_AuthRequest ( &$endpoint, $assoc)
void addExtension ( &$extension_request)
void addExtensionArg (string $namespace, string $key, string $value)
void formMarkup ( $realm, [ $return_to = null], [ $immediate = false], [ $form_tag_attrs = null])
void getMessage (string $realm, [string $return_to = null], [bool $immediate = false])
void htmlMarkup ( $realm, [ $return_to = null], [ $immediate = false], [ $form_tag_attrs = null])
void redirectURL ( $realm, [ $return_to = null], [ $immediate = false])
void setAnonymous ( $is_anonymous)
void shouldSendRedirect ()
Methods
Constructor Auth_OpenID_AuthRequest (line 1751)

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.

Auth_OpenID_AuthRequest Auth_OpenID_AuthRequest ( &$endpoint, $assoc)

- &$endpoint
- $assoc

addExtension (line 1767)

Add an extension to this checkid request.

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

void addExtension ( &$extension_request)

- &$extension_request

addExtensionArg (line 1791)

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.

void addExtensionArg (string $namespace, string $key, string $value)

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

formMarkup (line 1928)

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.

void formMarkup ( $realm, [ $return_to = null], [ $immediate = false], [ $form_tag_attrs = null])

- $realm
- $return_to
- $immediate
- $form_tag_attrs

getMessage (line 1835)

Produce a Auth_OpenID_Message representing this request.

void getMessage (string $realm, [string $return_to = null], [bool $immediate = false])

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

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

htmlMarkup (line 1947)

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

Wraps formMarkup. See the documentation for that function.

void htmlMarkup ( $realm, [ $return_to = null], [ $immediate = false], [ $form_tag_attrs = null])

- $realm
- $return_to
- $immediate
- $form_tag_attrs

redirectURL (line 1908)
void redirectURL ( $realm, [ $return_to = null], [ $immediate = false])

- $realm
- $return_to
- $immediate

setAnonymous (line 1805)

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.

void setAnonymous ( $is_anonymous)

- $is_anonymous

shouldSendRedirect (line 1959)
void shouldSendRedirect ()

Documentation generated on Tue, 21 Apr 2009 11:31:30 -0700 by phpDocumentor 1.3.2