N°9065 - XML Definition for Dashlet properties

sources/PropertyType/PropertyType.php

@@ -0,0 +1,79 @@
+<?php
+
+/*
+ * @copyright   Copyright (C) 2010-2025 Combodo SAS
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+
+namespace Combodo\iTop\PropertyType;
+
+use Combodo\iTop\DesignElement;
+use Combodo\iTop\PropertyType\ValueType\AbstractValueType;
+
+/**
+ * A property type is a definition of properties (organized in tree)
+ * used for dashlet for example.
+ * @since 3.3.0
+ */
+class PropertyType
+{
+	private string $sParentType = '';
+	private string $sId;
+	private AbstractValueType $oValueType;
+
+	/**
+	 * @param \Combodo\iTop\DesignElement $oDomNode
+	 *
+	 * @return void
+	 * @throws \Combodo\iTop\PropertyType\PropertyTypeException
+	 * @throws \DOMFormatException
+	 */
+	public function InitFromDomNode(DesignElement $oDomNode): void
+	{
+		$this->sId = $oDomNode->getAttribute('id');
+		$this->sParentType = $oDomNode->GetChildText('extends', '');
+
+		$oDefinitionNode = $oDomNode->GetUniqueElement('definition');
+		$sDefinitionNodeType = $oDefinitionNode->getAttribute('xsi:type');
+
+		if (!is_a($sDefinitionNodeType, AbstractValueType::class, true)) {
+			throw new PropertyTypeException('Unsupported type '.json_encode($sDefinitionNodeType).' in ');
+		}
+
+		$this->oValueType = new $sDefinitionNodeType();
+		$this->oValueType->SetRootId($this->sId);
+		$this->oValueType->InitFromDomNode($oDefinitionNode);
+	}
+
+	public function ToPHPFormBlock(): string
+	{
+		$aPHPFragments = [];
+
+		if ($this->oValueType->IsLeaf()) {
+
+			$sLocalPHP = <<<PHP
+class FormFor__$this->sId extends Combodo\iTop\Forms\Block\Base\FormBlock
+{
+	protected function BuildForm(): void
+	{
+PHP;
+
+			$sLocalPHP .= "\n".$this->oValueType->ToPHPFormBlock($aPHPFragments);
+
+			$sLocalPHP .= <<<PHP
+	}
+}
+PHP;
+			$aPHPFragments[] = $sLocalPHP;
+		} else {
+			$this->oValueType->ToPHPFormBlock($aPHPFragments);
+		}
+
+		return implode("\n\n", $aPHPFragments);
+	}
+
+	public function GetParentType(): string
+	{
+		return $this->sParentType;
+	}
+}