♻️ new FieldFactory

Idea is to remove the aParams parameter from the Field object
And also allow to pass subblocks for the input value instead of only raw HTML

sources/application/UI/Base/Component/Field/Field.php

@@ -10,16 +10,10 @@ namespace Combodo\iTop\Application\UI\Base\Component\Field;
 use Combodo\iTop\Application\UI\Base\UIBlock;
 
 /**
- * Class Field
- *
- * @package Combodo\iTop\Application\UI\Base\Component\Field
- * @author Eric Espie <eric.espie@combodo.com>
- * @author Anne-Catherine Cognet <annecatherine.cognet@combodo.com>
  * @since 3.0.0
  */
 class Field extends UIBlock
 {
-	// Overloaded constants
 	/** @inheritdoc */
 	public const BLOCK_CODE = 'ibo-field';
 	/** @inheritdoc */
@@ -28,26 +22,323 @@ class Field extends UIBlock
 	public const ENUM_FIELD_LAYOUT_SMALL = 'small';
 	public const ENUM_FIELD_LAYOUT_LARGE = 'large';
 
+	/** @var string */
+	protected $sLayout;
+	/** @var string */
+	protected $sAttCode;
+	/** @var string */
+	protected $sAttType;
+	/** @var string */
+	protected $sAttLabel;
+	/** @var bool */
+	protected $bIsHidden;
+	/** @var bool */
+	protected $bIsReadOnly;
+	/** @var bool */
+	protected $bIsMandatory;
+	/** @var bool */
+	protected $bMustChange;
+	/** @var bool */
+	protected $bMustPrompt;
+	/** @var bool */
+	protected $bIsSlave;
+	/** @var string */
+	protected $sValueRaw;
+	/** @var string */
+	protected $sLabel;
 	/**
-	 * @var array Array of various parameters of the field.
-	 *            This should be exploded in dedicated properties instead of a grey array.
-	 *            See in the corresponding Twig file for keys to use
+	 * Could be Input, but we have legacy code that needs to set raw HTML !
+	 *
+	 * @var UIBlock
 	 */
-	protected $aParams;
+	protected $oValue;
+	/** @var string */
+	protected $sComments;
 
-	public function __construct(array $aParams, ?string $sId = null)
+	public function __construct(string $sLabel, UIBlock $oValue, ?string $sId = null)
 	{
 		parent::__construct($sId);
-		$this->aParams = $aParams;
+		$this->sLabel = $sLabel;
+		$this->oValue = $oValue;
 	}
 
 	/**
-	 * @return array
-	 * @internal
+	 * @return string
 	 */
-	public function GetParams(): array
+	public function GetLayout(): ?string
 	{
-		return $this->aParams;
+		return $this->sLayout;
 	}
 
+	/**
+	 * @param string $sLayout
+	 *
+	 * @return Field
+	 */
+	public function SetLayout(string $sLayout)
+	{
+		$this->sLayout = $sLayout;
+
+		return $this;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function GetAttCode(): ?string
+	{
+		return $this->sAttCode;
+	}
+
+	/**
+	 * @param string $sAttCode
+	 *
+	 * @return Field
+	 */
+	public function SetAttCode(string $sAttCode): Field
+	{
+		$this->sAttCode = $sAttCode;
+
+		return $this;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function GetAttType(): ?string
+	{
+		return $this->sAttType;
+	}
+
+	/**
+	 * @param string $sAttType
+	 *
+	 * @return Field
+	 */
+	public function SetAttType(string $sAttType): Field
+	{
+		$this->sAttType = $sAttType;
+
+		return $this;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function GetAttLabel(): ?string
+	{
+		return $this->sAttLabel;
+	}
+
+	/**
+	 * @param string $sAttLabel
+	 *
+	 * @return Field
+	 */
+	public function SetAttLabel(string $sAttLabel): Field
+	{
+		$this->sAttLabel = $sAttLabel;
+
+		return $this;
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function IsHidden(): bool
+	{
+		return $this->bIsHidden;
+	}
+
+	/**
+	 * @param bool $bIsHidden
+	 *
+	 * @return Field
+	 */
+	public function SetIsHidden(bool $bIsHidden)
+	{
+		$this->bIsHidden = $bIsHidden;
+
+		return $this;
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function IsReadOnly(): bool
+	{
+		return $this->bIsReadOnly;
+	}
+
+	/**
+	 * @param bool $bIsReadOnly
+	 *
+	 * @return Field
+	 */
+	public function SetIsReadOnly(bool $bIsReadOnly)
+	{
+		$this->bIsReadOnly = $bIsReadOnly;
+
+		return $this;
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function IsMandatory(): bool
+	{
+		return $this->bIsMandatory;
+	}
+
+	/**
+	 * @param bool $bIsMandatory
+	 *
+	 * @return Field
+	 */
+	public function SetIsMandatory(bool $bIsMandatory)
+	{
+		$this->bIsMandatory = $bIsMandatory;
+
+		return $this;
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function IsMustChange(): bool
+	{
+		return $this->bMustChange;
+	}
+
+	/**
+	 * @param bool $bIsMustChange
+	 *
+	 * @return Field
+	 */
+	public function SetMustChange(bool $bIsMustChange)
+	{
+		$this->bMustChange = $bIsMustChange;
+
+		return $this;
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function IsMustPrompt(): bool
+	{
+		return $this->bMustPrompt;
+	}
+
+	/**
+	 * @param bool $bIsMustPrompt
+	 *
+	 * @return Field
+	 */
+	public function SetMustPrompt(bool $bIsMustPrompt)
+	{
+		$this->bMustPrompt = $bIsMustPrompt;
+
+		return $this;
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function IsSlave(): bool
+	{
+		return $this->bIsSlave;
+	}
+
+	/**
+	 * @param bool $bIsSlave
+	 *
+	 * @return Field
+	 */
+	public function SetIsSlave(bool $bIsSlave)
+	{
+		$this->bIsSlave = $bIsSlave;
+
+		return $this;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function GetValueRaw(): ?string
+	{
+		return $this->sValueRaw;
+	}
+
+	/**
+	 * @param string $sValueRaw
+	 *
+	 * @return Field
+	 */
+	public function SetValueRaw(string $sValueRaw)
+	{
+		$this->sValueRaw = $sValueRaw;
+
+		return $this;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function GetLabel(): string
+	{
+		return $this->sLabel;
+	}
+
+	/**
+	 * @param string $sLabel
+	 *
+	 * @return Field
+	 */
+	public function SetLabel(string $sLabel)
+	{
+		$this->sLabel = $sLabel;
+
+		return $this;
+	}
+
+	/**
+	 * @return \Combodo\iTop\Application\UI\Base\UIBlock
+	 */
+	public function GetValue()
+	{
+		return $this->oValue;
+	}
+
+	/**
+	 * @param \Combodo\iTop\Application\UI\Base\UIBlock $oValue
+	 *
+	 * @return Field
+	 */
+	public function SetValue(UIBlock $oValue)
+	{
+		$this->oValue = $oValue;
+
+		return $this;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function GetComments(): ?string
+	{
+		return $this->sComments;
+	}
+
+	/**
+	 * @param string $sComments
+	 *
+	 * @return Field
+	 */
+	public function SetComments(string $sComments)
+	{
+		$this->sComments = $sComments;
+
+		return $this;
+	}
 }

sources/application/UI/Base/Component/Field/FieldFactory.php

@@ -0,0 +1,74 @@
+<?php
+/**
+ * @copyright   Copyright (C) 2010-2020 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+
+namespace Combodo\iTop\Application\UI\Base\Component\Field;
+
+
+use Combodo\iTop\Application\UI\Base\Component\Html\Html;
+use Combodo\iTop\Application\UI\Base\Component\Input\AbstractInput;
+
+/**
+ * @since 3.0.0
+ */
+class FieldFactory
+{
+	public static function MakeFromParams($aParams)
+	{
+		$oValue = new Html($aParams['value']);
+		$oField = new Field($aParams['label'], $oValue);
+
+		$aParamsMapping = [
+			'layout' => 'SetLayout',
+			'attcode' => 'SetAttCode',
+			'atttype' => 'SetAttType',
+			'attlabel' => 'SetAttLabel',
+			'value_raw' => 'SetValueRaw',
+			'comments' => 'SetComments',
+		];
+		foreach ($aParamsMapping as $sParamKey => $sFieldMethod) {
+			self::UpdateFieldFromParams($oField, $sFieldMethod, $aParams, $sParamKey);
+		}
+
+		if (isset($aParams['attflags'])) {
+			$aParamsFlagsMapping = [
+				OPT_ATT_HIDDEN => 'SetIsHidden',
+				OPT_ATT_READONLY => 'SetIsReadOnly',
+				OPT_ATT_MANDATORY => 'SetIsMandatory',
+				OPT_ATT_MUSTCHANGE => 'SetMustChange',
+				OPT_ATT_MUSTPROMPT => 'SetMustPrompt',
+				OPT_ATT_SLAVE => 'SetIsSlave',
+			];
+			foreach ($aParamsFlagsMapping as $sConstant => $sFieldMethod) {
+				self::UpdateFlagsFieldFromParams($oField, $sFieldMethod, $aParams['attflags'], $sConstant);
+			}
+		}
+
+		return $oField;
+	}
+
+	private static function UpdateFieldFromParams($oField, $sMethodName, $aParams, $sKey): void
+	{
+		if (isset($aParams[$sKey])) {
+			$oField->$sMethodName($aParams[$sKey]);
+		}
+	}
+
+	private static function UpdateFlagsFieldFromParams($oField, $sMethodName, $iParamsFlags, $iConstant): void
+	{
+		$oField->$sMethodName(($iParamsFlags & $iConstant) === $iConstant);
+	}
+
+	public static function MakeFromObject(string $sLabel, AbstractInput $oInput, ?string $sLayout = null)
+	{
+		$oField = new Field($sLabel, $oInput);
+
+		if (!is_null($sLayout)) {
+			$oField->SetLayout($sLayout);
+		}
+
+		return $oField;
+	}
+}