Class 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 /Auth/OpenID/Consumer.php (line 215)

Method Summary
 Auth_OpenID_Consumer Auth_OpenID_Consumer (Auth_OpenID_OpenIDStore $store, [mixed $session = null], [str $consumer_cls = null])
 Auth_OpenID_AuthRequest begin (string $user_url, [bool $anonymous = false])
 Auth_OpenID_ConsumerResponse complete (string $current_url, [array $query = null])
Constructor Auth_OpenID_Consumer (line 261)

Initialize a Consumer instance.

You should create a new instance of the Consumer object with every HTTP request that handles OpenID transactions.

Auth_OpenID_Consumer Auth_OpenID_Consumer (Auth_OpenID_OpenIDStore $store, [mixed $session = null], [str $consumer_cls = null])
  • 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: An object which implements the interface of the Auth_Yadis_PHPSession 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.
  • str $consumer_cls: The name of the class to instantiate when creating the internal consumer object. This is used for testing.
begin (line 313)

Start the OpenID authentication process. See steps 1-2 in the overview at the top of this file.

  • return: An object containing the discovered information will be returned, with a method for building a redirect URL to the server, as described in step 3 of the overview. This object may also be used to add extension arguments to the request, using its 'addExtensionArg' method.
Auth_OpenID_AuthRequest begin (string $user_url, [bool $anonymous = false])
  • string $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 will be normalized to normalizing and resolving any redirects the server might issue.
  • bool $anonymous: True if the OpenID request is to be sent to the server without any identifier information. Use this when you want to transport data but don't want to do OpenID authentication with identifiers.
beginWithoutDiscovery (line 373)

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.

  • return: An OpenID authentication request object.
Auth_OpenID_AuthRequest beginWithoutDiscovery (Auth_OpenID_ServiceEndpoint $endpoint, [bool $anonymous = false])
  • Auth_OpenID_ServiceEndpoint $endpoint: an OpenID service endpoint descriptor.
  • bool $anonymous: anonymous Set to true if you want to perform OpenID without identifiers.
complete (line 410)

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.

  • return: A instance of an Auth_OpenID_ConsumerResponse subclass. The type of response is indicated by the status attribute, which will be one of SUCCESS, CANCEL, FAILURE, or SETUP_NEEDED.
Auth_OpenID_ConsumerResponse complete (string $current_url, [array $query = null])
  • string $current_url: The URL used to invoke the application. Extract the URL from your application's web request framework and specify it here to have it checked against the openid.current_url value in the response. If the current_url URL check fails, the status of the completion will be FAILURE.
  • array $query: An array of the query parameters (key => value pairs) for this HTTP request. Defaults to null. If null, the GET or POST data are automatically gotten from the PHP environment. It is only useful to override $query for testing.

Documentation generated on Thu, 29 Jul 2010 13:58:33 -0700 by phpDocumentor 1.4.3