beu/TrackManiaControl
1
0
Fork 0
Code Issues 11 Pull Requests Releases Wiki Activity

added license and copyright annotations

Browse Source 
improved phpdoc
This commit is contained in:
Steffen Schröder 2014-04-12 12:14:37 +02:00
parent 07a63cf518
commit 08cad46cfc
61 changed files with 345 additions and 204 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.gitignore vendored
View File

@ -3,5 +3,3 @@
/.settings/
/.buildpath
/.project
/updates/
/versions/

6
application/core/Admin/ActionsMenu.php
View File

@ -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;

30
application/core/Admin/AdminLists.php
View File

@ -1,14 +1,7 @@
<?php
/**
* Created by PhpStorm.
* User: Lukas
* Date: 31.01.14
* Time: 12:54
*/
namespace ManiaControl\Admin;
use FML\Controls\Control;
use FML\Controls\Frame;
use FML\Controls\Labels\Label_Button;
@ -25,15 +18,22 @@ use ManiaControl\Manialinks\ManialinkManager;
use ManiaControl\Manialinks\ManialinkPageAnswerListener;
use ManiaControl\Players\Player;
/**
* Widget Class listing Authorized Players
*
* @author kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
class AdminLists implements ManialinkPageAnswerListener, CallbackListener {
/**
/*
* Constants
*/
const ACTION_OPEN_ADMINLISTS = "AdminList.OpenAdminLists";
const ACTION_REVOKE_RIGHTS = "AdminList.RevokeRights";
const MAX_PLAYERS_PER_PAGE = 15;
/**
/*
* Private Properties
*/
private $adminListShown = array();
@ -51,7 +51,6 @@ class AdminLists implements ManialinkPageAnswerListener, CallbackListener {
$this->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;

6
application/core/Admin/AuthCommands.php
View File

@ -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;

8
application/core/Admin/AuthenticationManager.php
View File

@ -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;

21
application/core/Bills/BillData.php
View File

@ -1,13 +1,18 @@
<?php
namespace ManiaControl\Bills;
/**
* ManiaControl BillData Structure
*
* @author kremsy and steeffeen
* @author kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
namespace ManiaControl\Bills;
class BillData {
/*
* Public Properties
*/
public $function = null;
public $pay = false;
public $player = null;
@ -15,6 +20,14 @@ class BillData {
public $amount = 0;
public $creationTime = -1;
/**
* Construct new BillData
* @param unknown $function
* @param unknown $player
* @param unknown $amount
* @param string $pay
* @param string $receiverLogin
*/
public function __construct($function, $player, $amount, $pay = false, $receiverLogin = false) {
$this->function = $function;
$this->player = $player;

18
application/core/Bills/BillManager.php
View File

@ -1,11 +1,6 @@
<?php
/**
* ManiaControl Bill-Manager
*
* @author kremsy and steeffeen
*/
namespace ManiaControl\Bills;
namespace ManiaControl\Bills;
use ManiaControl\Callbacks\CallbackListener;
use ManiaControl\Callbacks\CallbackManager;
@ -14,8 +9,15 @@ use ManiaControl\Players\Player;
use Maniaplanet\DedicatedServer\Structures\Bill;
use Maniaplanet\DedicatedServer\Xmlrpc\Exception;
/**
* ManiaControl Bill-Manager
*
* @author kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
class BillManager implements CallbackListener {
/**
/*
* Constants
*/
const DONATED_TO_SERVER = 1;
@ -24,7 +26,7 @@ class BillManager implements CallbackListener {
const PLAYER_REFUSED_DONATION = 4;
const ERROR_WHILE_TRANSACTION = 5;
/**
/*
* Private Properties
*/
private $maniaControl = null;

4
application/core/Callbacks/CallbackListener.php
View File

@ -6,9 +6,11 @@ namespace ManiaControl\Callbacks;
* Interface for CallbackListener
*
* @author steeffeen & kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
interface CallbackListener {
/**
/*
* Constants
*/
const CALLBACKLISTENER_INTERFACE = __CLASS__;

8
application/core/Callbacks/CallbackManager.php
View File

@ -8,9 +8,11 @@ use ManiaControl\ManiaControl;
* Class for managing Server and ManiaControl Callbacks
*
* @author steeffeen & kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
class CallbackManager {
/**
/*
* Constants
*/
// ManiaControl callbacks
@ -44,12 +46,12 @@ class CallbackManager {
const CB_TM_PLAYERINCOHERENCE = 'TrackMania.PlayerIncoherence';
/*
* Public proeprties
* Public Properties
*/
public $shootManiaCallbacks = null;
/*
* Private properties
* Private Properties
*/
private $maniaControl = null;
private $callbackListeners = array();

4
application/core/Callbacks/ShootManiaCallbacks.php
View File

@ -8,6 +8,8 @@ use ManiaControl\ManiaControl;
* Class handling and parsing ShootMania Callbacks
*
* @author steeffeen
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
class ShootManiaCallbacks implements CallbackListener {
/*
@ -23,7 +25,7 @@ class ShootManiaCallbacks implements CallbackListener {
const SCB_TIMEATTACK_ONFINISH = 'TimeAttack_OnFinish';
/*
* Private properties
* Private Properties
*/
private $maniaControl = null;

12
application/core/Callbacks/TimerListener.php
View File

@ -1,14 +1,16 @@
<?php
namespace ManiaControl\Callbacks;
/**
* Interface for TimerListener
*
* @author steeffeen & kremsy
* @author kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
namespace ManiaControl\Callbacks;
interface TimerListener {
/**
/*
* Constants
*/
const TIMERLISTENER_INTERFACE = __CLASS__;

18
application/core/Callbacks/TimerManager.php
View File

@ -1,15 +1,20 @@
<?php
/**
* Class for managing Timers
*
* @author steeffeen & kremsy
*/
namespace ManiaControl\Callbacks;
namespace ManiaControl\Callbacks;
use ManiaControl\ManiaControl;
/**
* Class for managing Timers
*
* @author kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
class TimerManager {
/*
* Private Properties
*/
private $maniaControl = null;
private $timerListenings = array();
@ -22,7 +27,6 @@ class TimerManager {
$this->maniaControl = $maniaControl;
}
/**
* Registers a One Time Listening
*

11
application/core/Chat.php
View File

@ -1,15 +1,18 @@
<?php
namespace ManiaControl;
use Maniaplanet\DedicatedServer\Xmlrpc\Exception;
/**
* Chat utility class
* Chat Utility Class
*
* @author steeffeen & kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
class Chat {
/**
/*
* Constants
*/
const SETTING_PREFIX = 'Messages Prefix';
@ -18,8 +21,8 @@ class Chat {
const SETTING_FORMAT_ERROR = 'Error Format';
const SETTING_FORMAT_USAGEINFO = 'UsageInfo Format';
/**
* Private properties
/*
* Private Properties
*/
private $maniaControl = null;

4
application/core/ColorUtil.php
View File

@ -3,9 +3,11 @@
namespace ManiaControl;
/**
* Utility class offering methods to convert and use ManiaPlanet colors
* Utility Class offering Methods to convert and use ManiaPlanet Colors
*
* @author steeffeen
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
abstract class ColorUtil {

4
application/core/Commands/CommandListener.php
View File

@ -3,9 +3,11 @@
namespace ManiaControl\Commands;
/**
* Interface for command listeners
* Interface for Command Listeners
*
* @author steeffeen & kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
interface CommandListener {
}

5
application/core/Commands/CommandManager.php
View File

@ -9,11 +9,12 @@ use ManiaControl\ManiaControl;
/**
* Class for handling Chat Commands
*
* @property mixed commandListeners
* @author steeffeen & kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
class CommandManager implements CallbackListener {
/**
/*
* Private Properties
*/
private $maniaControl = null;

9
application/core/Commands/HelpManager.php
View File

@ -8,12 +8,14 @@ use ManiaControl\ManiaControl;
use ManiaControl\Players\Player;
/**
* ManiaControl Chat-Message Plugin
* Help Manager
*
* @author kremsy and steeffeen
* @author kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
class HelpManager implements CommandListener, CallbackListener {
/**
/*
* Private Properties
*/
private $maniaControl = null;
@ -87,5 +89,4 @@ class HelpManager implements CommandListener, CallbackListener {
array_push($this->playerCommands, array("Name" => $name, "Description" => $description));
}
}
}

10
application/core/Configurators/Configurator.php
View File

@ -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;

2
application/core/Configurators/ConfiguratorMenu.php
View File

@ -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 {

18
application/core/Configurators/ManiaControlSettings.php
View File

@ -1,11 +1,6 @@
<?php
/**
* Class offering a Configurator for Script Settings
*
* @author steeffeen & kremsy
*/
namespace ManiaControl\Configurators;
namespace ManiaControl\Configurators;
use FML\Controls\Control;
use FML\Controls\Entry;
@ -20,8 +15,15 @@ use ManiaControl\Callbacks\CallbackManager;
use ManiaControl\ManiaControl;
use ManiaControl\Players\Player;
/**
* Class offering a Configurator for ManiaControl Settings
*
* @author steeffeen & kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
class ManiaControlSettings implements ConfiguratorMenu, CallbackListener {
/**
/*
* Constants
*/
const TITLE = 'ManiaControl Settings';
@ -29,7 +31,7 @@ class ManiaControlSettings implements ConfiguratorMenu, CallbackListener {
const ACTION_SETTING_BOOL = 'ManiaControlSettings.ActionBoolSetting.';
const SETTING_PERMISSION_CHANGE_MC_SETTINGS = 'Change ManiaControl Settings';
/**
/*
* Private Properties
*/
private $maniaControl = null;

6
application/core/Configurators/ScriptSettings.php
View File

@ -21,9 +21,11 @@ use ManiaControl\Maps\Map;
* Class offering a Configurator for Script Settings
*
* @author steeffeen & kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
class ScriptSettings implements ConfiguratorMenu, CallbackListener {
/**
/*
* Constants
*/
const ACTION_PREFIX_SETTING = 'ScriptSetting';
@ -33,7 +35,7 @@ class ScriptSettings implements ConfiguratorMenu, CallbackListener {
const TABLE_SCRIPT_SETTINGS = 'mc_scriptsettings';
const SETTING_LOAD_DEFAULT_SETTINGS_MAP_BEGIN = 'Load Stored Script-Settings on Map-Begin';
/**
/*
* Private Properties
*/
private $maniaControl = null;

7
application/core/Configurators/ServerSettings.php
View File

@ -14,14 +14,15 @@ use ManiaControl\Callbacks\CallbackManager;
use ManiaControl\ManiaControl;
use ManiaControl\Players\Player;
/**
* Class offering a Configurator for Server Settings
*
* @author steeffeen & kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
class ServerSettings implements ConfiguratorMenu, CallbackListener {
/**
/*
* Constants
*/
const ACTION_PREFIX_SETTING = 'ServerSettings';
@ -30,7 +31,7 @@ class ServerSettings implements ConfiguratorMenu, CallbackListener {
const CB_SERVERSETTINGS_CHANGED = 'ServerSettings.SettingsChanged';
const TABLE_SERVER_SETTINGS = 'mc_serversettings';
/**
/*
* Private Properties
*/
private $maniaControl = null;

12
application/core/Database.php
View File

@ -5,18 +5,20 @@ namespace ManiaControl;
use ManiaControl\Callbacks\TimerListener;
/**
* Database connection class
* Database Connection Class
*
* @author steeffeen & kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
class Database implements TimerListener {
/**
* Public properties
/*
* Public Properties
*/
public $mysqli = null;
/**
* Private properties
/*
* Private Properties
*/
private $maniaControl = null;

6
application/core/ErrorHandler.php
View File

@ -9,14 +9,16 @@ use ManiaControl\Update\UpdateManager;
* Error and Exception Manager Class
*
* @author steeffeen & kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
class ErrorHandler {
/**
/*
* Constants
*/
const MC_DEBUG_NOTICE = "ManiaControl.DebugNotice";
/**
/*
* Private Properties
*/
private $maniaControl = null;

9
application/core/Files/AsynchronousFileReader.php
View File

@ -1,4 +1,5 @@
<?php
namespace ManiaControl\Files;
use cURL\Exception;
@ -9,17 +10,19 @@ use ManiaControl\ManiaControl;
/**
* Asynchronous File Reader
*
* @author kremsy & steeffeen
* @author kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
class AsynchronousFileReader {
/**
/*
* Private Properties
*/
private $maniaControl = null;
private $requests = array();
/**
* Construct
* Construct FileReader
*
* @param ManiaControl $maniaControl
*/

4
application/core/Files/FileUtil.php
View File

@ -6,9 +6,11 @@ use ManiaControl\ManiaControl;
use ManiaControl\Formatter;
/**
* File utility class
* Files Utility Class
*
* @author steeffeen & kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
abstract class FileUtil {

4
application/core/Formatter.php
View File

@ -6,11 +6,13 @@ namespace ManiaControl;
* Class offering Methods to format Texts and Values
*
* @author steeffeen & kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
abstract class Formatter {
/**
* Formats the given Time (Milliseconds)
* Format the given Time (in Milliseconds)
*
* @param int $time
* @return string

15
application/core/ManiaControl.php
View File

@ -40,7 +40,7 @@ require_once __DIR__ . '/Libs/curl-easy/autoload.php';
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
class ManiaControl implements CommandListener, TimerListener {
/**
/*
* Constants
*/
const VERSION = '0.01';
@ -53,8 +53,8 @@ class ManiaControl implements CommandListener, TimerListener {
const SETTING_PERMISSION_SHUTDOWN = 'Shutdown ManiaControl';
const SETTING_PERMISSION_RESTART = 'Restart ManiaControl';
/**
* Public properties
/*
* Public Properties
*/
public $actionsMenu = null;
public $authenticationManager = null;
@ -62,10 +62,7 @@ class ManiaControl implements CommandListener, TimerListener {
public $chat = null;
public $config = null;
public $configurator = null;
/**
*
* @var Connection $client
*/
/** @var Connection $client */
public $client = null;
public $commandManager = null;
public $database = null;
@ -82,8 +79,8 @@ class ManiaControl implements CommandListener, TimerListener {
public $fileReader = null;
public $billManager = null;
/**
* Private properties
/*
* Private Properties
*/
private $shutdownRequested = false;

4
application/core/ManiaExchange/MXMapInfo.php
View File

@ -8,7 +8,9 @@ use ManiaControl\Formatter;
* Mania Exchange Map Info Object
*
* @author Xymph
* @updated lukas and steeffeen
* @updated kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
class MXMapInfo {
public $prefix, $id, $uid, $name, $userid, $author, $uploaded, $updated, $type, $maptype;

7
application/core/ManiaExchange/ManiaExchangeList.php
View File

@ -23,14 +23,15 @@ use ManiaControl\Maps\MapCommands;
use ManiaControl\Maps\MapQueue;
use ManiaControl\Players\Player;
/**
* ManiaExchange List Widget Class
*
* @author steeffeen & kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
class ManiaExchangeList implements CallbackListener, ManialinkPageAnswerListener {
/**
/*
* Constants
*/
const ACTION_ADD_MAP = 'ManiaExchangeList.AddMap';
@ -39,7 +40,7 @@ class ManiaExchangeList implements CallbackListener, ManialinkPageAnswerListener
const ACTION_GET_MAPS_FROM_AUTHOR = 'ManiaExchangeList.GetMapsFromAuthor';
const MAX_MX_MAPS_PER_PAGE = 14;
/**
/*
* Private Properties
*/
private $maniaControl = null;

8
application/core/ManiaExchange/ManiaExchangeManager.php
View File

@ -11,9 +11,11 @@ use Maniaplanet\DedicatedServer\Xmlrpc\Exception;
* Mania Exchange Info Searcher Class
*
* @author steeffeen & kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
class ManiaExchangeManager{
/**
/*
* Constants
*/
//Search others
@ -41,8 +43,8 @@ class ManiaExchangeManager{
//Beta Testing Activated
const SETTING_MP3_BETA_TESTING = 'Activate MP3 Beta Testing';
/**
* Private Propertieswc
/*
* Private Properties
*/
private $maniaControl = null;
private $mxIdUidVector = array();

7
application/core/Manialinks/CustomUIManager.php
View File

@ -13,15 +13,16 @@ use ManiaControl\Players\PlayerManager;
* Class managing the Custom UI Settings
*
* @author steeffeen & kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
class CustomUIManager implements CallbackListener, TimerListener {
/**
/*
* Constants
*/
const CUSTOMUI_MLID = 'CustomUI.MLID';
/**
/*
* Private Properties
*/
private $maniaControl = null;

4
application/core/Manialinks/IconManager.php
View File

@ -15,9 +15,11 @@ use ManiaControl\Players\Player;
* Class managing Icons
*
* @author steeffeen & kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
class IconManager implements CallbackListener {
/**
/*
* Constants
*/
const DEFAULT_IMG_URL = 'http://images.maniacontrol.com/icons/';

15
application/core/Manialinks/ManialinkManager.php
View File

@ -13,13 +13,14 @@ use ManiaControl\Players\Player;
use Maniaplanet\DedicatedServer\Xmlrpc\Exception;
/**
* Manialink manager class
* Manialink Manager Class
*
* @author steeffeen & kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
class ManialinkManager implements ManialinkPageAnswerListener, CallbackListener {
/**
/*
* Constants
*/
const MAIN_MLID = 'Main.ManiaLinkId';
@ -27,15 +28,15 @@ class ManialinkManager implements ManialinkPageAnswerListener, CallbackListener
const CB_MAIN_WINDOW_CLOSED = 'ManialinkManagerCallback.MainWindowClosed';
const CB_MAIN_WINDOW_OPENED = 'ManialinkManagerCallback.MainWindowOpened';
/**
* Public properties
/*
* Public Properties
*/
public $styleManager = null;
public $customUIManager = null;
public $iconManager = null;
/**
* Private properties
/*
* Private Properties
*/
private $maniaControl = null;
private $pageAnswerListeners = array();

6
application/core/Manialinks/ManialinkPageAnswerListener.php
View File

@ -3,12 +3,14 @@
namespace ManiaControl\Manialinks;
/**
* Interface for manialink page answer listeners
* Interface for Manialink Page Answer Listeners
*
* @author steeffeen & kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
interface ManialinkPageAnswerListener {
/**
/*
* Constants
*/
const MANIALINKPAGEANSWERLISTENER_INTERFACE = __CLASS__;

10
application/core/Manialinks/StyleManager.php
View File

@ -13,12 +13,14 @@ use FML\Script\Script;
use ManiaControl\ManiaControl;
/**
* Class managing default control styles
* Class managing default Control Styles
*
* @author steeffeen & kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
class StyleManager {
/**
/*
* Constants
*/
const SETTING_LABEL_DEFAULT_STYLE = 'Default Label Style';
@ -32,8 +34,8 @@ class StyleManager {
const SETTING_ICON_DEFAULT_OFFSET_SM = 'Default Icon Offset in Shootmania';
/**
* Private properties
/*
* Private Properties
*/
private $maniaControl = null;

4
application/core/Maps/Map.php
View File

@ -9,9 +9,11 @@ use ManiaControl\ManiaExchange\MXMapInfo;
* Map Class
*
* @author kremsy & steeffeen
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
class Map {
/**
/*
* Public Properties
*/
public $index = -1;

8
application/core/Maps/MapCommands.php
View File

@ -14,12 +14,14 @@ use ManiaControl\Players\Player;
use Maniaplanet\DedicatedServer\Xmlrpc\Exception;
/**
* Class offering commands to manage maps
* Class offering Commands to manage Maps
*
* @author steeffeen & kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
class MapCommands implements CommandListener, ManialinkPageAnswerListener, CallbackListener {
/**
/*
* Constants
*/
const ACTION_OPEN_MAPLIST = 'MapCommands.OpenMapList';
@ -27,7 +29,7 @@ class MapCommands implements CommandListener, ManialinkPageAnswerListener, Callb
const ACTION_RESTART_MAP = 'MapCommands.RestartMap';
const ACTION_SKIP_MAP = 'MapCommands.NextMap';
/**
/*
* Private Properties
*/
private $maniaControl = null;

6
application/core/Maps/MapList.php
View File

@ -30,9 +30,11 @@ use Maniaplanet\DedicatedServer\Xmlrpc\Exception;
* MapList Widget Class
*
* @author steeffeen & kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
class MapList implements ManialinkPageAnswerListener, CallbackListener {
/**
/*
* Constants
*/
const ACTION_UPDATE_MAP = 'MapList.UpdateMap';
@ -47,7 +49,7 @@ class MapList implements ManialinkPageAnswerListener, CallbackListener {
const DEFAULT_KARMA_PLUGIN = 'KarmaPlugin';
const DEFAULT_CUSTOM_VOTE_PLUGIN = 'CustomVotesPlugin';
/**
/*
* Private Properties
*/
private $maniaControl = null;

2
application/core/Maps/MapManager.php
View File

@ -19,6 +19,8 @@ use Maniaplanet\DedicatedServer\Xmlrpc\Exception;
* Manager for Maps
*
* @author kremsy & steeffeen
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
class MapManager implements CallbackListener {
/*

10
application/core/Maps/MapQueue.php
View File

@ -14,9 +14,11 @@ use ManiaControl\Players\Player;
* MapQueue Class
*
* @author steeffeen & kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
class MapQueue implements CallbackListener, CommandListener {
/**
/*
* Constants
*/
const CB_MAPQUEUE_CHANGED = 'MapQueue.MapQueueBoxChanged';
@ -27,8 +29,9 @@ class MapQueue implements CallbackListener, CommandListener {
const ADMIN_COMMAND_CLEAR_MAPQUEUE = 'clearmapqueue';
const ADMIN_COMMAND_CLEAR_JUKEBOX = 'clearjukebox';
/**
* Private properties
/*
* Private Properties
*/
private $maniaControl = null;
private $queuedMaps = array();
@ -241,5 +244,4 @@ class MapQueue implements CallbackListener, CommandListener {
var_dump($map->name);
}
}
}

8
application/core/Players/Player.php
View File

@ -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
*

10
application/core/Players/PlayerActions.php
View File

@ -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;

6
application/core/Players/PlayerCommands.php
View File

@ -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;

8
application/core/Players/PlayerDetailed.php
View File

@ -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;

6
application/core/Players/PlayerList.php
View File

@ -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;

8
application/core/Players/PlayerManager.php
View File

@ -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;

4
application/core/Plugins/Plugin.php
View File

@ -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__;

8
application/core/Plugins/PluginManager.php
View File

@ -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;

10
application/core/Plugins/PluginMenu.php
View File

@ -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

4
application/core/Server/Config.php
View File

@ -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;

18
application/core/Server/RankingManager.php
View File

@ -1,24 +1,28 @@
<?php
/**
* Class managing Rankings
*
* @author steeffeen & kremsy
*/
namespace ManiaControl\Server;
namespace ManiaControl\Server;
use ManiaControl\Callbacks\CallbackListener;
use ManiaControl\Callbacks\CallbackManager;
use ManiaControl\ManiaControl;
use Maniaplanet\DedicatedServer\Xmlrpc\Exception;
/**
* Class managing Rankings
*
* @author kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
class RankingManager implements CallbackListener {
/**
/*
* Private Properties
*/
private $rankings = array();
/**
* Get Rankings
*
* @return mixed
*/
public function getRankings() {

9
application/core/Server/Server.php
View File

@ -8,12 +8,13 @@ use ManiaControl\ManiaControl;
use Maniaplanet\DedicatedServer\Xmlrpc\Exception;
/**
* Class providing Information about theconnected ManiaPlanet Server
* Class providing Access to the connected ManiaPlanet Server
*
* @author steeffeen & kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
class Server implements CallbackListener {
/*
* Constants
*/
@ -21,7 +22,7 @@ class Server implements CallbackListener {
const CB_TEAM_MODE_CHANGED = 'ServerCallback.TeamModeChanged';
/*
* Public properties
* Public Properties
*/
public $config = null;
public $index = -1;
@ -36,7 +37,7 @@ class Server implements CallbackListener {
public $rankingManager = null;
/*
* Private properties
* Private Properties
*/
private $maniaControl = null;
private $teamMode = false;

10
application/core/Server/ServerCommands.php
View File

@ -16,12 +16,14 @@ use ManiaControl\Players\Player;
use Maniaplanet\DedicatedServer\Xmlrpc\Exception;
/**
* Class offering various commands related to the dedicated server
* Class offering various Commands related to the Dedicated Server
*
* @author steeffeen & kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
class ServerCommands implements CallbackListener, CommandListener, ManialinkPageAnswerListener, TimerListener {
/**
/*
* Constants
*/
const ACTION_SET_PAUSE = 'ServerCommands.SetPause';
@ -36,8 +38,8 @@ class ServerCommands implements CallbackListener, CommandListener, ManialinkPage
const SETTING_PERMISSION_SHUTDOWN_SERVER = 'Shutdown Server';
const SETTING_PERMISSION_CHANGE_SERVERSETTINGS = 'Change ServerSettings';
/**
* Private properties
/*
* Private Properties
*/
private $maniaControl = null;
private $serverShutdownTime = -1;

6
application/core/Server/UsageReporter.php
View File

@ -12,15 +12,17 @@ use Maniaplanet\DedicatedServer\Xmlrpc\Exception;
* Class reporting ManiaControl Usage for the Server
*
* @author steeffeen & kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
class UsageReporter implements TimerListener {
/**
/*
* Constants
*/
const UPDATE_MINUTE_COUNT = 10;
const SETTING_DISABLE_USAGE_REPORTING = 'Disable Usage Reporting';
/**
/*
* Private Properties
*/
private $maniaControl = null;

8
application/core/Settings/SettingManager.php
View File

@ -10,9 +10,11 @@ use ManiaControl\ManiaControl;
* Class managing Settings and Configurations
*
* @author steeffeen & kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
class SettingManager implements CallbackListener {
/**
/*
* Constants
*/
const TABLE_SETTINGS = 'mc_settings';
@ -23,8 +25,8 @@ class SettingManager implements CallbackListener {
const TYPE_ARRAY = 'array';
const CB_SETTINGS_CHANGED = 'SettingManager.SettingsChanged';
/**
* Private properties
/*
* Private Properties
*/
private $maniaControl = null;
private $arrayDelimiter = ';;';

12
application/core/Statistics/SimpleStatsList.php
View File

@ -2,7 +2,6 @@
namespace ManiaControl\Statistics;
use FML\Controls\Control;
use FML\Controls\Frame;
use FML\Controls\Label;
@ -23,14 +22,21 @@ use ManiaControl\Manialinks\ManialinkPageAnswerListener;
use ManiaControl\Players\Player;
use ManiaControl\Players\PlayerManager;
/**
* Simple Stats List Class
*
* @author kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
class SimpleStatsList implements ManialinkPageAnswerListener, CallbackListener, CommandListener {
/**
/*
* Constants
*/
const ACTION_OPEN_STATSLIST = 'SimpleStatsList.OpenStatsList';
const ACTION_SORT_STATS = 'SimpleStatsList.SortStats';
/**
/*
* Private Properties
*/
private $maniaControl = null;

18
application/core/Statistics/StatisticCollector.php
View File

@ -1,11 +1,6 @@
<?php
/**
* Statistic Collector Class
*
* @author steeffeen & kremsy
*/
namespace ManiaControl\Statistics;
namespace ManiaControl\Statistics;
use ManiaControl\Callbacks\CallbackListener;
use ManiaControl\Callbacks\CallbackManager;
@ -13,8 +8,15 @@ use ManiaControl\ManiaControl;
use ManiaControl\Players\Player;
use ManiaControl\Players\PlayerManager;
/**
* Statistic Collector Class
*
* @author steeffeen & kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
class StatisticCollector implements CallbackListener {
/**
/*
* Constants
*/
const SETTING_COLLECT_STATS_ENABLED = 'Collect Stats Enabled';
@ -49,7 +51,7 @@ class StatisticCollector implements CallbackListener {
const WEAPON_NUCLEUS = 3;
const WEAPON_ARROW = 5;
/**
/*
* Private Properties
*/
private $maniaControl = null;

8
application/core/Statistics/StatisticManager.php
View File

@ -9,9 +9,11 @@ use ManiaControl\Players\Player;
* Statistic Manager Class
*
* @author steeffeen & kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
class StatisticManager {
/**
/*
* Constants
*/
const TABLE_STATMETADATA = 'mc_statmetadata';
@ -27,13 +29,13 @@ class StatisticManager {
const SPECIAL_STAT_ROCKET_ACC = 'Rocket Accuracy';
const SPECIAL_STAT_ARROW_ACC = 'Arrow Accuracy';
/**
/*
* Public Properties
*/
public $statisticCollector = null;
public $simpleStatsList = null;
/**
/*
* Private Properties
*/
private $maniaControl = null;

16
application/core/Update/UpdateData.php
View File

@ -1,18 +1,28 @@
<?php
namespace ManiaControl\Update;
/**
* UpdateStructure
*
* @author steeffeen & kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
namespace ManiaControl\Update;
class UpdateData {
/*
* Public Properties
*/
public $version = 0;
public $channel = "";
public $url = "";
public $releaseDate = "";
/**
* Construct new Update Data
*
* @param unknown $updateData
*/
public function __construct($updateData) {
$this->version = $updateData->version;
$this->channel = $updateData->channel;

2
application/core/Update/UpdateManager.php
View File

@ -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 {
/*