Class Auth_OpenID_OpenIDStore
This is the interface for the store objects the OpenID library
uses. It is a single class that provides all of the persistence
mechanisms that the OpenID library needs, for both servers and
consumers. If you want to create an SQL-driven store, please see
then Auth_OpenID_SQLStore class.
Change: Version 2.0 removed the storeNonce, getAuthKey, and isDumb
methods, and changed the behavior of the useNonce method to support
one-way nonces.
Methods summary
public
|
#
storeAssociation( string $server_url, Association $association )
This method puts an Association object into storage,
retrievable by server URL and handle.
This method puts an Association object into storage,
retrievable by server URL and handle.
Parameters
- $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
- The Association to store.
|
public
|
|
public
|
|
public
|
|
public
|
#
supportsCleanup( )
Report whether this storage supports cleanup
Report whether this storage supports cleanup
|
public
Association
|
#
getAssociation( string $server_url, mixed $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.
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.
Parameters
- $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. - $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. Returns
Association The Association for the given identity
server.
|
public
mixed
|
#
removeAssociation( string $server_url, string $handle )
This method removes the matching association if it's found, and
returns whether the association was removed or not.
This method removes the matching association if it's found, and
returns whether the association was removed or not.
Parameters
- $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. - $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. Returns
mixed
Returns whether or not the given association existed.
|
public
boolean
|
#
useNonce( string $server_url, $timestamp, $salt )
Called when using a nonce.
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.
Parameters
- $server_url
- $nonce The nonce to use.
- $timestamp
- $salt
Returns
boolean
Whether or not the nonce was valid.
|
public
|
#
reset( )
Removes all entries from the store; implementation is optional.
Removes all entries from the store; implementation is optional.
|