

[ class tree: OpenID ] [ index: OpenID ] [ all elements ]

Class: Auth_OpenID_MDB2Store

Source Location: /zp-extensions/federated_logon/Auth/OpenID/MDB2Store.php

Class Auth_OpenID_MDB2Store

Class Overview

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.

Located in /zp-extensions/federated_logon/Auth/OpenID/MDB2Store.php [line 46]

Auth_OpenID_OpenIDStore
   |
   --Auth_OpenID_MDB2Store

Author(s):

JanRain, Inc. <openid@janrain.com>

Information Tags:

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From Auth_OpenID_OpenIDStore

Auth_OpenID_OpenIDStore::cleanup()

Auth_OpenID_OpenIDStore::cleanupAssociations()

Auth_OpenID_OpenIDStore::cleanupNonces()

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.

Auth_OpenID_OpenIDStore::removeAssociation()

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

Auth_OpenID_OpenIDStore::reset()

Removes all entries from the store; implementation is optional.

Auth_OpenID_OpenIDStore::storeAssociation()

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

Auth_OpenID_OpenIDStore::supportsCleanup()

Report whether this storage supports cleanup

Auth_OpenID_OpenIDStore::useNonce()

Called when using a nonce.

[ Top ]

Method Summary

Auth_OpenID_MDB2Store	Auth_OpenID_MDB2Store()	This creates a new MDB2Store instance. It requires an established database connection be given to it, and it allows overriding the default table names.
void	cleanupAssociations()
void	cleanupNonces()
void	createTables()
void	create_assoc_table()
void	create_nonce_table()
void	getAssociation()
void	removeAssociation()
void	reset()	Resets the store by removing all records from the store's tables.
void	storeAssociation()
void	tableExists()
void	useNonce()

[ Top ]

Methods

Constructor Auth_OpenID_MDB2Store [line 65]

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

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

Parameters:

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'.

[ Top ]

cleanupAssociations [line 311]

void cleanupAssociations(
)

Redefinition of:

Auth_OpenID_OpenIDStore::cleanupAssociations()

[ Top ]

cleanupNonces [line 301]

void cleanupNonces(
)

Redefinition of:

Auth_OpenID_OpenIDStore::cleanupNonces()

[ Top ]

createTables [line 111]

void createTables(
)

[ Top ]

create_assoc_table [line 192]

void create_assoc_table(
)

[ Top ]

create_nonce_table [line 122]

void create_nonce_table(
)

[ Top ]

getAssociation [line 318]

void getAssociation(

$server_url, [
$handle = null] 
)

Parameters:

	$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.

[ Top ]

removeAssociation [line 357]

void removeAssociation(

$server_url, 
$handle 
)

Parameters:

	$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.

[ Top ]

reset [line 402]

void reset(
)

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

Redefinition of:

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

[ Top ]

storeAssociation [line 270]

void storeAssociation(

$server_url, 
$association 
)

Parameters:

	$server_url:
	$association:

Redefinition of:

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

[ Top ]

tableExists [line 104]

void tableExists(

$table_name 
)

Parameters:

$table_name:

[ Top ]

useNonce [line 370]

void useNonce(

$server_url, 
$timestamp, 
$salt 
)

Parameters:

	$server_url:
	$timestamp:
	$salt:

Redefinition of:

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

[ Top ]

OpenID

Packages:

core
admin
classes
functions
GoogleMapAPI
JSMin
OpenID
PHPMailer
plugins
Services_JSON

Files:

Classes:

Documentation generated on Tue, 20 Dec 2011 16:07:40 +0100 by phpDocumentor 1.4.3

RSS feeds!

Social networks

Join the Google Groups!

zenphoto-announce
Release announcements and security alerts only (no support)
Subscribe right here:

Email:
Zenphoto Translate
Support and discussion for translators only

Zenphoto

Class: Auth_OpenID_MDB2Store