mediawiki-skins-MinervaNeue/includes/menu/PageActions/UserNamespaceOverflowBuilder.php
Piotr Miazga b8abf809ac Hygiene: rename $navUrls to $toolbox
Previously we were passing the $tpl->data['nav_urls'] array,
because of that all params were called $navUrls. That approach
was incorrect and we have to pass $tpl->getToolbox(), which
means all $navUrls variables/paramters have to be renamed to
$toolbox for better clarity

Changes:
 - renamed $navUrls to $toolbox
 - update phpdocs blocks
 - renamed buildEntry() into build()

Bug: T222630
Change-Id: Id0023cfbb9779c502edc0f91e31a2a912af84084
2019-06-14 19:05:37 +02:00

110 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\PageActions;
use Hooks;
use MediaWiki\Minerva\Menu\Group;
use MediaWiki\Minerva\SkinUserPageHelper;
use MessageLocalizer;
use MinervaUI;
use MWException;
use SpecialPage;
use User;
class UserNamespaceOverflowBuilder implements IOverflowBuilder {
/**
* @var MessageLocalizer
*/
private $messageLocalizer;
/**
* @var User|null
*/
private $pageUser;
/**
* Initialize the overflow menu visible on the User namespace
* @param MessageLocalizer $msgLocalizer
* @param SkinUserPageHelper $userPageHelper
*/
public function __construct( MessageLocalizer $msgLocalizer, SkinUserPageHelper $userPageHelper ) {
$this->messageLocalizer = $msgLocalizer;
$this->pageUser = $userPageHelper->getPageUser();
}
/**
* @inheritDoc
* @throws MWException
*/
public function getGroup( array $toolbox ) {
$group = new Group();
$group->insertEntry( $this->build(
'uploads', 'upload', SpecialPage::getTitleFor( 'Uploads', $this->pageUser )->getLocalURL()
) );
$possibleEntries = array_filter( [
$this->buildFromToolbox( 'user-rights', 'userAvatar', 'userrights', $toolbox ),
$this->buildFromToolbox( 'logs', 'listBullet', 'log', $toolbox ),
$this->buildFromToolbox( 'info', 'info', 'info', $toolbox ),
$this->buildFromToolbox( 'permalink', 'link', 'permalink', $toolbox ),
$this->buildFromToolbox( 'backlinks', 'articleRedirect', 'whatlinkshere', $toolbox )
] );
foreach ( $possibleEntries as $menuEntry ) {
$group->insertEntry( $menuEntry );
}
Hooks::run( 'MobileMenu', [ 'pageactions.overflow', &$group ] );
return $group;
}
/**
* Build entry based on the $toolbox element
*
* @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
* @return PageActionMenuEntry|null
*/
private function buildFromToolbox( $name, $icon, $toolboxIdx, array $toolbox ) {
return $this->build( $name, $icon, $toolbox[$toolboxIdx]['href'] ?? null );
}
/**
* Build single Menu entry
*
* @param string $name
* @param string $icon Wikimedia UI icon name.
* @param string|null $href
* @return PageActionMenuEntry|null
*/
private function build( $name, $icon, $href ) {
return $href ?
new PageActionMenuEntry(
'page-actions-overflow-' . $name,
$href,
MinervaUI::iconClass( '', 'before', 'wikimedia-ui-' . $icon . '-base20' ),
$this->messageLocalizer->msg( 'minerva-page-actions-' . $name )
) : null;
}
}