* @author Romain Quetiez * @author Denis Flaven * @license http://www.opensource.org/licenses/gpl-3.0.html LGPL */ require_once(APPROOT."/application/utils.inc.php"); /** * Helper class to store and manipulate the parameters that make the application's context * * Usage: * 1) Build the application's context by constructing the object * (the object will read some of the page's parameters) * * 2) Add these parameters to hyperlinks or to forms using the helper, functions * GetForLink(), GetForForm() or GetAsHash() */ class ApplicationContext { protected $aNames; protected $aValues; protected static $aDefaultValues; // Cache shared among all instances public function __construct() { $this->aNames = array( 'org_id', 'menu' ); $this->ReadContext(); } /** * Read the context directly in the PHP parameters (either POST or GET) * return nothing */ protected function ReadContext() { if (empty(self::$aDefaultValues)) { self::$aDefaultValues = array(); $aContext = utils::ReadParam('c', array()); foreach($this->aNames as $sName) { $sValue = isset($aContext[$sName]) ? $aContext[$sName] : ''; // TO DO: check if some of the context parameters are mandatory (or have default values) if (!empty($sValue)) { self::$aDefaultValues[$sName] = $sValue; } // Hmm, there must be a better (more generic) way to handle the case below: // When there is only one possible (allowed) organization, the context must be // fixed to this org if ($sName == 'org_id') { if (MetaModel::IsValidClass('Organization')) { $oSearchFilter = new DBObjectSearch('Organization'); $oSet = new CMDBObjectSet($oSearchFilter); $iCount = $oSet->Count(); if ($iCount == 1) { // Only one possible value for org_id, set it in the context $oOrg = $oSet->Fetch(); self::$aDefaultValues[$sName] = $oOrg->GetKey(); } } } } } $this->aValues = self::$aDefaultValues; } /** * Returns the current value for the given parameter * @param string $sParamName Name of the parameter to read * @return mixed The value for this parameter */ public function GetCurrentValue($sParamName, $defaultValue = '') { if (isset($this->aValues[$sParamName])) { return $this->aValues[$sParamName]; } return $defaultValue; } /** * Returns the context as string with the format name1=value1&name2=value2.... * return string The context as a string to be appended to an href property */ public function GetForLink() { $aParams = array(); foreach($this->aValues as $sName => $sValue) { $aParams[] = "c[$sName]".'='.urlencode($sValue); } return implode("&", $aParams); } /** * Returns the context as sequence of input tags to be inserted inside a

tag * return string The context as a sequence of tags */ public function GetForForm() { $sContext = ""; foreach($this->aValues as $sName => $sValue) { $sContext .= "\n"; } return $sContext; } /** * Returns the context as a hash array 'parameter_name' => value * return array The context information */ public function GetAsHash() { $aReturn = array(); foreach($this->aValues as $sName => $sValue) { $aReturn["c[$sName]"] = $sValue; } return $aReturn; } /** * Returns an array of the context parameters NAMEs * @return array The list of context parameters */ public function GetNames() { return $this->aNames; } /** * Removes the specified parameter from the context, for example when the same parameter * is already a search parameter * @param string $sParamName Name of the parameter to remove * @return none */ public function Reset($sParamName) { if (isset($this->aValues[$sParamName])) { unset($this->aValues[$sParamName]); } } } ?>