Moved under "trunk" to be able to track releases under "tags"

SVN:trunk[55]

core/stimulus.class.inc.php

@@ -0,0 +1,59 @@
+<?php
+
+/**
+ * A stimulus is the trigger that makes the lifecycle go ahead (state machine) 
+ *
+ * @package     iTopORM
+ * @author      Romain Quetiez <romainquetiez@yahoo.fr>
+ * @author      Denis Flaven <denisflave@free.fr>
+ * @license     http://www.opensource.org/licenses/lgpl-license.php LGPL
+ * @link        www.itop.com
+ * @since       1.0
+ * @version     1.1.1.1 $
+ */
+
+class ObjectStimulus
+{
+	private $m_aParams = array();
+
+	public function __construct($aParams)
+	{
+		$this->m_aParams = $aParams;
+		$this->ConsistencyCheck();
+	}
+
+	public function Get($sParamName) {return $this->m_aParams[$sParamName];}
+
+	// Note: I could factorize this code with the parameter management made for the AttributeDef class
+	// to be overloaded
+	static protected function ListExpectedParams()
+	{
+		return array("label", "description");
+	}
+
+	private function ConsistencyCheck()
+	{
+
+		// Check that any mandatory param has been specified
+		//
+		$aExpectedParams = $this->ListExpectedParams();
+		foreach($aExpectedParams as $sParamName)
+		{
+			if (!array_key_exists($sParamName, $this->m_aParams))
+			{
+				$aBacktrace = debug_backtrace();
+				$sTargetClass = $aBacktrace[2]["class"];
+				$sCodeInfo = $aBacktrace[1]["file"]." - ".$aBacktrace[1]["line"];
+				throw new CoreException("missing parameter '$sParamName' in ".get_class($this)." declaration for class $sTargetClass ($sCodeInfo)");
+			}
+		}
+	}
+}
+
+
+
+class StimulusUserAction extends ObjectStimulus
+{
+}
+
+?>