Dev: Complete initial porting of Vector to Mustache

Bug: T240062
Change-Id: I18cb1fda6850646a38314a7d2dd356103f04ec28
This commit is contained in:
jdlrobson 2020-01-14 10:47:30 -08:00 committed by Sam Smith
parent 052b26f684
commit 0cdf0c238a
3 changed files with 80 additions and 45 deletions

View File

@ -126,35 +126,20 @@ class VectorTemplate extends BaseTemplate {
'html-hook-vector-before-footer' => $htmlHookVectorBeforeFooter, 'html-hook-vector-before-footer' => $htmlHookVectorBeforeFooter,
'array-footer-rows' => $this->getTemplateFooterRows(), 'array-footer-rows' => $this->getTemplateFooterRows(),
] ), ] ),
'html-navigation' => $this->templateParser->processTemplate( 'Navigation', [
'html-navigation-heading' => $this->getMsg( 'navigation-heading' ),
'html-personal-menu' => $this->renderNavigation( [ 'PERSONAL' ] ),
'html-navigation-left-tabs' => $this->renderNavigation( [ 'NAMESPACES', 'VARIANTS' ] ),
'html-navigation-right-tabs' => $this->renderNavigation( [ 'VIEWS', 'ACTIONS', 'SEARCH' ] ),
'html-logo' => '<div id="p-logo" role="banner"><a class="mw-wiki-logo" href="' .
htmlspecialchars( $this->data['nav_urls']['mainpage']['href'] ) .
'"' .
Xml::expandAttributes( Linker::tooltipAndAccesskeyAttribs( 'p-logo' ) ) .
'></a></div>',
'html-portals' => $this->renderPortals( $this->data['sidebar'] ),
] ),
]; ];
// TODO: Convert the rest to Mustache
ob_start();
?>
<div id="mw-navigation">
<h2><?php $this->msg( 'navigation-heading' ) ?></h2>
<div id="mw-head">
<?php $this->renderNavigation( [ 'PERSONAL' ] ); ?>
<div id="left-navigation">
<?php $this->renderNavigation( [ 'NAMESPACES', 'VARIANTS' ] ); ?>
</div>
<div id="right-navigation">
<?php $this->renderNavigation( [ 'VIEWS', 'ACTIONS', 'SEARCH' ] ); ?>
</div>
</div>
<div id="mw-panel">
<div id="p-logo" role="banner"><a class="mw-wiki-logo" href="<?php
echo htmlspecialchars( $this->data['nav_urls']['mainpage']['href'] )
?>"<?php
echo Xml::expandAttributes( Linker::tooltipAndAccesskeyAttribs( 'p-logo' ) )
?>></a></div>
<?php $this->renderPortals( $this->data['sidebar'] ); ?>
</div>
</div>
<?php
$params['html-unported'] = ob_get_contents();
ob_end_clean();
// Prepare and output the HTML response // Prepare and output the HTML response
echo $this->templateParser->processTemplate( 'index', $params ); echo $this->templateParser->processTemplate( 'index', $params );
} }
@ -212,8 +197,10 @@ class VectorTemplate extends BaseTemplate {
* Render a series of portals * Render a series of portals
* *
* @param array $portals * @param array $portals
* @return string
*/ */
protected function renderPortals( array $portals ) { protected function renderPortals( array $portals ) {
$html = '';
// Force the rendering of the following portals // Force the rendering of the following portals
if ( !isset( $portals['TOOLBOX'] ) ) { if ( !isset( $portals['TOOLBOX'] ) ) {
$portals['TOOLBOX'] = true; $portals['TOOLBOX'] = true;
@ -234,19 +221,24 @@ class VectorTemplate extends BaseTemplate {
case 'SEARCH': case 'SEARCH':
break; break;
case 'TOOLBOX': case 'TOOLBOX':
$this->renderPortal( 'tb', $this->getToolbox(), 'toolbox', 'SkinTemplateToolboxEnd' ); $html .= $this->renderPortal( 'tb', $this->getToolbox(), 'toolbox', 'SkinTemplateToolboxEnd' );
ob_start();
Hooks::run( 'VectorAfterToolbox', [], '1.35' ); Hooks::run( 'VectorAfterToolbox', [], '1.35' );
$html .= ob_get_clean();
break; break;
case 'LANGUAGES': case 'LANGUAGES':
if ( $this->data['language_urls'] !== false ) { if ( $this->data['language_urls'] !== false ) {
$this->renderPortal( 'lang', $this->data['language_urls'], 'otherlanguages' ); $html .= $this->renderPortal(
'lang', $this->data['language_urls'], 'otherlanguages'
);
} }
break; break;
default: default:
$this->renderPortal( $name, $content ); $html .= $this->renderPortal( $name, $content );
break; break;
} }
} }
return $html;
} }
/** /**
@ -254,6 +246,7 @@ class VectorTemplate extends BaseTemplate {
* @param array|string $content * @param array|string $content
* @param null|string $msg * @param null|string $msg
* @param null|string|array $hook * @param null|string|array $hook
* @return string
*/ */
protected function renderPortal( $name, $content, $msg = null, $hook = null ) { protected function renderPortal( $name, $content, $msg = null, $hook = null ) {
if ( $msg === null ) { if ( $msg === null ) {
@ -291,7 +284,7 @@ class VectorTemplate extends BaseTemplate {
$props['html-portal-content'] = $content; $props['html-portal-content'] = $content;
} }
echo $this->templateParser->processTemplate( 'Portal', $props ); return $this->templateParser->processTemplate( 'Portal', $props );
} }
/** /**
@ -299,31 +292,34 @@ class VectorTemplate extends BaseTemplate {
* when UI is in RTL mode * when UI is in RTL mode
* *
* @param array $elements * @param array $elements
* @return string
*/ */
protected function renderNavigation( array $elements ) { protected function renderNavigation( array $elements ) {
$html = '';
// Render elements // Render elements
foreach ( $elements as $name => $element ) { foreach ( $elements as $name => $element ) {
switch ( $element ) { switch ( $element ) {
case 'NAMESPACES': case 'NAMESPACES':
$this->renderNamespacesComponent(); $html .= $this->renderNamespacesComponent();
break; break;
case 'VARIANTS': case 'VARIANTS':
$this->renderVariantsComponent(); $html .= $this->renderVariantsComponent();
break; break;
case 'VIEWS': case 'VIEWS':
$this->renderViewsComponent(); $html .= $this->renderViewsComponent();
break; break;
case 'ACTIONS': case 'ACTIONS':
$this->renderActionsComponent(); $html .= $this->renderActionsComponent();
break; break;
case 'PERSONAL': case 'PERSONAL':
$this->renderPersonalComponent(); $html .= $this->renderPersonalComponent();
break; break;
case 'SEARCH': case 'SEARCH':
$this->renderSearchComponent(); $html .= $this->renderSearchComponent();
break; break;
} }
} }
return $html;
} }
/** /**
@ -354,6 +350,9 @@ class VectorTemplate extends BaseTemplate {
return parent::makeListItem( $key, $item, $options ); return parent::makeListItem( $key, $item, $options );
} }
/**
* @return string
*/
private function renderNamespacesComponent() { private function renderNamespacesComponent() {
$props = [ $props = [
'tabs-id' => 'p-namespaces', 'tabs-id' => 'p-namespaces',
@ -368,9 +367,12 @@ class VectorTemplate extends BaseTemplate {
$props[ 'html-items' ] .= $this->makeListItem( $key, $item ); $props[ 'html-items' ] .= $this->makeListItem( $key, $item );
} }
echo $this->templateParser->processTemplate( 'VectorTabs', $props ); return $this->templateParser->processTemplate( 'VectorTabs', $props );
} }
/**
* @return string
*/
private function renderVariantsComponent() { private function renderVariantsComponent() {
$props = [ $props = [
'empty-portlet' => ( count( $this->data['variant_urls'] ) == 0 ) ? 'emptyPortlet' : '', 'empty-portlet' => ( count( $this->data['variant_urls'] ) == 0 ) ? 'emptyPortlet' : '',
@ -392,9 +394,12 @@ class VectorTemplate extends BaseTemplate {
$props['html-items'] .= $this->makeListItem( $key, $item ); $props['html-items'] .= $this->makeListItem( $key, $item );
} }
echo $this->templateParser->processTemplate( 'VectorMenu', $props ); return $this->templateParser->processTemplate( 'VectorMenu', $props );
} }
/**
* @return string
*/
private function renderViewsComponent() { private function renderViewsComponent() {
$props = [ $props = [
'tabs-id' => 'p-views', 'tabs-id' => 'p-views',
@ -411,9 +416,12 @@ class VectorTemplate extends BaseTemplate {
] ); ] );
} }
echo $this->templateParser->processTemplate( 'VectorTabs', $props ); return $this->templateParser->processTemplate( 'VectorTabs', $props );
} }
/**
* @return string
*/
private function renderActionsComponent() { private function renderActionsComponent() {
$props = [ $props = [
'empty-portlet' => ( count( $this->data['action_urls'] ) == 0 ) ? 'emptyPortlet' : '', 'empty-portlet' => ( count( $this->data['action_urls'] ) == 0 ) ? 'emptyPortlet' : '',
@ -428,9 +436,12 @@ class VectorTemplate extends BaseTemplate {
$props['html-items'] .= $this->makeListItem( $key, $item ); $props['html-items'] .= $this->makeListItem( $key, $item );
} }
echo $this->templateParser->processTemplate( 'VectorMenu', $props ); return $this->templateParser->processTemplate( 'VectorMenu', $props );
} }
/**
* @return string
*/
private function renderPersonalComponent() { private function renderPersonalComponent() {
$personalTools = $this->getPersonalTools(); $personalTools = $this->getPersonalTools();
$props = [ $props = [
@ -460,7 +471,7 @@ class VectorTemplate extends BaseTemplate {
$props['html-personal-tools'] .= $this->makeListItem( $key, $item ); $props['html-personal-tools'] .= $this->makeListItem( $key, $item );
} }
echo $this->templateParser->processTemplate( 'PersonalMenu', $props ); return $this->templateParser->processTemplate( 'PersonalMenu', $props );
} }
private function renderSearchComponent() { private function renderSearchComponent() {
@ -480,6 +491,6 @@ class VectorTemplate extends BaseTemplate {
), ),
'searchInputLabel' => $this->getMsg( 'search' ) 'searchInputLabel' => $this->getMsg( 'search' )
]; ];
echo $this->templateParser->processTemplate( 'SearchBox', $props ); return $this->templateParser->processTemplate( 'SearchBox', $props );
} }
} }

View File

@ -0,0 +1,25 @@
{{!
string html-navigation-heading heading for entire navigation that is
usually hidden to screen readers
string html-personal-menu content that appears as the first child of mw-head
string html-navigation-left-tabs that appears inside #left-navigation (namespaces and variants)
string html-navigation-right-tabs that appears inside #right-navigation (page actions and search)
string html-logo for site logo
string html-portals for portal(s) that appear in the main menu for Vector
}}
<div id="mw-navigation">
<h2>{{{html-navigation-heading}}}</h2>
<div id="mw-head">
{{{html-personal-menu}}}
<div id="left-navigation">
{{{html-navigation-left-tabs}}}
</div>
<div id="right-navigation">
{{{html-navigation-right-tabs}}}
</div>
</div>
<div id="mw-panel">
{{{html-logo}}}
{{{html-portals}}}
</div>
</div>

View File

@ -29,7 +29,6 @@
</div> </div>
</div> </div>
{{{html-dataAfterContent}}} {{{html-dataAfterContent}}}
{{! html-unported outputs <div id="mw-navigation"> and <div id="footer"> }} {{{html-navigation}}}
{{{html-unported}}}
{{{html-footer}}} {{{html-footer}}}
{{{html-printtail}}} {{{html-printtail}}}