Constants

SETTING_PREFIX

SETTING_PREFIX

SETTING_FORMAT_INFORMATION

SETTING_FORMAT_INFORMATION

SETTING_FORMAT_SUCCESS

SETTING_FORMAT_SUCCESS

SETTING_FORMAT_ERROR

SETTING_FORMAT_ERROR

SETTING_FORMAT_USAGEINFO

SETTING_FORMAT_USAGEINFO

CHAT_BUFFER_SIZE

CHAT_BUFFER_SIZE

Properties

$chatBuffer

$chatBuffer : 

Type

Methods

getUsageInformation()

getUsageInformation() 

Gets Information about the Class, and a List of the Public Method

__construct()

__construct(\ManiaControl\ManiaControl  $maniaControl) 

Construct chat utility

Parameters

\ManiaControl\ManiaControl $maniaControl

sendInformation()

sendInformation(string  $message, string  $login = null, string|boolean  $prefix = true) : boolean

Send an information message to the given login

Parameters

string $message
string $login
string|boolean $prefix

Returns

boolean

sendChat()

sendChat(string  $message, string  $login = null, string|boolean  $prefix = true) : boolean

Send a chat message to the given login

Parameters

string $message
string $login
string|boolean $prefix

Returns

boolean

sendErrorToAdmins()

sendErrorToAdmins(string  $message, integer  $minLevel = \ManiaControl\Admin\AuthenticationManager::AUTH_LEVEL_MODERATOR, boolean  $prefix = true) 

Send an Error Message to all Connected Admins

Parameters

string $message
integer $minLevel
boolean $prefix

sendMessageToAdmins()

sendMessageToAdmins(string  $message, integer  $minLevel = \ManiaControl\Admin\AuthenticationManager::AUTH_LEVEL_MODERATOR, boolean|string  $prefix = true) : boolean

Send a Message to all connected Admins

Parameters

string $message
integer $minLevel
boolean|string $prefix

Returns

boolean

sendSuccess()

sendSuccess(string  $message, string  $login = null, boolean|string  $prefix = true) : boolean

Send a success message to the given login

Parameters

string $message
string $login
boolean|string $prefix

Returns

boolean

sendInformationToAdmins()

sendInformationToAdmins(string  $message, integer  $minLevel = \ManiaControl\Admin\AuthenticationManager::AUTH_LEVEL_MODERATOR, boolean|string  $prefix = true) : boolean

Sends a Information Message to all connected Admins

Parameters

string $message
integer $minLevel
boolean|string $prefix

Returns

boolean

sendSuccessToAdmins()

sendSuccessToAdmins(string  $message, integer  $minLevel = \ManiaControl\Admin\AuthenticationManager::AUTH_LEVEL_MODERATOR, boolean|string  $prefix = true) : boolean

Sends a Success Message to all connected Admins

Parameters

string $message
integer $minLevel
boolean|string $prefix

Returns

boolean

sendException()

sendException(\Exception  $exception, string  $login = null) : boolean

Send the Exception Information to the Chat

Parameters

\Exception $exception
string $login

Returns

boolean

sendError()

sendError(string  $message, string  $login = null, string|boolean  $prefix = true) : boolean

Send an Error Message to the Chat

Parameters

string $message
string $login
string|boolean $prefix

Returns

boolean

sendExceptionToAdmins()

sendExceptionToAdmins(\Exception  $exception, integer  $minLevel = \ManiaControl\Admin\AuthenticationManager::AUTH_LEVEL_MODERATOR, boolean|string  $prefix = true) 

Send a Exception Message to all Connected Admins

Parameters

\Exception $exception
integer $minLevel
boolean|string $prefix

sendUsageInfo()

sendUsageInfo(string  $message, string  $login = null, string|boolean  $prefix = false) : boolean

Send an usage info message to the given login

Parameters

string $message
string $login
string|boolean $prefix

Returns

boolean

communcationSendChat()

communcationSendChat(  $data) : array

Handles SendChat Communication Request

Parameters

$data

Returns

array

onPlayerChat()

onPlayerChat(  $data) 

Stores the ChatMessage in the Buffer

Parameters

$data

buildPrefix()

buildPrefix(string|boolean  $prefixParam, string|array  $login = null) : string

Build the chat message prefix

Parameters

string|boolean $prefixParam
string|array $login

Returns

string