Auth_OpenID_OpenIDStore Klassenreferenz

Basisklasse für Auth_OpenID_DumbStore, Auth_OpenID_FileStore, Auth_OpenID_MemcachedStore und Auth_OpenID_SQLStore.


Öffentliche Methoden

 storeAssociation ($server_url, $association)
 cleanupNonces ()
 cleanupAssociations ()
 cleanup ()
 supportsCleanup ()
 getAssociation ($server_url, $handle=null)
 removeAssociation ($server_url, $handle)
 useNonce ($server_url, $timestamp, $salt)
 reset ()


Ausführliche Beschreibung

Definiert in Zeile 30 der Datei Interface.php.


Dokumentation der Elementfunktionen

cleanup (  ) 

Definiert in Zeile 90 der Datei Interface.php.

00091     {
00092         return array($this->cleanupNonces(),
00093                      $this->cleanupAssociations());
00094     }

cleanupAssociations (  ) 

Erneute Implementation in Auth_OpenID_FileStore und Auth_OpenID_SQLStore.

Definiert in Zeile 77 der Datei Interface.php.

00078     {
00079         trigger_error("Auth_OpenID_OpenIDStore::cleanupAssociations ".
00080                       "not implemented", E_USER_ERROR);
00081     }

cleanupNonces (  ) 

Erneute Implementation in Auth_OpenID_FileStore und Auth_OpenID_SQLStore.

Definiert in Zeile 62 der Datei Interface.php.

00063     {
00064         trigger_error("Auth_OpenID_OpenIDStore::cleanupNonces ".
00065                       "not implemented", E_USER_ERROR);
00066     }

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.

Parameter:
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.
Rückgabe:
Association The Association for the given identity server.

Erneute Implementation in Auth_OpenID_DumbStore, Auth_OpenID_FileStore, Auth_OpenID_MemcachedStore und Auth_OpenID_SQLStore.

Definiert in Zeile 134 der Datei Interface.php.

00135     {
00136         trigger_error("Auth_OpenID_OpenIDStore::getAssociation ".
00137                       "not implemented", E_USER_ERROR);
00138     }

removeAssociation ( server_url,
handle 
)

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

Parameter:
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.
Rückgabe:
mixed Returns whether or not the given association existed.

Erneute Implementation in Auth_OpenID_DumbStore, Auth_OpenID_FileStore, Auth_OpenID_MemcachedStore und Auth_OpenID_SQLStore.

Definiert in Zeile 158 der Datei Interface.php.

00159     {
00160         trigger_error("Auth_OpenID_OpenIDStore::removeAssociation ".
00161                       "not implemented", E_USER_ERROR);
00162     }

reset (  ) 

Removes all entries from the store; implementation is optional.

Erneute Implementation in Auth_OpenID_SQLStore.

Definiert in Zeile 192 der Datei Interface.php.

00193     {
00194     }

storeAssociation ( server_url,
association 
)

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

Parameter:
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.

Erneute Implementation in Auth_OpenID_DumbStore, Auth_OpenID_FileStore, Auth_OpenID_MemcachedStore und Auth_OpenID_SQLStore.

Definiert in Zeile 44 der Datei Interface.php.

00045     {
00046         trigger_error("Auth_OpenID_OpenIDStore::storeAssociation ".
00047                       "not implemented", E_USER_ERROR);
00048     }

supportsCleanup (  ) 

Report whether this storage supports cleanup

Erneute Implementation in Auth_OpenID_MemcachedStore.

Definiert in Zeile 99 der Datei Interface.php.

00100     {
00101         return true;
00102     }

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.

Parameter:
string $nonce The nonce to use.
Rückgabe:
bool Whether or not the nonce was valid.

Erneute Implementation in Auth_OpenID_DumbStore, Auth_OpenID_FileStore, Auth_OpenID_MemcachedStore und Auth_OpenID_SQLStore.

Definiert in Zeile 183 der Datei Interface.php.

00184     {
00185         trigger_error("Auth_OpenID_OpenIDStore::useNonce ".
00186                       "not implemented", E_USER_ERROR);
00187     }


Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:
Copyright © 2003 - 2009 MyOOS [Shopsystem]. All rights reserved.
MyOOS [Shopsystem] is Free Software released under the GNU/GPL License.

Webmaster: info@r23.de (Impressum)
doxygen