composer/iTop
6
0
Fork 0
mirror of https://github.com/Combodo/iTop.git synced 2026-05-18 06:48:50 +02:00
Code Issues Packages Projects Releases Wiki Activity

Enhancement: PHP snippets inside the XML.

Browse Source 
SVN:trunk[3520]
This commit is contained in:
Denis Flaven
2015-03-27 17:16:40 +00:00
parent 3cf0fa3ee2
commit 2ba3ab3057
1 changed files with 110 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

110
setup/compiler.class.inc.php
View File

@@ -33,6 +33,7 @@ class MFCompiler
protected $aRootClasses; protected $aRootClasses;
protected $aLog; protected $aLog;
protected $sMainPHPCode; // Code that goes into core/main.php protected $sMainPHPCode; // Code that goes into core/main.php
protected $aSnippets;
public function __construct($oModelFactory) public function __construct($oModelFactory)
{ {
@@ -43,6 +44,7 @@ class MFCompiler
$this->sMainPHPCode .= "/**\n"; $this->sMainPHPCode .= "/**\n";
$this->sMainPHPCode .= " * This file was automatically generated by the compiler on ".date('Y-m-d H:i:s')." -- DO NOT EDIT\n"; $this->sMainPHPCode .= " * This file was automatically generated by the compiler on ".date('Y-m-d H:i:s')." -- DO NOT EDIT\n";
$this->sMainPHPCode .= " */\n"; $this->sMainPHPCode .= " */\n";
$this->aSnippets = array();
} }
protected function Log($sText) protected function Log($sText)
@@ -151,6 +153,8 @@ class MFCompiler
$this->Log("Root class (with child classes): ".$oClass->getAttribute('id')); $this->Log("Root class (with child classes): ".$oClass->getAttribute('id'));
$this->aRootClasses[$oClass->getAttribute('id')] = $oClass; $this->aRootClasses[$oClass->getAttribute('id')] = $oClass;
} }
$this->LoadSnippets();
// Compile, module by module // Compile, module by module
// //
@@ -179,6 +183,18 @@ class MFCompiler
$sCompiledCode .= $this->CompileConstant($oConstant)."\n"; $sCompiledCode .= $this->CompileConstant($oConstant)."\n";
} }
} }
if (array_key_exists($sModuleName, $this->aSnippets))
{
foreach( $this->aSnippets[$sModuleName]['before'] as $aSnippet)
{
$sCompiledCode .= "\n";
$sCompiledCode .= "/**\n";
$sCompiledCode .= " * Snippet: {$aSnippet['snippet_id']}\n";
$sCompiledCode .= " */\n";
$sCompiledCode .= $aSnippet['content']."\n";
}
}
$oClasses = $this->oFactory->ListClasses($sModuleName); $oClasses = $this->oFactory->ListClasses($sModuleName);
$iClassCount = $oClasses->length; $iClassCount = $oClasses->length;
@@ -294,6 +310,7 @@ EOF;
<<<EOF <<<EOF
} }
} // class $sMenuCreationClass } // class $sMenuCreationClass
EOF; EOF;
} }
@@ -304,6 +321,18 @@ EOF;
$sCompiledCode .= $this->CompileUserRights($oUserRightsNode); $sCompiledCode .= $this->CompileUserRights($oUserRightsNode);
} }
if (array_key_exists($sModuleName, $this->aSnippets))
{
foreach( $this->aSnippets[$sModuleName]['after'] as $aSnippet)
{
$sCompiledCode .= "\n";
$sCompiledCode .= "/**\n";
$sCompiledCode .= " * Snippet: {$aSnippet['snippet_id']}\n";
$sCompiledCode .= " */\n";
$sCompiledCode .= $aSnippet['content']."\n";
}
}
// Create (overwrite if existing) the compiled file // Create (overwrite if existing) the compiled file
// //
if (strlen($sCompiledCode) > 0) if (strlen($sCompiledCode) > 0)
@@ -382,6 +411,18 @@ EOF;
// //
$oBrandingNode = $this->oFactory->GetNodes('branding')->item(0); $oBrandingNode = $this->oFactory->GetNodes('branding')->item(0);
$this->CompileBranding($oBrandingNode, $sTempTargetDir, $sFinalTargetDir); $this->CompileBranding($oBrandingNode, $sTempTargetDir, $sFinalTargetDir);
if (array_key_exists('_core_', $this->aSnippets))
{
foreach( $this->aSnippets['_core_']['before'] as $aSnippet)
{
$this->sMainPHPCode .= "\n";
$this->sMainPHPCode .= "/**\n";
$this->sMainPHPCode .= " * Snippet: {$aSnippet['snippet_id']}\n";
$this->sMainPHPCode .= " */\n";
$this->sMainPHPCode .= $aSnippet['content']."\n";
}
}
// Compile the portals // Compile the portals
$oPortalsNode = $this->oFactory->GetNodes('/itop_design/portals')->item(0); $oPortalsNode = $this->oFactory->GetNodes('/itop_design/portals')->item(0);
@@ -391,6 +432,18 @@ EOF;
$oParametersNode = $this->oFactory->GetNodes('/itop_design/module_parameters')->item(0); $oParametersNode = $this->oFactory->GetNodes('/itop_design/module_parameters')->item(0);
$this->CompileParameters($oParametersNode, $sTempTargetDir, $sFinalTargetDir); $this->CompileParameters($oParametersNode, $sTempTargetDir, $sFinalTargetDir);
if (array_key_exists('_core_', $this->aSnippets))
{
foreach( $this->aSnippets['_core_']['after'] as $aSnippet)
{
$this->sMainPHPCode .= "\n";
$this->sMainPHPCode .= "/**\n";
$this->sMainPHPCode .= " * Snippet: {$aSnippet['snippet_id']}\n";
$this->sMainPHPCode .= " */\n";
$this->sMainPHPCode .= $aSnippet['content']."\n";
}
}
// Write core/main.php // Write core/main.php
SetupUtils::builddir($sTempTargetDir.'/core'); SetupUtils::builddir($sTempTargetDir.'/core');
$sPHPFile = $sTempTargetDir.'/core/main.php'; $sPHPFile = $sTempTargetDir.'/core/main.php';
@@ -2117,6 +2170,63 @@ EOF;
$this->sMainPHPCode .= "}\n"; $this->sMainPHPCode .= "}\n";
} }
} }
protected function LoadSnippets()
{
$oSnippets = $this->oFactory->GetNodes('/itop_design/snippets/snippet');
foreach($oSnippets as $oSnippet)
{
$sSnippetId = $oSnippet->getAttribute('id');
$sPlacement = $oSnippet->GetChildText('placement', null);
if ($sPlacement == 'core')
{
$sModuleId = '_core_';
}
else if ($sPlacement == 'module')
{
$sModuleId = $oSnippet->GetChildText('module', null);
if ($sModuleId == null)
{
throw new DOMFormatException("Invalid definition for snippet id='$sSnippetId' with placement=module. Missing '<module>' tag.");
}
}
else if ($sPlacement === 'null')
{
throw new DOMFormatException("Invalid definition for snippet id='$sSnippetId'. Missing <placement> tag.");
}
else
{
throw new DOMFormatException("Invalid definition for snippet id='$sSnippetId'. Incorrect value '$sPlacement' for <placement> tag. The allowed values are either 'core' or 'module'.");
}
if (!array_key_exists($sModuleId, $this->aSnippets))
{
$this->aSnippets[$sModuleId] = array('before' => array(), 'after' => array());
}
$fOrder = (float) $oSnippet->GetChildText('rank', 0);
$sContent = $oSnippet->GetChildText('content', '');
if ($fOrder < 0)
{
$this->aSnippets[$sModuleId]['before'][] = array(
'rank' => $fOrder,
'content' => $sContent,
'snippet_id' => $sSnippetId,
);
}
else
{
$this->aSnippets[$sModuleId]['after'][] = array(
'rank' => $fOrder,
'content' => $sContent,
'snippet_id' => $sSnippetId,
);
}
}
foreach($this->aSnippets as $sModuleId => $void)
{
uasort($this->aSnippets[$sModuleId]['before'], array(get_class($this), 'SortOnRank'));
}
}
} }
?> ?>