Source for file Log.php

Documentation is available at Log.php

  1. <?php
  2. /**
  3.  * OpenID_Observer_Log
  4.  * 
  5.  * PHP Version 5.2.0+
  6.  * 
  7.  * @uses      OpenID_Observer_Common
  8.  * @category  Auth
  9.  * @package   OpenID
  10.  * @author    Bill Shupp <hostmaster@shupp.org>
  11.  * @copyright 2009 Bill Shupp
  12.  * @license   http://www.opensource.org/licenses/bsd-license.php FreeBSD
  13.  * @link      http://pearopenid.googlecode.com
  14.  */
  15.  
  16. /**
  17.  * Required files
  18.  */
  19. require_once 'OpenID/Observer/Common.php';
  20. require_once 'Log.php';
  21.  
  22. /**
  23.  * An observer based on PEAR's Log package.  You may either pass in your own Log
  24.  * instance to the constructor, or allow the default file driver to write to
  25.  * /tmp/OpenID_Observer_Log.log by default.
  26.  *
  27.  * @uses      OpenID_Observer_Common
  28.  * @category  Auth
  29.  * @package   OpenID
  30.  * @author    Bill Shupp <hostmaster@shupp.org>
  31.  * @copyright 2009 Bill Shupp
  32.  * @license   http://www.opensource.org/licenses/bsd-license.php FreeBSD
  33.  * @link      http://pearopenid.googlecode.com
  34.  */
  35. class OpenID_Observer_Log extends OpenID_Observer_Common
  36. {
  37.     /**
  38.      * Holds the instance of Log
  39.      * 
  40.      * @var Log 
  41.      */
  42.     protected $log = null;
  43.  
  44.     /**
  45.      * Allows you to pass in a Log instance and an array of events to log.  If
  46.      * no instance of Log is given, the 'file' Log driver will be used, and write to
  47.      * /tmp/OpenID_Observer_Log.log.
  48.      * 
  49.      * @param Log   $log    Instance of Log, optional
  50.      * @param array $events Custom list of events to log
  51.      * 
  52.      * @return void 
  53.      */
  54.     public function __construct(Log $log = null, array $events = array())
  55.     {
  56.         if (count($events)) {
  57.             $this->setEvents($events);
  58.         }
  59.  
  60.         if (!$log instanceof Log) {
  61.             $log = Log::factory('file', '/tmp/' . __CLASS__ . '.log');
  62.         }
  63.         $this->log = $log;
  64.     }
  65.  
  66.     /**
  67.      * Logs the event
  68.      * 
  69.      * @param array $event Array containing 'name' and 'data' keys
  70.      * 
  71.      * @return void 
  72.      */
  73.     public function update(array $event)
  74.     {
  75.         if (!in_array($event['name'], $this->events)) {
  76.             return;
  77.         }
  78.         $this->log->log($event['name'] . ":\n");
  79.         $this->log->log($event['data']);
  80.     }
  81. }
  82. ?>

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