TrackManiaControl/application/core/Chat.php

131 lines
3.7 KiB
PHP
Raw Normal View History

2013-11-09 17:24:03 +01:00
<?php
namespace ManiaControl;
/**
* Chat utility class
2013-11-09 17:24:03 +01:00
*
* @author steeffeen & kremsy
2013-11-09 17:24:03 +01:00
*/
class Chat {
/**
* Constants
*/
const SETTING_PREFIX = 'Messages Prefix';
const SETTING_FORMAT_INFORMATION = 'Information Format';
const SETTING_FORMAT_SUCCESS = 'Success Format';
const SETTING_FORMAT_ERROR = 'Error Format';
const SETTING_FORMAT_USAGEINFO = 'UsageInfo Format';
2013-11-09 17:24:03 +01:00
/**
* Private properties
*/
private $maniaControl = null;
2013-11-09 17:24:03 +01:00
/**
* Construct chat utility
*
* @param ManiaControl $maniaControl
*/
public function __construct(ManiaControl $maniaControl) {
$this->maniaControl = $maniaControl;
// Init settings
$this->maniaControl->settingManager->initSetting($this, self::SETTING_PREFIX, 'MC» ');
$this->maniaControl->settingManager->initSetting($this, self::SETTING_FORMAT_INFORMATION, '$fff');
$this->maniaControl->settingManager->initSetting($this, self::SETTING_FORMAT_SUCCESS, '$0f0');
$this->maniaControl->settingManager->initSetting($this, self::SETTING_FORMAT_ERROR, '$f00');
$this->maniaControl->settingManager->initSetting($this, self::SETTING_FORMAT_USAGEINFO, '$f80');
}
2013-11-09 17:24:03 +01:00
/**
* Get prefix
*
* @param string|bool $prefix
* @return string
2013-11-09 17:24:03 +01:00
*/
private function getPrefix($prefix) {
if (is_string($prefix)) {
return $prefix;
}
if ($prefix === true) {
return $this->maniaControl->settingManager->getSetting($this, self::SETTING_PREFIX);
}
return '';
2013-11-09 17:24:03 +01:00
}
/**
* Send a chat message to the given login
*
* @param string $message
* @param string $login
* @param string|bool $prefix
* @return bool
2013-11-09 17:24:03 +01:00
*/
public function sendChat($message, $login = null, $prefix = true) {
if (!$this->maniaControl->client) {
return false;
2013-11-09 17:24:03 +01:00
}
$client = $this->maniaControl->client;
$chatMessage = '$z$<' . $this->getPrefix($prefix) . $message . '$>$z';
if ($login === null) {
return $client->query('ChatSendServerMessage', $chatMessage);
2013-11-09 17:24:03 +01:00
}
return $client->query('ChatSendServerMessageToLogin', $chatMessage, $login);
2013-11-09 17:24:03 +01:00
}
/**
* Send an information message to the given login
*
* @param string $message
* @param string $login
* @param string|bool $prefix
* @return bool
2013-11-09 17:24:03 +01:00
*/
public function sendInformation($message, $login = null, $prefix = true) {
$format = $this->maniaControl->settingManager->getSetting($this, self::SETTING_FORMAT_INFORMATION);
2013-11-09 17:24:03 +01:00
return $this->sendChat($format . $message, $login);
}
/**
* Send a success message to the given login
*
* @param string $message
* @param string $login
* @param string|bool $prefix
* @return bool
2013-11-09 17:24:03 +01:00
*/
public function sendSuccess($message, $login = null, $prefix = true) {
$format = $this->maniaControl->settingManager->getSetting($this, self::SETTING_FORMAT_SUCCESS);
2013-11-09 17:24:03 +01:00
return $this->sendChat($format . $message, $login);
}
/**
* Send an error message to the given login
*
* @param string $message
* @param string $login
* @param string|bool $prefix
* @return bool
2013-11-09 17:24:03 +01:00
*/
public function sendError($message, $login = null, $prefix = true) {
$format = $this->maniaControl->settingManager->getSetting($this, self::SETTING_FORMAT_ERROR);
2013-11-09 17:24:03 +01:00
return $this->sendChat($format . $message, $login);
}
/**
* Send an usage info message to the given login
*
* @param string $message
* @param string $login
* @param string|bool $prefix
* @return bool
*/
public function sendUsageInfo($message, $login = null, $prefix = false) {
$format = $this->maniaControl->settingManager->getSetting($this, self::SETTING_FORMAT_USAGEINFO);
return $this->sendChat($format . $message, $login);
}
2013-11-09 17:24:03 +01:00
}
?>