added license and copyright annotations

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

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;

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() {

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;

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;

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;