Docs For Class Auth_OpenID

Auth_OpenID_MDB2Store

Description

This store uses a PEAR::MDB2 connection to store persistence information.

The table names used are determined by the class variables associations_table_name and nonces_table_name. To change the name of the tables used, pass new table names into the constructor.

To create the tables with the proper schema, see the createTables method.

author: JanRain, Inc. <openid@janrain.com>

Located in /Auth/OpenID/MDB2Store.php (line 46)

Auth_OpenID_OpenIDStore
   |
   --Auth_OpenID_MDB2Store

Method Summary

Auth_OpenID_MDB2Store Auth_OpenID_MDB2Store (connection $connection, [associations_table: $associations_table = null], [nonces_table: $nonces_table = null])

void cleanupAssociations ()

void cleanupNonces ()

void createTables ()

void create_assoc_table ()

void create_nonce_table ()

void getAssociation ( $server_url, [ $handle = null])

void removeAssociation ( $server_url, $handle)

void reset ()

void storeAssociation ( $server_url, $association)

void tableExists ( $table_name)

void useNonce ( $server_url, $timestamp, $salt)

Methods

Constructor Auth_OpenID_MDB2Store (line 65)

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

Auth_OpenID_MDB2Store Auth_OpenID_MDB2Store (connection $connection, [associations_table: $associations_table = null], [nonces_table: $nonces_table = null])

connection $connection: This must be an established connection to a database of the correct type for the SQLStore subclass you're using. This must be a PEAR::MDB2 connection handle.
associations_table: $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: $nonces_table: This is an optional parameter to specify the name of the table used for storing nonces. The default value is 'oid_nonces'.

cleanupAssociations (line 311)

void cleanupAssociations ()

Redefinition of:

Auth_OpenID_OpenIDStore::cleanupAssociations()

cleanupNonces (line 301)

void cleanupNonces ()

Redefinition of:

Auth_OpenID_OpenIDStore::cleanupNonces()

createTables (line 111)

void createTables ()

create_assoc_table (line 192)

void create_assoc_table ()

create_nonce_table (line 122)

void create_nonce_table ()

getAssociation (line 318)

void getAssociation ( $server_url, [ $handle = null])

$server_url
$handle

Redefinition of:

Auth_OpenID_OpenIDStore::getAssociation(): 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.

removeAssociation (line 357)

void removeAssociation ( $server_url, $handle)

$server_url
$handle

Redefinition of:

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

reset (line 402)

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

void reset ()

Redefinition of:

Auth_OpenID_OpenIDStore::reset(): Removes all entries from the store; implementation is optional.

storeAssociation (line 270)

void storeAssociation ( $server_url, $association)

$server_url
$association

Redefinition of:

Auth_OpenID_OpenIDStore::storeAssociation(): This method puts an Association object into storage, retrievable by server URL and handle.

tableExists (line 104)

void tableExists ( $table_name)

$table_name

useNonce (line 370)

void useNonce ( $server_url, $timestamp, $salt)

$server_url
$timestamp
$salt

Redefinition of:

Auth_OpenID_OpenIDStore::useNonce(): Called when using a nonce.

Inherited Methods

Inherited From Auth_OpenID_OpenIDStore

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

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