mediawiki-skins-MinervaNeue/includes/menu/PageActions/DefaultOverflowBuilder.php

87 lines
2.5 KiB
PHP
Raw Normal View History

PageActions menu should use Builder pattern 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
2019-05-23 22:34:10 +00:00
<?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 Hooks;
use MediaWiki\Minerva\Menu\Group;
use MessageLocalizer;
use MinervaUI;
class DefaultOverflowBuilder implements IOverflowBuilder {
/**
* @var MessageLocalizer
*/
private $messageLocalizer;
/**
* Initialize Default overflow menu Group
*
* @param MessageLocalizer $messageLocalizer
*/
public function __construct( MessageLocalizer $messageLocalizer ) {
$this->messageLocalizer = $messageLocalizer;
}
/**
* @inheritDoc
*/
public function getGroup( array $toolbox ): Group {
PageActions menu should use Builder pattern 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
2019-05-23 22:34:10 +00:00
$group = new Group();
$possibleEntries = array_filter( [
$this->build( 'info', 'info', 'info', $toolbox ),
$this->build( 'permalink', 'link', 'permalink', $toolbox ),
$this->build( 'backlinks', 'articleRedirect', 'whatlinkshere', $toolbox ),
$this->build( 'wikibase', 'logoWikidata', 'wikibase', $toolbox ),
$this->build( 'cite', 'quotes', 'citethispage', $toolbox )
PageActions menu should use Builder pattern 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
2019-05-23 22:34:10 +00:00
] );
foreach ( $possibleEntries as $menuEntry ) {
$group->insertEntry( $menuEntry );
}
Hooks::run( 'MobileMenu', [ 'pageactions.overflow', &$group ] );
return $group;
}
/**
* Build the single menu entry
*
PageActions menu should use Builder pattern 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
2019-05-23 22:34:10 +00:00
* @param string $name
* @param string $icon Wikimedia UI icon name.
* @param string $toolboxIdx
* @param array $toolbox An array of common toolbox items from the sidebar menu
PageActions menu should use Builder pattern 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
2019-05-23 22:34:10 +00:00
* @return PageActionMenuEntry|null
*/
private function build( $name, $icon, $toolboxIdx, array $toolbox ) {
$href = $toolbox[$toolboxIdx]['href'] ?? null;
PageActions menu should use Builder pattern 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
2019-05-23 22:34:10 +00:00
return $href ?
new PageActionMenuEntry(
'page-actions-overflow-' . $name,
$href,
MinervaUI::iconClass(
'', 'before', 'wikimedia-ui-' . $icon . '-base20 toggle-list-item__anchor--menu'
),
PageActions menu should use Builder pattern 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
2019-05-23 22:34:10 +00:00
$this->messageLocalizer->msg( 'minerva-page-actions-' . $name )
) : null;
}
}