N°2847 - Tab Management - iTop Pages refactoring - introduction of UIContentBlock as base block

2026-04-26 12:08:47 +02:00 · 2020-09-16 12:00:48 +02:00
parent 163c1ebc91
commit 410a637598
46 changed files with 1245 additions and 737 deletions
--- a/sources/application/UI/Layout/TabContainer/TabContainer.php
+++ b/sources/application/UI/Layout/TabContainer/TabContainer.php
@@ -0,0 +1,125 @@
+<?php
+/**
+ * Copyright (C) 2013-2020 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\Layout\TabContainer;
+
+
+use Combodo\iTop\Application\UI\iUIBlock;
+use Combodo\iTop\Application\UI\Layout\iUIContentBlock;
+use Combodo\iTop\Application\UI\Layout\TabContainer\Tab\AjaxTab;
+use Combodo\iTop\Application\UI\Layout\TabContainer\Tab\Tab;
+use Combodo\iTop\Application\UI\Layout\UIContentBlock;
+use Combodo\iTop\Application\UI\UIException;
+use Dict;
+
+/**
+ * Class TabContainer
+ *
+ * @package Combodo\iTop\Application\UI\Layout\TabContainer
+ */
+class TabContainer extends UIContentBlock
+{
+	// Overloaded constants
+	public const BLOCK_CODE = 'ibo-tabcontainer';
+	public const HTML_TEMPLATE_REL_PATH = 'layouts/tabcontainer/layout';
+	public const JS_TEMPLATE_REL_PATH = 'layouts/tabcontainer/layout';
+
+	private $sName;
+	private $sPrefix;
+
+	/**
+	 * TabContainer constructor.
+	 *
+	 * @param $sName
+	 * @param $sPrefix
+	 */
+	public function __construct($sName, $sPrefix)
+	{
+		parent::__construct("{$sName}".((!empty($sPrefix)) ? "-{$sPrefix}" : ""));
+
+		$this->sName = $sName;
+		$this->sPrefix = $sPrefix;
+	}
+
+	/**
+	 * @param string $sTabCode
+	 *
+	 * @return bool
+	 */
+	public function TabExists(string $sTabCode): bool
+	{
+		return $this->HasSubBlock($sTabCode);
+	}
+
+	public function GetTab($sTabCode): ?Tab
+	{
+		/** @var \Combodo\iTop\Application\UI\Layout\TabContainer\Tab\Tab $oTab */
+		$oTab = $this->GetSubBlock($sTabCode);
+		return $oTab;
+	}
+
+	/**
+	 * @param string $sTabCode
+	 * @param string $sTitle
+	 *
+	 * @return \Combodo\iTop\Application\UI\Layout\TabContainer\Tab\Tab
+	 * @throws \Combodo\iTop\Application\UI\UIException
+	 */
+	public function AddAjaxTab(string $sTabCode, string $sTitle): Tab
+	{
+		$oTab = new AjaxTab($sTabCode, $sTitle);
+		$this->AddSubBlock($oTab);
+		return $oTab;
+	}
+
+
+	/**
+	 * @param string $sTabCode
+	 * @param string $sTitle
+	 *
+	 * @return \Combodo\iTop\Application\UI\Layout\TabContainer\Tab\Tab
+	 * @throws \Combodo\iTop\Application\UI\UIException
+	 */
+	public function AddTab(string $sTabCode, string $sTitle): Tab
+	{
+		$oTab = new Tab($sTabCode, $sTitle);
+		$this->AddSubBlock($oTab);
+		return $oTab;
+	}
+
+	public function RemoveTab(string $sTabCode): self
+	{
+		$this->RemoveSubBlock($sTabCode);
+		return $this;
+	}
+
+	/**
+	 * @param \Combodo\iTop\Application\UI\iUIBlock $oSubBlock
+	 *
+	 * @return iUIContentBlock
+	 * @throws \Combodo\iTop\Application\UI\UIException
+	 */
+	public function AddSubBlock(iUIBlock $oSubBlock): iUIContentBlock
+	{
+		if (!($oSubBlock instanceof Tab)) {
+			throw new UIException($this, Dict::Format('UIBlock:Error:AddBlockNotTabForbidden', $oSubBlock->GetId(), $this->GetId()));
+		}
+		return parent::AddSubBlock($oSubBlock);
+	}
+}