From 6ca5decdb474165b9feb290e363175e792feb93b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Steffen=20Schro=CC=88der?= Date: Tue, 20 May 2014 14:59:17 +0200 Subject: [PATCH] PHPDoc improvements Replaced deprecated method call --- application/core/Admin/AdminLists.php | 1 - application/core/Admin/AuthCommands.php | 2 +- application/core/Configurators/ManiaControlSettings.php | 5 ++--- application/core/Configurators/ServerSettings.php | 6 +++++- application/core/Manialinks/ManialinkManager.php | 2 +- application/core/Maps/MapCommands.php | 4 ++-- application/core/Players/PlayerCommands.php | 2 +- application/core/Plugins/PluginMenu.php | 7 +++---- application/core/Statistics/SimpleStatsList.php | 9 +++++---- application/plugins/MCTeam/ChatMessagePlugin.php | 2 +- application/plugins/MCTeam/ChatlogPlugin.php | 3 +++ application/plugins/MCTeam/DonationPlugin.php | 2 +- application/plugins/TheM/QueuePlugin.php | 4 ++-- 13 files changed, 27 insertions(+), 22 deletions(-) diff --git a/application/core/Admin/AdminLists.php b/application/core/Admin/AdminLists.php index 7de660b1..e66474e0 100644 --- a/application/core/Admin/AdminLists.php +++ b/application/core/Admin/AdminLists.php @@ -2,7 +2,6 @@ namespace ManiaControl\Admin; -use FML\Controls\Control; use FML\Controls\Frame; use FML\Controls\Labels\Label_Button; use FML\Controls\Labels\Label_Text; diff --git a/application/core/Admin/AuthCommands.php b/application/core/Admin/AuthCommands.php index d76428b6..84b06f5f 100644 --- a/application/core/Admin/AuthCommands.php +++ b/application/core/Admin/AuthCommands.php @@ -149,7 +149,7 @@ class AuthCommands implements CommandListener { } /** - * Send usage example for //addop command + * Send usage example for //addmod command * * @param Player $player * @return bool diff --git a/application/core/Configurators/ManiaControlSettings.php b/application/core/Configurators/ManiaControlSettings.php index 6f26ce45..48bc0222 100644 --- a/application/core/Configurators/ManiaControlSettings.php +++ b/application/core/Configurators/ManiaControlSettings.php @@ -351,9 +351,8 @@ class ManiaControlSettings implements ConfiguratorMenu, CallbackListener { return; } - $oldSetting = $this->maniaControl->settingManager->getSettingByIndex($settingIndex); - - if (!isset($oldSetting)) { + $oldSetting = $this->maniaControl->settingManager->getSettingObjectByIndex($settingIndex); + if (!$oldSetting) { var_dump('no setting ' . $settingIndex); return; } diff --git a/application/core/Configurators/ServerSettings.php b/application/core/Configurators/ServerSettings.php index 2a31c6ac..90c3b83d 100644 --- a/application/core/Configurators/ServerSettings.php +++ b/application/core/Configurators/ServerSettings.php @@ -123,7 +123,11 @@ class ServerSettings implements ConfiguratorMenu, CallbackListener { return true; } - $this->maniaControl->client->setServerOptions($serverSettings); + try { + $this->maniaControl->client->setServerOptions($serverSettings); + } catch (ServerOptionsException $exception) { + $this->maniaControl->chat->sendExceptionToAdmins($exception); + } return true; } diff --git a/application/core/Manialinks/ManialinkManager.php b/application/core/Manialinks/ManialinkManager.php index 85882ad9..ce0d1340 100644 --- a/application/core/Manialinks/ManialinkManager.php +++ b/application/core/Manialinks/ManialinkManager.php @@ -104,7 +104,7 @@ class ManialinkManager implements ManialinkPageAnswerListener, CallbackListener $this->pageAnswerRegexListener[$actionIdRegex] = array(); } - // Register page answer reg exlistener + // Register page answer regex listener array_push($this->pageAnswerRegexListener[$actionIdRegex], array($listener, $method)); return true; diff --git a/application/core/Maps/MapCommands.php b/application/core/Maps/MapCommands.php index 7723436f..95c530ee 100644 --- a/application/core/Maps/MapCommands.php +++ b/application/core/Maps/MapCommands.php @@ -103,7 +103,7 @@ class MapCommands implements CommandListener, ManialinkPageAnswerListener, Callb /** * Shows which map is the next * - * @param array $chat + * @param array $chatCallback * @param Player $player */ public function command_ShowNextMap(array $chatCallback, Player $player) { @@ -126,7 +126,7 @@ class MapCommands implements CommandListener, ManialinkPageAnswerListener, Callb /** * Handle removemap command * - * @param array $chat + * @param array $chatCallback * @param Player $player */ public function command_RemoveMap(array $chatCallback, Player $player) { diff --git a/application/core/Players/PlayerCommands.php b/application/core/Players/PlayerCommands.php index e1a6d5f6..7e63a0fb 100644 --- a/application/core/Players/PlayerCommands.php +++ b/application/core/Players/PlayerCommands.php @@ -64,7 +64,7 @@ class PlayerCommands implements CommandListener, ManialinkPageAnswerListener, Ca //CallbackManager $this->maniaControl->callbackManager->registerCallbackListener(Server::CB_TEAM_MODE_CHANGED, $this, 'teamStatusChanged'); - // Action Open Playerlist + // Action Open PlayerList $this->maniaControl->manialinkManager->registerManialinkPageAnswerListener(self::ACTION_OPEN_PLAYERLIST, $this, 'command_playerList'); $itemQuad = new Quad_UIConstruction_Buttons(); $itemQuad->setSubStyle($itemQuad::SUBSTYLE_Author); diff --git a/application/core/Plugins/PluginMenu.php b/application/core/Plugins/PluginMenu.php index 541300de..caf83cfe 100644 --- a/application/core/Plugins/PluginMenu.php +++ b/application/core/Plugins/PluginMenu.php @@ -248,7 +248,7 @@ class PluginMenu implements CallbackListener, ConfiguratorMenu, ManialinkPageAns * @return Frame */ private function getPluginSettingsMenu(Frame $frame, $width, $height, Paging $paging, Player $player, $settingClass) { - // TODO: use maniacontrolsettings menu + // TODO: use maniacontrol settings menu $settings = $this->maniaControl->settingManager->getSettingsByClass($settingClass); $pageSettingsMaxCount = 12; @@ -416,9 +416,8 @@ class PluginMenu implements CallbackListener, ConfiguratorMenu, ManialinkPageAns return; } - $oldSetting = $this->maniaControl->settingManager->getSettingByIndex($settingIndex); - - if (!isset($oldSetting)) { + $oldSetting = $this->maniaControl->settingManager->getSettingObjectByIndex($settingIndex); + if (!$oldSetting) { var_dump('no setting with index: ' . $settingIndex); return; } diff --git a/application/core/Statistics/SimpleStatsList.php b/application/core/Statistics/SimpleStatsList.php index c856b2da..ebcf4cec 100644 --- a/application/core/Statistics/SimpleStatsList.php +++ b/application/core/Statistics/SimpleStatsList.php @@ -78,20 +78,21 @@ class SimpleStatsList implements ManialinkPageAnswerListener, CallbackListener, $this->registerStat(StatisticCollector::STAT_ON_CAPTURE, 60, "C"); $this->registerStat(StatisticManager::SPECIAL_STAT_KD_RATIO, 70, "K/D", 12, StatisticManager::STAT_TYPE_FLOAT); - $this->registerStat(StatisticManager::SPECIAL_STAT_LASER_ACC, 80, "Lacc", 15, StatisticManager::STAT_TYPE_FLOAT); + $this->registerStat(StatisticManager::SPECIAL_STAT_LASER_ACC, 80, "LAcc", 15, StatisticManager::STAT_TYPE_FLOAT); $this->registerStat(StatisticManager::SPECIAL_STAT_HITS_PH, 85, "H/h", 15, StatisticManager::STAT_TYPE_FLOAT); } /** * Register a Certain Stat * - * @param $statName - * @param $order - * @param $headShortCut + * @param string $statName + * @param int $order + * @param string $headShortCut * @param int $width * @param string $format */ public function registerStat($statName, $order, $headShortCut, $width = 10, $format = StatisticManager::STAT_TYPE_INT) { + // TODO: use own model class $this->statArray[$order] = array(); $this->statArray[$order]["Name"] = $statName; $this->statArray[$order]["HeadShortCut"] = '$o' . $headShortCut; diff --git a/application/plugins/MCTeam/ChatMessagePlugin.php b/application/plugins/MCTeam/ChatMessagePlugin.php index 60487942..1d71edcc 100644 --- a/application/plugins/MCTeam/ChatMessagePlugin.php +++ b/application/plugins/MCTeam/ChatMessagePlugin.php @@ -96,7 +96,7 @@ class ChatMessagePlugin implements CommandListener, Plugin { $this->maniaControl->commandManager->registerCommandListener('afk', $this, 'chat_afk', false, 'Writes an away from keyboard message to the chat.'); $this->maniaControl->commandManager->registerCommandListener(array('bm', 'bootme'), $this, 'chat_bootme', false, 'Gets you away from this server quickly!'); $this->maniaControl->commandManager->registerCommandListener(array('rq', 'ragequit'), $this, 'chat_ragequit', false, 'Gets you away from this server in rage!'); - //TODO block commandlistener for muted people + //TODO block command listener for muted people $this->maniaControl->settingManager->initSetting($this, self::SETTING_AFK_FORCE_SPEC, true); return true; diff --git a/application/plugins/MCTeam/ChatlogPlugin.php b/application/plugins/MCTeam/ChatlogPlugin.php index 44d8b139..1cf1988c 100644 --- a/application/plugins/MCTeam/ChatlogPlugin.php +++ b/application/plugins/MCTeam/ChatlogPlugin.php @@ -101,6 +101,8 @@ class ChatlogPlugin implements CallbackListener, Plugin { /** * Build the Log File Name and Folder + * + * @return bool */ private function buildLogFileName() { $folderName = $this->maniaControl->settingManager->getSettingValue($this, self::SETTING_FOLDERNAME); @@ -132,6 +134,7 @@ class ChatlogPlugin implements CallbackListener, Plugin { } } $this->fileName = $folderDir . DIRECTORY_SEPARATOR . $fileName; + return true; } /** diff --git a/application/plugins/MCTeam/DonationPlugin.php b/application/plugins/MCTeam/DonationPlugin.php index 1679bb3b..3a8c88ff 100644 --- a/application/plugins/MCTeam/DonationPlugin.php +++ b/application/plugins/MCTeam/DonationPlugin.php @@ -108,7 +108,7 @@ class DonationPlugin implements CallbackListener, CommandListener, Plugin { // Register for commands $this->maniaControl->commandManager->registerCommandListener('donate', $this, 'command_Donate', false, 'Donate some planets to the server.'); $this->maniaControl->commandManager->registerCommandListener('pay', $this, 'command_Pay', true, 'Pays planets from the server to a player.'); - $this->maniaControl->commandManager->registerCommandListener('planets', $this, 'command_GetPlanets', true, 'Checks the planets-balance of the server.'); + $this->maniaControl->commandManager->registerCommandListener(array('getplanets', 'planets'), $this, 'command_GetPlanets', true, 'Checks the planets-balance of the server.'); $this->maniaControl->commandManager->registerCommandListener('topdons', $this, 'command_TopDons', false, 'Provides an overview of who donated the most planets.'); // Register for callbacks diff --git a/application/plugins/TheM/QueuePlugin.php b/application/plugins/TheM/QueuePlugin.php index df7abc25..7b19e86b 100644 --- a/application/plugins/TheM/QueuePlugin.php +++ b/application/plugins/TheM/QueuePlugin.php @@ -44,7 +44,7 @@ class QueuePlugin implements CallbackListener, ManialinkPageAnswerListener, Time const QUEUE_WIDGET_POS_X = 'X position of the widget'; const QUEUE_WIDGET_POS_Y = 'Y position of the widget'; const QUEUE_ACTIVE_ON_PASS = 'Activate queue when there is a play password'; - const QUEUE_CHATMESSAGES = 'Activate chatmessages on queue join/leave/move to play'; + const QUEUE_CHATMESSAGES = 'Activate chat messages on queue join/leave/move to play'; /** * Private properties @@ -432,7 +432,7 @@ class QueuePlugin implements CallbackListener, ManialinkPageAnswerListener, Time } /** - * Function sends (or not depending on setting) chatmessages for the queue. + * Function sends (or not depending on setting) chat messages for the queue. * * @param string $message */