composer/iTop
6
0
Fork 0
mirror of https://github.com/Combodo/iTop.git synced 2026-02-13 07:24:13 +01:00
Code Issues Packages Projects Releases Wiki Activity

N°2847 - Rework iTopWebPage layout (WIP Part IV)

Browse Source 
- iTopWebPage: Clean up some commented sections
- iTopWebPage: Marked some new methods as @internal
- iTopWebPage: Restore page content to allow // developments
- Quick create: Add quick object creation box to the top bar
- Global search: Improve cinematic with other widgets
- Components / Layouts: Move JS parts to iTopWebPage, will be put in dedicated PHP helpers later
This commit is contained in:
Molkobain
2020-07-27 15:07:40 +02:00
parent d56f6e684a
commit d4694b271f
18 changed files with 726 additions and 76 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -22,6 +22,7 @@ require_once(APPROOT."/application/applicationcontext.class.inc.php");
require_once(APPROOT."/application/user.preferences.class.inc.php");
use Combodo\iTop\Application\Branding;
use Combodo\iTop\Application\QuickCreate\QuickCreateHelper;
use Combodo\iTop\Application\GlobalSearch\GlobalSearchHelper;
use Combodo\iTop\Application\TwigBase\Twig\TwigHelper;
@@ -175,24 +176,6 @@ class iTopWebPage extends NiceWebPage implements iTabbedPage
*/
protected function PrepareLayout()
{
// TODO: Move this to the menu renderer
// if (MetaModel::GetConfig()->Get('demo_mode'))
// {
// // No pin button
// $sConfigureWestPane = '';
// }
// else
// {
// $sConfigureWestPane =
// <<<EOF
// if (typeof myLayout !== "undefined")
// {
// myLayout.addPinBtn( "#tPinMenu", "west" );
// }
//EOF;
// }
// $sInitClosed = $this->IsMenuPaneVisible() ? '' : 'initClosed: true,';
$sJSDisconnectedMessage = json_encode(Dict::S('UI:DisconnectedDlgMessage'));
$sJSTitle = json_encode(Dict::S('UI:DisconnectedDlgTitle'));
$sJSLoginAgain = json_encode(Dict::S('UI:LoginAgain'));
@@ -305,6 +288,8 @@ class iTopWebPage extends NiceWebPage implements iTabbedPage
JS
);
// TODO: This is for tag sets, refactor the attribute markup so it contains the necessary
// TODO: data-tooltip-* attributes to activate the tooltips automatically (see /js/pages/backoffice.js)
// Attribute set tooltip on items
$this->add_ready_script(
<<<JS
@@ -336,6 +321,8 @@ JS
});
JS
);
// TODO: Change CSS class and extract this in backoffice.js
// Make image attributes zoomable
$this->add_ready_script(
<<<JS
@@ -345,7 +332,8 @@ JS
.magnificPopup({type: 'image', closeOnContentClick: true });
JS
);
// TODO: Change CSS class and extract this in backoffice.js
// Highlight code content created with CKEditor
$this->add_ready_script(
<<<JS
@@ -852,12 +840,13 @@ JS
* @throws \Exception
* @throws \DictExceptionMissingString
* @since 2.8.0
* @internal
*/
protected function GetNavigationMenuData()
{
$oAppContext = new ApplicationContext();
return [
$aData = [
'sId' => 'ibo-navigation-menu',
'sAppRevisionNumber' => $this->GetApplicationRevisionNumber(),
'sAppSquareIconUrl' => Branding::GetSquareMainLogoAbsoluteUrl(),
@@ -866,6 +855,16 @@ JS
'aMenuGroups' => ApplicationMenu::GetMenuGroups($oAppContext->GetAsHash()),
'bIsExpanded' => $this->IsMenuPaneVisible(),
];
// TODO: Move this in the PHP component when designed
$this->add_linked_script('../js/layouts/navigation-menu.js');
// ... and this in a dedicated JS TWIG
$this->add_ready_script(<<<JS
$('#{$aData['sId']}').navigation_menu();
JS
);
return $aData;
}
/**
@@ -874,13 +873,16 @@ JS
* @return array
* @throws \ConfigException
* @throws \CoreException
* @throws \Exception
* @since 2.8.0
* @internal
*/
protected function GetTopBarData()
{
$aData = [
'sId' => 'ibo-top-bar',
'aComponents' => [
'aQuickCreate' => $this->GetQuickCreateData(),
'aGlobalSearch' => $this->GetGlobalSearchData(),
'aBreadCrumbs' => $this->GetBreadCrumbsData(),
],
@@ -889,12 +891,43 @@ JS
return $aData;
}
/**
* Return the quick create data (last classes)
*
* @return array
* @throws \Exception
* @since 2.8.0
* @internal
*/
protected function GetQuickCreateData()
{
$aData = [
'sId' => 'ibo-quick-create',
'sEndpoint' => utils::GetAbsoluteUrlAppRoot().'pages/UI.php',
'aAvailableClasses' => UserRights::GetAllowedClasses(UR_ACTION_CREATE, array('bizmodel'), true),
'aLastClasses' => QuickCreateHelper::GetLastClasses(),
];
// TODO: Move this in the PHP component when designed
$this->add_linked_stylesheet(utils::GetAbsoluteUrlAppRoot().'css/selectize.default.css');
$this->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/selectize.min.js');
$this->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/components/quick-create.js');
// ... and this in a dedicated JS TWIG
$this->add_ready_script(<<<JS
$('#{$aData['sId']}').quick_create();
JS
);
return $aData;
}
/**
* Return the global search data (last queries)
*
* @return array
* @throws \Exception
* @since 2.8.0
* @internal
*/
protected function GetGlobalSearchData()
{
@@ -904,6 +937,14 @@ JS
'aLastQueries' => GlobalSearchHelper::GetLastQueries(),
];
// TODO: Move this in the PHP component when designed
$this->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/components/global-search.js');
// ... and this in a dedicated JS TWIG
$this->add_ready_script(<<<JS
$('#{$aData['sId']}').global_search();
JS
);
return $aData;
}
@@ -914,11 +955,13 @@ JS
* @throws \ConfigException
* @throws \CoreException
* @since 2.8.0
* @internal
*/
protected function GetBreadCrumbsData()
{
$aData = [
'sId' => 'ibo-breadcrumbs',
'aWidgetOptions' => [],
];
$iBreadCrumbMaxCount = utils::GetConfig()->Get('breadcrumb.max_count');
@@ -961,6 +1004,16 @@ JS
];
}
// TODO: Move this in the PHP component when designed
$this->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/components/breadcrumbs.js');
// ... and this in a dedicated JS TWIG
$sWidgetOptionsAsJson = json_encode($aData['aWidgetOptions']);
$this->add_ready_script(<<<JS
// Note: When refactor in the JS TWIG, use {{ aBreadCrumbs.aWidgetOptions|json_encode|raw }}
$('#{$aData['sId']}').breadcrumbs($sWidgetOptionsAsJson);
JS
);
return $aData;
}
@@ -1029,6 +1082,7 @@ EOF
* Render the banner HTML which can come from both iTop itself and from extensions
*
* @see \iPageUIExtension::GetBannerHtml()
* @internal
*
* @return string
* @since 2.8.0
@@ -1050,6 +1104,7 @@ EOF
* Render the header HTML which can come from both iTop itself and from extensions
*
* @see \iPageUIExtension::GetNorthPaneHtml()
* @internal
*
* @return string
* @since 2.8.0
@@ -1077,6 +1132,7 @@ EOF
* Render the footer HTML which can come from both iTop itself and from extensions
*
* @see \iPageUIExtension::GetSouthPaneHtml()
* @internal
*
* @return string
* @since 2.8.0
@@ -1110,6 +1166,10 @@ EOF
// - Generate necessary dict. files
$this->output_dict_entries();
// TODO: Check if we can keep this as is
// Render the tabs in the page (if any)
$this->s_content = $this->m_oTabs->RenderIntoContent($this->s_content, $this);
// Base structure of data to pass to the TWIG template
$aData['aPage'] = [
'sAbsoluteUrlAppRoot' => $sAbsoluteUrlAppRoot,
@@ -1119,14 +1179,6 @@ EOF
'sCharset' => static::PAGES_CHARSET,
'sLang' => $sMetadataLanguage,
],
'aCssFiles' => $this->a_linked_stylesheets,
'aCssInline' => $this->a_styles,
'aJsFiles' => $this->a_linked_scripts,
'aJsInlineOnInit' => $this->m_aInitScript,
'aJsInlineOnDomReady' => $this->m_aReadyScripts,
'aJsInlineLive' => $this->a_scripts,
// TODO: TEMP, used while developping, remove it.
'aSanitizedContent' => self::FilterXSS($this->s_content),
];
// Base tag
@@ -1149,6 +1201,21 @@ EOF
// - Top bar
$aData['aLayouts']['aTopBar'] = $this->GetTopBarData();
// Variable content of the page
$aData['aPage'] = array_merge(
$aData['aPage'],
[
'aCssFiles' => $this->a_linked_stylesheets,
'aCssInline' => $this->a_styles,
'aJsFiles' => $this->a_linked_scripts,
'aJsInlineOnInit' => $this->m_aInitScript,
'aJsInlineOnDomReady' => $this->m_aReadyScripts,
'aJsInlineLive' => $this->a_scripts,
// TODO: TEMP, used while developping, remove it.
'aSanitizedContent' => self::FilterXSS($this->s_content),
]
);
$oTwigEnv = TwigHelper::GetTwigEnvironment(APPROOT.'templates/');
$sTemplateRelPath = 'pages/backoffice/layout';