composer/iTop
6
0
Fork 0
mirror of https://github.com/Combodo/iTop.git synced 2026-05-18 23:08:46 +02:00
Code Issues Packages Projects Releases Wiki Activity

PHPDoc & code cleanup

Browse Source
This commit is contained in:
Molkobain
2020-08-04 15:23:18 +02:00
parent 46f8fadac0
commit 1604e233f9
12 changed files with 22 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
application/itopwebpage.class.inc.php
View File

@@ -52,6 +52,7 @@ class iTopWebPage extends NiceWebPage implements iTabbedPage
protected $sBreadCrumbEntryUrl;
protected $sBreadCrumbEntryIcon;
protected $sBreadCrumbEntryIconType;
/** @var \ContextTag $oCtx */
protected $oCtx;
/**
@@ -1063,7 +1064,7 @@ EOF
}
// Components
// Note: For now all components are either included in the layouts above or put in page through the add_ui_block() API, so there is no need to do anything more.
// Note: For now all components are either included in the layouts above or put in page through the AddUiBlock() API, so there is no need to do anything more.
// Variable content of the page
$aData['aPage'] = array_merge(

4
application/menunode.class.inc.php
View File

@@ -291,7 +291,7 @@ class ApplicationMenu
* @param array $aExtraParams
* @throws DictExceptionMissingString
*
* @deprecated Will be removed in 2.8.0
* @deprecated Will be removed in 2.8.0, use static::GetMenuGroups() instead
*/
public static function DisplayMenu($oPage, $aExtraParams)
{
@@ -367,7 +367,7 @@ EOF
* @return bool True if the currently selected menu is one of the submenus
* @throws DictExceptionMissingString
* @throws \Exception
* @deprecated Will be removed in 2.8.0
* @deprecated Will be removed in 2.8.0, use static::GetSubMenuNodes() instead
*/
protected static function DisplaySubMenu($oPage, $aMenus, $aExtraParams, $iActiveMenu = -1)
{

2
sources/application/UI/Component/Breadcrumbs/Breadcrumbs.php
View File

@@ -34,8 +34,8 @@ use utils;
*/
class Breadcrumbs extends UIBlock
{
// Overloaded constants
const BLOCK_CODE = 'ibo-breadcrumbs';
const HTML_TEMPLATE_REL_PATH = 'components/breadcrumbs/layout';
const JS_TEMPLATE_REL_PATH = 'components/breadcrumbs/layout';
const JS_FILES_REL_PATH = [

2
sources/application/UI/Component/GlobalSearch/GlobalSearch.php
View File

@@ -33,8 +33,8 @@ use utils;
*/
class GlobalSearch extends UIBlock
{
// Overloaded constants
const BLOCK_CODE = 'ibo-global-search';
const HTML_TEMPLATE_REL_PATH = 'components/global-search/layout';
const JS_TEMPLATE_REL_PATH = 'components/global-search/layout';
const JS_FILES_REL_PATH = [

2
sources/application/UI/Component/PopoverMenu/PopoverMenu.php
View File

@@ -34,8 +34,8 @@ use Exception;
*/
class PopoverMenu extends UIBlock
{
// Overloaded constants
const BLOCK_CODE = 'ibo-popover-menu';
const HTML_TEMPLATE_REL_PATH = 'components/popover-menu/layout';
//const JS_TEMPLATE_REl_PATH = 'components/popover-menu/layout';
const JS_FILES_REL_PATH = [

1
sources/application/UI/Component/PopoverMenu/PopoverMenuItem/JsPopoverMenuItem.php
View File

@@ -32,6 +32,7 @@ use JSPopupMenuItem;
*/
class JsPopoverMenuItem extends PopoverMenuItem
{
// Overloaded constants
const HTML_TEMPLATE_REL_PATH = 'components/popover-menu/item/mode_js';
public function GetJsCode()

2
sources/application/UI/Component/PopoverMenu/PopoverMenuItem/PopoverMenuItem.php
View File

@@ -33,8 +33,8 @@ use Combodo\iTop\Application\UI\UIBlock;
*/
class PopoverMenuItem extends UIBlock
{
// Overloaded constants
const BLOCK_CODE = 'ibo-popover-menu--item';
const HTML_TEMPLATE_REL_PATH = '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 */

1
sources/application/UI/Component/PopoverMenu/PopoverMenuItem/UrlPopoverMenuItem.php
View File

@@ -30,6 +30,7 @@ namespace Combodo\iTop\Application\UI\Component\PopoverMenu\PopoverMenuItem;
*/
class UrlPopoverMenuItem extends PopoverMenuItem
{
// Overloaded constants
const HTML_TEMPLATE_REL_PATH = 'components/popover-menu/item/mode_url';
/** @ignore */

3
sources/application/UI/Component/QuickCreate/QuickCreate.php
View File

@@ -33,8 +33,8 @@ use UserRights;
*/
class QuickCreate extends UIBlock
{
// Overloaded constants
const BLOCK_CODE = 'ibo-quick-create';
const HTML_TEMPLATE_REL_PATH = 'components/quick-create/layout';
const JS_TEMPLATE_REL_PATH = 'components/quick-create/layout';
const JS_FILES_REL_PATH = [
@@ -45,6 +45,7 @@ class QuickCreate extends UIBlock
'css/selectize.default.css',
];
// Specific constants
const DEFAULT_ENDPOINT_REL_URL = 'pages/UI.php';
/** @var array $aAvailableClasses */

2
sources/application/UI/Layout/NavigationMenu/NavigationMenu.php
View File

@@ -42,8 +42,8 @@ use utils;
*/
class NavigationMenu extends UIBlock
{
// Overloaded constants
const BLOCK_CODE = 'ibo-navigation-menu';
const HTML_TEMPLATE_REL_PATH = 'layouts/navigation-menu/layout';
const JS_TEMPLATE_REL_PATH = 'layouts/navigation-menu/layout';
const JS_FILES_REL_PATH = [

2
sources/application/UI/Layout/TopBar/TopBar.php
View File

@@ -35,8 +35,8 @@ use Combodo\iTop\Application\UI\UIBlock;
*/
class TopBar extends UIBlock
{
// Overloaded constants
const BLOCK_CODE = 'ibo-top-bar';
const HTML_TEMPLATE_REL_PATH = 'layouts/top-bar/layout';
/** @var QuickCreate|null $oQuickCreate */

18
templates/pages/backoffice/layout.html.twig
View File

@@ -40,16 +40,14 @@
{{ render_block(aLayouts.oTopBar) }}
</div>
{{ include('pages/backoffice/extension-blocks/header.html.twig') }}
<main id="ibo-page-content">
{{ aPage.sSanitizedContent|raw }}
{# TODO: Remove this when modal development is done #}
<div id="at_the_end">{{ aPage.sDeferredContent|raw }}</div>
<div style="display:none" title="ex2" id="ex2">Please wait...</div>
<div style="display:none" title="dialog" id="ModalDlg"></div>
<div style="display:none" id="ajax_content"></div>
</main>
{{ render_block(aLayouts.oPageContent) }}
{{ include('pages/backoffice/extension-blocks/footer.html.twig') }}
{# TODO: Remove this when modal development is done #}
<div id="at_the_end">{{ aPage.sDeferredContent|raw }}</div>
<div style="display:none" title="ex2" id="ex2">Please wait...</div>
<div style="display:none" title="dialog" id="ModalDlg"></div>
<div style="display:none" id="ajax_content"></div>
</div>
{% block iboPageJsFiles %}
@@ -80,7 +78,7 @@
{% block iboPageJsInlineLive %}
{% for sJsInline in aPage.aJsInlineLive %}
{# We put each scripts in a dedicated script tag to prevent massive failure if 1 script is broken (eg. missing semi-colon or non closed comment) #}
{# We put each scripts in a dedicated script tag to prevent massive failure if 1 script is broken (eg. missing semi-colon or non closed multi-line comment) #}
<script type="text/javascript">
{{ sJsInline|raw }}
</script>