Page MenuHomeWickedGov Phorge
Files F6032476

SingleMenuEntry.php
No OneTemporary
Actions

Size
5 KB
Referenced Files
None
Subscribers
None

SingleMenuEntry.php
View Options

<?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 MediaWiki\Message\Message;
/**
* Model for a simple menu entries with label and icon
*/
class SingleMenuEntry implements IMenuEntry {
private string $name;
private array $attributes;
private bool $isJSOnly = false;
/**
* 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|array $className Additional CSS class names.
* @param bool $isInterface If true, the menu element is provided with data-mw='interface'
* and is treated as a standard part of the interface (ie. MediaWiki Core might bind to
* the menu element)
*/
public function __construct( string $name, string $text, string $url, $className = '', bool $isInterface = true ) {
$this->name = $name;
$menuClass = 'menu__item--' . $name;
$this->attributes = [
'data-icon' => [
'icon' => null,
],
'data-event-name' => null,
'title' => null,
'id' => null,
'text' => $text,
'href' => $url,
'role' => '',
'class' => is_array( $className ) ?
implode( ' ', $className + [ $menuClass ] ) :
ltrim( $className . ' ' . $menuClass ),
];
if ( $isInterface ) {
// This is needed when Minerva uses a standard MediaWiki button (such as the
// watchstar) for a different purpose than MediaWiki usually uses it for. Not setting
// data-mw interface will prevent MediaWiki Core from binding to the element and
// potentially triggering its own actions. See T344925 for an example bug report.
$this->attributes['data-mw'] = 'interface';
}
}
/**
* Override the icon used in the home menu entry.
*
* @param string $icon
* @return $this
*/
public function overrideIcon( string $icon ): self {
$this->setIcon( $icon );
return $this;
}
/**
* Override the text used in the home menu entry.
*
* @param string $text
* @return $this
*/
public function overrideText( string $text ): self {
$this->attributes['text'] = $text;
return $this;
}
/**
* 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
* @param string|null $icon defaults to $name if not specified
* @param bool $trackable Whether an entry will track clicks or not. Default is false.
* @return static
*/
public static function create( $name, $text, $url, $className = '', $icon = null, $trackable = false ) {
$entry = new static( $name, $text, $url, $className );
if ( $trackable ) {
$entry->trackClicks( $name );
}
if ( $icon === null ) {
$icon = $name;
}
$entry->setIcon( $icon );
return $entry;
}
/**
* @inheritDoc
*/
public function getName(): string {
return $this->name;
}
/**
* @inheritDoc
*/
public function getCSSClasses(): array {
return $this->isJSOnly ? [ 'skin-minerva-list-item-jsonly' ] : [];
}
/**
* @inheritDoc
*/
public function getComponents(): array {
$attrs = [];
foreach ( [ 'id', 'href', 'data-event-name', 'data-mw', 'role' ] as $key ) {
$value = $this->attributes[$key] ?? null;
if ( $value ) {
$attrs[] = [
'key' => $key,
'value' => $value,
];
}
}
$btn = [
'tag-name' => 'a',
'label' => $this->attributes['text'],
'array-attributes' => $attrs,
'classes' => $this->attributes['class'],
'data-icon' => $this->attributes['data-icon'],
];
return [ $btn ];
}
/**
* @param string $eventName Should clicks be tracked. To override the tracking code
* pass the tracking code as string
* @return $this
*/
public function trackClicks( $eventName ): self {
$this->attributes['data-event-name'] = 'menu.' . $eventName;
return $this;
}
/**
* Set the Menu entry icon
* @param string|null $iconName
* @return $this
*/
public function setIcon( $iconName ): self {
if ( $iconName !== null ) {
$this->attributes['data-icon']['icon'] = $iconName;
} else {
$this->attributes['data-icon'] = null;
}
return $this;
}
/**
* Set the menu entry title
* @param Message $message Title message
* @return $this
*/
public function setTitle( Message $message ): self {
$this->attributes['title'] = $message->escaped();
return $this;
}
/**
* Set the Menu entry ID html attribute
* @param string $nodeID
* @return $this
*/
public function setNodeID( $nodeID ): self {
$this->attributes['id'] = $nodeID;
return $this;
}
/**
* Mark entry as JS only.
*/
public function setJSOnly() {
$this->isJSOnly = true;
}
}

File Metadata

Mime Type
text/x-php
Expires
Oct 4 2026, 18:20 (5 w, 4 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
81/63/b05c89c84c6c72d110ea288fbf7a
Default Alt Text
SingleMenuEntry.php (5 KB)

Event Timeline