mirror of
https://gerrit.wikimedia.org/r/mediawiki/skins/MinervaNeue
synced 2024-11-28 16:10:55 +00:00
2794ea10dc
For consistency with other methods, a mechanism for overriding the home page icon is provided. Bug: T291423 Change-Id: I7fb2e23cf10a75ed37e333f166f93111283f7f3e
115 lines
2.7 KiB
PHP
115 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;
|
|
|
|
/**
|
|
* Class for defining a home menu entry in Special:MobileMenu
|
|
* @internal with exception of usage inside Extension:GrowthExperiments. Please check
|
|
* compatibility with any method/class changes.
|
|
*/
|
|
final class HomeMenuEntry implements IMenuEntry {
|
|
|
|
/**
|
|
* @var string
|
|
*/
|
|
private $name;
|
|
|
|
/**
|
|
* @var array
|
|
*/
|
|
private $component;
|
|
|
|
/**
|
|
* Override the text used in the home menu entry.
|
|
*
|
|
* @param string $text
|
|
* @return $this
|
|
*/
|
|
public function overrideText( $text ) {
|
|
$this->component['text'] = $text;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Override the CSS class used in the home menu entry.
|
|
*
|
|
* @param string $cssClass
|
|
* @return $this
|
|
*/
|
|
public function overrideCssClass( $cssClass ) {
|
|
$this->component['class'] = $cssClass;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Override the icon used in the home menu entry.
|
|
*
|
|
* @param string $icon
|
|
* @return $this
|
|
*/
|
|
public function overrideIcon( $icon ) {
|
|
$this->component['icon'] = $icon;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Create a home 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 bool|string $trackClicks Should clicks be tracked. To override the tracking code
|
|
* pass the tracking code as string
|
|
*/
|
|
public function __construct( $name, $text, $url, $trackClicks = true ) {
|
|
$this->name = $name;
|
|
$this->component = [
|
|
'text' => $text,
|
|
'href' => $url,
|
|
'icon' => 'minerva-' . $name,
|
|
];
|
|
if ( $trackClicks !== false ) {
|
|
$eventName = $trackClicks === true ? $name : $trackClicks;
|
|
$this->component['data-event-name'] = 'menu.' . $eventName;
|
|
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
public function getName() {
|
|
return $this->name;
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
public function getCSSClasses(): array {
|
|
return [];
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
public function getComponents(): array {
|
|
return [ $this->component ];
|
|
}
|
|
|
|
}
|