com.woltlab.wcf.message.sidebar.data.message.sidebar
Represents a message sidebar.
| Type | Name |
|---|---|
MessageSidebarObject |
$object |
array |
$userContacts |
array |
$userCredits |
string |
$usernameStyle |
static UserOptions |
$userOptions |
array |
$userSymbols |
| Return | Name |
|---|---|
MessageSidebar |
__construct(MessageSidebarObject $object, UserProfile $user)
|
void |
addUserContact(string $value)
|
void |
addUserCredit(string $name, string $value, [string $url = ''])
|
void |
addUserSymbol(string $value)
|
integer |
getMessageID()
|
MessageSidebarObject |
getSidebarObject()
|
string |
getStyledUsername()
|
UserProfile |
getUser()
|
array |
getUserContacts()
|
array |
getUserCredits()
|
static array |
getUserOptions()
|
array |
getUserSymbols()
|
public MessageSidebarObject $object = null
sidebar object.
public array $userContacts = array()
list of user contacts
public array $userCredits = array()
list of user credits
public string $usernameStyle = '%s'
special username styling
protected static UserOptions $userOptions = null
user options
public array $userSymbols = array()
list of user symbols
public MessageSidebar __construct(MessageSidebarObject $object, UserProfile $user)
Creates a new MessageSidebar object.
$user $object public void addUserContact(string $value)
Adds a user contact option to the sidebar.
$value public void addUserCredit(string $name, string $value, [string $url = ''])
Adds a user credit to the sidebar.
$name $value $url public void addUserSymbol(string $value)
Adds a user symbol to the sidebar.
$value public integer getMessageID()
Returns the message id.
public MessageSidebarObject getSidebarObject()
Returns the sidebar object.
public string getStyledUsername()
Returns a special username styles.
public UserProfile getUser()
Returns the user object.
public array getUserContacts()
Returns the user contacts.
public array getUserCredits()
Returns the user credits.
protected static array getUserOptions()
Returns the cached user options.
public array getUserSymbols()
Returns the user symbols.