Interface OpenID_Store_Interface

Description

Defines the OpenID storage interface.

Located in /OpenID/Store/Interface.php (line 27)


	
			
Class Constant Summary
Method Summary
void deleteAssociation (string $uri)
void deleteNonce (string $nonce, string $opURL)
OpenID_Association getAssociation (string $uri, [string $handle = null])
OpenID_Discover getDiscover (string $identifier)
string getNonce (string $nonce, string $opURL)
void setAssociation (OpenID_Association $association)
void setDiscover (OpenID_Discover $discover, [int $expire = null])
void setNonce (string $nonce, string $opURL)
Methods
deleteAssociation (line 83)

Deletes an association from storage

  • access: public
void deleteAssociation (string $uri)
  • string $uri: OP Endpoint URI
deleteNonce (line 113)

Deletes a nonce from storage

  • access: public
void deleteNonce (string $nonce, string $opURL)
  • string $nonce: The nonce to delete
  • string $opURL: The OP endpoint URL it is associated with
getAssociation (line 64)

Gets an OpenID_Assocation instance from storage

  • access: public
OpenID_Association getAssociation (string $uri, [string $handle = null])
  • string $uri: The OP endpoint URI to get an association for
  • string $handle: The association handle if available
getDiscover (line 44)

Gets an OpenID_Discover object from storage

  • access: public
OpenID_Discover getDiscover (string $identifier)
  • string $identifier: The normalized identifier that discovery was performed on
getNonce (line 93)

Gets a nonce from storage

  • access: public
string getNonce (string $nonce, string $opURL)
  • string $nonce: The nonce itself
  • string $opURL: The OP Endpoint URL it was used with
setAssociation (line 74)

Stores an OpenID_Association instance. Details (such as endpoint url and exiration) are retrieved from the object itself.

  • access: public
void setAssociation (OpenID_Association $association)
setDiscover (line 54)

Stores an instance of OpenID_Discover

  • access: public
void setDiscover (OpenID_Discover $discover, [int $expire = null])
  • OpenID_Discover $discover: Instance of OpenID_Discover
  • int $expire: How long to cache it for, in seconds
setNonce (line 103)

Stores a nonce for an OP endpoint URL

  • access: public
void setNonce (string $nonce, string $opURL)
  • string $nonce: The nonce itself
  • string $opURL: The OP endpoint URL it was associated with
Class Constants
TYPE_ASSOCIATION = 1 (line 32)

Constants used for setting which type of storage is being used.

TYPE_DISCOVER = 2 (line 33)
TYPE_NONCE = 3 (line 34)

Documentation generated on Tue, 15 Dec 2009 19:00:54 -0800 by phpDocumentor 1.4.3