Auth_OpenID_OpenIDStore Class Reference

Inheritance diagram for Auth_OpenID_OpenIDStore:

Public Member Functions
	storeAssociation ($server_url, $association)
	cleanupNonces ()
	cleanupAssociations ()
	cleanup ()
	supportsCleanup ()
	getAssociation ($server_url, $handle=null)
	removeAssociation ($server_url, $handle)
	useNonce ($server_url, $timestamp, $salt)
	reset ()

Detailed Description

Definition at line 30 of file Interface.php.

Member Function Documentation

cleanup()

Auth_OpenID_OpenIDStore::cleanup

(

)

Definition at line 90 of file Interface.php.

References cleanupAssociations(), and cleanupNonces().

cleanupAssociations()

Auth_OpenID_OpenIDStore::cleanupAssociations

(

)

Definition at line 77 of file Interface.php.

References E_USER_ERROR.

Referenced by cleanup().

cleanupNonces()

Auth_OpenID_OpenIDStore::cleanupNonces

(

)

Definition at line 62 of file Interface.php.

References E_USER_ERROR.

Referenced by cleanup().

getAssociation()

Auth_OpenID_OpenIDStore::getAssociation	(		$server_url,
			$handle = null
	)

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.

Parameters

string	$server_url	The URL of the identity server to get the association for. Because of the way the server portion of the library uses this interface, don't assume there are any limitations on the character set of the input string. In particular, expect to see unescaped non-url-safe characters in the server_url field.
mixed	$handle	This optional parameter is the handle of the specific association to get. If no specific handle is provided, any valid association matching the server URL is returned.

Returns

Association The Association for the given identity server.

Definition at line 134 of file Interface.php.

References E_USER_ERROR.

removeAssociation()

Auth_OpenID_OpenIDStore::removeAssociation	(		$server_url,
			$handle
	)

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

Parameters

string	$server_url	The URL of the identity server the association to remove belongs to. Because of the way the server portion of the library uses this interface, don't assume there are any limitations on the character set of the input string. In particular, expect to see unescaped non-url-safe characters in the server_url field.
string	$handle	This is the handle of the association to remove. If there isn't an association found that matches both the given URL and handle, then there was no matching handle found.

Returns

mixed Returns whether or not the given association existed.

Definition at line 158 of file Interface.php.

References E_USER_ERROR.

reset()

Auth_OpenID_OpenIDStore::reset

(

)

Removes all entries from the store; implementation is optional.

Definition at line 192 of file Interface.php.

storeAssociation()

Auth_OpenID_OpenIDStore::storeAssociation	(		$server_url,
			$association
	)

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

Parameters

string	$server_url	The URL of the identity server that this association is with. Because of the way the server portion of the library uses this interface, don't assume there are any limitations on the character set of the input string. In particular, expect to see unescaped non-url-safe characters in the server_url field.
Association	$association	The Association to store.

Definition at line 44 of file Interface.php.

References E_USER_ERROR.

supportsCleanup()

Auth_OpenID_OpenIDStore::supportsCleanup

(

)

Report whether this storage supports cleanup

Definition at line 99 of file Interface.php.

useNonce()

Auth_OpenID_OpenIDStore::useNonce	(		$server_url,
			$timestamp,
			$salt
	)

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.

Parameters

string

$nonce

The nonce to use.

Returns

bool Whether or not the nonce was valid.

Definition at line 183 of file Interface.php.

References E_USER_ERROR.