<?php
/**
 * Event finished working succsessfully
 *
 */
	define('erSUCCESS',0);	
	
/**
 * Event finished working, but result is unsuccsessfull
 *
 */
	define('erFAIL',-1);
/**
 * Event experienced FATAL error - no hooks should continue!
 *
 */
	define('erFATAL',-2);

	class kEvent extends kBase {
		
		/**
		 * Event reference, that
		 * created this event
		 *
		 * @var kEvent
		 * @access public
		 */
		var $MasterEvent;
		
		/**
		 * Event name
		 *
		 * @var string
		 * @access public
		 */
		var $Name;

		/**
		 * Pseudo class name
		 *
		 * @var string
		 * @access public
		 */
		//var $Prefix;	
		
		/**
		 * Special, that is recognized
		 * by class with pseudo class
		 * equals to $Prefix attrbute.
		 *
		 * @var string
		 * @access public
		 */
		//var $Special;

		/**
		 * Joined prefix and special,
		 * usually taken directly from
		 * tag beeing processes, to use
		 * in recallObject method
		 *
		 * @var string
		 */
		var $Prefix_Special;
		
		/**
		 * Do not execute Before hooks
		 * while processing main event
		 *
		 * @var bool
		 * @access public
		 */
		var $SkipBeforeHooks=false;
		
		/**
		 * Do not execute After hooks
		 * while processing main event
		 *
		 * @var bool
		 * @access public
		 */
		var $SkipAfterHooks=false;
	
		/**
		 * Redirect is allowed after
		 * this event
		 *
		 * @var bool
		 * @access public
		 */
		var $redirect=false;
		
		
		/**
		 * Params passed to redirect on succsessfull event
		 *
		 * @var bool
		 * @access public
		 */
		var $redirect_params=null;

		/**
		 * php file to redirect to
		 *
		 * @var string
		 * @access public
		 */
		var $redirect_script=null;
		
		/**
		 * Event processing result
		 *
		 * @var int
		 * @access public
		 */
		var $status=erSUCCESS;
		
		/**
		 * Each event specific only params,
		 * that they use for communication
		 *
		 * @var Array
		 * @access public
		 */
		var $specificParams=Array();
		
		/**
		 * Pseudo class used to create object,
		 * in case if one is not already created
		 *
		 * @var string
		 * @access public
		 */
		var $pseudoClass='';
		
		/**
		 * Create event based on params passed
		 *
		 * @param Array $params
		 * @return kEvent
		 * @access public
		 */
		function kEvent($params=Array(), $specificParams=null)
		{
			parent::kBase();
			if($params && is_array($params))
			{
				$prefix = getArrayValue($params,'prefix');
				$special = getArrayValue($params,'special');
				if($prefix) $this->Init($prefix,$special);
				$this->Name = getArrayValue($params,'name');
			}
			elseif ($params && is_string($params)) {
				if (preg_match('/([^.:]*)[.]{0,1}([^:]*):(.*)/', $params, $regs)) {
					$prefix = $regs[1];
					$special = $regs[2];
					if($prefix) $this->Init($prefix,$special);
					$this->Name = $regs[3];
				}
				else {
					trigger_error('Invalid event string '.$params.' should be prefix[.special]:OnEvent ', E_USER_ERROR);
				}
			}
			if (isset($specificParams)) $this->specificParams = $specificParams;
		}
		
		function setEventParam($name,$value)
		{
			$this->specificParams[$name]=$value;
		}

		function getEventParam($name)
		{
			return getArrayValue($this->specificParams, $name);
		}
		
		function getPrefixSpecial($from_submit=false)
		{
			$separator=!$from_submit?'.':'_';
			$ret=$this->Prefix.$separator.$this->Special;
			return rtrim($ret,$separator);
		}
		
		/**
		 * Set's pseudo class that differs from
		 * the one specified in $Prefix
		 *
		 * @param string $appendix
		 * @access public
		 */
		function setPseudoClass($appendix)
		{
			$this->pseudoClass=$this->Prefix.$appendix;
		}
		
		function Init($prefix,$special='')
		{
			$this->Prefix=$prefix;
			$this->pseudoClass=$prefix; // default value
			$this->Special=$special;
			$this->Prefix_Special = rtrim($this->Prefix.'.'.$this->Special,'.');
		}
		
		/**
		 * Returns object used in event
		 *
		 * @access public
		 * @return kDBBase
		 */
		function &getObject($params = Array())
		{
			$object =& $this->Application->recallObject($this->Prefix_Special, $this->pseudoClass, $params);
			return $object;
		}
		
		/**
		 * Calls passed event by name in current prefix/special environment
		 * Called event gets this event as MasterEvent,
		 * but its results (status and redirect* properties are copied back to current event)
		 *
		 * @param string $name EventName to call
		 */
		function CallSubEvent($name)
		{
			$child_event = new kEvent();
			$child_event->MasterEvent =& $this;
			$child_event->Prefix = $this->Prefix;
			$child_event->Special = $this->Special;
			$child_event->Prefix_Special = $this->Prefix_Special;
			$child_event->redirect = $this->redirect;
			$child_event->redirect_params = $this->redirect_params;
			$child_event->redirect_script = $this->redirect_script;
			$child_event->Name = $name;
			
			$this->Application->HandleEvent( $child_event );
			
			$this->status = $child_event->status;
			$this->redirect = $child_event->redirect;
			$this->redirect_params = $child_event->redirect_params;
			$this->redirect_script = $child_event->redirect_script;
		}
		
		/**
		 * Set's redirect param for event
		 *
		 * @param string $name
		 * @param string $value
		 * @access public
		 */
		function SetRedirectParam($name, $value)
		{
			$this->redirect_params[$name] = $value;
		}
		
		/**
		 * Allows to merge passed redirect params hash with existing ones
		 *
		 * @param Array $params
		 * @access public
		 */
		function setRedirectParams($params)
		{
			$this->redirect_params = array_merge_recursive2($this->redirect_params, $params);
		}
		
		/**
		 * Returns Master event name if any
		 *
		 * @return mixed
		 * @access public
		 */
		function hasMasterEvent()
		{
			return is_object($this->MasterEvent) ? $this->MasterEvent->Name : false;
		}
		
	}

?>