From 08cad46cfc66f32f3bb9d4f449e87a05dc744d8c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Steffen=20Schro=CC=88der?= Date: Sat, 12 Apr 2014 12:14:37 +0200 Subject: [PATCH] added license and copyright annotations improved phpdoc --- .gitignore | 4 +-- application/core/Admin/ActionsMenu.php | 6 ++-- application/core/Admin/AdminLists.php | 30 ++++++++++++------- application/core/Admin/AuthCommands.php | 6 ++-- .../core/Admin/AuthenticationManager.php | 8 +++-- application/core/Bills/BillData.php | 21 ++++++++++--- application/core/Bills/BillManager.php | 20 +++++++------ .../core/Callbacks/CallbackListener.php | 4 ++- .../core/Callbacks/CallbackManager.php | 8 +++-- .../core/Callbacks/ShootManiaCallbacks.php | 4 ++- application/core/Callbacks/TimerListener.php | 14 +++++---- application/core/Callbacks/TimerManager.php | 20 ++++++++----- application/core/Chat.php | 11 ++++--- application/core/ColorUtil.php | 4 ++- application/core/Commands/CommandListener.php | 4 ++- application/core/Commands/CommandManager.php | 5 ++-- application/core/Commands/HelpManager.php | 11 +++---- .../core/Configurators/Configurator.php | 10 ++++--- .../core/Configurators/ConfiguratorMenu.php | 2 ++ .../Configurators/ManiaControlSettings.php | 18 ++++++----- .../core/Configurators/ScriptSettings.php | 6 ++-- .../core/Configurators/ServerSettings.php | 7 +++-- application/core/Database.php | 12 ++++---- application/core/ErrorHandler.php | 6 ++-- .../core/Files/AsynchronousFileReader.php | 9 ++++-- application/core/Files/FileUtil.php | 4 ++- application/core/Formatter.php | 4 ++- application/core/ManiaControl.php | 15 ++++------ application/core/ManiaExchange/MXMapInfo.php | 6 ++-- .../core/ManiaExchange/ManiaExchangeList.php | 7 +++-- .../ManiaExchange/ManiaExchangeManager.php | 8 +++-- .../core/Manialinks/CustomUIManager.php | 7 +++-- application/core/Manialinks/IconManager.php | 4 ++- .../core/Manialinks/ManialinkManager.php | 15 +++++----- .../ManialinkPageAnswerListener.php | 6 ++-- application/core/Manialinks/StyleManager.php | 10 ++++--- application/core/Maps/Map.php | 4 ++- application/core/Maps/MapCommands.php | 8 +++-- application/core/Maps/MapList.php | 6 ++-- application/core/Maps/MapManager.php | 2 ++ application/core/Maps/MapQueue.php | 12 ++++---- application/core/Players/Player.php | 8 ++--- application/core/Players/PlayerActions.php | 10 ++++--- application/core/Players/PlayerCommands.php | 6 ++-- application/core/Players/PlayerDetailed.php | 8 +++-- application/core/Players/PlayerList.php | 6 ++-- application/core/Players/PlayerManager.php | 8 +++-- application/core/Plugins/Plugin.php | 4 ++- application/core/Plugins/PluginManager.php | 8 +++-- application/core/Plugins/PluginMenu.php | 10 ++++--- application/core/Server/Config.php | 4 ++- application/core/Server/RankingManager.php | 18 ++++++----- application/core/Server/Server.php | 9 +++--- application/core/Server/ServerCommands.php | 10 ++++--- application/core/Server/UsageReporter.php | 6 ++-- application/core/Settings/SettingManager.php | 8 +++-- .../core/Statistics/SimpleStatsList.php | 12 ++++++-- .../core/Statistics/StatisticCollector.php | 18 ++++++----- .../core/Statistics/StatisticManager.php | 8 +++-- application/core/Update/UpdateData.php | 18 ++++++++--- application/core/Update/UpdateManager.php | 2 ++ 61 files changed, 345 insertions(+), 204 deletions(-) diff --git a/.gitignore b/.gitignore index c2a85a16..f09c8c8d 100644 --- a/.gitignore +++ b/.gitignore @@ -2,6 +2,4 @@ /application/.idea/ /.settings/ /.buildpath -/.project -/updates/ -/versions/ \ No newline at end of file +/.project \ No newline at end of file diff --git a/application/core/Admin/ActionsMenu.php b/application/core/Admin/ActionsMenu.php index 34be4218..b006ef6c 100644 --- a/application/core/Admin/ActionsMenu.php +++ b/application/core/Admin/ActionsMenu.php @@ -20,9 +20,11 @@ use ManiaControl\Players\PlayerManager; * Class managing Actions Menus * * @author steeffeen & kremsy + * @copyright ManiaControl Copyright © 2014 ManiaControl Team + * @license http://www.gnu.org/licenses/ GNU General Public License, Version 3 */ class ActionsMenu implements CallbackListener, ManialinkPageAnswerListener { - /** + /* * Constants */ const MLID_MENU = 'ActionsMenu.MLID'; @@ -32,7 +34,7 @@ class ActionsMenu implements CallbackListener, ManialinkPageAnswerListener { const ACTION_OPEN_ADMIN_MENU = 'ActionsMenu.OpenAdminMenu'; const ACTION_OPEN_PLAYER_MENU = 'ActionsMenu.OpenPlayerMenu'; - /** + /* * Private Properties */ private $maniaControl = null; diff --git a/application/core/Admin/AdminLists.php b/application/core/Admin/AdminLists.php index 23f4381f..c751541f 100644 --- a/application/core/Admin/AdminLists.php +++ b/application/core/Admin/AdminLists.php @@ -1,14 +1,7 @@ maniaControl->callbackManager->registerCallbackListener(ManialinkManager::CB_MAIN_WINDOW_OPENED, $this, 'handleWidgetOpened'); $this->maniaControl->callbackManager->registerCallbackListener(AuthenticationManager::CB_AUTH_LEVEL_CHANGED, $this, 'updateWidget'); - // Menu Entry AdminList $this->maniaControl->manialinkManager->registerManialinkPageAnswerListener(self::ACTION_OPEN_ADMINLISTS, $this, 'openAdminList'); $itemQuad = new Quad_UIConstruction_Buttons(); @@ -60,10 +59,21 @@ class AdminLists implements ManialinkPageAnswerListener, CallbackListener { $this->maniaControl->actionsMenu->addMenuItem($itemQuad, false, 50, 'Open Adminlist'); } + /** + * Open Admin List Action + * + * @param array $callback + * @param Player $player + */ public function openAdminList(array $callback, Player $player) { $this->showAdminLists($player); } + /** + * Show the Admin List + * + * @param Player $player + */ public function showAdminLists(Player $player) { $this->adminListShown[$player->login] = true; diff --git a/application/core/Admin/AuthCommands.php b/application/core/Admin/AuthCommands.php index 0a2f874a..6dac2baa 100644 --- a/application/core/Admin/AuthCommands.php +++ b/application/core/Admin/AuthCommands.php @@ -7,12 +7,14 @@ use ManiaControl\Commands\CommandListener; use ManiaControl\Players\Player; /** - * Class offering commands to grant authorizations to players + * Class offering Commands to grant Authorizations to Players * * @author steeffeen & kremsy + * @copyright ManiaControl Copyright © 2014 ManiaControl Team + * @license http://www.gnu.org/licenses/ GNU General Public License, Version 3 */ class AuthCommands implements CommandListener { - /** + /* * Private properties */ private $maniaControl = null; diff --git a/application/core/Admin/AuthenticationManager.php b/application/core/Admin/AuthenticationManager.php index 374a4fb3..3eee8835 100644 --- a/application/core/Admin/AuthenticationManager.php +++ b/application/core/Admin/AuthenticationManager.php @@ -12,9 +12,11 @@ use ManiaControl\Players\PlayerManager; * Class managing Authentication Levels * * @author steeffeen & kremsy + * @copyright ManiaControl Copyright © 2014 ManiaControl Team + * @license http://www.gnu.org/licenses/ GNU General Public License, Version 3 */ class AuthenticationManager implements CallbackListener { - /** + /* * Constants */ const AUTH_LEVEL_PLAYER = 0; @@ -24,12 +26,12 @@ class AuthenticationManager implements CallbackListener { const AUTH_LEVEL_MASTERADMIN = 4; const CB_AUTH_LEVEL_CHANGED = 'AuthenticationManager.AuthLevelChanged'; - /** + /* * Public Properties */ public $authCommands = null; - /** + /* * Private Properties */ private $maniaControl = null; diff --git a/application/core/Bills/BillData.php b/application/core/Bills/BillData.php index 298a97bb..2a0d70f2 100644 --- a/application/core/Bills/BillData.php +++ b/application/core/Bills/BillData.php @@ -1,13 +1,18 @@ function = $function; $this->player = $player; diff --git a/application/core/Bills/BillManager.php b/application/core/Bills/BillManager.php index f57d35de..9d2f7d26 100644 --- a/application/core/Bills/BillManager.php +++ b/application/core/Bills/BillManager.php @@ -1,11 +1,6 @@ maniaControl = $maniaControl; } - /** * Registers a One Time Listening * @@ -129,4 +133,4 @@ class TimerManager { } } } -} \ No newline at end of file +} diff --git a/application/core/Chat.php b/application/core/Chat.php index de2e4edf..c5b922fc 100644 --- a/application/core/Chat.php +++ b/application/core/Chat.php @@ -1,15 +1,18 @@ playerCommands, array("Name" => $name, "Description" => $description)); } } - -} \ No newline at end of file +} diff --git a/application/core/Configurators/Configurator.php b/application/core/Configurators/Configurator.php index 43ca8871..527199c7 100644 --- a/application/core/Configurators/Configurator.php +++ b/application/core/Configurators/Configurator.php @@ -21,12 +21,14 @@ use ManiaControl\Manialinks\ManialinkPageAnswerListener; use ManiaControl\Players\Player; /** - * Class managing ingame ManiaControl configuration + * Class managing ingame ManiaControl Configuration * * @author steeffeen & kremsy + * @copyright ManiaControl Copyright © 2014 ManiaControl Team + * @license http://www.gnu.org/licenses/ GNU General Public License, Version 3 */ class Configurator implements CallbackListener, CommandListener, ManialinkPageAnswerListener { - /** + /* * Constants */ const ACTION_TOGGLEMENU = 'Configurator.ToggleMenuAction'; @@ -39,8 +41,8 @@ class Configurator implements CallbackListener, CommandListener, ManialinkPageAn const SETTING_MENU_STYLE = 'Menu Widget BackgroundQuad Style'; const SETTING_MENU_SUBSTYLE = 'Menu Widget BackgroundQuad Substyle'; - /** - * Private properties + /* + * Private Properties */ private $maniaControl = null; private $scriptSettings = null; diff --git a/application/core/Configurators/ConfiguratorMenu.php b/application/core/Configurators/ConfiguratorMenu.php index 4c889064..eb70c509 100644 --- a/application/core/Configurators/ConfiguratorMenu.php +++ b/application/core/Configurators/ConfiguratorMenu.php @@ -9,6 +9,8 @@ use ManiaControl\Players\Player; * Interface for Configurator Menus * * @author steeffeen & kremsy + * @copyright ManiaControl Copyright © 2014 ManiaControl Team + * @license http://www.gnu.org/licenses/ GNU General Public License, Version 3 */ interface ConfiguratorMenu { diff --git a/application/core/Configurators/ManiaControlSettings.php b/application/core/Configurators/ManiaControlSettings.php index 09a76ad7..582f08d7 100644 --- a/application/core/Configurators/ManiaControlSettings.php +++ b/application/core/Configurators/ManiaControlSettings.php @@ -1,11 +1,6 @@ name); } } - -} \ No newline at end of file +} diff --git a/application/core/Players/Player.php b/application/core/Players/Player.php index 0a76a3d9..46955506 100644 --- a/application/core/Players/Player.php +++ b/application/core/Players/Player.php @@ -8,10 +8,12 @@ use ManiaControl\Formatter; * Player Model Class * * @author kremsy & steeffeen + * @copyright ManiaControl Copyright © 2014 ManiaControl Team + * @license http://www.gnu.org/licenses/ GNU General Public License, Version 3 */ class Player { - /** - * Public properties + /* + * Public Properties */ public $index = -1; public $pid = -1; @@ -56,7 +58,6 @@ class Player { public $autoTarget = false; public $currentTargetId = 0; - /** * Construct a player from ManiaPlanet Player structure * @@ -114,7 +115,6 @@ class Player { } } - /** * Check if player is not a real player * diff --git a/application/core/Players/PlayerActions.php b/application/core/Players/PlayerActions.php index d13426dd..b0d72e1a 100644 --- a/application/core/Players/PlayerActions.php +++ b/application/core/Players/PlayerActions.php @@ -14,12 +14,14 @@ use ManiaControl\Manialinks\ManialinkManager; use Maniaplanet\DedicatedServer\Xmlrpc\Exception; /** - * PlayerActions Class + * Player Actions Class * * @author steeffeen & kremsy + * @copyright ManiaControl Copyright © 2014 ManiaControl Team + * @license http://www.gnu.org/licenses/ GNU General Public License, Version 3 */ class PlayerActions { - /** + /* * Constants */ const TEAM_BLUE = 0; @@ -29,7 +31,7 @@ class PlayerActions { const SPECTATOR_PLAYER = 2; const SPECTATOR_BUT_KEEP_SELECTABLE = 3; - /** + /* * Permission Setting Constants */ const SETTING_PERMISSION_FORCE_PLAYER_PLAY = 'Force Player to Play'; @@ -40,7 +42,7 @@ class PlayerActions { const SETTING_PERMISSION_KICK_PLAYER = 'Kick Player'; const SETTING_PERMISSION_BAN_PLAYER = 'Ban Player'; - /** + /* * Private Properties */ private $maniaControl = null; diff --git a/application/core/Players/PlayerCommands.php b/application/core/Players/PlayerCommands.php index be0793b3..23cc3ad8 100644 --- a/application/core/Players/PlayerCommands.php +++ b/application/core/Players/PlayerCommands.php @@ -16,9 +16,11 @@ use Maniaplanet\DedicatedServer\Xmlrpc\Exception; * Class offering various Admin Commands related to Players * * @author steeffeen & kremsy + * @copyright ManiaControl Copyright © 2014 ManiaControl Team + * @license http://www.gnu.org/licenses/ GNU General Public License, Version 3 */ class PlayerCommands implements CommandListener, ManialinkPageAnswerListener, CallbackListener { - /** + /* * Constants */ const ACTION_BALANCE_TEAMS = 'PlayerCommands.BalanceTeams'; @@ -26,7 +28,7 @@ class PlayerCommands implements CommandListener, ManialinkPageAnswerListener, Ca const SETTING_PERMISSION_ADD_BOT = 'Add Bot'; const SETTING_PERMISSION_TEAM_BALANCE = 'Balance Teams'; - /** + /* * Private Properties */ private $maniaControl = null; diff --git a/application/core/Players/PlayerDetailed.php b/application/core/Players/PlayerDetailed.php index dacfb7a4..aba4fbe4 100644 --- a/application/core/Players/PlayerDetailed.php +++ b/application/core/Players/PlayerDetailed.php @@ -19,15 +19,17 @@ use ManiaControl\Statistics\StatisticManager; * Player Detailed Page * * @author steeffeen & kremsy + * @copyright ManiaControl Copyright © 2014 ManiaControl Team + * @license http://www.gnu.org/licenses/ GNU General Public License, Version 3 */ class PlayerDetailed { - /** + /* * Constants */ const STATS_PER_COLUMN = 13; - /** - * Private properties + /* + * Private Properties */ private $maniaControl = null; diff --git a/application/core/Players/PlayerList.php b/application/core/Players/PlayerList.php index f91f2a77..73ef1494 100644 --- a/application/core/Players/PlayerList.php +++ b/application/core/Players/PlayerList.php @@ -29,9 +29,11 @@ use Maniaplanet\DedicatedServer\Xmlrpc\Exception; * PlayerList Widget Class * * @author steeffeen & kremsy + * @copyright ManiaControl Copyright © 2014 ManiaControl Team + * @license http://www.gnu.org/licenses/ GNU General Public License, Version 3 */ class PlayerList implements ManialinkPageAnswerListener, CallbackListener, TimerListener { - /** + /* * Constants */ const ACTION_FORCE_RED = 'PlayerList.ForceRed'; @@ -57,7 +59,7 @@ class PlayerList implements ManialinkPageAnswerListener, CallbackListener, Timer const SHOWN_MAIN_WINDOW = -1; const MAX_PLAYERS_PER_PAGE = 15; - /** + /* * Private Properties */ private $maniaControl = null; diff --git a/application/core/Players/PlayerManager.php b/application/core/Players/PlayerManager.php index a5bcee7b..9b6094b2 100644 --- a/application/core/Players/PlayerManager.php +++ b/application/core/Players/PlayerManager.php @@ -15,9 +15,11 @@ use Maniaplanet\DedicatedServer\Xmlrpc\Exception; * Class managing Players * * @author kremsy & steeffeen + * @copyright ManiaControl Copyright © 2014 ManiaControl Team + * @license http://www.gnu.org/licenses/ GNU General Public License, Version 3 */ class PlayerManager implements CallbackListener, TimerListener { - /** + /* * Constants */ const CB_PLAYERCONNECT = 'PlayerManagerCallback.PlayerConnect'; @@ -28,7 +30,7 @@ class PlayerManager implements CallbackListener, TimerListener { const STAT_JOIN_COUNT = 'Joins'; const STAT_SERVERTIME = 'Servertime'; - /** + /* * Public Properties */ public $playerActions = null; @@ -38,7 +40,7 @@ class PlayerManager implements CallbackListener, TimerListener { public $adminLists = null; public $players = array(); - /** + /* * Private Properties */ private $maniaControl = null; diff --git a/application/core/Plugins/Plugin.php b/application/core/Plugins/Plugin.php index f99ed964..b3046a2a 100644 --- a/application/core/Plugins/Plugin.php +++ b/application/core/Plugins/Plugin.php @@ -8,9 +8,11 @@ use ManiaControl\ManiaControl; * Interface for ManiaControl Plugins * * @author steeffeen & kremsy + * @copyright ManiaControl Copyright © 2014 ManiaControl Team + * @license http://www.gnu.org/licenses/ GNU General Public License, Version 3 */ interface Plugin { - /** + /* * Constants */ const PLUGIN_INTERFACE = __CLASS__; diff --git a/application/core/Plugins/PluginManager.php b/application/core/Plugins/PluginManager.php index e70f1a30..c7d51f5c 100644 --- a/application/core/Plugins/PluginManager.php +++ b/application/core/Plugins/PluginManager.php @@ -10,15 +10,17 @@ use ManiaControl\Manialinks\ManialinkPageAnswerListener; * Class managing Plugins * * @author steeffeen & kremsy + * @copyright ManiaControl Copyright © 2014 ManiaControl Team + * @license http://www.gnu.org/licenses/ GNU General Public License, Version 3 */ class PluginManager { - /** + /* * Constants */ const TABLE_PLUGINS = 'mc_plugins'; - /** - * Private properties + /* + * Private Properties */ private $maniaControl = null; private $pluginMenu = null; diff --git a/application/core/Plugins/PluginMenu.php b/application/core/Plugins/PluginMenu.php index 3ae5874e..737de6b6 100644 --- a/application/core/Plugins/PluginMenu.php +++ b/application/core/Plugins/PluginMenu.php @@ -21,12 +21,14 @@ use ManiaControl\Manialinks\ManialinkPageAnswerListener; use ManiaControl\Players\Player; /** - * Configurator for enabling and disabling plugins + * Configurator for enabling and disabling Plugins * * @author steeffeen + * @copyright ManiaControl Copyright © 2014 ManiaControl Team + * @license http://www.gnu.org/licenses/ GNU General Public License, Version 3 */ class PluginMenu implements CallbackListener, ConfiguratorMenu, ManialinkPageAnswerListener { - /** + /* * Constants */ const ACTION_PREFIX_ENABLEPLUGIN = 'PluginMenu.Enable.'; @@ -37,8 +39,8 @@ class PluginMenu implements CallbackListener, ConfiguratorMenu, ManialinkPageAns const ACTION_BACK_TO_PLUGINS = 'PluginMenu.BackToPlugins'; const SETTING_PERMISSION_CHANGE_PLUGIN_SETTINGS = 'Change Plugin Settings'; - /** - * Private properties + /* + * Private Properties */ private $maniaControl = null; private $settingsClass = ''; //TODO needs to be improved diff --git a/application/core/Server/Config.php b/application/core/Server/Config.php index 6738304b..85598c05 100644 --- a/application/core/Server/Config.php +++ b/application/core/Server/Config.php @@ -6,10 +6,12 @@ namespace ManiaControl\Server; * Model Class holding the Server Config * * @author steeffeen + * @copyright ManiaControl Copyright © 2014 ManiaControl Team + * @license http://www.gnu.org/licenses/ GNU General Public License, Version 3 */ class Config { /* - * Public properties + * Public Properties */ public $id = null; public $host = null; diff --git a/application/core/Server/RankingManager.php b/application/core/Server/RankingManager.php index ec15c7da..c58e8b95 100644 --- a/application/core/Server/RankingManager.php +++ b/application/core/Server/RankingManager.php @@ -1,24 +1,28 @@ version = $updateData->version; $this->channel = $updateData->channel; $this->url = $updateData->url; $this->releaseDate = $updateData->release_date; } -} \ No newline at end of file +} diff --git a/application/core/Update/UpdateManager.php b/application/core/Update/UpdateManager.php index 3557f37f..46a80012 100644 --- a/application/core/Update/UpdateManager.php +++ b/application/core/Update/UpdateManager.php @@ -16,6 +16,8 @@ use ManiaControl\Plugins\Plugin; * Manager checking for ManiaControl Core and Plugin Updates * * @author steeffeen & kremsy + * @copyright ManiaControl Copyright © 2014 ManiaControl Team + * @license http://www.gnu.org/licenses/ GNU General Public License, Version 3 */ class UpdateManager implements CallbackListener, CommandListener, TimerListener { /*