mediawiki-skins-MinervaNeue/includes/menu/Main/MainMenuDirector.php
James D. Forrester e8d227b78e build: Upgrade mediawiki-codesniffer to v28.0.0
Change-Id: I8ce5f16f496f048f6bcf587c545745193dbfe151
2019-10-11 12:04:00 -07:00

125 lines
3.2 KiB
PHP

<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
namespace MediaWiki\Minerva\Menu\Main;
use Html;
use MessageLocalizer;
use MinervaUI;
use SpecialPage;
use MediaWiki\Special\SpecialPageFactory;
/**
* Director responsible for building Main Menu
*/
final class MainMenuDirector {
/**
* @var IMainMenuBuilder
*/
private $builder;
/**
* @var array
*/
private $menuData;
/**
* @var MessageLocalizer
*/
private $msgLocalizer;
/**
* @var SpecialPageFactory
*/
private $specialPageFactory;
/**
* Director responsible for Main Menu building
*
* @param IMainMenuBuilder $builder
* @param MessageLocalizer $messageLocalizer Used for translating texts in menu toggle
* @param SpecialPageFactory $specialPageFactory Used to check for MobileMenu special page
* existence
*/
public function __construct(
IMainMenuBuilder $builder,
MessageLocalizer $messageLocalizer,
SpecialPageFactory $specialPageFactory
) {
$this->builder = $builder;
$this->msgLocalizer = $messageLocalizer;
$this->specialPageFactory = $specialPageFactory;
}
/**
* Returns a data representation of the main menus
* @return array
*/
public function getMenuData(): array {
if ( $this->menuData === null ) {
$this->menuData = $this->buildMenu();
}
return $this->menuData;
}
/**
* Build the menu data array that can be passed to views/javascript
* @return array
*/
private function buildMenu(): array {
$menuData = [
'buttonHTML' => $this->prepareToggle(),
'items' => [
'groups' => [],
'sitelinks' => $this->builder->getSiteLinks()->getEntries()
]
];
foreach ( $this->builder->getGroups() as $group ) {
if ( $group->hasEntries() ) {
$menuData['items']['groups'][] = $group->getEntries();
}
}
return $menuData;
}
/**
* Prepare the button opens the main side menu
* @return string Rendered Menu button as HTML
*/
protected function prepareToggle() {
$url = $this->specialPageFactory->exists( 'MobileMenu' ) ?
SpecialPage::getTitleFor( 'MobileMenu' )->getLocalURL() : '#';
$title = $this->msgLocalizer->msg( 'mobile-frontend-main-menu-button-tooltip' )->text();
$tooltip = $this->msgLocalizer->msg( 'mobile-frontend-main-menu-button-tooltip' )
->text();
return Html::element( 'a', [
'title' => $title,
'href' => $url,
'class' => MinervaUI::iconClass(
'mainmenu', 'element', 'main-menu-button mw-ui-icon-flush-left'
),
'data-event-name' => 'ui.mainmenu',
'id' => 'mw-mf-main-menu-button',
], $tooltip );
}
}