composer/iTop
6
0
Fork 0
mirror of https://github.com/Combodo/iTop.git synced 2026-04-24 02:58:43 +02:00
Code Issues Packages Projects Releases Wiki Activity

N°9065 - XML Definition for Dashlet properties

Browse Source
This commit is contained in:
Eric Espie
2026-01-06 15:59:46 +01:00
parent 904cd0b518
commit efb1bd765b
56 changed files with 2433 additions and 1270 deletions
Download Patch File Download Diff File Expand all files Collapse all files

133
sources/PropertyType/Compiler/PropertyTypeCompiler.php Normal file
View File

@@ -0,0 +1,133 @@
<?php
/*
* @copyright Copyright (C) 2010-2025 Combodo SAS
* @license http://opensource.org/licenses/AGPL-3.0
*/
namespace Combodo\iTop\PropertyType\Compiler;
use Combodo\iTop\DesignDocument;
use Combodo\iTop\PropertyType\PropertyType;
use Combodo\iTop\PropertyType\PropertyTypeFactory;
use utils;
/**
* XML to PHP Forms compiler.
*
* @package Combodo\iTop\PropertyType\Compiler
* @since 3.3.0
*/
class PropertyTypeCompiler
{
private static PropertyTypeCompiler $oInstance;
protected function __construct()
{
}
final public static function GetInstance(): PropertyTypeCompiler
{
if (!isset(static::$oInstance)) {
static::$oInstance = new PropertyTypeCompiler();
}
return static::$oInstance;
}
/**
* @param string $sXMLContent
*
* @return \Combodo\iTop\PropertyType\PropertyType
* @throws \Combodo\iTop\PropertyType\Compiler\PropertyTypeCompilerException
* @throws \Combodo\iTop\PropertyType\PropertyTypeException
* @throws \DOMFormatException
*/
protected function CompilePropertyTypeFromXML(string $sXMLContent): PropertyType
{
$oDoc = new DesignDocument();
libxml_clear_errors();
$oDoc->loadXML($sXMLContent);
$aErrors = libxml_get_errors();
if (count($aErrors) > 0) {
throw new PropertyTypeCompilerException('Property types definition not correctly formatted!');
}
/** @var \Combodo\iTop\DesignElement $oRoot */
$oRoot = $oDoc->firstChild;
return PropertyTypeFactory::GetInstance()->CreatePropertyTypeFromDom($oRoot);
}
/**
* @param string $sId
* @param string $sType
*
* @return string
* @throws \Combodo\iTop\PropertyType\Compiler\PropertyTypeCompilerException
*/
protected function GetXMLContent(string $sId, string $sType): string
{
$sPath = utils::GetAbsoluteModulePath('core')."property_types/$sType/$sId.xml";
if (!file_exists($sPath)) {
throw new PropertyTypeCompilerException("Properties definition $sType/$sId not present");
}
return file_get_contents($sPath);
}
/**
* Compile XML property tree into PHP to create the configuration form
*
* @param string $sXMLContent property tree structure in xml
*
* @return string Generated PHP
* @throws \Combodo\iTop\PropertyType\Compiler\PropertyTypeCompilerException
* @throws \Combodo\iTop\PropertyType\PropertyTypeException
* @throws \DOMFormatException
*/
public function CompileFormFromXML(string $sXMLContent): string
{
$oPropertyType = $this->CompilePropertyTypeFromXML($sXMLContent);
return $oPropertyType->ToPHPFormBlock();
}
/**
* @param string $sXMLContent
*
* @return string
* @throws \Combodo\iTop\PropertyType\Compiler\PropertyTypeCompilerException
* @throws \Combodo\iTop\PropertyType\PropertyTypeException
* @throws \DOMFormatException
*/
public function CompileEntityFromXML(string $sXMLContent): string
{
$oPropertyType = $this->CompilePropertyTypeFromXML($sXMLContent);
return $oPropertyType->ToPHPEntity();
}
/**
* @param string $sId
* @param string $sType
*
* @return string Generated PHP
* @throws \Combodo\iTop\PropertyType\Compiler\PropertyTypeCompilerException
* @throws \Combodo\iTop\PropertyType\PropertyTypeException
* @throws \DOMFormatException
*/
public function CompileForm(string $sId, string $sType): string
{
$sXMLContent = $this->GetXMLContent($sId, $sType);
return $this->CompileFormFromXML($sXMLContent);
}
public function CompileEntity(string $sId, string $sType): string
{
$sXMLContent = $this->GetXMLContent($sId, $sType);
return $this->CompileEntityFromXML($sXMLContent);
}
}

14
sources/PropertyType/Compiler/PropertyTypeCompilerException.php Normal file
View File

@@ -0,0 +1,14 @@
<?php
/*
* @copyright Copyright (C) 2010-2025 Combodo SAS
* @license http://opensource.org/licenses/AGPL-3.0
*/
namespace Combodo\iTop\PropertyType\Compiler;
use Combodo\iTop\PropertyType\PropertyTypeException;
class PropertyTypeCompilerException extends PropertyTypeException
{
}