PHPXRef 0.7.1 : Joomla 1.5.25 : Detail view of Interface.php

This file specifies the interface for PHP OpenID store implementations. PHP versions 4 and 5

Author:	JanRain, Inc. <openid@janrain.com>
Copyright:	2005-2008 Janrain, Inc.
License:	http://www.apache.org/licenses/LICENSE-2.0 Apache
File Size:	200 lines (7 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

Auth_OpenID_OpenIDStore:: (9 methods):
  storeAssociation()
  cleanupNonces()
  cleanupAssociations()
  cleanup()
  supportsCleanup()
  getAssociation()
  removeAssociation()
  useNonce()
  reset()

Class: Auth_OpenID_OpenIDStore - X-Ref

This is the interface for the store objects the OpenID library
uses. It is a single class that provides all of the persistence
mechanisms that the OpenID library needs, for both servers and
consumers. If you want to create an SQL-driven store, please see
then {@link Auth_OpenID_SQLStore} class.

Change: Version 2.0 removed the storeNonce, getAuthKey, and isDumb
methods, and changed the behavior of the useNonce method to support
one-way nonces.

storeAssociation($server_url, $association) X-Ref

This method puts an Association object into storage,
retrievable by server URL and handle.

param: string $server_url The URL of the identity server that
param: Association $association The Association to store.

cleanupNonces() X-Ref

No description

cleanupAssociations() X-Ref

No description

cleanup() X-Ref

No description

supportsCleanup() X-Ref

Report whether this storage supports cleanup

getAssociation($server_url, $handle = null) X-Ref

This method returns an Association object from storage that
matches the server URL and, if specified, handle. It returns
null if no such association is found or if the matching
association is expired.

If no handle is specified, the store may return any association
which matches the server URL. If multiple associations are
valid, the recommended return value for this method is the one
most recently issued.

This method is allowed (and encouraged) to garbage collect
expired associations when found. This method must not return
expired associations.

param: string $server_url The URL of the identity server to get
param: mixed $handle This optional parameter is the handle of
return: Association The Association for the given identity

removeAssociation($server_url, $handle) X-Ref

This method removes the matching association if it's found, and
returns whether the association was removed or not.

param: string $server_url The URL of the identity server the
param: string $handle This is the handle of the association to
return: mixed Returns whether or not the given association existed.

useNonce($server_url, $timestamp, $salt) X-Ref

Called when using a nonce.

This method should return C{True} if the nonce has not been
used before, and store it for a while to make sure nobody
tries to use the same value again.  If the nonce has already
been used, return C{False}.

Change: In earlier versions, round-trip nonces were used and a
nonce was only valid if it had been previously stored with
storeNonce.  Version 2.0 uses one-way nonces, requiring a
different implementation here that does not depend on a
storeNonce call.  (storeNonce is no longer part of the
interface.

param: string $nonce The nonce to use.
return: bool Whether or not the nonce was valid.

reset() X-Ref

Removes all entries from the store; implementation is optional.

PHP Cross Reference of Joomla 1.5.25

/libraries/openid/Auth/OpenID/ -> Interface.php (summary)

Defines 1 class