N°7063 - Forms SDK - Add Symfony forms component

error forms issue

sources/FormSDK/Service/FactoryAddon/FormFactoryObjectAddon.php

@@ -0,0 +1,182 @@
+<?php
+/*
+ * Copyright (C) 2013-2023 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
+ */
+
+namespace Combodo\iTop\FormSDK\Service\FactoryPlugin;
+
+use AttributeDefinition;
+use AttributeString;
+use Combodo\iTop\FormSDK\Field\Description\FormFieldDescription;
+use Combodo\iTop\FormSDK\Field\Description\FormFieldTypeEnumeration;
+use DBObject;
+use Exception;
+use ExceptionLog;
+use MetaModel;
+
+/**
+ * Form manipulation for DBObject.
+ *
+ * @package FormSDK
+ * @since 3.2.0
+ */
+final class FormFactoryObjectAddon implements FormFactoryAddonInterface
+{
+	/** @var array list of object attributes */
+	private array $aAttributes = [];
+
+	/**
+	 * Constructor.
+	 *
+	 * @param \DBObject $oDBObject
+	 * @param bool $bGroup
+	 */
+	public function __construct(
+		private readonly DBObject $oDBObject,
+		private readonly bool $bGroup = true
+	)
+	{
+
+	}
+
+	/**
+	 * Add an object attribute.
+	 *
+	 * @param string $sAttributeCode
+	 * @param array $aOptions
+	 *
+	 * @return $this
+	 */
+	public function AddAttribute(string $sAttributeCode, array $aOptions = []) : FormFactoryObjectAddon
+	{
+		$this->aAttributes[$sAttributeCode] = $aOptions;
+		return $this;
+	}
+
+	/**
+	 * Get attribute data.
+	 *
+	 * @throws \CoreException
+	 * @throws \ArchivedObjectException
+	 */
+	protected function GetAttributeData(string $sAttributeCode) : mixed
+	{
+		return $this->oDBObject->Get($sAttributeCode);
+	}
+
+	/**
+	 * Get attribute form type options.
+	 *
+	 * @param \AttributeDefinition $oAttributeDefinition
+	 *
+	 * @return array
+	 */
+	private function GetAttributeOptions(AttributeDefinition $oAttributeDefinition) : array
+	{
+		$aOptions = [];
+
+		if($oAttributeDefinition instanceof AttributeString) {
+			$aOptions['required'] = !$oAttributeDefinition->IsNullAllowed();
+		}
+
+		return $aOptions;
+	}
+
+	/**
+	 * Get attribute description.
+	 *
+	 * @param string $sAttributeCode
+	 *
+	 * @return \Combodo\iTop\FormSDK\Field\Description\FormFieldDescription|null
+	 * @throws \Exception
+	 */
+	private function GetAttributeDescription(string $sAttributeCode) : ?FormFieldDescription
+	{
+		$oAttributeDefinition = MetaModel::GetAttributeDef(get_class($this->oDBObject), $sAttributeCode);
+
+		if($oAttributeDefinition instanceof AttributeString) {
+			return new FormFieldDescription(
+				$this->GetAttributePath($sAttributeCode),
+				FormFieldTypeEnumeration::TEXT,
+				array_merge(
+					$this->GetAttributeOptions($oAttributeDefinition),
+					$this->aAttributes[$sAttributeCode])
+			);
+		}
+
+		return null;
+	}
+
+	/**
+	 * Return attribute path.
+	 *
+	 * @param string $sAttributeCode
+	 *
+	 * @return string
+	 */
+	private function GetAttributePath(string $sAttributeCode) : string
+	{
+		return $this->bGroup ? $sAttributeCode : $this->GetIdentifier() . '-' . $sAttributeCode;
+	}
+
+	/** @inheritdoc */
+	public function GetFormData() : array
+	{
+		$aData = [];
+		foreach ($this->aAttributes as $sAttributeCode => $oValue){
+			try {
+				$aData[$this->GetAttributePath($sAttributeCode)] = $this->GetAttributeData($sAttributeCode);
+			}
+			catch (Exception $e) {
+				$aData[$this->GetAttributePath($sAttributeCode)] = null;
+				ExceptionLog::LogException($e);
+			}
+		}
+		return $aData;
+	}
+
+	/** @inheritdoc */
+	public function GetFormDescriptions() : array
+	{
+		$aDescriptions = [];
+
+		foreach ($this->aAttributes as $sKey => $oValue){
+			try {
+				$aDescriptions[$sKey] = $this->GetAttributeDescription($sKey);
+			}
+			catch (Exception $e) {
+				ExceptionLog::LogException($e);
+			}
+		}
+
+		if($this->bGroup){
+			$oGroupDescriptions = new FormFieldDescription($this->GetIdentifier(), FormFieldTypeEnumeration::DB_OBJECT, [
+				'descriptions' => $aDescriptions
+			]);
+			return [$oGroupDescriptions];
+		}
+		else{
+			return $aDescriptions;
+		}
+	}
+
+	/** @inheritdoc */
+	public function GetIdentifier(): string
+	{
+		return get_class($this->oDBObject) . '_' . $this->oDBObject->GetKey();
+	}
+}