Class: OpenID_Observer_Common

Source Location: /OpenID-0.4.0/OpenID/Observer/Common.php

Class Overview

Allows for observers to listen in to key events. The most common use case is for logging. To use OpenID_Observe_Log, for example you could do this:

Author(s):

Bill Shupp <hostmaster at shupp.org>

Copyright:

2009 Bill Shupp

Variables

$events

Methods

Child classes:

OpenID_Observer_Log: An observer based on PEAR's Log package. You may either pass in your own Log instance to the constructor, or allow the default file driver to write to /tmp/OpenID_Observer_Log.log by default.

Inherited Variables

Inherited Methods

Class Details

[line 39]
Allows for observers to listen in to key events. The most common use case is for logging. To use OpenID_Observe_Log, for example you could do this:

  $log = new OpenID_Observer_Log;

  OpenID::attach($log);

Now, your logs will by default go to /tmp/OpenID_Observer_Log.log. To stop observing, just detach like so:

  OpenID::detach($log);

Author: Bill Shupp <hostmaster@shupp.org>
Copyright: 2009 Bill Shupp
See: OpenID_Observer_Log
Link: http://github.com/shupp/openid
Abstract:
Usedby: Log.php
Usedby: OpenID_Observer_Log
License: FreeBSD

[ Top ]

Class Variables

$events = array(
        'OpenID_Association_Request::sendAssociationRequest',
        'OpenID_Association::checkMessageSignature',
        'OpenID_Assertion::validateReturnTo',
        'OpenID_Assertion::validateReturnToNonce',
        'OpenID_RelyingParty::verify',
        'OpenID_Auth_Request::addNonce',
    )

[line 47]

Events to act upon

See: OpenID_Observer_Common::getEvents()
Access: protected

Type:

array

[ Top ]

Method Detail

getEvents [line 62]

array getEvents(
)

Gets the current array of events

See: OpenID_Observer_Common::$events
Access: public

[ Top ]

setEvents [line 75]

void setEvents(
array
$events)

Sets a custom array of events to act upon

See: OpenID_Observer_Common::$events
Access: public

Parameters:

array $events — Array of events

[ Top ]

update [line 87]

void update(
array
$event)

Acts upon an event that just occured

Abstract:
Access: public

Overridden in child classes as:

OpenID_Observer_Log::update(): Logs the event

Parameters:

array $event — Event array, containing 'name' and 'data' keys

[ Top ]

Class: OpenID_Observer_Common

Class Overview

Author(s):

Copyright:

Variables

Methods

Child classes:

Inherited Variables

Inherited Methods

Class Details

Class Variables

$events = array( 'OpenID_Association_Request::sendAssociationRequest', 'OpenID_Association::checkMessageSignature', 'OpenID_Assertion::validateReturnTo', 'OpenID_Assertion::validateReturnToNonce', 'OpenID_RelyingParty::verify', 'OpenID_Auth_Request::addNonce', )

Method Detail

getEvents [line 62]

setEvents [line 75]

Parameters:

update [line 87]

Parameters:

$events = array(
'OpenID_Association_Request::sendAssociationRequest',
'OpenID_Association::checkMessageSignature',
'OpenID_Assertion::validateReturnTo',
'OpenID_Assertion::validateReturnToNonce',
'OpenID_RelyingParty::verify',
'OpenID_Auth_Request::addNonce',
)