mirror of
https://github.com/Combodo/iTop.git
synced 2026-02-13 15:34:12 +01:00
869 lines
34 KiB
PHP
869 lines
34 KiB
PHP
<?php
|
|
/*
|
|
* @copyright Copyright (C) 2010-2021 Combodo SARL
|
|
* @license http://opensource.org/licenses/AGPL-3.0
|
|
*/
|
|
|
|
namespace Combodo\iTop\Application\UI\Base\Component\DataTable;
|
|
|
|
use ApplicationException;
|
|
use appUserPreferences;
|
|
use AttributeLinkedSet;
|
|
use cmdbAbstractObject;
|
|
use Combodo\iTop\Application\UI\Base\AbstractUIBlockFactory;
|
|
use Combodo\iTop\Application\UI\Base\Component\DataTable\StaticTable\FormTable\FormTable;
|
|
use Combodo\iTop\Application\UI\Base\Component\DataTable\StaticTable\FormTableRow\FormTableRow;
|
|
use Combodo\iTop\Application\UI\Base\Component\DataTable\StaticTable\StaticTable;
|
|
use Combodo\iTop\Application\UI\Base\Component\Panel\PanelUIBlockFactory;
|
|
use Combodo\iTop\Application\UI\Base\Component\Title\TitleUIBlockFactory;
|
|
use Combodo\iTop\Application\UI\Base\Component\Toolbar\ToolbarUIBlockFactory;
|
|
use Combodo\iTop\Application\UI\Base\Layout\UIContentBlock;
|
|
use DBObjectSet;
|
|
use Dict;
|
|
use MenuBlock;
|
|
use MetaModel;
|
|
use UserRights;
|
|
use utils;
|
|
use WebPage;
|
|
|
|
/**
|
|
* Class DataTableUIBlockFactory
|
|
*
|
|
* @internal
|
|
* @package Combodo\iTop\Application\UI\Base\Component\DataTable
|
|
* @since 3.0.0
|
|
*/
|
|
class DataTableUIBlockFactory extends AbstractUIBlockFactory
|
|
{
|
|
public const TWIG_TAG_NAME = 'UIDataTable';
|
|
public const UI_BLOCK_CLASS_NAME = DataTable::class;
|
|
|
|
/**
|
|
* @param \WebPage $oPage
|
|
* @param string $sListId
|
|
* @param \DBObjectSet $oSet
|
|
* @param array $aExtraParams
|
|
*
|
|
* @return \Combodo\iTop\Application\UI\Base\Layout\UIContentBlock
|
|
* @throws \ApplicationException
|
|
* @throws \ArchivedObjectException
|
|
* @throws \CoreException
|
|
* @throws \CoreUnexpectedValue
|
|
* @throws \DictExceptionMissingString
|
|
* @throws \MissingQueryArgument
|
|
* @throws \MySQLException
|
|
* @throws \MySQLHasGoneAwayException
|
|
* @throws \OQLException
|
|
* @throws \ReflectionException
|
|
*/
|
|
public static function MakeForResult(WebPage $oPage, string $sListId, DBObjectSet $oSet, $aExtraParams = array())
|
|
{
|
|
$oDataTable = DataTableUIBlockFactory::MakeForRendering($sListId, $oSet, $aExtraParams);
|
|
return self::RenderDataTable($oDataTable, 'list', $oPage, $sListId, $oSet, $aExtraParams);
|
|
}
|
|
|
|
/**
|
|
* @param \WebPage $oPage
|
|
* @param string $sListId
|
|
* @param DBObjectSet $oSet
|
|
* @param array $aExtraParams
|
|
*
|
|
* @return \Combodo\iTop\Application\UI\Base\Layout\UIContentBlock
|
|
* @throws \ArchivedObjectException
|
|
* @throws \CoreException
|
|
* @throws \CoreUnexpectedValue
|
|
* @throws \DictExceptionMissingString
|
|
* @throws \MissingQueryArgument
|
|
* @throws \MySQLException
|
|
* @throws \MySQLHasGoneAwayException
|
|
* @throws \OQLException
|
|
* @throws \ReflectionException
|
|
*/
|
|
public static function MakeForObject(WebPage $oPage, string $sListId, DBObjectSet $oSet, $aExtraParams = array())
|
|
{
|
|
$oDataTable = DataTableUIBlockFactory::MakeForRenderingObject($sListId, $oSet, $aExtraParams);
|
|
return self::RenderDataTable($oDataTable, 'listInObject', $oPage, $sListId, $oSet, $aExtraParams);
|
|
}
|
|
|
|
/**
|
|
* @param \Combodo\iTop\Application\UI\Base\Component\DataTable\DataTable $oDataTable
|
|
* @param string $sStyle
|
|
* @param \WebPage $oPage
|
|
* @param string $sListId
|
|
* @param \DBObjectSet $oSet
|
|
* @param array $aExtraParams
|
|
*
|
|
* @return \Combodo\iTop\Application\UI\Base\Layout\UIContentBlock
|
|
* @throws \ArchivedObjectException
|
|
* @throws \CoreException
|
|
* @throws \CoreUnexpectedValue
|
|
* @throws \DictExceptionMissingString
|
|
* @throws \MissingQueryArgument
|
|
* @throws \MySQLException
|
|
* @throws \MySQLHasGoneAwayException
|
|
* @throws \OQLException
|
|
* @throws \ReflectionException
|
|
*/
|
|
protected static function RenderDataTable(DataTable $oDataTable, string $sStyle, WebPage $oPage, string $sListId, DBObjectSet $oSet, array $aExtraParams)
|
|
{
|
|
if (!isset($aExtraParams['menu']) || $aExtraParams['menu']) {
|
|
$oMenuBlock = new MenuBlock($oSet->GetFilter(), $sStyle);
|
|
$aExtraParams['sRefreshAction'] = $oDataTable->GetJSRefresh();
|
|
$oBlockMenu = $oMenuBlock->GetRenderContent($oPage, $aExtraParams, $sListId);
|
|
} else {
|
|
$bToolkitMenu = true;
|
|
if (isset($aExtraParams['toolkit_menu'])) {
|
|
$bToolkitMenu = (bool)$aExtraParams['toolkit_menu'];
|
|
}
|
|
if (UserRights::IsPortalUser() || $oPage->IsPrintableVersion()) {
|
|
// Portal users have a limited access to data, for now they can only see what's configured for them
|
|
$bToolkitMenu = false;
|
|
}
|
|
if ($bToolkitMenu) {
|
|
$aExtraParams['selection_mode'] = true;
|
|
$oMenuBlock = new MenuBlock($oSet->GetFilter(), $sStyle);
|
|
$oBlockMenu = $oMenuBlock->GetRenderContent($oPage, $aExtraParams, $sListId);
|
|
} else {
|
|
$oBlockMenu = new UIContentBlock();
|
|
}
|
|
}
|
|
|
|
if (!isset($aExtraParams['surround_with_panel']) || $aExtraParams['surround_with_panel']) {
|
|
$iCount = $oSet->Count();
|
|
$oContainer = PanelUIBlockFactory::MakeForClass($oSet->GetClass(), "")->AddCSSClass('ibo-datatable-panel');
|
|
$oContainer->SetSubTitle(Dict::Format("UI:Pagination:HeaderNoSelection", $iCount));
|
|
$oContainer->AddToolbarBlock($oBlockMenu);
|
|
$oContainer->AddMainBlock($oDataTable);
|
|
} else {
|
|
$oContainer = new UIContentBlock();
|
|
$oToolbar = ToolbarUIBlockFactory::MakeStandard();
|
|
$oToolbar->AddSubBlock($oBlockMenu);
|
|
$oContainer->AddSubBlock($oToolbar);
|
|
$oContainer->AddSubBlock($oDataTable);
|
|
}
|
|
|
|
return $oContainer;
|
|
}
|
|
|
|
/**
|
|
* Make a basis Panel component
|
|
*
|
|
* @param string $sListId
|
|
* @param \DBObjectSet $oSet
|
|
* @param array $aExtraParams
|
|
*
|
|
* @return DataTable
|
|
* @throws \ApplicationException
|
|
* @throws \ArchivedObjectException
|
|
* @throws \CoreException
|
|
* @throws \CoreUnexpectedValue
|
|
* @throws \DictExceptionMissingString
|
|
* @throws \MySQLException
|
|
*/
|
|
public static function MakeForRendering(string $sListId, DBObjectSet $oSet, $aExtraParams = array())
|
|
{
|
|
$oDataTable = new DataTable('datatable_'.$sListId);
|
|
|
|
$oAppRoot = utils::GetAbsoluteUrlAppRoot();
|
|
|
|
// Initialize and check the parameters
|
|
$bViewLink = isset($aExtraParams['view_link']) ? $aExtraParams['view_link'] : true;
|
|
$sLinkageAttribute = isset($aExtraParams['link_attr']) ? $aExtraParams['link_attr'] : '';
|
|
$iLinkedObjectId = isset($aExtraParams['object_id']) ? $aExtraParams['object_id'] : 0;
|
|
$sTargetAttr = isset($aExtraParams['target_attr']) ? $aExtraParams['target_attr'] : '';
|
|
if (!empty($sLinkageAttribute)) {
|
|
if ($iLinkedObjectId == 0) {
|
|
// if 'links' mode is requested the id of the object to link to must be specified
|
|
throw new ApplicationException(Dict::S('UI:Error:MandatoryTemplateParameter_object_id'));
|
|
}
|
|
if ($sTargetAttr == '') {
|
|
// if 'links' mode is requested the d of the object to link to must be specified
|
|
throw new ApplicationException(Dict::S('UI:Error:MandatoryTemplateParameter_target_attr'));
|
|
}
|
|
}
|
|
$bSelectMode = isset($aExtraParams['selection_mode']) ? $aExtraParams['selection_mode'] == true : false;
|
|
$bSingleSelectMode = isset($aExtraParams['selection_type']) ? ($aExtraParams['selection_type'] == 'single') : false;
|
|
|
|
$aExtraFieldsRaw = isset($aExtraParams['extra_fields']) ? explode(',',
|
|
trim($aExtraParams['extra_fields'])) : array();
|
|
$aExtraFields = array();
|
|
foreach ($aExtraFieldsRaw as $sFieldName) {
|
|
// Ignore attributes not of the main queried class
|
|
if (preg_match('/^(.*)\.(.*)$/', $sFieldName, $aMatches)) {
|
|
$sClassAlias = $aMatches[1];
|
|
$sAttCode = $aMatches[2];
|
|
if ($sClassAlias == $oSet->GetFilter()->GetClassAlias()) {//$oSet->GetFilter()->GetSelectedClasses()
|
|
$aExtraFields[] = $sAttCode;
|
|
}
|
|
} else {
|
|
$aExtraFields[] = $sFieldName;
|
|
}
|
|
}
|
|
$sClassName = $oSet->GetFilter()->GetClass();
|
|
$sZListName = isset($aExtraParams['zlist']) ? ($aExtraParams['zlist']) : 'list';
|
|
if ($sZListName !== false) {
|
|
$aList = cmdbAbstractObject::FlattenZList(MetaModel::GetZListItems($sClassName, $sZListName));
|
|
$aList = array_merge($aList, $aExtraFields);
|
|
} else {
|
|
$aList = $aExtraFields;
|
|
}
|
|
|
|
// Filter the list to removed linked set since we are not able to display them here
|
|
foreach ($aList as $index => $sAttCode) {
|
|
$oAttDef = MetaModel::GetAttributeDef($sClassName, $sAttCode);
|
|
if ($oAttDef instanceof AttributeLinkedSet) {
|
|
// Removed from the display list
|
|
unset($aList[$index]);
|
|
}
|
|
}
|
|
|
|
if (!empty($sLinkageAttribute)) {
|
|
// The set to display is in fact a set of links between the object specified in the $sLinkageAttribute
|
|
// and other objects...
|
|
// The display will then group all the attributes related to the link itself:
|
|
// | Link_attr1 | link_attr2 | ... || Object_attr1 | Object_attr2 | Object_attr3 | .. | Object_attr_n |
|
|
$aDisplayList = array();
|
|
$aAttDefs = MetaModel::ListAttributeDefs($sClassName);
|
|
assert(isset($aAttDefs[$sLinkageAttribute]));
|
|
$oAttDef = $aAttDefs[$sLinkageAttribute];
|
|
assert($oAttDef->IsExternalKey());
|
|
// First display all the attributes specific to the link record
|
|
foreach ($aList as $sLinkAttCode) {
|
|
$oLinkAttDef = $aAttDefs[$sLinkAttCode];
|
|
if ((!$oLinkAttDef->IsExternalKey()) && (!$oLinkAttDef->IsExternalField())) {
|
|
$aDisplayList[] = $sLinkAttCode;
|
|
}
|
|
}
|
|
// Then display all the attributes neither specific to the link record nor to the 'linkage' object (because the latter are constant)
|
|
foreach ($aList as $sLinkAttCode) {
|
|
$oLinkAttDef = $aAttDefs[$sLinkAttCode];
|
|
if (($oLinkAttDef->IsExternalKey() && ($sLinkAttCode != $sLinkageAttribute))
|
|
|| ($oLinkAttDef->IsExternalField() && ($oLinkAttDef->GetKeyAttCode() != $sLinkageAttribute))) {
|
|
$aDisplayList[] = $sLinkAttCode;
|
|
}
|
|
}
|
|
// First display all the attributes specific to the link
|
|
// Then display all the attributes linked to the other end of the relationship
|
|
$aList = $aDisplayList;
|
|
}
|
|
|
|
$sSelectMode = '';
|
|
if ($bSelectMode) {
|
|
$sSelectMode = $bSingleSelectMode ? 'single' : 'multiple';
|
|
}
|
|
|
|
$sClassAlias = $oSet->GetClassAlias();
|
|
$bDisplayLimit = isset($aExtraParams['display_limit']) ? $aExtraParams['display_limit'] : true;
|
|
|
|
$sTableId = isset($aExtraParams['table_id']) ? $aExtraParams['table_id'] : null;
|
|
$aClassAliases = array($sClassAlias => $sClassName);
|
|
$oDefaultSettings = DataTableSettings::GetDataModelSettings($aClassAliases, $bViewLink, array($sClassAlias => $aList));
|
|
|
|
if ($bDisplayLimit) {
|
|
$iDefaultPageSize = appUserPreferences::GetPref('default_page_size', MetaModel::GetConfig()->GetMinDisplayLimit());
|
|
$oDefaultSettings->iDefaultPageSize = $iDefaultPageSize;
|
|
} else {
|
|
$oDefaultSettings->iDefaultPageSize = 0;
|
|
}
|
|
$oDefaultSettings->aSortOrder = MetaModel::GetOrderByDefault($sClassName);
|
|
|
|
$bUseCustomSettings = false;
|
|
// Identified tables can have their own specific settings
|
|
$oCustomSettings = DataTableSettings::GetTableSettings($aClassAliases, $sTableId);
|
|
|
|
if ($oCustomSettings != null) {
|
|
// Custom settings overload the default ones
|
|
$bUseCustomSettings = true;
|
|
if ($oDefaultSettings->iDefaultPageSize == 0) {
|
|
$oCustomSettings->iDefaultPageSize = 0;
|
|
}
|
|
} else {
|
|
$oCustomSettings = $oDefaultSettings;
|
|
}
|
|
|
|
if ($oCustomSettings->iDefaultPageSize > 0) {
|
|
$oSet->SetLimit($oCustomSettings->iDefaultPageSize);
|
|
}
|
|
|
|
if (sizeof($oCustomSettings->aColumns) == 0)
|
|
{
|
|
$oCustomSettings->aColumns = $oDefaultSettings->aColumns;
|
|
$oCustomSettings->aSortOrder = $oDefaultSettings->aSortOrder;
|
|
}
|
|
|
|
// Load only the requested columns
|
|
$aColumnsToLoad = array();
|
|
foreach ($oCustomSettings->aColumns as $sAlias => $aColumnsInfo) {
|
|
foreach ($aColumnsInfo as $sAttCode => $aData) {
|
|
if ($sAttCode != '_key_') {
|
|
if ($aData['checked']) {
|
|
$aColumnsToLoad[$sAlias][] = $sAttCode;
|
|
} else {
|
|
// See if this column is a must to load
|
|
$sClass = $aClassAliases[$sAlias];
|
|
$oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
|
|
if ($oAttDef->alwaysLoadInTables()) {
|
|
$aColumnsToLoad[$sAlias][] = $sAttCode;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
$oSet->OptimizeColumnLoad($aColumnsToLoad);
|
|
$aSortOrder=[];
|
|
$aSortDatable=[];
|
|
$aColumnDefinition = [];
|
|
$iIndexColumn=0;
|
|
if($sSelectMode!="") {
|
|
$iIndexColumn++;
|
|
}
|
|
foreach ($aClassAliases as $sClassAlias => $sClassName) {
|
|
foreach ($oCustomSettings->aColumns[$sClassAlias] as $sAttCode => $aData) {
|
|
if ($aData['sort'] != 'none') {
|
|
$sCode = ($aData['code'] == '_key_') ? 'friendlyname' : $aData['code'];
|
|
$aSortOrder[$sAlias.$sCode] = ($aData['sort'] == 'asc'); // true for ascending, false for descending
|
|
$aSortDatable=[$iIndexColumn,$aData['sort']];
|
|
}
|
|
if ($aData['checked']) {
|
|
if ($sAttCode == '_key_') {
|
|
if ($bViewLink) {
|
|
if (MetaModel::IsValidAttCode($sClassName, 'obsolescence_flag')) {
|
|
$sDisplayFunction = "let displayField = '<span class=\"object-ref\" title=\"".$sClassAlias."::'+data+'\"><a class=\'object-ref-link\' href=\'".$oAppRoot."/pages/UI.php?operation=details&class=".$sClassName."&id='+data+'\'>'+row['".$sClassAlias."/friendlyname']+'</a></span>'; if (row['".$sClassAlias."/obsolescence_flag'].indexOf('no') == -1){displayField = '<span class=\"object-ref obsolete\" title=\"obsolete\"><a class=\'object-ref-link\' href=\'UI.php?operation=details&class=".$sClassName."&id='+data+'\'><span class=\"object-ref-icon text_decoration\"><span class=\"fas fa-eye-slash object-obsolete fa-1x fa-fw\"></span></span>'+row['".$sClassAlias."/friendlyname']+'</a></span>';} return displayField;";
|
|
} else {
|
|
$sDisplayFunction = "let displayField = '<span class=\"object-ref\" title=\"".$sClassAlias."::'+data+'\"><a class=\'object-ref-link\' href=\'".$oAppRoot."/pages/UI.php?operation=details&class=".$sClassName."&id='+data+'\'>'+row['".$sClassAlias."/friendlyname']+'</a></span>'; return displayField;";
|
|
}
|
|
$aColumnDefinition[] = [
|
|
'description' => $aData['label'],
|
|
'object_class' => $sClassName,
|
|
'class_alias' => $sClassAlias,
|
|
'attribute_code' => $sAttCode,
|
|
'attribute_type' => '_key_',
|
|
'attribute_label' => MetaModel::GetName($sClassName),
|
|
'render' => $sDisplayFunction,
|
|
];
|
|
|
|
}
|
|
} else {
|
|
$oAttDef = MetaModel::GetAttributeDef($sClassName, $sAttCode);
|
|
$sAttDefClass = get_class($oAttDef);
|
|
$sAttLabel = $oAttDef->GetLabel();
|
|
$aColumnDefinition[] = [
|
|
'description' => $oAttDef->GetOrderByHint(),
|
|
'object_class' => $sClassName,
|
|
'class_alias' => $sClassAlias,
|
|
'attribute_code' => $sAttCode,
|
|
'attribute_type' => $sAttDefClass,
|
|
'attribute_label' => $sAttLabel,
|
|
'render' => $oAttDef->GetRenderForDataTable($sClassAlias),
|
|
];
|
|
}
|
|
$iIndexColumn++;
|
|
}
|
|
}
|
|
}
|
|
$oSet->SetOrderBy($aSortOrder);
|
|
|
|
$aOptions = [];
|
|
if ($oDefaultSettings != null) {
|
|
$aOptions['oDefaultSettings'] = json_encode(array('iDefaultPageSize' => $oDefaultSettings->iDefaultPageSize, 'oColumns' => $oDefaultSettings->aColumns));
|
|
}
|
|
$aOptions['sort'] = $aSortDatable;
|
|
if ($sSelectMode == 'multiple') {
|
|
$aOptions['select_mode'] = "multiple";
|
|
} else {
|
|
if ($sSelectMode == 'single') {
|
|
$aOptions['select_mode'] = "single";
|
|
}
|
|
}
|
|
$aOptions['selectionMode'] = $aExtraParams['selectionMode']?? 'positive';
|
|
|
|
if (isset($aExtraParams['cssCount'])) {
|
|
$aOptions['sCountSelector'] = $aExtraParams['cssCount'];
|
|
}
|
|
|
|
$aOptions['iPageSize'] = 10;
|
|
if ($oCustomSettings->iDefaultPageSize > 0) {
|
|
$aOptions['iPageSize'] = $oCustomSettings->iDefaultPageSize;
|
|
}
|
|
|
|
$aOptions['processing'] = true;
|
|
$aOptions['sTableId'] = $sTableId;
|
|
$aOptions['bUseCustomSettings'] = $bUseCustomSettings;
|
|
$aOptions['bViewLink'] = $bViewLink;
|
|
$aOptions['sListId'] = $sListId;
|
|
$aOptions['oClassAliases'] = json_encode($aClassAliases);
|
|
if (isset($aExtraParams['selected_rows']) && !empty($aExtraParams['selected_rows'])) {
|
|
$aOptions['sSelectedRows'] = json_encode($aExtraParams['selected_rows']);
|
|
} else {
|
|
$aOptions['sSelectedRows'] = '[]';
|
|
}
|
|
$aExtraParams['table_id']=$sTableId;
|
|
$aExtraParams['list_id']=$sListId;
|
|
|
|
|
|
$oDataTable->SetOptions($aOptions);
|
|
$oDataTable->SetAjaxUrl(utils::GetAbsoluteUrlAppRoot()."pages/ajax.render.php");
|
|
$oDataTable->SetAjaxData([
|
|
"operation" => 'search',
|
|
"filter" => $oSet->GetFilter()->serialize(),
|
|
"columns" => $oCustomSettings->aColumns,
|
|
"extra_params" => $aExtraParams,
|
|
"class_aliases" => $aClassAliases,
|
|
"select_mode" => $sSelectMode,
|
|
]);
|
|
$oDataTable->SetDisplayColumns($aColumnDefinition);
|
|
$oDataTable->SetResultColumns($oCustomSettings->aColumns);
|
|
|
|
return $oDataTable;
|
|
}
|
|
|
|
/**
|
|
* @param string $sListId
|
|
* @param DBObjectSet $oSet
|
|
* @param array $aExtraParams
|
|
*
|
|
* @return \Combodo\iTop\Application\UI\Base\Component\DataTable\DataTable
|
|
* @throws \ArchivedObjectException
|
|
* @throws \CoreException
|
|
* @throws \CoreUnexpectedValue
|
|
* @throws \DictExceptionMissingString
|
|
* @throws \MySQLException
|
|
*/
|
|
public static function MakeForRenderingObject(string $sListId, DBObjectSet $oSet, $aExtraParams = array())
|
|
{
|
|
$oDataTable = new DataTable('datatable_'.$sListId);
|
|
$aList = array();
|
|
$oAppRoot = utils::GetAbsoluteUrlAppRoot();
|
|
|
|
// Initialize and check the parameters
|
|
$bViewLink = isset($aExtraParams['view_link']) ? $aExtraParams['view_link'] : true;
|
|
// Check if there is a list of aliases to limit the display to...
|
|
$aDisplayAliases = isset($aExtraParams['display_aliases']) ? explode(',',
|
|
$aExtraParams['display_aliases']) : array();
|
|
$sZListName = isset($aExtraParams['zlist']) ? ($aExtraParams['zlist']) : 'list';
|
|
|
|
$aExtraFieldsRaw = isset($aExtraParams['extra_fields']) ? explode(',',
|
|
trim($aExtraParams['extra_fields'])) : array();
|
|
$aExtraFields = array();
|
|
$sAttCode = '';
|
|
foreach ($aExtraFieldsRaw as $sFieldName) {
|
|
// Ignore attributes not of the main queried class
|
|
if (preg_match('/^(.*)\.(.*)$/', $sFieldName, $aMatches)) {
|
|
$sClassAlias = $aMatches[1];
|
|
$sAttCode = $aMatches[2];
|
|
if (array_key_exists($sClassAlias, $oSet->GetSelectedClasses())) {
|
|
$aExtraFields[$sClassAlias][] = $sAttCode;
|
|
}
|
|
} else {
|
|
$aExtraFields['*'] = $sAttCode;
|
|
}
|
|
}
|
|
|
|
$aClassAliases = $oSet->GetFilter()->GetSelectedClasses();
|
|
$aAuthorizedClasses = array();
|
|
foreach ($aClassAliases as $sAlias => $sClassName) {
|
|
if ((UserRights::IsActionAllowed($sClassName, UR_ACTION_READ, $oSet) != UR_ALLOWED_NO) &&
|
|
((count($aDisplayAliases) == 0) || (in_array($sAlias, $aDisplayAliases)))) {
|
|
$aAuthorizedClasses[$sAlias] = $sClassName;
|
|
}
|
|
}
|
|
foreach ($aAuthorizedClasses as $sAlias => $sClassName) {
|
|
if (array_key_exists($sAlias, $aExtraFields)) {
|
|
$aList[$sAlias] = $aExtraFields[$sAlias];
|
|
} else {
|
|
$aList[$sAlias] = array();
|
|
}
|
|
if ($sZListName !== false) {
|
|
$aDefaultList = MetaModel::FlattenZList(MetaModel::GetZListItems($sClassName, $sZListName));
|
|
$aList[$sAlias] = array_merge($aDefaultList, $aList[$sAlias]);
|
|
}
|
|
|
|
// Filter the list to removed linked set since we are not able to display them here
|
|
foreach ($aList[$sAlias] as $index => $sAttCode) {
|
|
$oAttDef = MetaModel::GetAttributeDef($sClassName, $sAttCode);
|
|
if ($oAttDef instanceof AttributeLinkedSet) {
|
|
// Removed from the display list
|
|
unset($aList[$sAlias][$index]);
|
|
}
|
|
}
|
|
|
|
if (empty($aList[$sAlias])) {
|
|
unset($aList[$sAlias], $aAuthorizedClasses[$sAlias]);
|
|
}
|
|
}
|
|
|
|
$sSelectMode = 'none';
|
|
|
|
$oDefaultSettings = DataTableSettings::GetDataModelSettings($aAuthorizedClasses, $bViewLink, $aList);
|
|
|
|
$bDisplayLimit = isset($aExtraParams['display_limit']) ? $aExtraParams['display_limit'] : true;
|
|
if ($bDisplayLimit) {
|
|
$iDefaultPageSize = appUserPreferences::GetPref('default_page_size',
|
|
MetaModel::GetConfig()->GetMinDisplayLimit());
|
|
$oDefaultSettings->iDefaultPageSize = $iDefaultPageSize;
|
|
}
|
|
|
|
$sTableId = isset($aExtraParams['table_id']) ? $aExtraParams['table_id'] : null;
|
|
$oDefaultSettings->aSortOrder = MetaModel::GetOrderByDefault($sClassName);
|
|
|
|
$bUseCustomSettings = false;
|
|
// Identified tables can have their own specific settings
|
|
$oCustomSettings = DataTableSettings::GetTableSettings($aClassAliases, $sTableId);
|
|
|
|
if ($oCustomSettings != null) {
|
|
// Custom settings overload the default ones
|
|
$bUseCustomSettings = true;
|
|
if ($oDefaultSettings->iDefaultPageSize == 0) {
|
|
$oCustomSettings->iDefaultPageSize = 0;
|
|
}
|
|
} else {
|
|
$oCustomSettings = $oDefaultSettings;
|
|
}
|
|
|
|
if ($oCustomSettings->iDefaultPageSize > 0) {
|
|
$oSet->SetLimit($oCustomSettings->iDefaultPageSize);
|
|
}
|
|
|
|
// Load only the requested columns
|
|
$aColumnsToLoad = array();
|
|
foreach ($oCustomSettings->aColumns as $sAlias => $aColumnsInfo) {
|
|
foreach ($aColumnsInfo as $sAttCode => $aData) {
|
|
if ($sAttCode != '_key_') {
|
|
if ($aData['checked']) {
|
|
$aColumnsToLoad[$sAlias][] = $sAttCode;
|
|
} else {
|
|
// See if this column is a must to load
|
|
$sClass = $aClassAliases[$sAlias];
|
|
$oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
|
|
if ($oAttDef->alwaysLoadInTables()) {
|
|
$aColumnsToLoad[$sAlias][] = $sAttCode;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
$oSet->OptimizeColumnLoad($aColumnsToLoad);
|
|
|
|
$aColumnDefinition = [];
|
|
$aSortOrder = [];
|
|
$iIndexColumn = 0;
|
|
if ($sSelectMode != "") {
|
|
$iIndexColumn++;
|
|
}
|
|
$aSortDatable = [];
|
|
foreach ($aAuthorizedClasses as $sClassAlias => $sClassName) {
|
|
if (isset($oCustomSettings->aColumns[$sClassAlias])) {
|
|
foreach ($oCustomSettings->aColumns[$sClassAlias] as $sAttCode => $aData) {
|
|
if ($aData['sort'] != 'none') {
|
|
$sCode = ($aData['code'] == '_key_') ? 'friendlyname' : $aData['code'];
|
|
$aSortOrder[$sAlias.$sCode] = ($aData['sort'] == 'asc'); // true for ascending, false for descending
|
|
$aSortDatable = [$iIndexColumn, $aData['sort']];
|
|
}
|
|
if ($aData['checked']) {
|
|
if ($sAttCode == '_key_') {
|
|
if ($bViewLink) {
|
|
if (MetaModel::IsValidAttCode($sClassName, 'obsolescence_flag')) {
|
|
$sRender = "let displayField = '<span class=\"object-ref\" title=\"".$sClassAlias."::'+data+'\"><a class=\'object-ref-link\' href=\'".$oAppRoot."/pages/UI.php?operation=details&class=".$sClassName."&id='+data+'\'>'+row['".$sClassAlias."/friendlyname']+'</a></span>'; if (row['".$sClassAlias."/obsolescence_flag'].indexOf('no') == -1){displayField = '<span class=\"object-ref obsolete\" title=\"obsolete\"><span class=\"object-ref-icon text_decoration\"><span class=\"fas fa-eye-slash object-obsolete fa-1x fa-fw\"></span></span><a class=\'object-ref-link\' href=\'UI.php?operation=details&class=".$sClassName."&id='+data+'\'>'+row['".$sClassAlias."/friendlyname']+'</a></span>';} return displayField;";
|
|
} else {
|
|
$sRender = "let displayField = '<span class=\"object-ref\" title=\"".$sClassAlias."::'+data+'\"><a class=\'object-ref-link\' href=\'".$oAppRoot."/pages/UI.php?operation=details&class=".$sClassName."&id='+data+'\'>'+row['".$sClassAlias."/friendlyname']+'</a></span>'; return displayField;";
|
|
}
|
|
$aColumnDefinition[] = [
|
|
'description' => $aData['label'],
|
|
'object_class' => $sClassName,
|
|
'class_alias' => $sClassAlias,
|
|
'attribute_code' => $sAttCode,
|
|
'attribute_type' => '_key_',
|
|
'attribute_label' => $aData['alias'],
|
|
"render" => $sRender,
|
|
];
|
|
}
|
|
} else {
|
|
$oAttDef = MetaModel::GetAttributeDef($sClassName, $sAttCode);
|
|
$sAttDefClass = get_class($oAttDef);
|
|
$sAttLabel = MetaModel::GetLabel($sClassName, $sAttCode);
|
|
$aColumnDefinition[] = [
|
|
'description' => $oAttDef->GetOrderByHint(),
|
|
'object_class' => $sClassName,
|
|
'class_alias' => $sClassAlias,
|
|
'attribute_code' => $sAttCode,
|
|
'attribute_type' => $sAttDefClass,
|
|
'attribute_label' => $sAttLabel,
|
|
"render" => $oAttDef->GetRenderForDataTable($sClassAlias),
|
|
];
|
|
}
|
|
$iIndexColumn++;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
$oSet->SetOrderBy($oCustomSettings->GetSortOrder());
|
|
|
|
$aOptions = [];
|
|
if ($oDefaultSettings != null) {
|
|
$aOptions['oDefaultSettings'] = json_encode(array('iDefaultPageSize' => $oDefaultSettings->iDefaultPageSize, 'oColumns' => $oDefaultSettings->aColumns));
|
|
}
|
|
|
|
if ($sSelectMode == 'multiple') {
|
|
$aOptions['select_mode'] = "multiple";
|
|
} else {
|
|
if ($sSelectMode == 'single') {
|
|
$aOptions['select_mode'] = "single";
|
|
}
|
|
}
|
|
$aOptions['selectionMode'] = $aExtraParams['selectionMode']?? 'positive';
|
|
|
|
$aOptions['sort'] = $aSortDatable;
|
|
|
|
$aOptions['iPageSize'] = 10;
|
|
if ($oCustomSettings->iDefaultPageSize > 0) {
|
|
$aOptions['iPageSize'] = $oCustomSettings->iDefaultPageSize;
|
|
}
|
|
|
|
$aOptions['sTableId'] = $sTableId;
|
|
$aOptions['bUseCustomSettings'] = $bUseCustomSettings;
|
|
$aOptions['bViewLink'] = $bViewLink;
|
|
$aOptions['oClassAliases'] = json_encode($aClassAliases);
|
|
|
|
$oDataTable->SetOptions($aOptions);
|
|
$oDataTable->SetAjaxUrl("ajax.render.php");
|
|
$oDataTable->SetAjaxData([
|
|
"operation" => 'search',
|
|
"filter" => $oSet->GetFilter()->serialize(),
|
|
"columns" => $oCustomSettings->aColumns,
|
|
"extra_params" => $aExtraParams,
|
|
"class_aliases" => $aClassAliases,
|
|
"select_mode" => $sSelectMode,
|
|
]);
|
|
$oDataTable->SetDisplayColumns($aColumnDefinition);
|
|
$oDataTable->SetResultColumns($oCustomSettings->aColumns);
|
|
|
|
return $oDataTable;
|
|
}
|
|
|
|
/**
|
|
* @param array $aColumns
|
|
* @param string $sSelectMode
|
|
* @param string $sFilter
|
|
* @param int $iLength
|
|
* @param array $aExtraParams
|
|
*
|
|
* @return array
|
|
* @throws \Exception
|
|
*/
|
|
public static function GetOptionsForRendering(array $aColumns, string $sSelectMode, string $sFilter, int $iLength, array $aClassAliases, array $aExtraParams)
|
|
{
|
|
$oAppRoot = utils::GetAbsoluteUrlAppRoot();
|
|
|
|
$aOptions = [];
|
|
$sTableId = $aExtraParams["table_id"];
|
|
$sListId = $aExtraParams["list_id"];
|
|
$aColumnsDefinitions = [];
|
|
$aColumnDefinition = [];
|
|
|
|
$sSortCol = utils::ReadParam('sort_col', '', false, 'raw_data');
|
|
$sSortOrder = utils::ReadParam('sort_order', '', false, 'raw_data');
|
|
$sOrder = [];
|
|
if ($sSortCol != "") {
|
|
$sOrder[] = [$sSortCol, $sSortOrder];
|
|
}
|
|
if ($sSelectMode != "") {
|
|
$aColumnDefinition["width"] = "auto";
|
|
$aColumnDefinition["searchable"] = false;
|
|
$aColumnDefinition["sortable"] = false;
|
|
if ($sSelectMode != "single") {
|
|
$aColumnDefinition["title"] = "<span class=\"row_input\"><input type=\"checkbox\" onclick=\"checkAllDataTable('".$sTableId."',this.checked,'".$sListId."');\" class=\"checkAll\" id=\"field_".$sTableId."_check_all\" name=\"field_".$sTableId."_check_all\" title=\"".Dict::S('UI:SearchValue:CheckAll')." / ".Dict::S('UI:SearchValue:UncheckAll')."\" /></span>";
|
|
} else {
|
|
$aColumnDefinition["title"] = "";
|
|
}
|
|
$aColumnDefinition["type"] = "html";
|
|
$aColumnDefinition["data"] = "";
|
|
$aColumnDefinition["render"]["display"] = "";
|
|
if ($sSelectMode != "single") {
|
|
$aColumnDefinition["render"]["display"] = $aColumnDefinition["render"]["display"] . " var oCheckboxElem = $('<span class=\"row_input\"><input type=\"checkbox\" class=\"selectList".$sTableId."\" name=\"selectObject\" /></span>');";
|
|
}
|
|
else {
|
|
$aColumnDefinition["render"]["display"] = $aColumnDefinition["render"]["display"] . " var oCheckboxElem = $('<span class=\"row_input\"><input type=\"radio\" class=\"selectList".$sTableId."\" name=\"selectObject\" /></span>');";
|
|
}
|
|
$aColumnDefinition["render"]["display"] = $aColumnDefinition["render"]["display"] . " if (row.limited_access) { oCheckboxElem.html('-'); } else { oCheckboxElem.find(':input').attr('data-object-id', row.id).attr('data-target-object-id', row.target_id); }";
|
|
$aColumnDefinition["render"]["display"] = $aColumnDefinition["render"]["display"]. " return oCheckboxElem.prop('outerHTML'); ";
|
|
array_push($aColumnsDefinitions, $aColumnDefinition);
|
|
}
|
|
|
|
foreach ($aColumns as $sClassAlias => $aClassColumns) {
|
|
$sClassName=$aClassAliases[$sClassAlias];
|
|
foreach ($aClassColumns as $sAttCode => $aData) {
|
|
if ($aData['checked'] == "true") {
|
|
$aColumnDefinition["width"] = "auto";
|
|
$aColumnDefinition["searchable"] = false;
|
|
$aColumnDefinition["sortable"] = true;
|
|
$aColumnDefinition["defaultContent"] = "";
|
|
$aColumnDefinition["type"] = "html";
|
|
|
|
if ($sAttCode == '_key_') {
|
|
$aColumnDefinition["title"] = $aData['alias'];
|
|
$aColumnDefinition['metadata'] = [
|
|
'object_class' => $sClassName,
|
|
'class_alias' => $sClassAlias,
|
|
'attribute_code' => $sAttCode,
|
|
'attribute_type' => '_key_',
|
|
'attribute_label' => $aData['alias'],
|
|
];
|
|
$aColumnDefinition["data"] = $sClassAlias."/".$sAttCode;
|
|
if (MetaModel::IsValidAttCode($sClassName, 'obsolescence_flag')) {
|
|
$sDisplay = "let displayField = '<span class=\"object-ref\" title=\"".$sClassAlias."::'+data+'\"><a class=\'object-ref-link\' href=\'".$oAppRoot."/pages/UI.php?operation=details&class=".$sClassName."&id='+data+'\'>'+row['".$sClassAlias."/friendlyname']+'</a></span>'; if (row['".$sClassAlias."/obsolescence_flag'].indexOf('no') == -1){displayField = '<span class=\"object-ref obsolete\" title=\"obsolete\"><a class=\'object-ref-link\' href=\'UI.php?operation=details&class=".$sClassName."&id='+data+'\'><span class=\"object-ref-icon text_decoration\"><span class=\"fas fa-eye-slash object-obsolete fa-1x fa-fw\"></span></span>'+row['".$sClassAlias."/friendlyname']+'</a></span>';} return displayField;";
|
|
} else {
|
|
$sDisplay = "let displayField = '<span class=\"object-ref\" title=\"".$sClassAlias."::'+data+'\"><a class=\'object-ref-link\' href=\'".$oAppRoot."/pages/UI.php?operation=details&class=".$sClassName."&id='+data+'\'>'+row['".$sClassAlias."/friendlyname']+'</a></span>'; return displayField;";
|
|
}
|
|
$aColumnDefinition["render"] = [
|
|
"display" => $sDisplay,
|
|
"_" => $sClassAlias."/".$sAttCode,
|
|
];
|
|
} else {
|
|
$oAttDef = MetaModel::GetAttributeDef($sClassName, $sAttCode);
|
|
$sAttDefClass = get_class($oAttDef);
|
|
$sAttLabel = MetaModel::GetLabel($sClassName, $sAttCode);
|
|
|
|
$aColumnDefinition["title"] = $sAttLabel;
|
|
$aColumnDefinition['metadata'] = [
|
|
'object_class' => $sClassName,
|
|
'class_alias' => $sClassAlias,
|
|
'attribute_code' => $sAttCode,
|
|
'attribute_type' => $sAttDefClass,
|
|
'attribute_label' => $sAttLabel,
|
|
];
|
|
$aColumnDefinition["data"] = $sClassAlias."/".$sAttCode;
|
|
$aColumnDefinition["render"] = [
|
|
"display" => $oAttDef->GetRenderForDataTable($sClassAlias),
|
|
"_" => $sClassAlias."/".$sAttCode,
|
|
];
|
|
}
|
|
array_push($aColumnsDefinitions, $aColumnDefinition);
|
|
}
|
|
}
|
|
}
|
|
|
|
$aOptions['select'] = ["style"=>$sSelectMode];
|
|
|
|
$aOptions['pageLength'] = $iLength;
|
|
|
|
$sAjaxData = json_encode([
|
|
"operation" => 'search',
|
|
"filter" => $sFilter,
|
|
"columns" => $aColumns,
|
|
"extra_params" => $aExtraParams,
|
|
"class_aliases" => $aClassAliases,
|
|
"select_mode" => $sSelectMode,
|
|
]);
|
|
|
|
|
|
$aOptions = array_merge($aOptions, [
|
|
"language" =>
|
|
[
|
|
"processing" => Dict::Format('UI:Datatables:Language:Processing'),
|
|
"search" => Dict::Format('UI:Datatables:Language:Search'),
|
|
"lengthMenu" => Dict::Format('UI:Datatables:Language:LengthMenu'),
|
|
"zeroRecords" => Dict::Format('UI:Datatables:Language:ZeroRecords'),
|
|
"info" => Dict::Format('UI:Datatables:Language:Info'),
|
|
"infoEmpty" => Dict::Format('UI:Datatables:Language:InfoEmpty'),
|
|
"infoFiltered" => Dict::Format('UI:Datatables:Language:InfoFiltered'),
|
|
"emptyTable" => Dict::Format('UI:Datatables:Language:EmptyTable'),
|
|
"paginate" => [
|
|
"first" => "<<",
|
|
"previous" => "<",
|
|
"next" => ">",
|
|
"last" => ">>",
|
|
],
|
|
"aria" => [
|
|
"sortAscending" => Dict::Format('UI:Datatables:Language:Sort:Ascending'),
|
|
"sortDescending" => Dict::Format('UI:Datatables:Language:Sort:Descending'),
|
|
],
|
|
],
|
|
"lengthMenu" => Dict::Format('Portal:Datatables:Language:DisplayLength:All'),
|
|
"dom" => "<'ibo-datatable-toolbar'pil>t<'ibo-datatable-toolbar'pil>",
|
|
"scrollX" => true,
|
|
"scrollCollapse" => true,
|
|
"ordering" => true,
|
|
"order" => $sOrder,
|
|
"filter" => false,
|
|
"processing" => true,
|
|
"serverSide" => true,
|
|
"columns" => $aColumnsDefinitions,
|
|
"allColumns" => $aColumns,
|
|
'ajax' => '$.fn.dataTable.pipeline( {
|
|
"url": "ajax.render.php",
|
|
"data": '.$sAjaxData.',
|
|
"method": "post",
|
|
"pages": 5 // number of pages to cache
|
|
} )'
|
|
]);
|
|
|
|
return $aOptions;
|
|
}
|
|
|
|
public static function MakeForStaticData(string $sTitle, array $aColumns, array $aData, ?string $sId = null, array $aExtraParams = [], string $sFilter = "", array $aOptions = [])
|
|
{
|
|
$oBlock = new UIContentBlock();
|
|
$oTitle = TitleUIBlockFactory::MakeNeutral($sTitle, 3);
|
|
$oBlock->AddSubBlock($oTitle);
|
|
$oTable = new StaticTable($sId, [], $aExtraParams);
|
|
$oTable->SetColumns($aColumns);
|
|
$oTable->SetData($aData);
|
|
$oTable->SetFilter($sFilter);
|
|
$oTable->SetOptions($aOptions);
|
|
|
|
$oBlock->AddSubBlock($oTable);
|
|
|
|
return $oBlock;
|
|
}
|
|
|
|
/**
|
|
* @param string $sRef
|
|
* @param array $aColumns
|
|
* @param array $aData
|
|
* @param string $sFilter
|
|
*
|
|
* $aColumns =[
|
|
* 'nameField1' => ['label' => labelFIeld1, 'description' => descriptionField1],
|
|
* 'nameField2' => ['label' => labelFIeld2, 'description' => descriptionField2],
|
|
* 'nameField3' => ['label' => labelFIeld3, 'description' => descriptionField3]];
|
|
* $aData = [['nameField1' => valueField1, 'nameField2' => valueField2, 'nameField3' => valueField3],...]
|
|
*
|
|
* @return \Combodo\iTop\Application\UI\Base\Component\DataTable\StaticTable\FormTable\FormTable
|
|
*/
|
|
public static function MakeForForm(string $sRef, array $aColumns, array $aData = [], string $sFilter = ''): FormTable
|
|
{
|
|
$oTable = new FormTable("datatable_".$sRef);
|
|
$oTable->SetRef($sRef);
|
|
$oTable->SetColumns($aColumns);
|
|
$oTable->SetFilter($sFilter);
|
|
|
|
foreach ($aData as $iRowId => $aRow) {
|
|
$oRow = new FormTableRow($sRef, $aColumns, $aRow, $iRowId);
|
|
$oTable->AddRow($oRow);
|
|
}
|
|
|
|
return $oTable;
|
|
}
|
|
|
|
public static function GetAllowedParams(): array
|
|
{
|
|
return [
|
|
'surround_with_panel', /** bool embed table into a Panel */
|
|
'menu', /** bool display table menu */
|
|
'view_link', /** bool display the friendlyname column with links to the objects details */
|
|
'link_attr', /** string link att code */
|
|
'object_id', /** int Id of the object linked */
|
|
'target_attr', /** string target att code of the link */
|
|
'selection_mode', /** bool activate selection */
|
|
'selection_type', /** string 'multiple' or 'single' */
|
|
'extra_fields', /** string comma separated list of link att code to display ('alias.attcode')*/
|
|
'zlist', /** string name of the zlist to display when 'extra_fields' is not set */
|
|
'display_limit', /** bool if true pagination is used (default = true) */
|
|
'table_id', /** string datatable id */
|
|
'cssCount', /** string external counter (input hidden) js selector */
|
|
'selected_rows', /** array list of Ids already selected when displaying the datatable */
|
|
'display_aliases', /** string comma separated list of class aliases to display */
|
|
'list_id', /** string list outer id */
|
|
];
|
|
}
|
|
} |