N°8771 - Add Symfony form component to iTop core

- IO debug

sources/Forms/Block/IO/AbstractFormIO.php

@@ -7,48 +7,168 @@
 namespace Combodo\iTop\Forms\Block\IO;
 
 use Combodo\iTop\Forms\Block\AbstractFormBlock;
+use Symfony\Component\Form\FormEvents;
 
 class AbstractFormIO
 {
-
+	/** @var AbstractFormBlock The owner block */
 	private AbstractFormBlock $oOwnerBlock;
+
+	/** @var string Name of the IO */
 	private string $sName;
+
+	/** @var string Type of the IO data */
 	private string $sType;
 
+	/** @var array Stored values */
+	private array $aValues = [];
+
+	/**
+	 * Constructor.
+	 *
+	 * @param string $sName
+	 * @param string $sType
+	 */
 	public function __construct(string $sName, string $sType)
 	{
 		$this->sName = $sName;
 		$this->sType = $sType;
 	}
 
+	/**
+	 * Get the IO name.
+	 *
+	 * @return string
+	 */
 	public function GetName(): string
 	{
 		return $this->sName;
 	}
 
-	public function SetName(string $sName): void
+	/**
+	 * Set the IO name.
+	 *
+	 * @param string $sName
+	 *
+	 * @return self
+	 */
+	public function SetName(string $sName): self
 	{
 		$this->sName = $sName;
+		return $this;
 	}
 
-	public function GetType(): string
+	/**
+	 * Get the IO data type.
+	 *
+	 * @return string
+	 */
+	public function GetDataType(): string
 	{
 		return $this->sType;
 	}
 
-	public function SetType(string $sType): void
-	{
-		$this->sType = $sType;
-	}
-
+	/**
+	 * Get the owner block.
+	 *
+	 * @return AbstractFormBlock
+	 */
 	public function GetOwnerBlock(): AbstractFormBlock
 	{
 		return $this->oOwnerBlock;
 	}
 
-	public function SetOwnerBlock(AbstractFormBlock $oOwnerBlock): void
+	/**
+	 * Set the owner block.
+	 *
+	 * @param AbstractFormBlock $oOwnerBlock
+	 *
+	 * @return $this
+	 */
+	public function SetOwnerBlock(AbstractFormBlock $oOwnerBlock): self
 	{
 		$this->oOwnerBlock = $oOwnerBlock;
+		return $this;
 	}
 
+	/**
+	 * Set the IO value.
+	 *
+	 * @param string $sEventType
+	 * @param mixed $oValue
+	 *
+	 * @return self
+	 */
+	public function SetValue(string $sEventType, mixed $oValue): self
+	{
+		$this->aValues[$sEventType] = $oValue;
+
+		return $this;
+	}
+
+	/**
+	 * Get the IO value.
+	 *
+	 * @param string $sEventType
+	 *
+	 * @return mixed
+	 */
+	public function GetValue(string $sEventType): mixed
+	{
+		return $this->aValues[$sEventType] ?? null;
+	}
+
+	/**
+	 * Return true if value exist.
+	 *
+	 * @return bool
+	 */
+	public function HasValue(): bool
+	{
+		$PostSetDataExist = array_key_exists(FormEvents::POST_SET_DATA, $this->aValues) && $this->aValues[FormEvents::POST_SET_DATA] !== null;
+		$PostSubmitExist = array_key_exists(FormEvents::POST_SUBMIT, $this->aValues) && $this->aValues[FormEvents::POST_SUBMIT] !== null;
+		return $PostSetDataExist || $PostSubmitExist;
+	}
+
+	/**
+	 * Return all values.
+	 *
+	 * @return array
+	 */
+	public function GetValues(): array
+	{
+		return $this->aValues;
+	}
+
+	/**
+	 * Set the IO values.
+	 *
+	 * @param array $aValues
+	 *
+	 * @return $this
+	 */
+	public function SetValues(array $aValues): self
+	{
+		$this->aValues = $aValues;
+
+		return $this;
+	}
+
+	/**
+	 * Get the most relevant value.
+	 *
+	 * @return mixed
+	 */
+	public function Value(): mixed
+	{
+		if(array_key_exists(FormEvents::POST_SUBMIT, $this->aValues) ){
+			return $this->aValues[FormEvents::POST_SUBMIT];
+		}
+		if(array_key_exists(FormEvents::POST_SET_DATA, $this->aValues) ){
+			return $this->aValues[FormEvents::POST_SET_DATA];
+		}
+		return null;
+	}
+
+
 }