added, fixed & improved PHPDoc & Type Hints

This commit is contained in:
Steffen Schröder
2014-05-02 16:13:45 +02:00
parent 7469d97712
commit 212517d290
32 changed files with 157 additions and 89 deletions

View File

@ -203,7 +203,6 @@ class PlayerActions {
*
* @param string $adminLogin
* @param string $targetLogin
* @param int $spectatorState
*/
public function unMutePlayer($adminLogin, $targetLogin) {
$admin = $this->maniaControl->playerManager->getPlayer($adminLogin);
@ -236,7 +235,6 @@ class PlayerActions {
*
* @param string $adminLogin
* @param string $targetLogin
* @param int $spectatorState
*/
public function mutePlayer($adminLogin, $targetLogin) {
$admin = $this->maniaControl->playerManager->getPlayer($adminLogin);

View File

@ -167,8 +167,8 @@ class PlayerCommands implements CommandListener, ManialinkPageAnswerListener, Ca
* @param array $chatCallback
* @param Player $player
*/
public function command_Warn(array $chat, Player $player) {
$params = explode(' ', $chat[1][2], 3);
public function command_Warn(array $chatCallback, Player $player) {
$params = explode(' ', $chatCallback[1][2], 3);
if (count($params) <= 1) {
$this->maniaControl->chat->sendUsageInfo("No Login given! Example: '//kick login'", $player->login);
return;

View File

@ -116,16 +116,16 @@ class PlayerDataManager {
/**
* Gets the Player Data
*
* @param $object
* @param $dataName
* @param mixed $object
* @param string $dataName
* @param Player $player
* @param $serverIndex
* @param int $serverIndex
* @return mixed|null
*/
public function getPlayerData($object, $statName, Player $player, $serverIndex = -1) {
public function getPlayerData($object, $dataName, Player $player, $serverIndex = -1) {
$className = $this->getClassName($object);
$meta = $this->metaData[$className . $statName];
$meta = $this->metaData[$className . $dataName];
//Check if data is already in the ram
if (isset($this->storedData[$player->index])) {
@ -152,7 +152,7 @@ class PlayerDataManager {
}
$dataStatement->store_result();
if ($dataStatement->num_rows <= 0) {
$this->setPlayerData($object, $statName, $player, $meta->defaultValue, $serverIndex);
$this->setPlayerData($object, $dataName, $player, $meta->defaultValue, $serverIndex);
return $meta->default;
}
$dataStatement->bind_result($value);
@ -172,11 +172,11 @@ class PlayerDataManager {
/**
* Set a PlayerData to a specific defined statMetaData
*
* @param $object
* @param $statName
* @param mixed $object
* @param string $dataName
* @param Player $player
* @param $value
* @param $serverIndex (let it empty if its global)
* @param mixed $value
* @param int $serverIndex (let it empty if its global)
* @return bool
*/
public function setPlayerData($object, $dataName, Player $player, $value, $serverIndex = -1) {
@ -225,7 +225,8 @@ class PlayerDataManager {
/**
* Return the Id of the MetaData
*
* @param $statName
* @param string $className
* @param string $statName
* @return int
*/
private function getMetaDataId($className, $statName) {

View File

@ -14,6 +14,7 @@ use ManiaControl\Formatter;
use ManiaControl\ManiaControl;
use ManiaControl\Manialinks\ManialinkManager;
use ManiaControl\Statistics\StatisticManager;
use Maniaplanet\DedicatedServer\Structures\Player;
/**
* Player Detailed Page
@ -48,8 +49,14 @@ class PlayerDetailed {
$this->quadSubstyle = $this->maniaControl->manialinkManager->styleManager->getDefaultMainWindowSubStyle();
}
/**
* Show a Frame with detailed Information about the Target Player
*
* @param Player $player
* @param string $targetLogin
*/
public function showPlayerDetailed(Player $player, $targetLogin) {
/** @var Player $target */
$target = $this->maniaControl->playerManager->getPlayer($targetLogin);
//Create ManiaLink
@ -209,7 +216,13 @@ class PlayerDetailed {
$this->maniaControl->manialinkManager->displayWidget($maniaLink, $player, 'PlayerDetailed');
}
public function statisticsFrame($player) {
/**
* Build a Frame with Statistics about the given Player
*
* @param Player $player
* @return Frame
*/
public function statisticsFrame(Player $player) {
$frame = new Frame();
$playerStats = $this->maniaControl->statisticManager->getAllPlayerStats($player);

View File

@ -2,6 +2,7 @@
namespace ManiaControl\Players;
use Maniaplanet\DedicatedServer\Structures\Player;
use MCTeam\CustomVotesPlugin;
use FML\Controls\Control;
use FML\Controls\Frame;
@ -412,10 +413,11 @@ class PlayerList implements ManialinkPageAnswerListener, CallbackListener, Timer
/**
* Extra window with special actions on players like warn,kick, ban, authorization levels...
*
* @param $login
* @param Player $admin
* @param string $login
* @return Frame
*/
public function showAdvancedPlayerWidget($admin, $login) {
public function showAdvancedPlayerWidget(Player $admin, $login) {
$player = $this->maniaControl->playerManager->getPlayer($login);
$width = $this->maniaControl->manialinkManager->styleManager->getListWidgetsWidth();
$height = $this->maniaControl->manialinkManager->styleManager->getListWidgetsHeight();

View File

@ -306,7 +306,7 @@ class PlayerManager implements CallbackListener, TimerListener {
*
* @param string $login
* @param bool $connectedPlayersOnly
* @return Player|null
* @return Player
*/
public function getPlayer($login, $connectedPlayersOnly = false) {
if (!isset($this->players[$login])) {
@ -390,10 +390,10 @@ class PlayerManager implements CallbackListener, TimerListener {
/**
* Get's a Player out of the database
* Get a Player from the Database
*
* @param $playerIndex
* @return Player $player
* @param string $playerLogin
* @return Player
*/
private function getPlayerFromDatabaseByLogin($playerLogin) {
$mysqli = $this->maniaControl->database->mysqli;