<?php
/**
 * Event handler base class
 * 
 * @author gERD Schaufelberger <gerd@exit0.net>
 * @copyright 2005 by http://wombat.exit0.net
 * @package wombatSite
 * @subpackage event
 */
 
/**
 * event
 *
 *
 * @version 0.1.0
 * @package wombatSite
 * @subpackage event
 */
class wbEventHandler
{
   /**
    * stop event handling on dropout
    * @var boolean $_dropout
    */
    var $_dropout   =   false;

   /**
    * handler default parameter
    * @var array $_params
    */
    var $_paramsDefault    =   array();

   /**
    * handler configuration parameter
    * @var array $_params
    */
    var $_params    =   array();

  /**
    * constructor
    *
    * @access public
    */
    function __construct() {
    }

   /**
    * constructor wrapper for PHP4
    *
    * @access public
    * @see __construct()
    */
    function wbEventHandler() {
        $this->__construct();
    }

   /**
    * set parameter for event handler
    *
    * @access public
    * @param object $e event object
    * @return string $msg
    */
    function setParams( $params ) {
        $this->_params  =   $this->_paramsDefault;
    
        if( !is_array( $params ) ) {
            return false;
        }
        
        foreach( $params as $key => $value ) {
            $this->_params[$key]  =   $value;
        }
    }
    
   /**
    * handle event
    *
    * @access public
    * @param object $e event object
    * @return string $msg
    */
    function process( &$e ) {
        return true;
    }
    
   /**
    * dropout
    * 
    * figure out whether event controller should stop event handling after 
    * processing this one
    *
    * @access public
    * @return booleadn $dropout
    */
    function dropout() {
        return  $this->_dropout;
    }
}
?>