Auth_OpenID_Consumer
An OpenID consumer implementation that performs discovery and does session management. See the Consumer.php file documentation for more information.
Located in /openid/Auth/OpenID/Consumer.php (line 222)
Auth_OpenID_Consumer
Initialize a Consumer instance.
You should create a new instance of the Consumer object with every HTTP request that handles OpenID transactions.
- 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.
- mixed $session: session An object which implements the interface of the Services_Yadis_Session class. Particularly, this object is expected to have these methods: get($key), set($key, $value), and del($key). This defaults to a session object which wraps PHP's native session machinery. You should only need to pass something here if you have your own sessioning implementation.
- &$store
Start the OpenID authentication process. See steps 1-2 in the overview at the top of this file.
- User_url: $user_url: Identity URL given by the user. This method performs a textual transformation of the URL to try and make sure it is normalized. For example, a user_url of example.com will be normalized to http://example.com/ normalizing and resolving any redirects the server might issue.
Start OpenID verification without doing OpenID server
discovery. This method is used internally by Consumer.begin after discovery is performed, and exists to provide an interface for library users needing to perform their own discovery.
- Auth_OpenID_ServiceEndpoint $endpoint: an OpenID service endpoint descriptor.
Called to interpret the server's response to an OpenID request. It is called in step 4 of the flow described in the consumer overview.
- array $query: An array of the query parameters (key => value pairs) for this HTTP request.
Documentation generated on Mon, 05 Mar 2007 20:55:27 +0000 by phpDocumentor 1.3.1