Auth_OpenID_MDB2Store
extends Auth_OpenID_OpenIDStore
in package
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.
Table of Contents
- __construct() : mixed
- This creates a new MDB2Store instance. It requires an established database connection be given to it, and it allows overriding the default table names.
- cleanup() : array<string|int, mixed>
- Shortcut for cleanupNonces(), cleanupAssociations().
- cleanupAssociations() : int
- Remove expired associations from the store.
- cleanupNonces() : int
- Remove expired nonces from the store.
- create_assoc_table() : mixed
- create_nonce_table() : mixed
- createTables() : mixed
- getAssociation() : Auth_OpenID_Association
- 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() : mixed
- This method removes the matching association if it's found, and returns whether the association was removed or not.
- reset() : mixed
- Resets the store by removing all records from the store's tables.
- storeAssociation() : mixed
- This method puts an Association object into storage, retrievable by server URL and handle.
- supportsCleanup() : mixed
- Report whether this storage supports cleanup
- tableExists() : mixed
- useNonce() : bool
- Called when using a nonce.
Methods
__construct()
This creates a new MDB2Store instance. It requires an established database connection be given to it, and it allows overriding the default table names.
public
__construct(connection $connection[, mixed $associations_table = null ][, mixed $nonces_table = null ]) : mixed
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 : mixed = null
- $nonces_table : mixed = null
Return values
mixed —cleanup()
Shortcut for cleanupNonces(), cleanupAssociations().
public
cleanup() : array<string|int, mixed>
This method is not called in the normal operation of the library. It provides a way for store admins to keep their storage from filling up with expired data.
Return values
array<string|int, mixed> —cleanupAssociations()
Remove expired associations from the store.
public
cleanupAssociations() : int
This method is not called in the normal operation of the library. It provides a way for store admins to keep their storage from filling up with expired data.
Return values
int —the number of associations expired.
cleanupNonces()
Remove expired nonces from the store.
public
cleanupNonces() : int
Discards any nonce from storage that is old enough that its timestamp would not pass useNonce().
This method is not called in the normal operation of the library. It provides a way for store admins to keep their storage from filling up with expired data.
Return values
int —the number of nonces expired
create_assoc_table()
public
create_assoc_table() : mixed
Return values
mixed —create_nonce_table()
public
create_nonce_table() : mixed
Return values
mixed —createTables()
public
createTables() : mixed
Return values
mixed —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.
public
getAssociation(mixed $server_url[, mixed $handle = null ]) : Auth_OpenID_Association
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
- $server_url : mixed
-
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.
- $handle : mixed = null
-
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.
Return values
Auth_OpenID_Association —The Association for the given identity server.
removeAssociation()
This method removes the matching association if it's found, and returns whether the association was removed or not.
public
removeAssociation(mixed $server_url, mixed $handle) : mixed
Parameters
- $server_url : mixed
-
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.
- $handle : mixed
-
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.
Return values
mixed —Returns whether or not the given association existed.
reset()
Resets the store by removing all records from the store's tables.
public
reset() : mixed
Return values
mixed —storeAssociation()
This method puts an Association object into storage, retrievable by server URL and handle.
public
storeAssociation(mixed $server_url, mixed $association) : mixed
Parameters
- $server_url : mixed
-
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 : mixed
-
The Association to store.
Return values
mixed —supportsCleanup()
Report whether this storage supports cleanup
public
supportsCleanup() : mixed
Return values
mixed —tableExists()
public
tableExists(mixed $table_name) : mixed
Parameters
- $table_name : mixed
Return values
mixed —useNonce()
Called when using a nonce.
public
useNonce(mixed $server_url, mixed $timestamp, mixed $salt) : bool
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
- $server_url : mixed
- $timestamp : mixed
- $salt : mixed
Return values
bool —Whether or not the nonce was valid.