mirror of
https://gerrit.wikimedia.org/r/mediawiki/skins/MinervaNeue
synced 2024-11-17 11:13:34 +00:00
4c224d2657
The SingleMenuEntry constructor has too many optional parameters which makes it confusing and dificult to use. Instead system should provide a named constructor `create` that creates new menu entry instance with Icon and click tracking enabled. If developer wants to override event tracking/change icon it is possible via calling `trackClicks` and `setIcon` method calls. This is a first refactoring step to simplify the SingleMenuEntry, the next follow-up will remove unnecessary PageActionsDirector. Bug: T232734 Change-Id: I7a631a635a5c5932845639123c285d1d18df1b5d
108 lines
2.7 KiB
PHP
108 lines
2.7 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.
|
|
*/
|
|
|
|
namespace MediaWiki\Minerva\Menu\Entries;
|
|
|
|
use MinervaUI;
|
|
|
|
/**
|
|
* Model for a simple menu entries with label and icon
|
|
*/
|
|
class SingleMenuEntry implements IMenuEntry {
|
|
/**
|
|
* @var string
|
|
*/
|
|
private $name;
|
|
/**
|
|
* @var array
|
|
*/
|
|
private $attributes;
|
|
|
|
/**
|
|
* Create a simple menu element with one component
|
|
*
|
|
* @param string $name An unique menu element identifier
|
|
* @param string $text Text to show on menu element
|
|
* @param string $url URL menu element points to
|
|
* @param string $className Additional CSS class names.
|
|
*/
|
|
public function __construct( $name, $text, $url, $className = '' ) {
|
|
$this->name = $name;
|
|
|
|
$this->attributes = [
|
|
'text' => $text,
|
|
'href' => $url,
|
|
'class' => $className
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Create a Single Menu entry with text, icon and active click tracking
|
|
*
|
|
* @param string $name Entry identifier
|
|
* @param string $text Entry label
|
|
* @param string $url The URL entry points to
|
|
* @param string $className Optional HTML classes
|
|
* @return static
|
|
*/
|
|
public static function create( $name, $text, $url, $className = '' ) {
|
|
$entry = new static( $name, $text, $url, $className );
|
|
$entry->trackClicks( $name );
|
|
$entry->setIcon( $name );
|
|
return $entry;
|
|
}
|
|
|
|
/**
|
|
* @param string $eventName Should clicks be tracked. To override the tracking code
|
|
* pass the tracking code as string
|
|
*/
|
|
public function trackClicks( $eventName ) {
|
|
$this->attributes['data-event-name'] = 'menu.' . $eventName;
|
|
}
|
|
|
|
/**
|
|
* Set the Menu entry icon
|
|
* @param string $iconName Icon name
|
|
* @param string $iconType Icon type
|
|
*/
|
|
public function setIcon( $iconName, $iconType = 'before' ) {
|
|
$this->attributes['class'] .= ' ' . MinervaUI::iconClass( $iconName, $iconType, '' );
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
public function getName() {
|
|
return $this->name;
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
public function getCSSClasses(): array {
|
|
return [];
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
public function getComponents(): array {
|
|
return [ $this->attributes ];
|
|
}
|
|
|
|
}
|