N°9065 - XML Definition for Dashlet properties

2026-02-13 07:24:13 +01:00 · 2026-01-06 15:59:46 +01:00
parent 904cd0b518
commit efb1bd765b
56 changed files with 2433 additions and 1270 deletions
--- a/sources/PropertyType/PropertyTypeService.php
+++ b/sources/PropertyType/PropertyTypeService.php
@@ -0,0 +1,91 @@
+<?php
+
+/*
+ * @copyright   Copyright (C) 2010-2026 Combodo SAS
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+
+namespace Combodo\iTop\PropertyType;
+
+use Combodo\iTop\Forms\Block\Base\FormBlock;
+use Combodo\iTop\Forms\Block\FormBlockException;
+use Combodo\iTop\Forms\Block\FormBlockService;
+use Combodo\iTop\PropertyType\Compiler\PropertyTypeCompiler;
+use Combodo\iTop\Service\Cache\DataModelDependantCache;
+use utils;
+
+class PropertyTypeService
+{
+	public const FORM_CACHE_POOL = 'Forms';
+
+	private DataModelDependantCache $oCacheService;
+
+	private static PropertyTypeService $oInstance;
+
+	protected function __construct()
+	{
+		$this->oCacheService = DataModelDependantCache::GetInstance();
+	}
+
+	final public static function GetInstance(): PropertyTypeService
+	{
+		if (!isset(static::$oInstance)) {
+			static::$oInstance = new PropertyTypeService();
+		}
+
+		return static::$oInstance;
+	}
+
+	/**
+	 * @param string $sId name of the form to retrieve
+	 * @param string $sType
+	 *
+	 * @return \Combodo\iTop\Forms\Block\Base\FormBlock
+	 * @throws \Combodo\iTop\Forms\Block\FormBlockException
+	 * @throws \Combodo\iTop\PropertyType\Compiler\PropertyTypeCompilerException
+	 * @throws \Combodo\iTop\PropertyType\PropertyTypeException
+	 * @throws \DOMFormatException
+	 */
+	public function GetFormBlockById(string $sId, string $sType): FormBlock
+	{
+		$sFilteredId = $this->SanitizeId($sId);
+		$sCacheKey = $this->GetCacheKey($sType, $sFilteredId);
+
+		if (!$this->oCacheService->HasEntry(self::FORM_CACHE_POOL, $sCacheKey) || utils::IsDevelopmentEnvironment()) {
+			// Cache not found, compile the form
+			$sPHPContent = PropertyTypeCompiler::GetInstance()->CompileForm($sFilteredId, $sType);
+			$this->oCacheService->StorePhpContent(self::FORM_CACHE_POOL, $sCacheKey, "<?php\n\n$sPHPContent");
+		}
+		$this->oCacheService->FetchPHP(self::FORM_CACHE_POOL, $sCacheKey);
+		$sFormBlockClass = 'FormFor__'.$sFilteredId;
+
+		return new $sFormBlockClass($sFilteredId);
+	}
+
+	/**
+	 * @param string $sId
+	 *
+	 * @return string
+	 * @throws \Combodo\iTop\Forms\Block\FormBlockException
+	 */
+	private function SanitizeId(string $sId): string
+	{
+		$sFilteredId = preg_replace('/[^0-9a-zA-Z_]/', '', $sId);
+		if (strlen($sFilteredId) === 0 || $sFilteredId !== $sId) {
+			throw new FormBlockException('Malformed name for block: '.json_encode($sId));
+		}
+
+		return $sFilteredId;
+	}
+
+	/**
+	 * @param string $sType
+	 * @param string $sFilteredId
+	 *
+	 * @return string
+	 */
+	private function GetCacheKey(string $sType, string $sFilteredId): string
+	{
+		return $sType.'/'.$sFilteredId;
+	}
+}