Graphe d'héritage de Auth_OpenID_SQLStore:

Graphe de collaboration de Auth_OpenID_SQLStore:

Fonctions membres publiques

Auth_OpenID_SQLStore ($connection, $associations_table=null, $nonces_table=null)
tableExists ($table_name)
isError ($value)
resultToBool ($obj)
setSQL ()
reset ()
_verifySQL ()
_fixSQL ()
blobDecode ($blob)
blobEncode ($str)
createTables ()
create_nonce_table ()
create_assoc_table ()
_set_assoc ($server_url, $handle, $secret, $issued, $lifetime, $assoc_type)
storeAssociation ($server_url, $association)
_get_assoc ($server_url, $handle)
_get_assocs ($server_url)
removeAssociation ($server_url, $handle)
getAssociation ($server_url, $handle=null)
_add_nonce ($server_url, $timestamp, $salt)
useNonce ($server_url, $timestamp, $salt)
_octify ($str)
_unoctify ($str)
cleanupNonces ()
cleanupAssociations ()

Documentation des fonctions membres

Auth_OpenID_SQLStore::_add_nonce	(	$	server_url,
		$	timestamp,
		$	salt
	)

private

Réimplémentée dans Auth_OpenID_SQLiteStore.

Auth_OpenID_SQLStore::_fixSQL ( )

private

Références $item, et $k.

Auth_OpenID_SQLStore::_get_assoc	(	$	server_url,
		$	handle
	)

private

Auth_OpenID_SQLStore::_get_assocs ( $ server_url )

private

Auth_OpenID_SQLStore::_octify ( $ str )

"Octifies" a binary string by returning a string with escaped octal bytes. This is used for preparing binary data for PostgreSQL BYTEA fields.

private

Références $i, et Auth_OpenID::bytes().

Voici le graphe d'appel pour cette fonction :

Auth_OpenID_SQLStore::_set_assoc	(	$	server_url,
		$	handle,
		$	secret,
		$	issued,
		$	lifetime,
		$	assoc_type
	)

private

Réimplémentée dans Auth_OpenID_PostgreSQLStore.

Auth_OpenID_SQLStore::_unoctify ( $ str )

"Unoctifies" octal-escaped data from PostgreSQL and returns the resulting ASCII (possibly binary) string.

private

Références $i.

Auth_OpenID_SQLStore::_verifySQL ( )

private

Auth_OpenID_SQLStore::Auth_OpenID_SQLStore	(	$	connection,
		$	associations_table = `null`,
		$	nonces_table = `null`
	)

This creates a new SQLStore instance. It requires an established database connection be given to it, and it allows overriding the default table names.

Paramètres:

connection	$connection	This must be an established connection to a database of the correct type for the SQLStore subclass you're using. This must either be an PEAR DB connection handle or an instance of a subclass of Auth_OpenID_DatabaseConnection.
	associations_table,:	This is an optional parameter to specify the name of the table used for storing associations. The default value is 'oid_associations'.
	nonces_table,:	This is an optional parameter to specify the name of the table used for storing nonces. The default value is 'oid_nonces'.

Références $__Auth_OpenID_PEAR_AVAILABLE.

Auth_OpenID_SQLStore::blobDecode ( $ blob )

Réimplémentée dans Auth_OpenID_PostgreSQLStore.

Auth_OpenID_SQLStore::blobEncode ( $ str )

Réimplémentée dans Auth_OpenID_MySQLStore, et Auth_OpenID_PostgreSQLStore.

Auth_OpenID_SQLStore::cleanupAssociations ( )

Réimplémentée à partir de Auth_OpenID_OpenIDStore.

Auth_OpenID_SQLStore::cleanupNonces ( )

Réimplémentée à partir de Auth_OpenID_OpenIDStore.

Références $Auth_OpenID_SKEW.

Auth_OpenID_SQLStore::create_assoc_table ( )

Auth_OpenID_SQLStore::create_nonce_table ( )

Auth_OpenID_SQLStore::createTables ( )

Références $n.

Auth_OpenID_SQLStore::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 à partir de Auth_OpenID_OpenIDStore.

Auth_OpenID_SQLStore::isError ( $ value )

Returns true if $value constitutes a database error; returns false otherwise.

Références PEAR::isError().

Voici le graphe d'appel pour cette fonction :

Auth_OpenID_SQLStore::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 à partir de Auth_OpenID_OpenIDStore.

Auth_OpenID_SQLStore::reset ( )

Resets the store by removing all records from the store's tables.

Réimplémentée à partir de Auth_OpenID_OpenIDStore.

Auth_OpenID_SQLStore::resultToBool ( $ obj )

Converts a query result to a boolean. If the result is a database error according to $this->isError(), this returns false; otherwise, this returns true.

Auth_OpenID_SQLStore::setSQL ( )

This method should be overridden by subclasses. This method is called by the constructor to set values in $this->sql, which is an array keyed on sql name.

Réimplémentée dans Auth_OpenID_MySQLStore, Auth_OpenID_PostgreSQLStore, et Auth_OpenID_SQLiteStore.

Auth_OpenID_SQLStore::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 à partir de Auth_OpenID_OpenIDStore.

Auth_OpenID_SQLStore::tableExists ( $ table_name )

Auth_OpenID_SQLStore::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 à partir de Auth_OpenID_OpenIDStore.

Références $Auth_OpenID_SKEW.

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

SQLStore.php

Référence de la classe Auth_OpenID_SQLStore

Fonctions membres publiques

Documentation des fonctions membres