Rename all the attributes for navigation in list with basket

2026-05-21 00:02:17 +02:00 · 2023-08-11 16:05:31 +02:00
parent 49cf6f5fe2
commit 0e76db8c93
33 changed files with 2763 additions and 2462 deletions
--- a/sources/Application/UI/Base/Component/Navigation/Navigation.php
+++ b/sources/Application/UI/Base/Component/Navigation/Navigation.php
@@ -17,7 +17,7 @@
 * You should have received a copy of the GNU Affero General Public License
 */

-namespace Combodo\iTop\Application\UI\Base\Component\Navigation;
+namespace Combodo\iTop\Application\UI\Base\Component\Basket;


 use Combodo\iTop\Application\UI\Base\Layout\UIContentBlock;
@@ -25,34 +25,34 @@ use iTopStandardURLMaker;
 use utils;

 /**
- * Class Navigation
+ * Class Basket
 *
- * @package Combodo\iTop\Application\UI\Base\Component\Navigation
- * @since 3.1.0
+ * @package Combodo\iTop\Application\UI\Base\Component\Basket
+ * @since 3.1.1
 */
-class Navigation extends UIContentBlock
+class Basket extends UIContentBlock
 {

 	// Overloaded constants
-	public const BLOCK_CODE = 'ibo-navigation';
+	public const BLOCK_CODE = 'ibo-basket';
 	/** @inheritDoc */
 	public const REQUIRES_ANCESTORS_DEFAULT_JS_FILES = true;
 	/** @inheritDoc */
 	public const REQUIRES_ANCESTORS_DEFAULT_CSS_FILES = true;
-	public const DEFAULT_HTML_TEMPLATE_REL_PATH = 'base/components/navigation/layout';
-	public const DEFAULT_JS_TEMPLATE_REL_PATH =  'base/components/navigation/layout';
-	public const DEFAULT_JS_FILES_REL_PATH = [	];
+	public const DEFAULT_HTML_TEMPLATE_REL_PATH       = 'base/components/basket/layout';
+	public const DEFAULT_JS_TEMPLATE_REL_PATH         = 'base/components/basket/layout';
+	public const DEFAULT_JS_FILES_REL_PATH            = [];

 	protected $iIdx;
 	protected $iCount;
-	protected $iIdFirst = 0 ;
+	protected $iIdFirst = 0;
 	protected $iIdPrev = 0;
 	protected $iIdNext = 0;
 	protected $iIdLast = 0;
 	protected $aList = [];
-	protected $sBasketFilter;
+	protected $sFilter;
 	protected $sBackUrl;
-	protected $sBasketClass;
+	protected $sClass;
 	protected $sPostedFields;

 	/**
@@ -63,16 +63,16 @@ class Navigation extends UIContentBlock
 	 * @param string $sColorScheme Color scheme code such as "success", "failure", "active", ... {@see css/backoffice/components/_panel.scss}
 	 * @param string|null $sId
 	 */
-	public function __construct(string $sBasketClass, int $iIdx, array $aList, string $sBasketFilter, string $sBackUrl, string $sPostedFieldsForBackUrl = "", ?string $sId = null)
+	public function __construct(string $sClass, int $iIdx, array $aList, string $sFilter, string $sBackUrl, string $sPostedFieldsForBackUrl = "", ?string $sId = null)
 	{
 		parent::__construct($sId);
 		$this->iCount = count($aList);
 		if ($this->iCount == 0) {
 			return new UIContentBlock();
 		}
-		$this->sBasketClass = $sBasketClass;
+		$this->sClass = $sClass;
 		$this->aList = $aList;
-		$this->sBasketFilter = $sBasketFilter;
+		$this->sFilter = $sFilter;
 		$this->sBackUrl = $sBackUrl;
 		$this->iIdx = $iIdx;
 		if ($this->iIdx>0) {
@@ -112,7 +112,7 @@ class Navigation extends UIContentBlock

 	private function GetUrlFromId($iId)
 	{
-		$sUrl = iTopStandardURLMaker::MakeObjectURL($this->sBasketClass, $iId);
+		$sUrl = iTopStandardURLMaker::MakeObjectURL($this->sClass, $iId);
 		return $sUrl;
 	}

@@ -159,9 +159,9 @@ class Navigation extends UIContentBlock
 	/**
 	 * @return string
 	 */
-	public function GetBasketFilter(): string
+	public function GetFilter(): string
 	{
-		return $this->sBasketFilter;
+		return $this->sFilter;
 	}

 	/**
--- a/sources/Application/UI/Base/Component/Navigation/NavigationUIBlockFactory.php
+++ b/sources/Application/UI/Base/Component/Navigation/NavigationUIBlockFactory.php
@@ -17,7 +17,7 @@
 * You should have received a copy of the GNU Affero General Public License
 */

-namespace Combodo\iTop\Application\UI\Base\Component\Navigation;
+namespace Combodo\iTop\Application\UI\Base\Component\Basket;

 use Combodo\iTop\Application\UI\Base\AbstractUIBlockFactory;
 use DBObjectSearch;
@@ -25,50 +25,48 @@ use DBObjectSet;
 use utils;

 /**
- * Class PanelUIBlockFactory
+ * Class BasketUIBlockFactory
 *
- * @package UIBlockExtensibilityAPI
 * @api
- * @since 3.1.0
+ * @package UIBlockExtensibilityAPI
+ * @since 3.1.1
 *
 * @link <itop_url>/test/VisualTest/Backoffice/RenderAllUiBlocks.php#title-panels to see live examples
 */
-class NavigationUIBlockFactory extends AbstractUIBlockFactory
+class BasketUIBlockFactory extends AbstractUIBlockFactory
 {
 	/** @inheritDoc */
-	public const TWIG_TAG_NAME = 'UINavigation';
+	public const TWIG_TAG_NAME = 'UIBasket';
 	/** @inheritDoc */
-	public const UI_BLOCK_CLASS_NAME = Navigation::class;
+	public const UI_BLOCK_CLASS_NAME = Basket::class;

 	/**
 	 * Make a basis Panel component
 	 *
 	 * @api
-	 * @param string $sTitle
-	 * @param string|null $sSubTitle
 	 *
-	 * @return \Combodo\iTop\Application\UI\Base\Component\Panel\Panel
+	 * @return \Combodo\iTop\Application\UI\Base\Component\Basket
 	 */
-	public static function MakeStandard($oObject, string $sBasketFilter, string $sBasketClass, array $aList = [], string $sBackUrl = '', $sPostedFieldsForBackUrl = "")
+	public static function MakeStandard($oObject, string $sFilter, string $sClass, array $aList = [], string $sBackUrl = '', $sPostedFieldsForBackUrl = "")
 	{
-		if (utils::IsNotNullOrEmptyString($sBasketFilter) && count($aList) === 0) {
-			$oBasketFilter = DBObjectSearch::FromOQL($sBasketFilter);
+		if (utils::IsNotNullOrEmptyString($sFilter) && count($aList) === 0) {
+			$oBasketFilter = DBObjectSearch::FromOQL($sFilter);
 			$oSet = new DBObjectSet($oBasketFilter);
 			$aList = $oSet->GetColumnAsArray('id', false);
-			if (utils::IsNullOrEmptyString($sBasketClass)) {
-				$sBasketClass = $oBasketFilter->GetClass();
+			if (utils::IsNullOrEmptyString($sClass)) {
+				$sClass = $oBasketFilter->GetClass();
 			}
 		}
-		if (utils::IsNullOrEmptyString($sBasketClass)) {
-			$oBasketFilter = DBObjectSearch::FromOQL($sBasketFilter);
-			$sBasketClass = $oBasketFilter->GetClass();
+		if (utils::IsNullOrEmptyString($sClass)) {
+			$oBasketFilter = DBObjectSearch::FromOQL($sFilter);
+			$sClass = $oBasketFilter->GetClass();
 		}
 		if (count($aList) === 0) {
 			return null;
 		}

 		$iIdx = array_search($oObject->GetKey(), $aList);
-		$oNavigationBlock = new Navigation($sBasketClass, $iIdx, $aList, $sBasketFilter, $sBackUrl, $sPostedFieldsForBackUrl);
+		$oNavigationBlock = new Basket($sClass, $iIdx, $aList, $sFilter, $sBackUrl, $sPostedFieldsForBackUrl);

 		return $oNavigationBlock;
 	}
--- a/sources/Application/UI/Base/Component/DataTable/DataTable.php
+++ b/sources/Application/UI/Base/Component/DataTable/DataTable.php
@@ -48,7 +48,10 @@ class DataTable extends UIContentBlock
 	protected $aAjaxData;
 	protected $aDisplayColumns;
 	protected $aResultColumns;
+	/* @since 3.1.1 */
 	protected $sBasketFilter;
+	/* @since 3.1.1 */
+	protected $sBasketClass;
 	/**
 	 * @var string
 	 */
@@ -224,6 +227,7 @@ class DataTable extends UIContentBlock

 	/**
 	 * @return string
+	 * @since 3.1.1
 	 */
 	public function GetBasketFilter()
 	{
@@ -232,12 +236,33 @@ class DataTable extends UIContentBlock

 	/**
 	 * @param string $sFilter
+	 *
+	 * @since 3.1.1
 	 */
-	public function setBasketFilter($sFilter): void
+	public function setBasketFilter(string $sFilter): void
 	{
 		$this->sBasketFilter = $sFilter;
 	}

+	/**
+	 * @return mixed
+	 * @since 3.1.1
+	 */
+	public function GetBasketClass()
+	{
+		return $this->sBasketClass;
+	}
+
+	/**
+	 * @param string $sBasketClass
+	 *
+	 * @since 3.1.1
+	 */
+	public function setBasketClass(string $sBasketClass): void
+	{
+		$this->sBasketClass = $sBasketClass;
+	}
+
 	/**
 	 *  Get $aInitDisplayData
 	 *
--- a/sources/Application/UI/Base/Component/DataTable/DataTableBasket.php
+++ b/sources/Application/UI/Base/Component/DataTable/DataTableBasket.php
@@ -16,7 +16,7 @@ use DataTableConfig;
 * Class DataTableBasket
 *
 * @package Combodo\iTop\Application\UI\Base\Component\DataTableBasket
- * @since 3.1.0
+ * @since 3.1.1
 */
 class DataTableBasket extends UIContentBlock
 {
@@ -25,24 +25,24 @@ class DataTableBasket extends UIContentBlock

 	public const DEFAULT_JS_ON_READY_TEMPLATE_REL_PATH = 'base/components/datatable/basket';

-	protected $sPostedFieldsForBackUrl;
+	protected $sBasketPostedFieldsForBackUrl;


 	/**
 	 * Panel constructor.
 	 *
 	 */
-	public function __construct(array $aPostedFieldsForBackUrl = [], ?string $sId = null)
+	public function __construct(array $aBasketPostedFieldsForBackUrl = [], ?string $sId = null)
 	{
 		parent::__construct($sId);
-		$this->sPostedFieldsForBackUrl = json_encode($aPostedFieldsForBackUrl);
+		$this->sBasketPostedFieldsForBackUrl = json_encode($aBasketPostedFieldsForBackUrl);
 	}

 	/**
 	 * @return string
 	 */
-	public function GetPostedFieldsForBackUrl(): string
+	public function GetBasketPostedFieldsForBackUrl(): string
 	{
-		return $this->sPostedFieldsForBackUrl;
+		return $this->sBasketPostedFieldsForBackUrl;
 	}
 }
--- a/sources/Application/UI/Base/Component/DataTable/DataTableUIBlockFactory.php
+++ b/sources/Application/UI/Base/Component/DataTable/DataTableUIBlockFactory.php
@@ -597,6 +597,7 @@ class DataTableUIBlockFactory extends AbstractUIBlockFactory
 		$oDataTable->SetResultColumns($oCustomSettings->aColumns);
 		$oFilter->SetSelectedClasses([$sBasketAliasClass]);
 		$oDataTable->SetBasketFilter($oFilter->ToOQL(true));
+		$oDataTable->SetBasketClass($oFilter->GetClass());
 		$oDataTable->SetInitDisplayData(AjaxRenderController::GetDataForTable($oSet, $aClassAliases, $aColumnsToLoad, $sIdName, $aExtraParams, 1, $sLinkToBasket));

 		// row actions
--- a/sources/Application/UI/Base/Layout/PageContent/PageContentFactory.php
+++ b/sources/Application/UI/Base/Layout/PageContent/PageContentFactory.php
@@ -21,7 +21,7 @@ namespace Combodo\iTop\Application\UI\Base\Layout\PageContent;


 use cmdbAbstractObject;
-use Combodo\iTop\Application\UI\Base\Component\Navigation\NavigationUIBlockFactory;
+use Combodo\iTop\Application\UI\Base\Component\Basket\BasketUIBlockFactory;
 use Combodo\iTop\Application\UI\Base\Layout\ActivityPanel\ActivityPanelFactory;
 use Combodo\iTop\Application\UI\Base\Layout\Object\ObjectFactory;
 use DBObject;
@@ -51,13 +51,15 @@ class PageContentFactory
 	 *
 	 * @see cmdbAbstractObject::ENUM_DISPLAY_MODE_XXX
 	 *
+	 * @param \DBObject $oObject
 	 * @param string $sMode Mode the object is being displayed (view, edit, create, ...), default is view.
+	 *
+	 * since 3.1.1 params for navigation in basket
 	 * @param string $sBasketFilter filter to find list of objects in basket
 	 * @param array $aBasketList list of id of objects in basket
 	 * @param string $sBackUrl url to go back to list of ojects in basket
 	 * @param string $sPostedFieldsForBackUrl fields to post for come back to main page
 	 *
-	 * @param \DBObject $oObject
 	 *
 	 * @return \Combodo\iTop\Application\UI\Base\Layout\PageContent\PageContentWithSideContent
 	 * @throws \CoreException
@@ -68,7 +70,7 @@ class PageContentFactory


 		if ($sBasketFilter != null) {
-			$oNavigationBlock = NavigationUIBlockFactory::MakeStandard($oObject, $sBasketFilter, $aBasketList, $sBackUrl, $sPostedFieldsForBackUrl);
+			$oNavigationBlock = BasketUIBlockFactory::MakeStandard($oObject, $sBasketFilter, $aBasketList, $sBackUrl, $sPostedFieldsForBackUrl);
 			if ($oNavigationBlock != null) {
 				$oLayout->AddSubBlock($oNavigationBlock);
 			}
--- a/sources/Controller/Base/Layout/ObjectController.php
+++ b/sources/Controller/Base/Layout/ObjectController.php
@@ -294,9 +294,21 @@ JS;
 			FormHelper::DisableAttributeBlobInputs($sClass, $aFormExtraParams);

 		} else {
+
+			//N°1386 - Advanced Search: Navigation in list - Browse this list
+			$sBasketBackUrl = utils::ReadPostedParam('basket_back_url', '', false, 'raw');
+			$sBasketClass = utils::ReadPostedParam('basket_class', null, false, 'raw');
+			$sBasketFilter = utils::ReadPostedParam('basket_filter', null, false, 'raw');
+			$sBasketList = utils::ReadPostedParam('basket_list_navigation', null, false, 'string');
+			$sBasketPostedFieldsForBackUrl = utils::ReadPostedParam('basket_back_posted_fields', "", false, 'raw');
+			$aBasketList = [];
+			if ($sBasketList != null) {
+				$aBasketList = json_decode($sBasketList);
+			}
+
 			$oPage = new iTopWebPage('', $bPrintable);
 			$oPage->DisableBreadCrumb();
-			$oPage->SetContentLayout(PageContentFactory::MakeForObjectDetails($oObj, cmdbAbstractObject::ENUM_DISPLAY_MODE_EDIT));
+			$oPage->SetContentLayout(PageContentFactory::MakeForObjectDetails($oObj, cmdbAbstractObject::ENUM_DISPLAY_MODE_EDIT, $sBasketFilter, $sBasketClass, $aBasketList, $sBasketBackUrl, $sBasketPostedFieldsForBackUrl));
 		}
 		// - JS files
 		foreach (static::EnumRequiredForModificationJsFilesRelPaths() as $sJsFileRelPath) {