Référence de la classe Auth_OpenID_OpenIDStore

Graphe d'héritage de Auth_OpenID_OpenIDStore:

Liste de tous les membres

Fonctions membres publiques

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

---

Documentation des fonctions membres

Auth_OpenID_OpenIDStore::cleanup

(

)

Auth_OpenID_OpenIDStore::cleanupAssociations

(

)

Réimplémentée dans Auth_OpenID_FileStore, et Auth_OpenID_SQLStore.

Auth_OpenID_OpenIDStore::cleanupNonces

(

)

Réimplémentée dans Auth_OpenID_FileStore, et Auth_OpenID_SQLStore.

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.

Paramètres:

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.

Renvoie:

Association The Association for the given identity server.

Réimplémentée dans Auth_OpenID_DumbStore, Auth_OpenID_FileStore, Auth_OpenID_MemcachedStore, et Auth_OpenID_SQLStore.

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.

Paramètres:

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.

Renvoie:

mixed Returns whether or not the given association existed.

Réimplémentée dans Auth_OpenID_DumbStore, Auth_OpenID_FileStore, Auth_OpenID_MemcachedStore, et Auth_OpenID_SQLStore.

Auth_OpenID_OpenIDStore::reset

(

)

Removes all entries from the store; implementation is optional.

Réimplémentée dans Auth_OpenID_SQLStore.

Auth_OpenID_OpenIDStore::storeAssociation	(	$	server_url,
		$	association
	)

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

Paramètres:

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.

Réimplémentée dans Auth_OpenID_DumbStore, Auth_OpenID_FileStore, Auth_OpenID_MemcachedStore, et Auth_OpenID_SQLStore.

Auth_OpenID_OpenIDStore::supportsCleanup

(

)

Report whether this storage supports cleanup

Réimplémentée dans Auth_OpenID_MemcachedStore.

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.

Paramètres:

string

$nonce

The nonce to use.

Renvoie:

bool Whether or not the nonce was valid.

Réimplémentée dans Auth_OpenID_DumbStore, Auth_OpenID_FileStore, Auth_OpenID_MemcachedStore, et Auth_OpenID_SQLStore.

---

La documentation de cette classe a été générée à partir du fichier suivant :

• Interface.php