N°5073 - Implements line actions in a datatable (#337)

* datatable row actions

Below is a sample of extra param to enable feature:

		$aExtraParams['row_actions'] = [
			[
				'tooltip'        => 'add an element',
				'icon_css_class' => 'fa-plus',
				'css_class'      => 'ibo-is-success',
				'level'          => 'secondary',
				'on_action_js'   => 'console.log(aData);',
			],
			[
				'tooltip'        => 'remove an element',
				'icon_css_class' => 'fa-minus',
				'css_class'      => 'ibo-is-danger',
				'level'          => 'secondary',
				'on_action_js'   => 'console.log("You clicked the remove button");',
			],
			[
				'tooltip'        => 'open in new tab',
				'icon_css_class' => 'fa-external-link-square-alt',
				'on_action_js'   => 'window.open("http://localhost/itop-branchs/dev/pages/UI.php?operation=details&class=UserRequest&id=" + aData.id + "&c[menu]=UserRequest%3AOpenRequests");',
			],
			[
				'tooltip'        => 'other actions',
				'icon_css_class' => 'fa-ellipsis-v',
				'on_action_js'   => 'console.log(event);',
			],
		];

* datatable row actions (update)

* datatable row actions (update)

* datatable row actions (add template role)

* datatable row actions (align actions)

* datatable row actions (change template factory make to make standard)

* datatable row actions (use trait to handle row actions)

* datatable row actions (row actions templates)

* datatable row actions (row actions templates)

* datatable row actions (row actions templates)

* datatable row actions (extends to static and form)

* datatable row actions (extends to static and form)

* datatable row actions (code review S)

* datatable row actions (code review S)

* datatable row actions (code review S)

* Update js/dataTables.main.js

Co-authored-by: Molkobain <lajarige.guillaume@free.fr>

* Update js/dataTables.main.js

Co-authored-by: Molkobain <lajarige.guillaume@free.fr>

* Update sources/Application/UI/Base/Component/DataTable/StaticTable/StaticTable.php

Co-authored-by: Molkobain <lajarige.guillaume@free.fr>

* Update templates/base/components/datatable/row-actions/handler.js.twig

Co-authored-by: Molkobain <lajarige.guillaume@free.fr>

* datatable row actions (code review M)

* Update js/dataTables.main.js

Co-authored-by: Molkobain <lajarige.guillaume@free.fr>

* Update js/dataTables.main.js

Co-authored-by: Molkobain <lajarige.guillaume@free.fr>

* Update js/dataTables.main.js

Co-authored-by: Molkobain <lajarige.guillaume@free.fr>

* Update sources/Application/UI/Base/Component/DataTable/StaticTable/StaticTable.php

Co-authored-by: Molkobain <lajarige.guillaume@free.fr>

* Update sources/Application/UI/Base/Component/DataTable/StaticTable/StaticTable.php

Co-authored-by: Molkobain <lajarige.guillaume@free.fr>

* Update sources/Application/UI/Base/Component/DataTable/StaticTable/StaticTable.php

Co-authored-by: Molkobain <lajarige.guillaume@free.fr>

* Update js/dataTables.main.js

Co-authored-by: Molkobain <lajarige.guillaume@free.fr>

* Update sources/Application/UI/Base/Component/DataTable/DataTableUIBlockFactory.php

Co-authored-by: Molkobain <lajarige.guillaume@free.fr>

* Update sources/Application/UI/Base/Component/DataTable/StaticTable/StaticTable.php

Co-authored-by: Molkobain <lajarige.guillaume@free.fr>

* Update application/utils.inc.php

Co-authored-by: Molkobain <lajarige.guillaume@free.fr>

* datatable row actions (code review M2)

* datatable row actions (code review M3)

Co-authored-by: Molkobain <lajarige.guillaume@free.fr>

application/utils.inc.php

@@ -3143,18 +3143,53 @@ HTML;
 	 */
 	public static function AddParameterToUrl(string $sUrl, string $sParamName, string $sParamValue): string
 	{
-		if (strpos($sUrl, '?') === false)
+		if (strpos($sUrl, '?') === false) {
-		{
 			$sUrl = $sUrl.'?'.urlencode($sParamName).'='.urlencode($sParamValue);
-		}
+		} else {
-		else
-		{
 			$sUrl = $sUrl.'&'.urlencode($sParamName).'='.urlencode($sParamValue);
 		}
 
 		return $sUrl;
 	}
 
+	/**
+	 * Return traits array used by a class and by parent classes hierarchy.
+	 *
+	 * @see https://www.php.net/manual/en/function.class-uses.php#110752
+	 *
+	 * @param string $sClass Class to scan
+	 * @param bool $bAutoload Autoload flag
+	 *
+	 * @return array traits used
+	 * @since 3.1.0
+	 */
+	public static function TraitsUsedByClass(string $sClass, bool $bAutoload = true): array
+	{
+		$aTraits = [];
+		do {
+			$aTraits = array_merge(class_uses($sClass, $bAutoload), $aTraits);
+		} while ($sClass = get_parent_class($sClass));
+		foreach ($aTraits as $sTrait => $same) {
+			$aTraits = array_merge(class_uses($sTrait, $bAutoload), $aTraits);
+		}
+
+		return array_unique($aTraits);
+	}
+
+	/**
+	 * Test trait usage by a class or by parent classes hierarchy.
+	 *
+	 * @param string $sTrait Trait to search for
+	 * @param string $sClass Class to check
+	 *
+	 * @return bool
+	 * @since 3.1.0
+	 */
+	public static function IsTraitUsedByClass(string $sTrait, string $sClass): bool
+	{
+		return in_array($sTrait, self::TraitsUsedByClass($sClass, true));
+	}
+  
 	public static function GetUniqId()
 	{
 		return hash('sha256', uniqid(sprintf('%x', rand()), true).sprintf('%x', rand()));

css/backoffice/components/_datatable.scss

@@ -119,6 +119,10 @@ $ibo-fieldsorter--selected--background-color: $ibo-color-blue-200 !default;
     &.selected {
       background-color: $ibo-datatable--row--background-color--is-selected;
     }
+
+    .ibo-datatable--row-actions-toolbar{
+      justify-content: end;
+    }
   }
 }
 

dictionaries/ui/components/datatable/en.dictionary.itop.datatable.php

@@ -19,14 +19,16 @@
 
 // Display DataTable
 Dict::Add('EN US', 'English', 'English', array(
-	'UI:Datatables:Language:Processing'        => 'Please wait...',
+	'UI:Datatables:Language:Processing'           => 'Please wait...',
-	'UI:Datatables:Language:LengthMenu'        => '_MENU_ per page',
+	'UI:Datatables:Language:LengthMenu'           => '_MENU_ per page',
-	'UI:Datatables:Language:ZeroRecords'       => 'No result',
+	'UI:Datatables:Language:ZeroRecords'          => 'No result',
-	'UI:Datatables:Language:Info'              => '_TOTAL_ item(s)',
+	'UI:Datatables:Language:Info'                 => '_TOTAL_ item(s)',
-	'UI:Datatables:Language:InfoEmpty'         => 'No information',
+	'UI:Datatables:Language:InfoEmpty'            => 'No information',
-	'UI:Datatables:Language:EmptyTable'        => 'No data available in this table',
+	'UI:Datatables:Language:EmptyTable'           => 'No data available in this table',
-	'UI:Datatables:Language:Error'             => 'An error occured while running the query',
+	'UI:Datatables:Language:Error'                => 'An error occured while running the query',
-	'UI:Datatables:Language:DisplayLength:All' => 'All',
+	'UI:Datatables:Language:DisplayLength:All'    => 'All',
-	'UI:Datatables:Language:Sort:Ascending'    => 'enable for an ascending sort',
+	'UI:Datatables:Language:Sort:Ascending'       => 'enable for an ascending sort',
-	'UI:Datatables:Language:Sort:Descending'   => 'enable for a descending sort',
+	'UI:Datatables:Language:Sort:Descending'      => 'enable for a descending sort',
+	'UI:Datatables:Column:RowActions:Label'       => '',
+	'UI:Datatables:Column:RowActions:Description' => '',
 ));

dictionaries/ui/components/datatable/fr.dictionary.itop.datatable.php

@@ -18,14 +18,16 @@
  */
 // Display DataTable
 Dict::Add('FR FR', 'French', 'Français', array(
-	'UI:Datatables:Language:Processing'        => 'Patientez ...',
+	'UI:Datatables:Language:Processing'           => 'Patientez ...',
-	'UI:Datatables:Language:LengthMenu'        => '_MENU_ par page',
+	'UI:Datatables:Language:LengthMenu'           => '_MENU_ par page',
-	'UI:Datatables:Language:ZeroRecords'       => 'Pas de résultat',
+	'UI:Datatables:Language:ZeroRecords'          => 'Pas de résultat',
-	'UI:Datatables:Language:Info'              => '_TOTAL_ élément(s)',
+	'UI:Datatables:Language:Info'                 => '_TOTAL_ élément(s)',
-	'UI:Datatables:Language:InfoEmpty'         => 'Pas d\'information',
+	'UI:Datatables:Language:InfoEmpty'            => 'Pas d\'information',
-	'UI:Datatables:Language:EmptyTable'        => 'Pas de résultat',
+	'UI:Datatables:Language:EmptyTable'           => 'Pas de résultat',
-	'UI:Datatables:Language:Error'             => 'Erreur lors du chargement des données',
+	'UI:Datatables:Language:Error'                => 'Erreur lors du chargement des données',
-	'UI:Datatables:Language:DisplayLength:All' => 'Tous',
+	'UI:Datatables:Language:DisplayLength:All'    => 'Tous',
-	'UI:Datatables:Language:Sort:Ascending'    => 'tri croissant',
+	'UI:Datatables:Language:Sort:Ascending'       => 'tri croissant',
-	'UI:Datatables:Language:Sort:Descending'   => 'tri décroissant',
+	'UI:Datatables:Language:Sort:Descending'      => 'tri décroissant',
+	'UI:Datatables:Column:RowActions:Label'       => '',
+	'UI:Datatables:Column:RowActions:Description' => '',
 ));

js/dataTables.main.js

@@ -78,4 +78,30 @@ function getMultipleSelectionParams(listId)
 	});
 
 	return oRes;
-}
+}
+
+/**
+ * Return column JSON declaration for row actions.
+ * Could be part of column or columnDefs declaration of datatable.js.
+ *
+ * @param sTableId
+ * @param iColumnTargetIndex
+ * @returns {*}
+ * @since 3.1.0
+ */
+function getRowActionsColumnDefinition(sTableId, iColumnTargetIndex = -1)
+{
+	let aColumn = {
+		type: "html",
+		orderable: false,
+		render: function ( data, type, row, meta ) {
+			return $(`#${sTableId}_actions_buttons_template`).html();
+		}
+	};
+
+	if (iColumnTargetIndex !== -1) {
+		aColumn['targets'] = iColumnTargetIndex;
+	}
+
+	return aColumn;
+}

lib/composer/autoload_classmap.php

@@ -227,6 +227,7 @@ return array(
     'Combodo\\iTop\\Application\\UI\\Base\\Component\\DataTable\\StaticTable\\FormTableRow\\FormTableRow' => $baseDir . '/sources/Application/UI/Base/Component/DataTable/StaticTable/FormTableRow/FormTableRow.php',
     'Combodo\\iTop\\Application\\UI\\Base\\Component\\DataTable\\StaticTable\\FormTable\\FormTable' => $baseDir . '/sources/Application/UI/Base/Component/DataTable/StaticTable/FormTable/FormTable.php',
     'Combodo\\iTop\\Application\\UI\\Base\\Component\\DataTable\\StaticTable\\StaticTable' => $baseDir . '/sources/Application/UI/Base/Component/DataTable/StaticTable/StaticTable.php',
+    'Combodo\\iTop\\Application\\UI\\Base\\Component\\DataTable\\tTableRowActions' => $baseDir . '/sources/Application/UI/Base/Component/DataTable/tTableRowActions.php',
     'Combodo\\iTop\\Application\\UI\\Base\\Component\\FieldBadge\\FieldBadge' => $baseDir . '/sources/Application/UI/Base/Component/FieldBadge/FieldBadge.php',
     'Combodo\\iTop\\Application\\UI\\Base\\Component\\FieldBadge\\FieldBadgeUIBlockFactory' => $baseDir . '/sources/Application/UI/Base/Component/FieldBadge/FieldBadgeUIBlockFactory.php',
     'Combodo\\iTop\\Application\\UI\\Base\\Component\\FieldSet\\FieldSet' => $baseDir . '/sources/Application/UI/Base/Component/FieldSet/FieldSet.php',
@@ -272,6 +273,8 @@ return array(
     'Combodo\\iTop\\Application\\UI\\Base\\Component\\QuickCreate\\QuickCreateHelper' => $baseDir . '/sources/Application/UI/Base/Component/QuickCreate/QuickCreateHelper.php',
     'Combodo\\iTop\\Application\\UI\\Base\\Component\\Spinner\\Spinner' => $baseDir . '/sources/Application/UI/Base/Component/Spinner/Spinner.php',
     'Combodo\\iTop\\Application\\UI\\Base\\Component\\Spinner\\SpinnerUIBlockFactory' => $baseDir . '/sources/Application/UI/Base/Component/Spinner/SpinnerUIBlockFactory.php',
+    'Combodo\\iTop\\Application\\UI\\Base\\Component\\Template\\Template' => $baseDir . '/sources/Application/UI/Base/Component/Template/Template.php',
+    'Combodo\\iTop\\Application\\UI\\Base\\Component\\Template\\TemplateUIBlockFactory' => $baseDir . '/sources/Application/UI/Base/Component/Template/TemplateUIBlockFactory.php',
     'Combodo\\iTop\\Application\\UI\\Base\\Component\\Text\\Text' => $baseDir . '/sources/Application/UI/Base/Component/Text/Text.php',
     'Combodo\\iTop\\Application\\UI\\Base\\Component\\Title\\Title' => $baseDir . '/sources/Application/UI/Base/Component/Title/Title.php',
     'Combodo\\iTop\\Application\\UI\\Base\\Component\\Title\\TitleUIBlockFactory' => $baseDir . '/sources/Application/UI/Base/Component/Title/TitleUIBlockFactory.php',

lib/composer/autoload_static.php

@@ -592,6 +592,7 @@ class ComposerStaticInit7f81b4a2a468a061c306af5e447a9a9f
         'Combodo\\iTop\\Application\\UI\\Base\\Component\\DataTable\\StaticTable\\FormTableRow\\FormTableRow' => __DIR__ . '/../..' . '/sources/Application/UI/Base/Component/DataTable/StaticTable/FormTableRow/FormTableRow.php',
         'Combodo\\iTop\\Application\\UI\\Base\\Component\\DataTable\\StaticTable\\FormTable\\FormTable' => __DIR__ . '/../..' . '/sources/Application/UI/Base/Component/DataTable/StaticTable/FormTable/FormTable.php',
         'Combodo\\iTop\\Application\\UI\\Base\\Component\\DataTable\\StaticTable\\StaticTable' => __DIR__ . '/../..' . '/sources/Application/UI/Base/Component/DataTable/StaticTable/StaticTable.php',
+        'Combodo\\iTop\\Application\\UI\\Base\\Component\\DataTable\\tTableRowActions' => __DIR__ . '/../..' . '/sources/Application/UI/Base/Component/DataTable/tTableRowActions.php',
         'Combodo\\iTop\\Application\\UI\\Base\\Component\\FieldBadge\\FieldBadge' => __DIR__ . '/../..' . '/sources/Application/UI/Base/Component/FieldBadge/FieldBadge.php',
         'Combodo\\iTop\\Application\\UI\\Base\\Component\\FieldBadge\\FieldBadgeUIBlockFactory' => __DIR__ . '/../..' . '/sources/Application/UI/Base/Component/FieldBadge/FieldBadgeUIBlockFactory.php',
         'Combodo\\iTop\\Application\\UI\\Base\\Component\\FieldSet\\FieldSet' => __DIR__ . '/../..' . '/sources/Application/UI/Base/Component/FieldSet/FieldSet.php',
@@ -637,6 +638,8 @@ class ComposerStaticInit7f81b4a2a468a061c306af5e447a9a9f
         'Combodo\\iTop\\Application\\UI\\Base\\Component\\QuickCreate\\QuickCreateHelper' => __DIR__ . '/../..' . '/sources/Application/UI/Base/Component/QuickCreate/QuickCreateHelper.php',
         'Combodo\\iTop\\Application\\UI\\Base\\Component\\Spinner\\Spinner' => __DIR__ . '/../..' . '/sources/Application/UI/Base/Component/Spinner/Spinner.php',
         'Combodo\\iTop\\Application\\UI\\Base\\Component\\Spinner\\SpinnerUIBlockFactory' => __DIR__ . '/../..' . '/sources/Application/UI/Base/Component/Spinner/SpinnerUIBlockFactory.php',
+        'Combodo\\iTop\\Application\\UI\\Base\\Component\\Template\\Template' => __DIR__ . '/../..' . '/sources/Application/UI/Base/Component/Template/Template.php',
+        'Combodo\\iTop\\Application\\UI\\Base\\Component\\Template\\TemplateUIBlockFactory' => __DIR__ . '/../..' . '/sources/Application/UI/Base/Component/Template/TemplateUIBlockFactory.php',
         'Combodo\\iTop\\Application\\UI\\Base\\Component\\Text\\Text' => __DIR__ . '/../..' . '/sources/Application/UI/Base/Component/Text/Text.php',
         'Combodo\\iTop\\Application\\UI\\Base\\Component\\Title\\Title' => __DIR__ . '/../..' . '/sources/Application/UI/Base/Component/Title/Title.php',
         'Combodo\\iTop\\Application\\UI\\Base\\Component\\Title\\TitleUIBlockFactory' => __DIR__ . '/../..' . '/sources/Application/UI/Base/Component/Title/TitleUIBlockFactory.php',

lib/composer/installed.php

@@ -5,7 +5,7 @@
         'type' => 'project',
         'install_path' => __DIR__ . '/../../',
         'aliases' => array(),
-        'reference' => '7b60c9c71af3167cc075063ce67b836b96a9e2f0',
+        'reference' => '8a3e07dd80c8316d68ad44a892c51f4ed5de572c',
         'name' => 'combodo/itop',
         'dev' => true,
     ),
@@ -25,7 +25,7 @@
             'type' => 'project',
             'install_path' => __DIR__ . '/../../',
             'aliases' => array(),
-            'reference' => '7b60c9c71af3167cc075063ce67b836b96a9e2f0',
+            'reference' => '8a3e07dd80c8316d68ad44a892c51f4ed5de572c',
             'dev_requirement' => false,
         ),
         'combodo/tcpdf' => array(

sources/Application/UI/Base/Component/DataTable/DataTable.php

@@ -21,6 +21,7 @@ use DataTableConfig;
 class DataTable extends UIContentBlock
 {
 	use tJSRefreshCallback;
+	use tTableRowActions;
 
 	// Overloaded constants
 	public const BLOCK_CODE = 'ibo-datatable';
@@ -51,6 +52,7 @@ class DataTable extends UIContentBlock
 	 */
 	protected $aInitDisplayData;
 
+
 	/**
 	 * Panel constructor.
 	 *
@@ -250,4 +252,5 @@ class DataTable extends UIContentBlock
 
 		return [];
 	}
+
 }

sources/Application/UI/Base/Component/DataTable/DataTableUIBlockFactory.php

@@ -12,6 +12,7 @@ use appUserPreferences;
 use AttributeLinkedSet;
 use cmdbAbstractObject;
 use Combodo\iTop\Application\UI\Base\AbstractUIBlockFactory;
+use Combodo\iTop\Application\UI\Base\Component\Button\ButtonUIBlockFactory;
 use Combodo\iTop\Application\UI\Base\Component\CollapsibleSection\CollapsibleSection;
 use Combodo\iTop\Application\UI\Base\Component\DataTable\StaticTable\FormTable\FormTable;
 use Combodo\iTop\Application\UI\Base\Component\DataTable\StaticTable\FormTableRow\FormTableRow;
@@ -19,8 +20,10 @@ use Combodo\iTop\Application\UI\Base\Component\DataTable\StaticTable\StaticTable
 use Combodo\iTop\Application\UI\Base\Component\Html\Html;
 use Combodo\iTop\Application\UI\Base\Component\Html\HtmlFactory;
 use Combodo\iTop\Application\UI\Base\Component\Panel\PanelUIBlockFactory;
+use Combodo\iTop\Application\UI\Base\Component\Template\TemplateUIBlockFactory;
 use Combodo\iTop\Application\UI\Base\Component\Title\TitleUIBlockFactory;
 use Combodo\iTop\Application\UI\Base\Component\Toolbar\ToolbarUIBlockFactory;
+use Combodo\iTop\Application\UI\Base\iUIBlock;
 use Combodo\iTop\Application\UI\Base\Layout\UIContentBlock;
 use Combodo\iTop\Controller\AjaxRenderController;
 use DBObjectSet;
@@ -180,6 +183,46 @@ class DataTableUIBlockFactory extends AbstractUIBlockFactory
 		return $oContainer;
 	}
 
+	/**
+	 * Make a row actions toolbar template.
+	 *
+	 * @param iUIBlock $oTable datatable object that needs to use tTableRowActions trait
+	 *
+	 * @return \Combodo\iTop\Application\UI\Base\Component\Template\Template
+	 * @throws \Exception
+	 * @since 3.1.0
+	 */
+	public static function MakeActionRowToolbarTemplate(iUIBlock $oTable)
+	{
+		// test trait
+		$sTableClass = get_class($oTable);
+		if (!utils::IsTraitUsedByClass(tTableRowActions::class, $sTableClass)) {
+			throw new \Exception("DataTableUIBlockFactory::MakeActionRowToolbarTemplate: {$sTableClass} iUIBlock needs tTableRowActions trait");
+		}
+
+		// row actions template
+		$oTemplate = TemplateUIBlockFactory::MakeStandard($oTable->GetId().'_actions_buttons_template');
+
+		// row actions toolbar container
+		$oToolbar = ToolbarUIBlockFactory::MakeStandard();
+		$oToolbar->AddCSSClass('ibo-datatable--row-actions-toolbar');
+
+		// for each action...create an icon button
+		foreach ($oTable->GetRowActions() as $iKey => $aAction) {
+			$oButton = ButtonUIBlockFactory::MakeIconAction(
+				array_key_exists('icon_classes', $aAction) ? $aAction['icon_classes'] : 'fas fa-question',
+				array_key_exists('tooltip', $aAction) ? $aAction['tooltip'] : '',
+				array_key_exists('name', $aAction) ? $aAction['name'] : 'undefined'
+			);
+			$oButton->SetDataAttributes(['action-id' => $iKey]);
+			$oToolbar->AddSubBlock($oButton);
+		}
+
+		$oTemplate->AddSubBlock($oToolbar);
+
+		return $oTemplate;
+	}
+
 	/**
 	 * Make a basis Panel component
 	 *
@@ -457,9 +500,8 @@ class DataTableUIBlockFactory extends AbstractUIBlockFactory
 		} else {
 			$aOptions['sSelectedRows'] = '[]';
 		}
-		$aExtraParams['table_id']=$sTableId;
+		$aExtraParams['table_id'] = $sTableId;
-		$aExtraParams['list_id']=$sListId;
+		$aExtraParams['list_id'] = $sListId;
-
 
 		$oDataTable->SetOptions($aOptions);
 		$oDataTable->SetAjaxUrl(utils::GetAbsoluteUrlAppRoot()."pages/ajax.render.php");
@@ -475,6 +517,12 @@ class DataTableUIBlockFactory extends AbstractUIBlockFactory
 		$oDataTable->SetResultColumns($oCustomSettings->aColumns);
 		$oDataTable->SetInitDisplayData(AjaxRenderController::GetDataForTable($oSet, $aClassAliases, $aColumnsToLoad, $sIdName, $aExtraParams));
 
+		// row actions
+		if (isset($aExtraParams['row_actions'])) {
+			$oDataTable->SetRowActions($aExtraParams['row_actions']);
+		}
+
+
 		return $oDataTable;
 	}
 
@@ -713,6 +761,11 @@ class DataTableUIBlockFactory extends AbstractUIBlockFactory
 		$oDataTable->SetResultColumns($oCustomSettings->aColumns);
 		$oDataTable->SetInitDisplayData(AjaxRenderController::GetDataForTable($oSet, $aClassAliases, $aColumnsToLoad, $sIdName, $aExtraParams));
 
+		// row actions
+		if (isset($aExtraParams['row_actions'])) {
+			$oDataTable->SetRowActions($aExtraParams['row_actions']);
+		}
+
 		return $oDataTable;
 	}
 
@@ -908,6 +961,7 @@ JS;
 	 * @param array $aExtraParams
 	 * @param string $sFilter
 	 * @param array $aOptions
+	 * @param array $aRowActions @since 3.1.0
 	 * *
 	 * $aColumns =[
 	 *           'nameField1' => ['label' => labelFIeld1, 'description' => descriptionField1],
@@ -917,7 +971,7 @@ JS;
 	 *
 	 * @return \Combodo\iTop\Application\UI\Base\Layout\UIContentBlock
 	 */
-	public static function MakeForStaticData(string $sTitle, array $aColumns, array $aData, ?string $sId = null, array $aExtraParams = [], string $sFilter = "", array $aOptions = [])
+	public static function MakeForStaticData(string $sTitle, array $aColumns, array $aData, ?string $sId = null, array $aExtraParams = [], string $sFilter = "", array $aOptions = [], array $aRowActions = null)
 	{
 		$oBlock = new UIContentBlock();
 		if ($sTitle != "") {
@@ -925,6 +979,13 @@ JS;
 			$oBlock->AddSubBlock($oTitle);
 		}
 		$oTable = new StaticTable($sId, [], $aExtraParams);
+		if ($aRowActions != null) {
+			$oTable->SetRowActions($aRowActions);
+			$aColumns['actions'] = [
+				'label'       => Dict::S('UI:Datatables:Column:RowActions:Label'),
+				'description' => Dict::S('UI:Datatables:Column:RowActions:Description'),
+			];
+		}
 		$oTable->SetColumns($aColumns);
 		$oTable->SetData($aData);
 		$oTable->SetFilter($sFilter);
@@ -940,6 +1001,7 @@ JS;
 	 * @param array $aColumns
 	 * @param array $aData
 	 * @param string $sFilter
+	 * @param array $aRowActions @since 3.1.0
 	 *
 	 * $aColumns =[
 	 *           'nameField1' => ['label' => labelFIeld1, 'description' => descriptionField1],
@@ -949,10 +1011,17 @@ JS;
 	 *
 	 * @return \Combodo\iTop\Application\UI\Base\Component\DataTable\StaticTable\FormTable\FormTable
 	 */
-	public static function MakeForForm(string $sRef, array $aColumns, array $aData = [], string $sFilter = '')
+	public static function MakeForForm(string $sRef, array $aColumns, array $aData = [], string $sFilter = '', array $aRowActions = null)
 	{
 		$oTable = new FormTable("datatable_".$sRef);
 		$oTable->SetRef($sRef);
+		if ($aRowActions != null) {
+			$oTable->SetRowActions($aRowActions);
+			$aColumns['actions'] = [
+				'label'       => Dict::S('UI:Datatables:Column:RowActions:Label'),
+				'description' => Dict::S('UI:Datatables:Column:RowActions:Description'),
+			];
+		}
 		$oTable->SetColumns($aColumns);
 		$oTable->SetFilter($sFilter);
 
@@ -970,24 +1039,44 @@ JS;
 	public static function GetAllowedParams(): array
 	{
 		return [
-			'surround_with_panel',  /** bool embed table into a Panel */
+			'surround_with_panel',
-			'menu',                 /** bool display table menu */
+			/** bool embed table into a Panel */
-			'view_link',            /** bool display the friendlyname column with links to the objects details */
+			'menu',
-			'link_attr',            /** string link att code */
+			/** bool display table menu */
-			'object_id',            /** int Id of the object linked */
+			'view_link',
-			'target_attr',          /** string target att code of the link */
+			/** bool display the friendlyname column with links to the objects details */
-			'selection_mode',       /** bool activate selection */
+			'link_attr',
-			'selection_type',       /** string 'multiple' or 'single' */
+			/** string link att code */
-			'extra_fields',         /** string comma separated list of link att code to display ('alias.attcode')*/
+			'object_id',
-			'zlist',                /** string name of the zlist to display when 'extra_fields' is not set */
+			/** int Id of the object linked */
-			'display_limit',        /** bool if true pagination is used (default = true)  */
+			'target_attr',
-			'table_id',             /** string datatable id */
+			/** string target att code of the link */
-			'cssCount',             /** string external counter (input hidden) js selector */
+			'selection_mode',
-			'selected_rows',        /** array list of Ids already selected when displaying the datatable */
+			/** bool activate selection */
-			'display_aliases',      /** string comma separated list of class aliases to display */
+			'selection_type',
-			'list_id',              /** string list outer id */
+			/** string 'multiple' or 'single' */
-			'selection_enabled',    	/** list of id in witch select is allowed, if not exists all lines are selectable */
+			'extra_fields',
-			'id_for_select', /**give definition of id for select checkbox*/
+			/** 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 */
+			'selection_enabled',
+			/** list of id in witch select is allowed, if not exists all lines are selectable */
+			'id_for_select',
+			/**give definition of id for select checkbox*/
+			'row_actions',
+			/** array of blocks displayed on every row */
 		];
 	}
 }

sources/Application/UI/Base/Component/DataTable/StaticTable/FormTable/FormTable.php

@@ -9,6 +9,7 @@ namespace Combodo\iTop\Application\UI\Base\Component\DataTable\StaticTable\FormT
 
 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\DataTable\tTableRowActions;
 use Combodo\iTop\Application\UI\Base\iUIBlock;
 
 /**
@@ -19,10 +20,10 @@ use Combodo\iTop\Application\UI\Base\iUIBlock;
 class FormTable extends StaticTable
 {
 	// Overloaded constants
-	public const BLOCK_CODE = 'ibo-formtable';
+	public const BLOCK_CODE                            = 'ibo-formtable';
-	public const REQUIRES_ANCESTORS_DEFAULT_JS_FILES = true;
+	public const REQUIRES_ANCESTORS_DEFAULT_JS_FILES   = true;
-	public const REQUIRES_ANCESTORS_DEFAULT_CSS_FILES = true;
+	public const REQUIRES_ANCESTORS_DEFAULT_CSS_FILES  = true;
-	public const DEFAULT_HTML_TEMPLATE_REL_PATH = 'base/components/datatable/static/formtable/layout';
+	public const DEFAULT_HTML_TEMPLATE_REL_PATH        = 'base/components/datatable/static/formtable/layout';
 	public const DEFAULT_JS_ON_READY_TEMPLATE_REL_PATH = 'base/components/datatable/static/formtable/layout';
 
 	/** @var string */

sources/Application/UI/Base/Component/DataTable/StaticTable/StaticTable.php

@@ -2,6 +2,7 @@
 
 namespace Combodo\iTop\Application\UI\Base\Component\DataTable\StaticTable;
 
+use Combodo\iTop\Application\UI\Base\Component\DataTable\tTableRowActions;
 use Combodo\iTop\Application\UI\Base\Layout\UIContentBlock;
 use Combodo\iTop\Application\UI\Base\tJSRefreshCallback;
 use utils;
@@ -18,12 +19,13 @@ use utils;
 class StaticTable extends UIContentBlock
 {
 	use tJSRefreshCallback;
+	use tTableRowActions;
 
 	// Overloaded constants
-	public const BLOCK_CODE = 'ibo-datatable';
+	public const BLOCK_CODE                            = 'ibo-datatable';
-	public const DEFAULT_HTML_TEMPLATE_REL_PATH = 'base/components/datatable/static/layout';
+	public const DEFAULT_HTML_TEMPLATE_REL_PATH        = 'base/components/datatable/static/layout';
 	public const DEFAULT_JS_ON_READY_TEMPLATE_REL_PATH = 'base/components/datatable/static/layout';
-	public const DEFAULT_JS_FILES_REL_PATH = [
+	public const DEFAULT_JS_FILES_REL_PATH             = [
 		'node_modules/datatables.net/js/jquery.dataTables.min.js',
 		'node_modules/datatables.net-fixedheader/js/dataTables.fixedHeader.min.js',
 		'node_modules/datatables.net-responsive/js/dataTables.responsive.min.js',
@@ -59,7 +61,7 @@ class StaticTable extends UIContentBlock
 	private $aExtraParams;
 	/*@var string $sUrlForRefresh*/
 	private $sFilter;
-	/** @var array $aOptions 
+	/** @var array $aOptions
 	 * List of specific options for display datatable
 	 */
 	private $aOptions;
@@ -81,6 +83,17 @@ class StaticTable extends UIContentBlock
 		return $this->aColumns;
 	}
 
+	/**
+	 * Return columns count.
+	 *
+	 * @return int
+	 * @since 3.1.0
+	 */
+	public function GetColumnsCount(): int
+	{
+		return count($this->aColumns);
+	}
+
 	/**
 	 * @param array $aColumns
 	 *
@@ -129,8 +142,8 @@ class StaticTable extends UIContentBlock
 	{
 		//$('#".$this->sId."').DataTable().clear().rows.add(data).draw()
 		$aParams = [
-			'style' => 'list',
+			'style'        => 'list',
-			'filter' => $this->sFilter,
+			'filter'       => $this->sFilter,
 			'extra_params' => $this->aExtraParams,
 		];
 
@@ -140,7 +153,7 @@ class StaticTable extends UIContentBlock
 	                    $('#".$this->sId."').dataTable().fnAddData(data);
 					});";
 	}
-	
+
 	/**
 	 * @return mixed
 	 */
@@ -149,6 +162,7 @@ class StaticTable extends UIContentBlock
 		if (isset($this->aOptions[$sOption])) {
 			return $this->aOptions[$sOption];
 		}
+
 		return null;
 	}
 

sources/Application/UI/Base/Component/DataTable/tTableRowActions.php

@@ -0,0 +1,73 @@
+<?php
+/*
+ * @copyright   Copyright (C) 2010-2022 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+
+namespace Combodo\iTop\Application\UI\Base\Component\DataTable;
+
+/**
+ * Trait tTableRowActions
+ *
+ * This brings the ability to add action rows to tables.
+ *
+ * @internal
+ * @package Combodo\iTop\Application\UI\Base\Component\DataTable
+ * @since 3.1.0
+ */
+trait tTableRowActions
+{
+	/**
+	 * @var $aRowActions array array of row actions
+	 * action => {
+	 *      tooltip: string,
+	 *      icon_classes: string,
+	 *      js_row_action: string
+	 * }
+	 */
+	protected $aRowActions;
+
+	/**
+	 * Set row actions.
+	 *
+	 * @param array $aRowActions
+	 *
+	 * @return $this
+	 */
+	public function SetRowActions(array $aRowActions)
+	{
+		$this->aRowActions = $aRowActions;
+
+		return $this;
+	}
+
+	/**
+	 * Get row actions.
+	 *
+	 * @return array
+	 */
+	public function GetRowActions(): array
+	{
+		return $this->aRowActions;
+	}
+
+	/**
+	 * Return true if row actions is set and not empty.
+	 *
+	 * @return bool
+	 */
+	public function HasRowActions(): bool
+	{
+		return isset($this->aRowActions) && count($this->aRowActions);
+	}
+
+	/**
+	 * Return row actions template.
+	 *
+	 * @return \Combodo\iTop\Application\UI\Base\Component\Template\Template
+	 */
+	public function GetRowActionsTemplate()
+	{
+		return DataTableUIBlockFactory::MakeActionRowToolbarTemplate($this);
+	}
+}

sources/Application/UI/Base/Component/Template/Template.php

@@ -0,0 +1,37 @@
+<?php
+/**
+ * Copyright (C) 2013-2022 Combodo SARL
+ *
+ * This file is part of iTop.
+ *
+ * iTop is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * iTop is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ */
+
+namespace Combodo\iTop\Application\UI\Base\Component\Template;
+
+use Combodo\iTop\Application\UI\Base\Layout\UIContentBlock;
+
+/**
+ * Class Template
+ *
+ * @author Benjamin Dalsass<benjamin.dalsass@combodo.com>
+ * @package Combodo\iTop\Application\UI\Base\Component\Template
+ * @since 3.1.0
+ */
+class Template extends UIContentBlock
+{
+	// Overloaded constants
+	public const BLOCK_CODE                     = 'ibo-template';
+	public const DEFAULT_HTML_TEMPLATE_REL_PATH = 'base/components/template/layout';
+
+}

sources/Application/UI/Base/Component/Template/TemplateUIBlockFactory.php

@@ -0,0 +1,50 @@
+<?php
+/**
+ * Copyright (C) 2013-2022 Combodo SARL
+ *
+ * This file is part of iTop.
+ *
+ * iTop is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * iTop is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ */
+
+namespace Combodo\iTop\Application\UI\Base\Component\Template;
+
+use Combodo\iTop\Application\UI\Base\AbstractUIBlockFactory;
+
+/**
+ * Class TemplateUIBlockFactory
+ *
+ * @api
+ *
+ * @author Benjamin Dalsass <benjamin.dalsass@combodo.com>
+ * @package Combodo\iTop\Application\UI\Base\Component\Template
+ * @since 3.1.0
+ * @link
+ */
+class TemplateUIBlockFactory extends AbstractUIBlockFactory
+{
+	/** @inheritDoc */
+	public const TWIG_TAG_NAME = 'UITemplate';
+	/** @inheritDoc */
+	public const UI_BLOCK_CLASS_NAME = Template::class;
+
+	/**
+	 * Make a Template component
+	 *
+	 * @return \Combodo\iTop\Application\UI\Base\Component\Template\Template
+	 */
+	public static function MakeStandard(string $sId)
+	{
+		return new Template($sId);
+	}
+}

templates/base/components/datatable/layout.html.twig

@@ -20,5 +20,12 @@
     {% for aColumn in oUIBlock.GetDisplayColumns() %}
         <th class="ibo-datatable-header" {% if aColumn["description"] is not empty %}title="{{ aColumn["description"] }}"{% endif %}>{{ aColumn["attribute_label"] }} </th>
     {% endfor %}
+    {% if oUIBlock.HasRowActions() %}
+        <th class="ibo-datatable-header">{{ 'UI:Datatables:Column:RowActions:Label'|dict_s }} </th>
+    {% endif %}
     </thead>
-</table>
+</table>
+
+{% if oUIBlock.HasRowActions() %}
+    {{ render_block(oUIBlock.GetRowActionsTemplate()) }}
+{% endif %}

templates/base/components/datatable/layout.ready.js.twig

@@ -208,6 +208,9 @@ var oTable{{ sListIDForVarSuffix }} = $('#{{ oUIBlock.GetId() }}').DataTable({
             }
         },
         {% endfor %}
+        {% if oUIBlock.HasRowActions() %}
+            getRowActionsColumnDefinition('{{ oUIBlock.GetId() }}'),
+        {% endif %}
     ],
     ajax: $.fn.dataTable.pipeline({
                 url: "{{ oUIBlock.GetAjaxUrl() }}",
@@ -415,4 +418,6 @@ if(window.ResizeObserver){
             }, 120);
         });
         oTable{{ sListIDForVarSuffix }}Resize.observe($('#{{ oUIBlock.GetId() }}')[0]);
-}
+}
+
+{% include 'base/components/datatable/row-actions/handler.js.twig' %}

templates/base/components/datatable/row-actions/handler.js.twig

@@ -0,0 +1,15 @@
+{# @copyright   Copyright (C) 2010-2022 Combodo SARL #}
+{# @license     http://opensource.org/licenses/AGPL-3.0 #}
+
+// for each row action
+{% if oUIBlock.HasRowActions() %}
+    {% for aAction in oUIBlock.GetRowActions() %}
+        $('#{{ oUIBlock.GetId() }} tbody').on('click', 'button[data-action-id="{{ loop.index0 }}"]', function() {
+            let iActionId = $(this).data('action-id');
+            let oDatatable = $('#{{ oUIBlock.GetId() }}').DataTable();
+            let oTrElement = $(this).closest('tr');
+            let aData = oDatatable.row(oTrElement).data();
+            {{ aAction.js_row_action|raw }};
+        });
+    {% endfor %}
+{% endif %}

templates/base/components/datatable/static/formtable/layout.html.twig

@@ -13,8 +13,12 @@
     </tr>
     </thead>
     <tbody>
-    {% for oSubBlock in oUIBlock.GetRows() %}
+    {% for oRowBlock in oUIBlock.GetRows() %}
-        {{ render_block(oSubBlock, {aPage: aPage}) }}
+        {{ render_block(oRowBlock, {aPage: aPage}) }}
     {% endfor %}
     </tbody>
-</table>
+</table>
+
+{% if oUIBlock.HasRowActions() %}
+    {{ render_block(oUIBlock.GetRowActionsTemplate()) }}
+{% endif %}

templates/base/components/datatable/static/formtable/layout.ready.js.twig

@@ -20,7 +20,10 @@ var oTable{{ sListIDForVarSuffix }} = $('#{{ oUIBlock.GetId() }}').DataTable({
     },
     {% endif %}
     columnDefs: [
-        {orderable: false, targets: 0}
+        {orderable: false, targets: 0},
+        {% if oUIBlock.HasRowActions() %}
+            getRowActionsColumnDefinition('{{ oUIBlock.GetId() }}', {{ oUIBlock.GetColumnsCount() - 1 }}),
+        {% endif %}
     ],
     {% endif %}
     drawCallback: function (settings) {
@@ -123,4 +126,6 @@ if (window.ResizeObserver)
 
     {% endif %}
 
-}
+}
+
+{% include 'base/components/datatable/row-actions/handler.js.twig' %}

templates/base/components/datatable/static/layout.html.twig

@@ -44,4 +44,8 @@
         </tr>
     {% endfor %}
     </tbody>
-</table>
+</table>
+
+{% if oUIBlock.HasRowActions() %}
+    {{ render_block(oUIBlock.GetRowActionsTemplate()) }}
+{% endif %}

templates/base/components/datatable/static/layout.ready.js.twig

@@ -54,6 +54,9 @@ var oTable{{ sListIDForVarSuffix }} = $('#{{ oUIBlock.GetId() }}').DataTable({
             sortable: true
         },
         {% endfor %}
+        {% if oUIBlock.HasRowActions() %}
+            getRowActionsColumnDefinition('{{ oUIBlock.GetId() }}'),
+        {% endif %}
     ],
     drawCallback: function (settings) {
         if(settings.json)
@@ -103,4 +106,6 @@ if (window.ResizeObserver)
         }, 120);
     });
     oStaticTable{{ sListIDForVarSuffix }}Resize.observe($('#{{ oUIBlock.GetId() }}')[0]);
-}
+}
+
+{% include 'base/components/datatable/row-actions/handler.js.twig' %}

templates/base/components/template/layout.html.twig

@@ -0,0 +1,9 @@
+{# @copyright   Copyright (C) 2010-2022 Combodo SARL #}
+{# @license     http://opensource.org/licenses/AGPL-3.0 #}
+{% apply spaceless %}
+    <template id="{{ oUIBlock.GetId() }}" data-role="ibo-template">
+        {% for oSubBlock in oUIBlock.GetSubBlocks() %}
+            {{ render_block(oSubBlock, {aPage: aPage}) }}
+        {% endfor %}
+    </template>
+{% endapply %}