[ class tree: OpenID ] [ index: OpenID ] [ all elements ]

Class: Auth_OpenID_GenericConsumer

Source Location: /zp-extensions/federated_logon/Auth/OpenID/Consumer.php

Class Auth_OpenID_GenericConsumer

Class Overview

This class is the interface to the OpenID consumer logic.

Instances of it maintain no per-request state, so they can be reused (or even used by multiple threads concurrently) as needed.

Located in /zp-extensions/federated_logon/Auth/OpenID/Consumer.php [line 568]



		
		
		
		

Properties

Methods

[ Top ]
Property Summary
mixed   $openid1_return_to_identifier_name   Another query parameter that gets added to the return_to for OpenID 1; if the user's session state is lost, use this claimed identifier to do discovery when verifying the response.
mixed   $store   This consumer's store object.

[ Top ]
Method Summary
Auth_OpenID_GenericConsumer   Auth_OpenID_GenericConsumer()   This method initializes a new Auth_OpenID_Consumer instance to access the library.

[ Top ]
Properties
mixed   $openid1_return_to_identifier_name = 'openid1_claimed_id' [line 594]

Another query parameter that gets added to the return_to for OpenID 1; if the user's session state is lost, use this claimed identifier to do discovery when verifying the response.


[ Top ]
mixed   $store [line 577]

This consumer's store object.


[ Top ]
Methods
Constructor Auth_OpenID_GenericConsumer  [line 614]

  Auth_OpenID_GenericConsumer Auth_OpenID_GenericConsumer( Auth_OpenID_OpenIDStore $store, bool $immediate  )

This method initializes a new Auth_OpenID_Consumer instance to access the library.

Parameters:
Auth_OpenID_OpenIDStore   $store:  This must be an object that implements the interface in Auth_OpenID_OpenIDStore. Several concrete implementations are provided, to cover most common use cases. For stores backed by MySQL, PostgreSQL, or SQLite, see the Auth_OpenID_SQLStore class and its sublcasses. For a filesystem-backed store, see the Auth_OpenID_FileStore module. As a last resort, if it isn't possible for the server to store state at all, an instance of Auth_OpenID_DumbStore can be used.
bool   $immediate:  This is an optional boolean value. It controls whether the library uses immediate mode, as explained in the module description. The default value is False, which disables immediate mode.


[ Top ]

Documentation generated on Tue, 20 Dec 2011 16:07:06 +0100 by phpDocumentor 1.4.3