mirror of
https://gerrit.wikimedia.org/r/mediawiki/skins/Vector.git
synced 2024-11-26 08:35:42 +00:00
24055a6752
* Leverage the infrastructure around feature management to handle the page tools pinning and persistence * Make pinnableHeader.js leverage features.js if the data-feature-name attribute is set * Sets tests/.eslintrc.json ecmaVersion to 2018 to enable destructuring in test files. * Adds a isPinned helper method to pinnableElement * Add a logged in requirement so that the pinned feature is disabled for anon users. Bug: T322051 Change-Id: Ib86282216882fa94e37b7088a3f4bd0c1bcf6cd4
119 lines
3.3 KiB
PHP
119 lines
3.3 KiB
PHP
<?php
|
|
namespace MediaWiki\Skins\Vector\Components;
|
|
|
|
use MessageLocalizer;
|
|
use Skin;
|
|
use User;
|
|
|
|
/**
|
|
* VectorComponentMainMenu component
|
|
*/
|
|
class VectorComponentMainMenu implements VectorComponent {
|
|
/** @var VectorComponent|null */
|
|
private $optOut;
|
|
/** @var VectorComponent|null */
|
|
private $alert;
|
|
/** @var array */
|
|
private $sidebarData;
|
|
/** @var array */
|
|
private $languageData;
|
|
/** @var MessageLocalizer */
|
|
private $localizer;
|
|
/** @var User */
|
|
private $user;
|
|
|
|
/**
|
|
* @param array $sidebarData
|
|
* @param Skin $skin
|
|
* @param bool $shouldLanguageAlertBeInSidebar
|
|
* @param array $languageData
|
|
*/
|
|
public function __construct(
|
|
array $sidebarData,
|
|
Skin $skin,
|
|
bool $shouldLanguageAlertBeInSidebar,
|
|
array $languageData
|
|
) {
|
|
$this->sidebarData = $sidebarData;
|
|
$this->localizer = $skin->getContext();
|
|
$this->languageData = $languageData;
|
|
$user = $skin->getUser();
|
|
$this->user = $user;
|
|
if ( $user->isRegistered() ) {
|
|
$this->optOut = new VectorComponentMainMenuActionOptOut( $skin );
|
|
}
|
|
if ( $shouldLanguageAlertBeInSidebar ) {
|
|
$this->alert = new VectorComponentMainMenuActionLanguageSwitchAlert( $skin );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @return User
|
|
*/
|
|
private function getUser(): User {
|
|
return $this->user;
|
|
}
|
|
|
|
/**
|
|
* Updates side bar data so that it has a label and heading-class defined
|
|
* so it doesn't inherit Mustache properties from parent
|
|
* @param array $portletData
|
|
* @return array
|
|
*/
|
|
private function fillMissingDataPortlet( $portletData ) {
|
|
return $portletData + [
|
|
'label' => '',
|
|
'heading-class' => '',
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Updates side bar data so that it has a label and heading-class defined
|
|
* so it doesn't inherit Mustache properties from parent
|
|
*
|
|
* @param array $sidebarData
|
|
* @return array
|
|
*/
|
|
private function fillMissingData( array $sidebarData ): array {
|
|
$portletsFirst = $sidebarData['data-portlets-first'];
|
|
$sidebarData['data-portlets-first'] = $this->fillMissingDataPortlet( $portletsFirst );
|
|
$portletsRest = $sidebarData['array-portlets-rest'];
|
|
foreach ( $portletsRest as $key => $childData ) {
|
|
$portletsRest[$key] = $this->fillMissingDataPortlet( $childData );
|
|
}
|
|
$sidebarData['array-portlets-rest'] = $portletsRest;
|
|
return $sidebarData;
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
public function getTemplateData(): array {
|
|
$action = $this->optOut;
|
|
$alert = $this->alert;
|
|
|
|
$pinnableHeader = new VectorComponentPinnableHeader(
|
|
$this->localizer,
|
|
false,
|
|
'vector-main-menu',
|
|
null
|
|
);
|
|
|
|
$class = $this->getUser()->isAnon() ? 'vector-main-menu-btn-dropdown-anon ' : '';
|
|
$class .= 'vector-main-menu';
|
|
return $this->fillMissingData( $this->sidebarData ) + [
|
|
'id' => 'vector-main-menu',
|
|
'class' => $class,
|
|
'label' => $this->localizer->msg( 'vector-main-menu-label' )->text(),
|
|
// @todo: Helper method for making icon classes would be useful.
|
|
'heading-class' => 'mw-checkbox-hack-button mw-ui-icon mw-ui-button '
|
|
. 'mw-ui-quiet mw-ui-icon-wikimedia-menu mw-ui-icon-element',
|
|
'data-main-menu-action' => $action ? $action->getTemplateData() : null,
|
|
// T295555 Add language switch alert message temporarily (to be removed).
|
|
'data-vector-language-switch-alert' => $alert ? $alert->getTemplateData() : null,
|
|
'data-pinnable-header' => $pinnableHeader->getTemplateData(),
|
|
'data-languages' => $this->fillMissingDataPortlet( $this->languageData ),
|
|
];
|
|
}
|
|
}
|