composer/iTop
6
0
Fork 0
mirror of https://github.com/Combodo/iTop.git synced 2026-04-27 20:48:46 +02:00
Code Issues Packages Projects Releases Wiki Activity

N°4621 Fix naming inconsistencies in sources/*

Browse Source
This commit is contained in:
Pierre Goiffon
2021-12-31 15:21:08 +01:00
parent 16142bd979
commit 5f575d524a
192 changed files with 384 additions and 380 deletions
Download Patch File Download Diff File Expand all files Collapse all files

66
sources/Application/UI/Base/Component/PopoverMenu/PopoverMenuItem/JsPopoverMenuItem.php Normal file
View File

@@ -0,0 +1,66 @@
<?php
/**
* Copyright (C) 2013-2021 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\PopoverMenu\PopoverMenuItem;
use JSPopupMenuItem;
/**
* Class JsPopoverMenuItem
*
* @author Guillaume Lajarige <guillaume.lajarige@combodo.com>
* @package Combodo\iTop\Application\UI\Base\Component\PopoverMenu\PopoverMenuItem
* @property \JSPopupMenuItem $oPopupMenuItem
* @since 3.0.0
*/
class JsPopoverMenuItem extends PopoverMenuItem
{
// Overloaded constants
public const DEFAULT_HTML_TEMPLATE_REL_PATH = 'base/components/popover-menu/item/mode_js';
/**
* @see \JSPopupMenuItem::GetJsCode()
* @return string
*/
public function GetJsCode()
{
return $this->oPopupMenuItem->GetJSCode();
}
/**
* @see \JSPopupMenuItem::GetUrl()
* @return string
*/
public function GetUrl()
{
return $this->oPopupMenuItem->GetUrl();
}
/**
* @inheritDoc
* @throws \Exception
*/
public function GetJsFilesUrlRecursively(bool $bAbsoluteUrl = false): array
{
$aJsFiles = array_merge(parent::GetJsFilesUrlRecursively($bAbsoluteUrl), $this->oPopupMenuItem->GetLinkedScripts());
return $aJsFiles;
}
}

164
sources/Application/UI/Base/Component/PopoverMenu/PopoverMenuItem/PopoverMenuItem.php Normal file
View File

@@ -0,0 +1,164 @@
<?php
/**
* Copyright (C) 2013-2021 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\PopoverMenu\PopoverMenuItem;
use ApplicationPopupMenuItem;
use Combodo\iTop\Application\UI\Base\UIBlock;
use utils;
/**
* Class PopoverMenuItem
*
* @author Guillaume Lajarige <guillaume.lajarige@combodo.com>
* @package Combodo\iTop\Application\UI\Base\Component\PopoverMenu\PopoverMenuItem
* @internal
* @since 3.0.0
*/
class PopoverMenuItem extends UIBlock
{
// Overloaded constants
public const BLOCK_CODE = 'ibo-popover-menu--item';
public const DEFAULT_HTML_TEMPLATE_REL_PATH = 'base/components/popover-menu/item/layout';
/** @var \ApplicationPopupMenuItem $oPopupMenuItem We decorate the class with the original \ApplicationPopupMenuItem as it is used among the application (backoffice, portal, extensions) and cannot be refactored without BC breaks */
protected $oPopupMenuItem;
/**
* PopoverMenuItem constructor.
*
* @param \ApplicationPopupMenuItem $oPopupMenuItem
*/
public function __construct(ApplicationPopupMenuItem $oPopupMenuItem)
{
$this->oPopupMenuItem = $oPopupMenuItem;
parent::__construct(/* ID will be generated from $oPopupMenuItem */);
}
/**
* @inheritDoc
*/
protected function GenerateId(): string
{
return parent::GenerateId().'--'.utils::GetSafeId($this->oPopupMenuItem->GetUID());
}
/**
* @see \ApplicationPopupMenuItem::GetLabel()
* @return string
*/
public function GetLabel()
{
return $this->oPopupMenuItem->GetLabel();
}
/**
* @param array $aCssClasses
*
* @return $this
* @uses oPopupMenuItem
* @uses \ApplicationPopupMenuItem::SetCssClasses()
*/
public function SetMenuItemCssClasses(array $aCssClasses)
{
$this->oPopupMenuItem->SetCssClasses($aCssClasses);
return $this;
}
/**
* @param string $sCssClass
*
* @return $this
* @uses oPopupMenuItem
* @uses \ApplicationPopupMenuItem::AddCssClass()
*/
public function AddMenuItemCssClass(string $sCssClass)
{
$this->oPopupMenuItem->AddCssClass($sCssClass);
return $this;
}
/**
* @return array
* @uses oPopupMenuItem
* @uses \ApplicationPopupMenuItem::GetCssClasses()
*/
public function GetMenuItemCssClasses(): array
{
return $this->oPopupMenuItem->GetCssClasses();
}
/**
* @return string
* @uses oPopupMenuItem
* @uses \ApplicationPopupMenuItem::GetIconClass()
*/
public function GetIconClass()
{
return $this->oPopupMenuItem->GetIconClass();
}
/**
* @return $this
* @uses oPopupMenuItem
* @uses \ApplicationPopupMenuItem::SetIconClass()
*/
public function SetIconClass($sIconClas)
{
$this->oPopupMenuItem->SetIconClass($sIconClas);
return $this;
}
/**
* @return string
* @uses oPopupMenuItem
* @uses \ApplicationPopupMenuItem::GetTooltip()
*/
public function GetTooltip()
{
return $this->oPopupMenuItem->GetTooltip();
}
/**
* @return $this
* @uses oPopupMenuItem
* @uses \ApplicationPopupMenuItem::SetTooltip()
*/
public function SetTooltip($sTooltip)
{
$this->oPopupMenuItem->SetTooltip($sTooltip);
return $this;
}
/**
* @return string
* @uses oPopupMenuItem
* @uses \ApplicationPopupMenuItem::GetUID()
*/
public function GetUID()
{
return $this->oPopupMenuItem->GetUID();
}
}

143
sources/Application/UI/Base/Component/PopoverMenu/PopoverMenuItem/PopoverMenuItemFactory.php Normal file
View File

@@ -0,0 +1,143 @@
<?php
/**
* Copyright (C) 2013-2021 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\PopoverMenu\PopoverMenuItem;
use ApplicationPopupMenuItem;
use JSPopupMenuItem;
use SeparatorPopupMenuItem;
use URLPopupMenuItem;
/**
* Class PopupMenuItemFactory
*
* @author Guillaume Lajarige <guillaume.lajarige@combodo.com>
* @package Combodo\iTop\Application\UI\Base\Component\PopoverMenu\PopoverMenuItem
* @internal
* @since 3.0.0
*/
class PopoverMenuItemFactory
{
/**
* Make a Pop*over*MenuItem (3.0 UI) from a Pop*up*MenuItem (Extensions API)
*
* @param \ApplicationPopupMenuItem $oItem
*
* @return \Combodo\iTop\Application\UI\Base\Component\PopoverMenu\PopoverMenuItem\PopoverMenuItem
*/
public static function MakeFromApplicationPopupMenuItem(ApplicationPopupMenuItem $oItem)
{
$sNamespace = 'Combodo\\iTop\\Application\\UI\\Base\\Component\\PopoverMenu\\PopoverMenuItem\\';
switch(true)
{
case $oItem instanceof URLPopupMenuItem:
$sTargetClass = 'UrlPopoverMenuItem';
break;
case $oItem instanceof JSPopupMenuItem:
$sTargetClass = 'JsPopoverMenuItem';
break;
case $oItem instanceof SeparatorPopupMenuItem:
$sTargetClass = 'SeparatorPopoverMenuItem';
break;
default:
$sTargetClass = 'PopoverMenuItem';
break;
}
$sTargetClass = $sNamespace.$sTargetClass;
return new $sTargetClass($oItem);
}
/**
* Make a PopoverMenuItem from an action data as return by {@see ApplicationPopupMenuItem::GetMenuItem()}
*
* @param string $sActionId
* @param array $aActionData
*
* @return \Combodo\iTop\Application\UI\Base\Component\PopoverMenu\PopoverMenuItem\PopoverMenuItem
* @throws \Exception
*/
public static function MakeFromApplicationPopupMenuItemData(string $sActionId, array $aActionData)
{
$aRefactoredItem = [
'uid' => $sActionId,
'css_classes' => isset($aActionData['css_classes']) ? $aActionData['css_classes'] : [],
'on_click' => isset($aActionData['onclick']) ? $aActionData['onclick'] : '',
'target' => isset($aActionData['target']) ? $aActionData['target'] : '',
'url' => $aActionData['url'],
'label' => $aActionData['label'],
'icon_class' => isset($aActionData['icon_class']) ? $aActionData['icon_class'] : '',
'tooltip' => isset($aActionData['tooltip']) ? $aActionData['tooltip'] : '',
];
// Avoid meaningless tooltips which are identical to the label
if ($aRefactoredItem['tooltip'] == $aRefactoredItem['label']) {
$aRefactoredItem['tooltip'] = '';
}
if (!empty($aRefactoredItem['on_click'])) {
// JS
$oPopoverMenuItem = PopoverMenuItemFactory::MakeFromApplicationPopupMenuItem(
new JSPopupMenuItem(
$aRefactoredItem['uid'],
$aRefactoredItem['label'],
$aRefactoredItem['on_click'])
);
} elseif (!empty($aRefactoredItem['url'])) {
// URL
$oPopoverMenuItem = PopoverMenuItemFactory::MakeFromApplicationPopupMenuItem(
new URLPopupMenuItem(
$aRefactoredItem['uid'],
$aRefactoredItem['label'],
$aRefactoredItem['url'],
$aRefactoredItem['target'])
);
} else {
// Separator
$oPopoverMenuItem = PopoverMenuItemFactory::MakeSeparator();
}
if (!empty($aRefactoredItem['css_classes'])) {
$oPopoverMenuItem->SetCssClasses($aRefactoredItem['css_classes']);
}
if (!empty($aRefactoredItem['icon_class'])) {
$oPopoverMenuItem->SetIconClass($aRefactoredItem['icon_class']);
}
if (!empty($aRefactoredItem['tooltip'])) {
$oPopoverMenuItem->SetTooltip($aRefactoredItem['tooltip']);
}
return $oPopoverMenuItem;
}
/**
* Make a separator item for the popover menu
*
* Note: You don't need to add separators manually if you put the items in dedicated sections of the menu
*
* @return \Combodo\iTop\Application\UI\Base\Component\PopoverMenu\PopoverMenuItem\SeparatorPopoverMenuItem
* @since 3.0.0
*/
public static function MakeSeparator()
{
return new SeparatorPopoverMenuItem(new SeparatorPopupMenuItem());
}
}

36
sources/Application/UI/Base/Component/PopoverMenu/PopoverMenuItem/SeparatorPopoverMenuItem.php Normal file
View File

@@ -0,0 +1,36 @@
<?php
/**
* Copyright (C) 2013-2021 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\PopoverMenu\PopoverMenuItem;
/**
* Class SeparatorPopoverMenuItem
*
* @author Stephen Abello <stephen.abello@combodo.com>
* @package Combodo\iTop\Application\UI\Base\Component\PopoverMenu\PopoverMenuItem
* @property \SeparatorPopupMenuItem $oPopupMenuItem
* @since 3.0.0
*/
class SeparatorPopoverMenuItem extends PopoverMenuItem
{
// Overloaded constants
public const BLOCK_CODE = 'ibo-popover-menu--item-separator';
public const DEFAULT_HTML_TEMPLATE_REL_PATH = 'base/components/popover-menu/item/mode_separator';
}

53
sources/Application/UI/Base/Component/PopoverMenu/PopoverMenuItem/UrlPopoverMenuItem.php Normal file
View File

@@ -0,0 +1,53 @@
<?php
/**
* Copyright (C) 2013-2021 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\PopoverMenu\PopoverMenuItem;
/**
* Class UrlPopoverMenuItem
*
* @author Guillaume Lajarige <guillaume.lajarige@combodo.com>
* @package Combodo\iTop\Application\UI\Base\Component\PopoverMenu\PopoverMenuItem
* @property \URLPopupMenuItem $oPopupMenuItem
* @since 3.0.0
*/
class UrlPopoverMenuItem extends PopoverMenuItem
{
// Overloaded constants
public const DEFAULT_HTML_TEMPLATE_REL_PATH = 'base/components/popover-menu/item/mode_url';
/**
* @see \URLPopupMenuItem::GetUrl()
* @return string
*/
public function GetUrl()
{
return $this->oPopupMenuItem->GetUrl();
}
/**
* @see \URLPopupMenuItem::GetTarget()
* @return string
*/
public function GetTarget()
{
return $this->oPopupMenuItem->GetTarget();
}
}