PHP Class Auth_OpenID_AuthRequest

Mostrar archivo Open project: openid/php-openid Class Usage Examples

Public Methods

Method	Description
__construct ( $endpoint, $assoc )	Initialize an authentication request with the specified token, association, and endpoint.
addExtension ( $extension_request )	Add an extension to this checkid request.
addExtensionArg ( string $namespace, string $key, string $value )	Add an extension argument to this OpenID authentication request.
formMarkup ( $realm, $return_to = null, $immediate = false, $form_tag_attrs = null )	Get html for a form to submit this request to the IDP.
getMessage ( string $realm, string $return_to = null, boolean $immediate = false )	Produce a {@link Auth_OpenID_Message} representing this request.
htmlMarkup ( $realm, $return_to = null, $immediate = false, $form_tag_attrs = null )	Get a complete html document that will autosubmit the request to the IDP.
redirectURL ( $realm, $return_to = null, $immediate = false )
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.
shouldSendRedirect ( )

Method Details

__construct() public method

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

public __construct ( $endpoint, $assoc )

addExtension() public method

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

public addExtension ( $extension_request )

addExtensionArg() public method

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

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

formMarkup() public method

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.

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

getMessage() public method

Produce a {@link Auth_OpenID_Message} representing this request.

public getMessage ( string $realm, string $return_to = null, boolean $immediate = false )
$realm	string	The URL (or URL pattern) that identifies your web site to the user when she is authorizing it.
$return_to	string	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.
$immediate	boolean	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() public method

Wraps formMarkup. See the documentation for that function.

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

redirectURL() public method

public redirectURL ( $realm, $return_to = null, $immediate = false )

setAnonymous() public method

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

public setAnonymous ( $is_anonymous )

shouldSendRedirect() public method

public shouldSendRedirect ( )