API Documentation
\
Lobby
Apps
CLI
UI

\Lobby\UIPanel

Manage panels

Summary

Methods
Properties
Constants
addTopItem()
removeTopItem()
getTopItems()
addLeftItem()
removeLeftItem()
getLeftItems()
addNotifyItem()
removeNotifyItem()
$topItems
$leftItems
$notifyItem
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$panelTopItemFormat
$panelLeftItemFormat
N/A

Properties

$topItems

$topItems : array

Type

array — Top panel"s items

$leftItems

$leftItems : array

Type

array — Left panel"s items

$notifyItem

$notifyItem :

Type

$panelTopItemFormat

$panelTopItemFormat : array

Type

array — Raw skeleton of a Top Panel item

$panelLeftItemFormat

$panelLeftItemFormat : array

Type

array — Raw skeleton of a Left Panel item

Methods

addTopItem()

addTopItem(string  $id, array  $info)

Add an item to the Top Panel

Parameters

string $id

Item ID
array $info

Item information

removeTopItem()

removeTopItem(string  $id, string  $position) : boolean

Remove an item from Top Panel

Parameters

string $id

ID of item to be removed
string $position

Position of item in Top Panel. Either "left" or "right"

Returns

boolean —

Whether item was removed

getTopItems()

getTopItems(string  $position = "left") : array

Get Top Panel items

Parameters

string $position

Items in which position to get

Returns

array —

Array of items

addLeftItem()

addLeftItem(string  $id, array  $info)

Add an item to the Left Panel

Parameters

string $id

Item ID
array $info

Item information

removeLeftItem()

removeLeftItem(string  $id, string  $position) : boolean

Remove an item from Left Panel

Parameters

string $id

ID of item to be removed
string $position

Position of item in Left Panel. Either "top" or "bottom"

Returns

boolean —

Whether item was removed

getLeftItems()

getLeftItems(string  $position = "left") : array

Get Left Panel items

Parameters

string $position

Items in which position to get

Returns

array —

Array of items

addNotifyItem()

addNotifyItem(  $id,   $info)

Push an item to Notify

Parameters

$id
$info

removeNotifyItem()

removeNotifyItem(  $id)

Remove an item from Notify

Parameters

$id