Source for file Common.php

Documentation is available at Common.php

  1. <?php
  2. /**
  3.  * OpenID_Observer_Common
  4.  * 
  5.  * PHP Version 5.2.0+
  6.  * 
  7.  * @category  Auth
  8.  * @package   OpenID
  9.  * @author    Bill Shupp <hostmaster@shupp.org>
  10.  * @copyright 2009 Bill Shupp
  11.  * @license   http://www.opensource.org/licenses/bsd-license.php FreeBSD
  12.  * @link      http://pearopenid.googlecode.com
  13.  */
  14.  
  15. /**
  16.  * Allows for observers to listen in to key events.  The most common use case is for
  17.  * logging.  To use OpenID_Observe_Log, for example you could do this:
  18.  *
  19.  * <code>
  20.  *  $log = new OpenID_Observer_Log;
  21.  *  OpenID::attach($log);
  22.  * </code>
  23.  *
  24.  * Now, your logs will by default go to /tmp/OpenID_Observer_Log.log.  To stop
  25.  * observing, just detach like so:
  26.  * 
  27.  * <code>
  28.  *  OpenID::detach($log);
  29.  * </code>
  30.  *
  31.  * @category  Auth
  32.  * @package   OpenID
  33.  * @author    Bill Shupp <hostmaster@shupp.org>
  34.  * @copyright 2009 Bill Shupp
  35.  * @license   http://www.opensource.org/licenses/bsd-license.php FreeBSD
  36.  * @link      http://pearopenid.googlecode.com
  37.  * @see       OpenID_Observer_Log
  38.  */
  39. abstract class OpenID_Observer_Common
  40. {
  41.     /**
  42.      * Events to act upon
  43.      * 
  44.      * @var array 
  45.      * @see getEvents()
  46.      */
  47.     protected $events = array(
  48.         'OpenID_Association_Request::sendAssociationRequest',
  49.         'OpenID_Association::checkMessageSignature',
  50.         'OpenID_Assertion::validateReturnTo',
  51.         'OpenID_Assertion::validateReturnToNonce',
  52.         'OpenID_RelyingParty::verify',
  53.         'OpenID_Auth_Request::addNonce',
  54.     );
  55.  
  56.     /**
  57.      * Gets the current array of events
  58.      * 
  59.      * @return array 
  60.      * @see $events
  61.      */
  62.     public function getEvents()
  63.     {
  64.         return $this->events;
  65.     }
  66.  
  67.     /**
  68.      * Sets a custom array of events to act upon
  69.      * 
  70.      * @param array $events Array of events
  71.      * 
  72.      * @return void 
  73.      * @see $events
  74.      */
  75.     public function setEvents(array $events)
  76.     {
  77.         $this->events = $events;
  78.     }
  79.  
  80.     /**
  81. /**
  82.      * Acts upon an event that just occured
  83.      * 
  84.      * @param array $event Event array, containing 'name' and 'data' keys
  85.      * 
  86.      * @return void 
  87.      */
  88.     abstract public function update(array $event);
  89. }
  90. ?>

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