mediawiki-skins-MinervaNeue/includes/Menu/PageActions/PageActionsDirector.php
Fomafix ff00805c5f Use PHP types (2)
* Add type hints where possible.
* Add initialization values to properties where needed.
* Remove @var block if redundant to type declaration.
* Use single line /** @var type $var */ instead of multi line.

Change-Id: I35236c5c1a2abb49e8ea2da090df3d655206195f
2024-05-08 19:08:30 +00:00

110 lines
3.4 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;
/**
* Director responsible for building Page Actions menu.
* This class is stateless.
*/
final class PageActionsDirector {
private ToolbarBuilder $toolbarBuilder;
private IOverflowBuilder $overflowBuilder;
private MessageLocalizer $messageLocalizer;
/**
* Director responsible for Page Actions menu building
*
* @param ToolbarBuilder $toolbarBuilder
* @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 $toolbox An array of common toolbox items from the sidebar menu
* @param array $actions An array of actions usually bucketed under the more menu
* @param array $views An array of actions usually bucketed under the view menu
* @return array
*/
public function buildMenu( array $toolbox, array $actions, array $views ): array {
$toolbar = $this->toolbarBuilder->getGroup( $actions, $views );
$overflowMenu = $this->overflowBuilder->getGroup( $toolbox, $actions );
$menu = [
'toolbar' => $toolbar->getEntries()
];
if ( $overflowMenu->hasEntries() ) {
// See includes/Skins/ToggleList.
$toggleID = 'page-actions-overflow-toggle';
$checkboxID = 'page-actions-overflow-checkbox';
$menu[ 'overflowMenu' ] = [
'item-id' => 'page-actions-overflow',
'checkboxID' => $checkboxID,
'toggleID' => $toggleID,
'data-btn' => [
'tag-name' => 'label',
'data-icon' => [
'icon' => 'ellipsis',
],
'classes' => 'toggle-list__toggle',
'array-attributes' => [
[
'key' => 'id',
'value' => $toggleID,
],
[
'key' => 'for',
'value' => $checkboxID,
],
[
'key' => 'aria-hidden',
'value' => 'true'
],
[
'key' => 'data-event-name',
'value' => 'ui.overflowmenu',
],
],
// class = toggle-list__toggle {{toggleClass}}
// data-event-name="{{analyticsEventName}}">
'label' => $this->messageLocalizer->msg( 'minerva-page-actions-overflow' ),
],
'listID' => $overflowMenu->getId(),
'listClass' => 'page-actions-overflow-list toggle-list__list--drop-down',
'items' => $overflowMenu->getEntries()
];
}
return $menu;
}
}