Page Menu
Home
WickedGov Phorge
Search
Configure Global Search
Log In
Files
F7420687
OverflowMenuItem.php
No One
Temporary
Actions
Download File
Edit File
Delete File
View Transforms
Subscribe
Flag For Later
Award Token
Size
2 KB
Referenced Files
None
Subscribers
None
OverflowMenuItem.php
View Options
<?php
namespace
MediaWiki\Extension\DiscussionTools
;
use
JsonSerializable
;
use
MessageLocalizer
;
use
Wikimedia\Message\MessageSpecifier
;
/**
* Item to go into the DiscussionTools overflow menu, as an OO.ui.MenuOptionWidget object.
*
* You must call parseLabel() after constructing this object and before serializing it.
*/
class
OverflowMenuItem
implements
JsonSerializable
{
/**
* @var string A rendered string to use as the label for the item.
*/
private
string
$label
;
private
string
$icon
;
private
MessageSpecifier
|
string
$labelMsg
;
private
array
$data
;
private
string
$id
;
private
int
$weight
;
/**
* @param string $id A unique identifier for the menu item, e.g. 'edit' or 'reportincident'
* @param string $icon An OOUI icon name.
* @param MessageSpecifier|string $labelMsg Message or message key to use as the label for the item.
* If the message does not need params, pass a string, which will avoid parsing the message repeatedly.
* @param int $weight Sorting weight. Higher values will push the item further up the menu.
* @param array $data Data to include with the menu item. Will be accessible via getData() on the
* OOUI MenuOptionWidget in client-side code.
*/
public
function
__construct
(
string
$id
,
string
$icon
,
MessageSpecifier
|
string
$labelMsg
,
int
$weight
=
0
,
array
$data
=
[]
)
{
$this
->
id
=
$id
;
$this
->
icon
=
$icon
;
$this
->
labelMsg
=
$labelMsg
;
$this
->
weight
=
$weight
;
$this
->
data
=
$data
;
}
public
function
parseLabel
(
MessageLocalizer
$contextSource
,
array
&
$msgCache
):
void
{
$labelMsg
=
$this
->
labelMsg
;
if
(
is_string
(
$labelMsg
)
)
{
if
(
!
isset
(
$msgCache
[
$labelMsg
]
)
)
{
$msgCache
[
$labelMsg
]
=
$contextSource
->
msg
(
$labelMsg
)->
text
();
}
$this
->
label
=
$msgCache
[
$labelMsg
];
}
else
{
$this
->
label
=
$contextSource
->
msg
(
$labelMsg
)->
text
();
}
}
public
function
jsonSerialize
():
array
{
$data
=
$this
->
data
;
// Add 'id' into the 'data' array, for easier access with OOUI's getData() method
$data
[
'id'
]
=
$this
->
id
;
return
[
'id'
=>
$this
->
id
,
'data'
=>
$data
,
'icon'
=>
$this
->
icon
,
'label'
=>
$this
->
label
,
];
}
public
function
getId
():
string
{
return
$this
->
id
;
}
public
function
getWeight
():
int
{
return
$this
->
weight
;
}
}
File Metadata
Details
Attached
Mime Type
text/x-php
Expires
Sun, Nov 22, 05:05 (1 d, 3 h)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
66/81/fda90cac2a341d437380d3c545d6
Default Alt Text
OverflowMenuItem.php (2 KB)
Attached To
Mode
rMWPROD MediaWiki Production
Attached
Detach File
Event Timeline
Log In to Comment