Docs for class Auth_OpenID

Auth_OpenID_AuthRequest

Description

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

 Auth_OpenID_AuthRequest

Method Summary

Auth_OpenID_AuthRequest Auth_OpenID_AuthRequest ( $assoc, $endpoint)

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

string redirectURL (string $trust_root, string$ $return_to, [ $immediate = false])

Methods

Constructor Auth_OpenID_AuthRequest (line 944)

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 ( $assoc, $endpoint)

addExtensionArg (line 971)

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.

redirectURL (line 990)

Compute the appropriate redirection URL for this request based on a specified trust root and return-to.

string redirectURL (string $trust_root, string$ $return_to, [ $immediate = false])

string $trust_root: The trust root URI for your application.
string$ $return_to: The return-to URL to be used when the OpenID server redirects the user back to your site.
$immediate

Documentation generated on Mon, 05 Mar 2007 20:55:26 +0000 by phpDocumentor 1.3.1