mediawiki-skins-MinervaNeue/includes/Menu/Main/DefaultMainMenuBuilder.php
jdlrobson 2e450e104e Donate link should be in a separate group in main menu
Bug: T219793
Change-Id: I7501c87eaa799e4c8a9052f5e3f650a89f376d1b
2020-06-29 14:38:34 -07:00

123 lines
3.1 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 FatalError;
use Hooks;
use MediaWiki\Minerva\Menu\Definitions;
use MediaWiki\Minerva\Menu\Group;
use MWException;
use User;
/**
* Used to build default (available for everyone by default) main menu
*/
final class DefaultMainMenuBuilder implements IMainMenuBuilder {
/**
* @var bool
*/
private $showMobileOptions;
/**
* @var bool
*/
private $showDonateLink;
/**
* Currently logged in user
* @var User
*/
private $user;
/**
* @var Definitions
*/
private $definitions;
/**
* Initialize the Default Main Menu builder
*
* @param bool $showMobileOptions Show MobileOptions instead of Preferences
* @param bool $showDonateLink whether to show the donate link
* @param User $user The current user
* @param Definitions $definitions A menu items definitions set
*/
public function __construct( $showMobileOptions, $showDonateLink, User $user, Definitions $definitions ) {
$this->showMobileOptions = $showMobileOptions;
$this->showDonateLink = $showDonateLink;
$this->user = $user;
$this->definitions = $definitions;
}
/**
* @inheritDoc
* @throws FatalError
* @throws MWException
*/
public function getGroups(): array {
$donate = $this->showDonateLink ?
BuilderUtil::getDonateGroup( $this->definitions ) : null;
$groups = [
BuilderUtil::getDiscoveryTools( $this->definitions ),
$this->getPersonalTools(),
BuilderUtil::getConfigurationTools( $this->definitions, $this->showMobileOptions ),
];
if ( $donate ) {
$groups[] = $donate;
}
return $groups;
}
/**
* @inheritDoc
* @throws MWException
*/
public function getSiteLinks(): Group {
return BuilderUtil::getSiteLinks( $this->definitions );
}
/**
* Builds the personal tools menu item group.
*
* ... by adding the Watchlist, Settings, and Log{in,out} menu items in the given order.
*
* @return Group
* @throws FatalError
* @throws MWException
*/
private function getPersonalTools(): Group {
$group = new Group( 'p-personal' );
$this->definitions->insertAuthMenuItem( $group );
if ( $this->user->isLoggedIn() ) {
$this->definitions->insertWatchlistMenuItem( $group );
$this->definitions->insertContributionsMenuItem( $group );
}
// Allow other extensions to add or override tools
Hooks::run( 'MobileMenu', [ 'personal', &$group ] );
return $group;
}
}