Custom fields: alpha version.

SVN:trunk[3943]

core/customfieldshandler.class.inc.php

@@ -0,0 +1,127 @@
+<?php
+// Copyright (C) 2016 Combodo SARL
+//
+//   This file is part of iTop.
+//
+//   iTop is free software; you can redistribute it and/or modify
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
+//   but WITHOUT ANY WARRANTY; without even the implied warranty of
+//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//   GNU Affero General Public License for more details.
+//
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
+use Combodo\iTop\Form\Form;
+use Combodo\iTop\Form\FormManager;
+
+/**
+ * Base class to implement a handler for AttributeCustomFields
+ *
+ * @copyright   Copyright (C) 2016 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+
+abstract class CustomFieldsHandler
+{
+	protected $oHostObject;
+	protected $sAttCode;
+	protected $aValues;
+	protected $oForm;
+
+	/**
+	 * This constructor's prototype must be frozen.
+	 * Any specific behavior must be implemented in BuildForm()
+	 *
+	 * @param DBObject $oHostObject
+	 * @param $sAttCode
+	 */
+	final public function __construct(DBObject $oHostObject, $sAttCode)
+	{
+		$this->oHostObject = $oHostObject;
+		$this->sAttCode = $sAttCode;
+		$this->aValues = null;
+	}
+
+	abstract public function BuildForm($sFormId);
+
+	/**
+	 *
+	 * @return \Combodo\iTop\Form\Form
+	 */
+	public function GetForm()
+	{
+		return $this->oForm;
+	}
+
+	public function SetCurrentValues($aValues)
+	{
+		$this->aValues = $aValues;
+	}
+
+	static public function GetPrerequisiteAttributes($sClass = null)
+	{
+		return array();
+	}
+
+	/**
+	 * List the available verbs for 'GetForTemplate'
+	 */
+	static public function EnumTemplateVerbs()
+	{
+		return array();
+	}
+
+	/**
+	 * Get various representations of the value, for insertion into a template (e.g. in Notifications)
+	 * @param $aValues array The current values
+	 * @param $sVerb string The verb specifying the representation of the value
+	 * @param $bLocalize bool Whether or not to localize the value
+	 * @return string
+	 */
+	abstract public function GetForTemplate($aValues, $sVerb, $bLocalize = true);
+
+	/**
+	 * @param $aValues
+	 * @param bool|true $bLocalize
+	 * @return mixed
+	 */
+	abstract public function GetAsHTML($aValues, $bLocalize = true);
+
+	/**
+	 * @param $aValues
+	 * @param bool|true $bLocalize
+	 * @return mixed
+	 */
+	abstract public function GetAsXML($aValues, $bLocalize = true);
+
+	/**
+	 * @param $aValues
+	 * @param string $sSeparator
+	 * @param string $sTextQualifier
+	 * @param bool|true $bLocalize
+	 * @return mixed
+	 */
+	abstract public function GetAsCSV($aValues, $sSeparator = ',', $sTextQualifier = '"', $bLocalize = true);
+
+	/**
+	 * @return array Associative array id => value
+	 */
+	abstract public function ReadValues();
+
+	/**
+	 * Record the data (currently in the processing of recording the host object)
+	 * It is assumed that the data has been checked prior to calling Write()
+	 * @param array Associative array id => value
+	 */
+	abstract public function WriteValues($aValues);
+
+	/**
+	 * Cleanup data upon object deletion (object id still available here)
+	 */
+	abstract public function DeleteValues();
+}