mirror of
https://gerrit.wikimedia.org/r/mediawiki/skins/MinervaNeue
synced 2024-11-29 00:20:51 +00:00
209becf63d
The PageActions menu shouldn't be built inside SkinMinerva class. All menus should be build in similar way so it's easier to understand how different parts of the system work. This will allow us to easily track different menu elements/move elements between different menus. Additionally we should allow extensions/3rd party to modify both the toolbar and overflow menus. Changes: - Removed PageActions logic from SkinMinerva class - introduced new PageActions/Director to build page actions menu - introduced Builders for toolbar, and different types of overflow menu - because Overflow menu elements require the BaseTemplate::data['nav_urls] array, instead building all links, pass the array when building PageActions menu. Code for getting menu entries had to be rewritten (use $navUrls array instead of $this->tpl['nav_urls']; - ServiceWirings file contains logic on what to pass to PageActions/Director class (which builders) - PageActionsMenuEntry setTitle() and setNodeID() returns $this so we can use method chaining. Only a syntax sugar. - if AMC is not available/Overflow menu is disabled via config, system will pass EmptyOverflowBuilder. System will not add "show more" icon to toolbar menu when $overflowBuilder returns empty set of options. - both ToolbarBulder and OverflowMenuBuilders (except EmptyOverflowBuilder) will run 'MobileMenu' hook. Extensions should listen to hook, and inject it's own menu entries at their leisure. Required follow-ups: - SkinMinerva provides isAllowedAction() method which is used both in the skin code and in Toolbar builder. We should extract that method into separate service - SkinMinerva provides getHistoryUrl() method which is used both in the skin code and in Toolbar builder. We should provide MinervaUrls service that knows how to build custom mobile URLs. Bug: T221792 Change-Id: Ie08c4b61cea60c3a42fbf796a39360feea22bc33
87 lines
2.6 KiB
PHP
87 lines
2.6 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\PageActions;
|
|
|
|
use MessageLocalizer;
|
|
use MinervaUI;
|
|
use MWException;
|
|
|
|
/**
|
|
* Director responsible for building Page Actions menu.
|
|
* This class is stateless.
|
|
*/
|
|
final class PageActionsDirector {
|
|
|
|
/**
|
|
* @var ToolbarBuilder
|
|
*/
|
|
private $toolbarBuilder;
|
|
|
|
/**
|
|
* @var IOverflowBuilder
|
|
*/
|
|
private $overflowBuilder;
|
|
|
|
/**
|
|
* @var MessageLocalizers
|
|
*/
|
|
private $messageLocalizer;
|
|
|
|
/**
|
|
* Director responsible for Page Actions menu building
|
|
*
|
|
* @param ToolbarBuilder $toolbarBuilder The toolbar builder
|
|
* @param IOverflowBuilder $overflowBuilder The overflow menu builder
|
|
* @param MessageLocalizer $messageLocalizer Message localizer used to translate texts
|
|
*/
|
|
public function __construct( ToolbarBuilder $toolbarBuilder, IOverflowBuilder $overflowBuilder,
|
|
MessageLocalizer $messageLocalizer ) {
|
|
$this->toolbarBuilder = $toolbarBuilder;
|
|
$this->overflowBuilder = $overflowBuilder;
|
|
$this->messageLocalizer = $messageLocalizer;
|
|
}
|
|
|
|
/**
|
|
* Build the menu data array that can be passed to views/javascript
|
|
* @param array $navUrls A set of navigation urls build by SkinTemplate::buildNavUrls()
|
|
* @param bool $doesHaveLangUrls Whether the page is also available in other languages or variants
|
|
* @return array
|
|
* @throws MWException
|
|
*/
|
|
public function buildMenu( array $navUrls, $doesHaveLangUrls ): array {
|
|
$toolbar = $this->toolbarBuilder->getGroup( $doesHaveLangUrls );
|
|
$overflowMenu = $this->overflowBuilder->getGroup( $navUrls );
|
|
|
|
$menu = [
|
|
'toolbar' => $toolbar->getEntries()
|
|
];
|
|
if ( $overflowMenu->hasEntries() ) {
|
|
$menu[ 'overflowMenu' ] = [
|
|
'item-id' => 'page-actions-overflow',
|
|
'class' => MinervaUI::iconClass( 'page-actions-overflow' ),
|
|
'text' => $this->messageLocalizer->msg( 'minerva-page-actions-overflow' ),
|
|
'pageActions' => $overflowMenu->getEntries()
|
|
];
|
|
}
|
|
return $menu;
|
|
}
|
|
|
|
}
|