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

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

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;

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;

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;

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;

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;