mirror of
https://gerrit.wikimedia.org/r/mediawiki/skins/Vector.git
synced 2024-12-04 20:18:57 +00:00
7f0b5fe305
* updateDropdownMenuData is removed. Although it was running inside legacy Vector, it didn't do anything as legacy Vector has no concept of collapsible items or icons. * updateLinkData is no longer used. Also: Document where other methods are being used. Bug: T320927 Change-Id: I5b40075db91b1d0f20c21bd7cf858fdfcff96538
187 lines
5.1 KiB
PHP
187 lines
5.1 KiB
PHP
<?php
|
|
|
|
namespace MediaWiki\Skins\Vector;
|
|
|
|
use MediaWiki\Skins\Vector\Components\VectorComponentMenuVariants;
|
|
use MediaWiki\Skins\Vector\Components\VectorComponentSearchBox;
|
|
use SkinMustache;
|
|
use SkinTemplate;
|
|
|
|
/**
|
|
* @ingroup Skins
|
|
* @package Vector
|
|
* @internal
|
|
*/
|
|
class SkinVectorLegacy extends SkinMustache {
|
|
/** @var int */
|
|
private const MENU_TYPE_DEFAULT = 0;
|
|
/** @var int */
|
|
private const MENU_TYPE_TABS = 1;
|
|
/** @var int */
|
|
private const MENU_TYPE_DROPDOWN = 2;
|
|
private const MENU_TYPE_PORTAL = 3;
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
protected function runOnSkinTemplateNavigationHooks( SkinTemplate $skin, &$content_navigation ) {
|
|
parent::runOnSkinTemplateNavigationHooks( $skin, $content_navigation );
|
|
Hooks::onSkinTemplateNavigation( $skin, $content_navigation );
|
|
}
|
|
|
|
/**
|
|
* Performs updates to all portlets.
|
|
*
|
|
* @param array $data
|
|
* @return array
|
|
*/
|
|
private function decoratePortletsData( array $data ) {
|
|
foreach ( $data['data-portlets'] as $key => $pData ) {
|
|
$data['data-portlets'][$key] = $this->decoratePortletData(
|
|
$key,
|
|
$pData
|
|
);
|
|
}
|
|
$mainMenuData = $data['data-portlets-sidebar'];
|
|
$mainMenuData['data-portlets-first'] = $this->decoratePortletData(
|
|
'navigation', $mainMenuData['data-portlets-first']
|
|
);
|
|
$rest = $mainMenuData['array-portlets-rest'];
|
|
foreach ( $rest as $key => $pData ) {
|
|
$rest[$key] = $this->decoratePortletData(
|
|
$pData['id'], $pData
|
|
);
|
|
}
|
|
$mainMenuData['array-portlets-rest'] = $rest;
|
|
$data['data-portlets-main-menu'] = $mainMenuData;
|
|
return $data;
|
|
}
|
|
|
|
/**
|
|
* Performs the following updates to portlet data:
|
|
* - Adds concept of menu types
|
|
* - Marks the selected variant in the variant portlet
|
|
* - modifies tooltips of personal and user-menu portlets
|
|
* @param string $key
|
|
* @param array $portletData
|
|
* @return array
|
|
*/
|
|
private function decoratePortletData(
|
|
string $key,
|
|
array $portletData
|
|
): array {
|
|
$isIconDropdown = false;
|
|
switch ( $key ) {
|
|
case 'data-user-menu':
|
|
$type = self::MENU_TYPE_DROPDOWN;
|
|
$isIconDropdown = true;
|
|
break;
|
|
case 'data-actions':
|
|
case 'data-variants':
|
|
case 'data-sticky-header-toc':
|
|
$type = self::MENU_TYPE_DROPDOWN;
|
|
break;
|
|
case 'data-views':
|
|
case 'data-associated-pages':
|
|
case 'data-namespaces':
|
|
$type = self::MENU_TYPE_TABS;
|
|
break;
|
|
case 'data-notifications':
|
|
case 'data-personal':
|
|
case 'data-user-page':
|
|
case 'data-vector-user-menu-overflow':
|
|
$type = self::MENU_TYPE_DEFAULT;
|
|
break;
|
|
default:
|
|
$type = self::MENU_TYPE_PORTAL;
|
|
break;
|
|
}
|
|
|
|
if ( $key === 'data-personal' ) {
|
|
// Set tooltip to empty string for the personal menu for both logged-in and logged-out users
|
|
// to avoid showing the tooltip for legacy version.
|
|
$portletData['html-tooltip'] = '';
|
|
$portletData['class'] .= ' vector-user-menu-legacy';
|
|
}
|
|
|
|
// Special casing for Variant to change label to selected.
|
|
// Hopefully we can revisit and possibly remove this code when the language switcher is moved.
|
|
if ( $key === 'data-variants' ) {
|
|
$variantMenu = new VectorComponentMenuVariants(
|
|
$portletData,
|
|
$this->getTitle()->getPageLanguage(),
|
|
$this->msg( 'vector-language-variant-switcher-label' )
|
|
);
|
|
$portletData = $variantMenu->getTemplateData();
|
|
}
|
|
|
|
$portletData = $this->updatePortletClasses(
|
|
$portletData,
|
|
$type
|
|
);
|
|
|
|
return $portletData + [
|
|
'is-dropdown' => $type === self::MENU_TYPE_DROPDOWN,
|
|
'is-portal' => $type === self::MENU_TYPE_PORTAL,
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Helper for applying Vector menu classes to portlets
|
|
*
|
|
* @param array $portletData returned by SkinMustache to decorate
|
|
* @param int $type representing one of the menu types (see MENU_TYPE_* constants)
|
|
* @return array modified version of portletData input
|
|
*/
|
|
private function updatePortletClasses(
|
|
array $portletData,
|
|
int $type = self::MENU_TYPE_DEFAULT
|
|
) {
|
|
$extraClasses = [
|
|
self::MENU_TYPE_DROPDOWN => 'vector-menu-dropdown',
|
|
self::MENU_TYPE_TABS => 'vector-menu-tabs vector-menu-tabs-legacy',
|
|
self::MENU_TYPE_PORTAL => 'vector-menu-portal portal',
|
|
self::MENU_TYPE_DEFAULT => '',
|
|
];
|
|
$portletData['class'] .= ' ' . $extraClasses[$type];
|
|
|
|
if ( !isset( $portletData['heading-class'] ) ) {
|
|
$portletData['heading-class'] = '';
|
|
}
|
|
|
|
$portletData['class'] = trim( $portletData['class'] );
|
|
$portletData['heading-class'] = trim( $portletData['heading-class'] );
|
|
return $portletData;
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
public function getTemplateData(): array {
|
|
$parentData = $this->decoratePortletsData( parent::getTemplateData() );
|
|
|
|
$components = [
|
|
'data-search-box' => new VectorComponentSearchBox(
|
|
$parentData['data-search-box'],
|
|
false,
|
|
// is primary mode of search
|
|
true,
|
|
'searchform',
|
|
true,
|
|
$this->getConfig(),
|
|
Constants::SEARCH_BOX_INPUT_LOCATION_DEFAULT,
|
|
$this->getContext()
|
|
),
|
|
];
|
|
foreach ( $components as $key => $component ) {
|
|
$parentData[$key] = $component->getTemplateData();
|
|
}
|
|
|
|
// SkinVector sometimes serves new Vector as part of removing the
|
|
// skin version user preference. To avoid T302461 we need to unset it here.
|
|
// This shouldn't be run on SkinVector22.
|
|
unset( $parentData['data-toc'] );
|
|
return $parentData;
|
|
}
|
|
}
|