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

Class: OpenID

Source Location: /OpenID-0.4.0/OpenID.php

Class Overview


OpenID


Author(s):

Copyright:

  • 2009 Bill Shupp

Variables

Methods


Child classes:

OpenID_RelyingParty
OpenID_RelyingParty
OpenID_Assertion
Class for verifying assertions. Does basic validation (nonce, return_to, etc), as well as signature verification and check_authentication.
OpenID_Association_Request
OpenID_Association_Request

Inherited Variables

Inherited Methods


Class Details

[line 39]
OpenID

Base OpenID class. Contains common constants and helper static methods, as well as the directRequest() method, which handles direct communications. It also is a common place to assign your custom Storage class and Observers.



[ Top ]


Class Variables

$lastEvent = array(
        'name' => 'start',
        'data' => null
    )

[line 115]

Stores the last event
  • Access: protected

Type:   $lastEvent


[ Top ]

$observers = array()

[line 108]

Array of attached observers
  • Access: protected

Type:   $observers


[ Top ]

$store =  null

[line 101]

Instance of OpenID_Store_Interface

Type:   $store


[ Top ]

$versionMap = array(
        self::SERVICE_2_0_SERVER => self::NS_2_0,
        self::SERVICE_2_0_SIGNON => self::NS_2_0,
        self::SERVICE_1_1_SIGNON => self::NS_1_1,
        self::SERVICE_1_0_SIGNON => self::NS_1_1,
    )

[line 60]

A map of which service types (versions) map to which protocol version. 1.0 is mapped to 1.1. This is mostly helpful to see if openid.ns is supported.
  • Access: public

Type:   $versionMap


[ Top ]



Method Detail

attach   [line 128]

void attach( OpenID_Observer_Common $observer)

Attaches an observer

Parameters:

OpenID_Observer_Common   $observer   —  Observer object

[ Top ]

detach   [line 145]

void detach( OpenID_Observer_Common $observer)

Detaches the observer
  • Access: public

Parameters:

OpenID_Observer_Common   $observer   —  Observer object

[ Top ]

directRequest   [line 232]

HTTP_Request2_Response directRequest( string $url, OpenID_Message $message, [array $options = array()])

Sends a direct HTTP request.

Parameters:

string   $url   —  URL to send the request to
OpenID_Message   $message   —  Contains message contents
array   $options   —  Options to pass to HTTP_Request2

[ Top ]

getHTTPRequest2Instance   [line 254]

HTTP_Request2_Response getHTTPRequest2Instance( )

Instantiates HTTP_Request2. Abstracted for testing.

[ Top ]

getLastEvent   [line 189]

void getLastEvent( )

Gets the last event
  • Access: public

[ Top ]

getStore   [line 212]

OpenID_Store_Interface getStore( )

Gets the OpenID_Store_Interface instance. If none has been set, then the default store is used (CacheLite).
  • Access: public

[ Top ]

getXRIGlobalSymbols   [line 266]

void getXRIGlobalSymbols( )

Returns an array of the 5 XRI globals symbols
  • Access: public

[ Top ]

normalizeIdentifier   [line 279]

string normalizeIdentifier( mixed $identifier)

Normalizes an identifier (URI or XRI)
  • Return: Normalized Identifier.
  • Throws: OpenID_Exception on invalid identifier
  • Access: public

Parameters:

mixed   $identifier   —  URI or XRI to be normalized

[ Top ]

notify   [line 160]

void notify( )

Notifies all observers of an event
  • Access: public

[ Top ]

resetInternalData   [line 311]

void resetInternalData( )

Resets internal static variables.

Useful for unit tests.

  • Access: public

[ Top ]

setLastEvent   [line 175]

void setLastEvent( string $name, mixed $data)

Sets the last event and notifies the observers
  • Access: public

Parameters:

string   $name   —  Name of the event
mixed   $data   —  The event's data

[ Top ]

setStore   [line 201]

void setStore( OpenID_Store_Interface $store)

Sets a custom OpenID_Store_Interface object
  • Access: public

Parameters:

OpenID_Store_Interface   $store   —  Custom storage instance

[ Top ]


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