Class OpenID_Association_Request

Description
Description | Vars (details) | Methods (details) Constants

OpenID_Association_Request

Request object for establishing OpenID Associations.

Located in /OpenID/Association/Request.php (line 38) 

OpenID
   |
   --OpenID_Association_Request
Variable Summary
Description | Vars (details) | Methods (details) Constants
Crypt_DiffieHellman $cdh
OpenID_Association_DiffieHellman $dh
OpenID_Message $message
string $opEndpointURL
array $response
string $version
Method Summary
Description | Constants Vars (details) | Methods (details)
void __construct (string $opEndpointURL, string $version, [ $cdh = null])
mixed associate ()
OpenID_Association buildAssociation ( $response)
void getAssociationType ()
OpenID_Association_DiffieHellman getDH ()
string getEndpointURL ()
void getResponse ()
string getSessionType ()
void initDH ()
OpenID_Message sendAssociationRequest ()
void setAssociationType (string $type)
void setSessionType (string $type)
Variables
Description | Vars (details) Constants | Methods (details)
Crypt_DiffieHellman $cdh = null (line 74)

Optional instance of Crypt_DiffieHellman

  • access: protected
OpenID_Association_DiffieHellman $dh = null (line 81)

OpenID_Association_DiffieHellman instance

  • access: protected
OpenID_Message $message = null (line 52)

Contains contents of the association request

  • access: protected
string $opEndpointURL = null (line 45)

OpenID provider endpoint URL

  • access: protected
array $response = array() (line 67)

The association request response in array format

string $version = null (line 59)

Version of OpenID in use. This determines which algorithms we can use.

  • access: protected

Inherited Variables

Inherited from OpenID

OpenID::$lastEvent
 OpenID::$observers
 OpenID::$store
 OpenID::$versionMap
Methods
Description | Vars (details) Constants Methods (details)
Constructor __construct (line 93)

Sets the arguments passed in, as well as creates the request message.

  • access: public
void __construct (string $opEndpointURL, string $version, [ $cdh = null])
  • string $opEndpointURL: URL of OP Endpoint
  • string $version: Version of OpenID in use
  • Crypt_DiffieHellman $cdh: Custom Crypt_DiffieHellman instance
associate (line 130)

Sends the association request. Loops over errors and adapts to 'unsupported-type' responses.

mixed associate ()
buildAssociation (line 167)

Build the OpenID_Association class based on the association response

OpenID_Association buildAssociation ( $response)
  • array $response: Association response in array format
getAssociationType (line 277)

Gets the current association type

  • access: public
void getAssociationType ()
getDH (line 243)

Gets an instance of OpenID_Association_DiffieHellman. If one is not already instanciated, a new one is returned.

  • access: protected
OpenID_Association_DiffieHellman getDH ()
getEndpointURL (line 328)

Gets the OP Endpoint URL

  • return: OP Endpoint URL
  • access: public
string getEndpointURL ()
getResponse (line 222)

Gets the last association response

  • access: public
void getResponse ()
getSessionType (line 318)

Gets the current session type

  • return: Current session type (sha1, sha256, or no-encryption)
  • access: public
string getSessionType ()
initDH (line 232)

Initialize the diffie-hellman parameters for the association request.

  • access: protected
void initDH ()
sendAssociationRequest (line 196)

Actually sends the assocition request to the OP Endpoing URL.

OpenID_Message sendAssociationRequest ()
setAssociationType (line 260)

Sets he association type for the request. Can be sha1 or sha256.

  • throws: OpenID_Association_Exception on invalid type
  • access: public
void setAssociationType (string $type)
  • string $type: sha1 or sha256
setSessionType (line 291)

Sets the session type. Can be sha1, sha256, or no-encryption

  • throws: OpenID_Association_Exception on invalid type, or if you set no-encryption for an OP URL that doesn't support HTTPS
  • access: public
void setSessionType (string $type)
  • string $type: sha1, sha256, or no-encryption

Inherited Methods

Inherited From OpenID

OpenID::attach()
OpenID::detach()
OpenID::directRequest()
OpenID::getHTTPRequest2Instance()
OpenID::getLastEvent()
OpenID::getStore()
OpenID::getXRIGlobalSymbols()
OpenID::normalizeIdentifier()
OpenID::notify()
OpenID::setLastEvent()
OpenID::setStore()
Class Constants
Description | Constants (details) Vars (details) | Methods (details)

Inherited Constants

Inherited from OpenID

OpenID::ASSOC_TYPE_HMAC_SHA1
 OpenID::ASSOC_TYPE_HMAC_SHA256
 OpenID::HASH_ALGORITHM_1_1
 OpenID::HASH_ALGORITHM_2_0
 OpenID::MODE_ASSOCIATE
 OpenID::MODE_CANCEL
 OpenID::MODE_CHECKID_IMMEDIATE
 OpenID::MODE_CHECKID_SETUP
 OpenID::MODE_CHECK_AUTHENTICATION
 OpenID::MODE_ERROR
 OpenID::MODE_ID_RES
 OpenID::MODE_SETUP_NEEDED
 OpenID::NS_1_1
 OpenID::NS_2_0
 OpenID::NS_2_0_ID_SELECT
 OpenID::SERVICE_1_0_SIGNON
 OpenID::SERVICE_1_1_SIGNON
 OpenID::SERVICE_2_0_SERVER
 OpenID::SERVICE_2_0_SIGNON
 OpenID::SESSION_TYPE_DH_SHA1
 OpenID::SESSION_TYPE_DH_SHA256
 OpenID::SESSION_TYPE_NO_ENCRYPTION

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