[ class tree: OpenID ] [ index: OpenID ] [ all elements ]

Class: OpenID_Association_Request

Source Location: /OpenID-0.4.0/OpenID/Association/Request.php

Class Overview





  • 2009 Bill Shupp



Inherited Variables

Inherited Methods

Class: OpenID

Attaches an observer
Detaches the observer
Sends a direct HTTP request.
Instantiates HTTP_Request2. Abstracted for testing.
Gets the last event
Gets the OpenID_Store_Interface instance. If none has been set, then the default store is used (CacheLite).
Returns an array of the 5 XRI globals symbols
Normalizes an identifier (URI or XRI)
Notifies all observers of an event
Resets internal static variables.
Sets the last event and notifies the observers
Sets a custom OpenID_Store_Interface object

Class Details

[line 38]

Request object for establishing OpenID Associations.

[ Top ]

Class Variables

$cdh =  null

[line 74]

Optional instance of Crypt_DiffieHellman
  • Access: protected

Type:   Crypt_DiffieHellman

[ Top ]

$dh =  null

[line 81]

OpenID_Association_DiffieHellman instance
  • Access: protected

[ Top ]

$message =  null

[line 52]

Contains contents of the association request
  • Access: protected

Type:   OpenID_Message

[ Top ]

$opEndpointURL =  null

[line 45]

OpenID provider endpoint URL
  • Access: protected

Type:   string

[ Top ]

$requestOptions = array()

[line 88]

HTTP_Request2 options
  • Access: protected

Type:   array

[ Top ]

$response = array()

[line 67]

The association request response in array format

Type:   array

[ Top ]

$version =  null

[line 59]

Version of OpenID in use. This determines which algorithms we can use.
  • Access: protected

Type:   string

[ Top ]

Method Detail

__construct (Constructor)   [line 101]

void __construct( string $opEndpointURL, string $version, [Crypt_DiffieHellman $cdh = null])

Sets the arguments passed in, as well as creates the request message.
  • Access: public


string   $opEndpointURL   —  URL of OP Endpoint
string   $version   —  Version of OpenID in use
Crypt_DiffieHellman   $cdh   —  Custom Crypt_DiffieHellman instance

[ Top ]

associate   [line 138]

mixed associate( )

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

[ Top ]

buildAssociation   [line 175]

OpenID_Association buildAssociation( array $response)

Build the OpenID_Association class based on the association response


array   $response   —  Association response in array format

[ Top ]

getAssociationType   [line 292]

void getAssociationType( )

Gets the current association type
  • Access: public

[ Top ]

getDH   [line 254]

OpenID_Association_DiffieHellman getDH( )

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

[ Top ]

getEndpointURL   [line 349]

string getEndpointURL( )

Gets the OP Endpoint URL
  • Return: OP Endpoint URL
  • Access: public

[ Top ]

getRequestOptions   [line 372]

array getRequestOptions( )

Return the HTTP_Request2 options
  • Return: Array of HTTP_Request2 options
  • Access: public

[ Top ]

getResponse   [line 233]

void getResponse( )

Gets the last association response
  • Access: public

[ Top ]

getSessionType   [line 339]

string getSessionType( )

Gets the current session type
  • Return: Current session type (sha1, sha256, or no-encryption)
  • Access: public

[ Top ]

initDH   [line 243]

void initDH( )

Initialize the diffie-hellman parameters for the association request.
  • Access: protected

[ Top ]

sendAssociationRequest   [line 205]

OpenID_Message sendAssociationRequest( )

Actually sends the assocition request to the OP Endpoint URL.

[ Top ]

setAssociationType   [line 272]

void setAssociationType( string $type)

Sets he association type for the request. Can be sha1 or sha256.
  • Throws: OpenID_Association_Exception on invalid type
  • Access: public


string   $type   —  sha1 or sha256

[ Top ]

setRequestOptions   [line 361]

self setRequestOptions( array $options)

Sets the HTTP_Request2 options to use
  • Return: Fluent interface
  • Access: public


array   $options   —  Array of HTTP_Request2 options

[ Top ]

setSessionType   [line 306]

void setSessionType( string $type)

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


string   $type   —  sha1, sha256, or no-encryption

[ Top ]

Documentation generated on Mon, 11 Mar 2019 15:57:49 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.