mirror of
https://gerrit.wikimedia.org/r/mediawiki/skins/MinervaNeue
synced 2024-11-17 19:21:39 +00:00
933dc0e370
Break up Menu/DefaultBuilder into functions that are reusable without inheritance. The functions do not need much state to produce their outputs and a weighty inheritance hierarchy makes the code difficult to reason about. The functions are used in a following patch for the user menu. They're now simple, independent, static functions in BuilderUtil that are easy to reason about and compose. Also, ban inheritance via `final` in a few places nearby. Inheritance has not worked well in MobileFrontend and enabling it should be a special deliberate case, not a default. E.g., in the user menu, the changes could have been to the base class' getPersonalTools() method such that the client passes a parameter for the advanced config or maybe just override it in the subclass. In either case, it makes the whole hierarchy nuanced and harder to reason about for something that should be dead simple. Bug: T214540 Change-Id: I6e9a2b36a1bff387eb3b33ea65b0a6806962810a
129 lines
3.3 KiB
PHP
129 lines
3.3 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 MWException;
|
|
use User;
|
|
use MediaWiki\Minerva\Menu\Definitions;
|
|
use MediaWiki\Minerva\Menu\Group;
|
|
|
|
/**
|
|
* A menu builder that provides additional menu entries that match
|
|
* Advanced Mobile Contributions project requirements. This menu
|
|
* is used when AMC SkinOption flag is set to true.
|
|
*
|
|
* @package MediaWiki\Minerva\Menu\Main
|
|
*/
|
|
final class AdvancedBuilder implements IBuilder {
|
|
/**
|
|
* @var bool
|
|
*/
|
|
private $showMobileOptions;
|
|
|
|
/**
|
|
* 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 User $user The current user
|
|
* @param Definitions $definitions A menu items definitions set
|
|
*/
|
|
public function __construct( $showMobileOptions, User $user, Definitions $definitions ) {
|
|
$this->showMobileOptions = $showMobileOptions;
|
|
$this->user = $user;
|
|
$this->definitions = $definitions;
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
* @return Group[]
|
|
* @throws FatalError
|
|
* @throws MWException
|
|
*/
|
|
public function getGroups(): array {
|
|
return [
|
|
BuilderUtil::getDiscoveryTools( $this->definitions ),
|
|
$this->getPersonalTools(),
|
|
$this->getSiteTools(),
|
|
BuilderUtil::getConfigurationTools( $this->definitions, $this->showMobileOptions ),
|
|
];
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
* @throws FatalError
|
|
* @throws MWException
|
|
*/
|
|
public function getSiteLinks(): Group {
|
|
return BuilderUtil::getSiteLinks( $this->definitions );
|
|
}
|
|
|
|
/**
|
|
* Builds the personal tools menu item group.
|
|
* @return Group
|
|
* @throws FatalError
|
|
* @throws MWException
|
|
*/
|
|
private function getPersonalTools(): Group {
|
|
$group = new Group();
|
|
|
|
$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;
|
|
}
|
|
|
|
/**
|
|
* Prepares a list of links that have the purpose of discovery in the main navigation menu
|
|
* @return Group
|
|
* @throws FatalError
|
|
* @throws MWException
|
|
*/
|
|
private function getSiteTools(): Group {
|
|
$group = new Group();
|
|
|
|
$this->definitions->insertSpecialPages( $group );
|
|
$this->definitions->insertCommunityPortal( $group );
|
|
|
|
// Allow other extensions to add or override tools
|
|
Hooks::run( 'MobileMenu', [ 'sitetools', &$group ] );
|
|
return $group;
|
|
}
|
|
}
|