N°9152 - Add extensibility API endpoints for UI elements (#1017)

--------- Co-authored-by: Molkobain <lajarige.guillaume@free.fr> Co-authored-by: Benjamin DALSASS <benjamin.dalsass@combodo.com>
2026-09-18 04:38:29 +02:00 · 2026-08-31 16:03:36 +02:00
parent 7d4fc98ecc
commit 373942f922
107 changed files with 4425 additions and 574 deletions
--- a/sources/Application/UI/Base/Component/ButtonBar/ButtonBarUIBlockFactory.php
+++ b/sources/Application/UI/Base/Component/ButtonBar/ButtonBarUIBlockFactory.php
@@ -0,0 +1,135 @@
+<?php
+
+/**
+ * Copyright (C) 2013-2024 Combodo SAS
+ *
+ * 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\ButtonBar;
+
+use Combodo\iTop\Application\UI\Base\AbstractUIBlockFactory;
+use Combodo\iTop\Application\UI\Base\Component\Button\Button;
+use Combodo\iTop\Application\UI\Base\Component\Button\ButtonSeparator;
+
+/**
+ * Class ButtonBarUIBlockFactory
+ *
+ * @api
+ * @since 3.3.0
+ */
+class ButtonBarUIBlockFactory extends AbstractUIBlockFactory
+{
+	/** @inheritDoc */
+	public const TWIG_TAG_NAME = 'UIButtonBar';
+
+	/** @inheritDoc */
+	public const UI_BLOCK_CLASS_NAME = ButtonBar::class;
+
+	/**
+	 * Build a button bar from a list of items.
+	 *
+	 * Each item can be:
+	 * - Button
+	 * - ButtonSeparator
+	 * (ButtonGroup are not supported in this factory)
+	 *
+	 * @param array $aItems
+	 * @param string|null $sMoreButtonTooltipText
+	 * @param string|null $sId
+	 *
+	 * @return ButtonBar
+	 */
+	public static function MakeStandard(
+		array $aItems = [],
+		?string $sMoreButtonTooltipText = null,
+		?string $sId = null
+	): ButtonBar {
+		return static::BuildButtonBar($aItems, $sMoreButtonTooltipText, $sId, ButtonBar::OVERFLOW_MODE_FIT);
+	}
+
+	/**
+	 * Build a button bar using a fixed visible item count before overflow.
+	 *
+	 * @param array $aItems
+	 * @param int $iOverflowCount Number of items to keep visible in the bar
+	 * @param string|null $sMoreButtonTooltipText
+	 * @param string|null $sId
+	 *
+	 * @return ButtonBar
+	 */
+	public static function MakeWithCountOverflow(
+		array $aItems = [],
+		int $iOverflowCount = 3,
+		?string $sMoreButtonTooltipText = null,
+		?string $sId = null
+	): ButtonBar {
+		return static::BuildButtonBar($aItems, $sMoreButtonTooltipText, $sId, ButtonBar::OVERFLOW_MODE_COUNT, $iOverflowCount);
+	}
+
+	/**
+	 * Build a button bar overflowing everything after a marker button.
+	 *
+	 * @param array $aItems
+	 * @param string $sOverflowStartAfterButtonId Button id used as marker
+	 * @param string|null $sMoreButtonTooltipText
+	 * @param string|null $sId
+	 *
+	 * @return ButtonBar
+	 */
+	public static function MakeWithAfterMarkerOverflow(
+		string $sOverflowStartAfterButtonId,
+		array $aItems = [],
+		?string $sMoreButtonTooltipText = null,
+		?string $sId = null
+	): ButtonBar {
+		return static::BuildButtonBar(
+			$aItems,
+			$sMoreButtonTooltipText,
+			$sId,
+			ButtonBar::OVERFLOW_MODE_AFTER_MARKER,
+			3,
+			$sOverflowStartAfterButtonId
+		);
+	}
+
+	/**
+	 * Internal builder shared by the public named constructors.
+	 */
+	protected static function BuildButtonBar(
+		array $aItems,
+		?string $sMoreButtonTooltipText,
+		?string $sId,
+		string $sOverflowMode,
+		int $iOverflowCount = 3,
+		?string $sOverflowStartAfterButtonId = null
+	): ButtonBar {
+		$oButtonBar = new ButtonBar([], $sMoreButtonTooltipText, $sId);
+		$oButtonBar
+			->SetOverflowMode($sOverflowMode)
+			->SetOverflowCount($iOverflowCount)
+			->SetOverflowStartAfterButtonId($sOverflowStartAfterButtonId);
+
+		foreach ($aItems as $iIndex => $oItem) {
+			if (!($oItem instanceof Button) && !($oItem instanceof ButtonSeparator)) {
+				throw new \InvalidArgumentException(sprintf('Button bar items must be a Button or ButtonSeparator, "%s" given at index %d', is_object($oItem) ? get_class($oItem) : gettype($oItem), $iIndex));
+			}
+
+			$oButtonBar->AddButton($oItem);
+		}
+
+		return $oButtonBar;
+	}
+}