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

Improved PHPDoc, Type Hints & Parameter Names

Browse Source
This commit is contained in:
Steffen Schröder
2014-05-13 16:40:05 +02:00
parent 3e69e03292
commit 2a705e05d9
27 changed files with 434 additions and 447 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
application/plugins/MCTeam/ChatMessagePlugin.php
View File

@ -142,14 +142,14 @@ class ChatMessagePlugin implements CommandListener, Plugin {
* Checks if a Player is in the PlayerList and returns the nickname if he is, can be called per login, pid or nickname or lj for
* (last joined)
*
* @param $login
* @param mixed $login
* @return mixed
*/
private function getTarget($login) {
/** @var Player $player */
$player = null;
foreach ($this->maniaControl->playerManager->getPlayers() as $player) {
if ($login == $player->login || $login == $player->pid || $login == $player->nickname) {
if ($login == $player && $login == $player->login || $login == $player->pid || $login == $player->nickname) {
return $player->nickname;
}
}

22
application/plugins/MCTeam/CustomVotesPlugin.php
View File

@ -486,8 +486,8 @@ class CustomVotesPlugin implements CommandListener, CallbackListener, ManialinkP
/**
* Handle Standard Votes
*
* @param $voteName
* @param $voteResult
* @param string $voteName
* @param float $voteResult
*/
public function handleVoteFinished($voteName, $voteResult) {
if ($voteResult >= $this->currentVote->neededRatio) {
@ -563,9 +563,9 @@ class CustomVotesPlugin implements CommandListener, CallbackListener, ManialinkP
}
/**
* Undefines a Vote
* Undefine a Vote
*
* @param $voteIndex
* @param int $voteIndex
*/
public function undefineVote($voteIndex) {
unset($this->voteCommands[$voteIndex]);
@ -600,11 +600,9 @@ class CustomVotesPlugin implements CommandListener, CallbackListener, ManialinkP
}
/**
* Handle ManiaControl 1 Second callback
*
* @param $time
* Handle ManiaControl 1 Second Callback
*/
public function handle1Second($time) {
public function handle1Second() {
if (!isset($this->currentVote)) {
return;
}
@ -774,10 +772,10 @@ class VoteCommand {
/**
* Construct a new Vote Command
*
* @param $index
* @param $name
* @param $idBased
* @param $neededRatio
* @param int $index
* @param string $name
* @param bool $idBased
* @param float $neededRatio
*/
public function __construct($index, $name, $idBased, $neededRatio) {
$this->index = $index;

14
application/plugins/MCTeam/Dedimania/DedimaniaData.php
View File

@ -3,6 +3,7 @@
namespace MCTeam\Dedimania;
use ManiaControl\ManiaControl;
use ManiaControl\Players\Player;
use Maniaplanet\DedicatedServer\Structures\Version;
/**
@ -52,6 +53,11 @@ class DedimaniaData {
$this->serverBuild = $serverVersion->build;
}
/**
* Build the Data Array
*
* @return array
*/
public function toArray() {
$array = array();
foreach (get_object_vars($this) as $key => $value) {
@ -63,6 +69,11 @@ class DedimaniaData {
return $array;
}
/**
* Get the Number of Records
*
* @return int
*/
public function getRecordCount() {
return count($this->records);
}
@ -70,10 +81,11 @@ class DedimaniaData {
/**
* Get Max Rank for a certain Player
*
* @param $login
* @param mixed $login
* @return int
*/
public function getPlayerMaxRank($login) {
$login = Player::parseLogin($login);
$maxRank = $this->serverMaxRank;
foreach ($this->players as $player) {
/** @var DedimaniaPlayer $player */

46
application/plugins/MCTeam/Dedimania/DedimaniaPlugin.php
View File

@ -14,12 +14,12 @@ use ManiaControl\Callbacks\CallbackManager;
use ManiaControl\Callbacks\Callbacks;
use ManiaControl\Callbacks\TimerListener;
use ManiaControl\Commands\CommandListener;
use ManiaControl\Utils\Formatter;
use ManiaControl\ManiaControl;
use ManiaControl\Manialinks\ManialinkManager;
use ManiaControl\Players\Player;
use ManiaControl\Players\PlayerManager;
use ManiaControl\Plugins\Plugin;
use ManiaControl\Utils\Formatter;
/**
* ManiaControl Dedimania Plugin
@ -226,11 +226,11 @@ class DedimaniaPlugin implements CallbackListener, CommandListener, TimerListene
/**
* Handle xml rpc fault
*
* @param $fault
* @param $method
* @param array $fault
* @param string $method
*/
private function handleXmlRpcFault($fault, $method) {
trigger_error('XmlRpc Fault on ' . $method . ': ' . $fault['faultString'] . ' (' . $fault['faultCode'] . ')');
private function handleXmlRpcFault(array $fault, $method) {
trigger_error("XmlRpc Fault on '{$method}': '{$fault['faultString']} ({$fault['faultCode']})!");
}
/**
@ -505,11 +505,9 @@ class DedimaniaPlugin implements CallbackListener, CommandListener, TimerListene
}
/**
* Check if the session is alive every minute
*
* @param null $callback
* Handle 1 Minute Callback
*/
public function handleEveryMinute($callback = null) {
public function handleEveryMinute() {
if (!$this->init) {
return;
}
@ -633,21 +631,17 @@ class DedimaniaPlugin implements CallbackListener, CommandListener, TimerListene
}
/**
* Handle Begin Map
*
* @param $callback
* Handle Begin Map Callback
*/
public function handleBeginMap($callback) {
public function handleBeginMap() {
unset($this->dedimaniaData->records);
$this->fetchDedimaniaRecords(true);
}
/**
* Handle EndMap callback
*
* @param $callback
* Handle EndMap Callback
*/
public function handleMapEnd($callback) {
public function handleMapEnd() {
if (!$this->dedimaniaData || !$this->dedimaniaData->records) {
return;
}
@ -714,11 +708,9 @@ class DedimaniaPlugin implements CallbackListener, CommandListener, TimerListene
}
/**
* Update the Playerlist every 3 Minutes
*
* @param $callback
* Update the PlayerList every 3 Minutes
*/
public function updatePlayerList($callback) {
public function updatePlayerList() {
$serverInfo = $this->getServerInfo();
$playerList = $this->getPlayerList();
$votesInfo = $this->getVotesInfo();
@ -769,11 +761,11 @@ class DedimaniaPlugin implements CallbackListener, CommandListener, TimerListene
}
/**
* Handle PlayerCheckpoint callback
* Handle PlayerCheckpoint Callback
*
* @param $callback
* @param array $callback
*/
public function handlePlayerCheckpoint($callback) {
public function handlePlayerCheckpoint(array $callback) {
$data = $callback[1];
$login = $data[1];
$time = $data[2];
@ -786,11 +778,11 @@ class DedimaniaPlugin implements CallbackListener, CommandListener, TimerListene
}
/**
* Player finished callback
* Handle Player Finished Callback
*
* @param $callback
* @param array $callback
*/
public function handlePlayerFinished($callback) {
public function handlePlayerFinished(array $callback) {
//var_dump($callback);
$data = $callback[1];
if ($data[0] <= 0 || $data[2] <= 0) {

14
application/plugins/MCTeam/KarmaPlugin.php
View File

@ -11,7 +11,6 @@ use ManiaControl\Callbacks\CallbackListener;
use ManiaControl\Callbacks\CallbackManager;
use ManiaControl\Callbacks\Callbacks;
use ManiaControl\Callbacks\TimerListener;
use ManiaControl\Utils\ColorUtil;
use ManiaControl\ManiaControl;
use ManiaControl\Maps\Map;
use ManiaControl\Players\Player;
@ -20,6 +19,7 @@ use ManiaControl\Plugins\Plugin;
use ManiaControl\Plugins\PluginMenu;
use ManiaControl\Settings\Setting;
use ManiaControl\Settings\SettingManager;
use ManiaControl\Utils\ColorUtil;
/**
* ManiaControl Karma Plugin
@ -280,7 +280,7 @@ class KarmaPlugin implements CallbackListener, TimerListener, Plugin {
/**
* Activates the MX-Karma Session
*
* @param $mxKarmaCode
* @param string $mxKarmaCode
*/
private function activateSession($mxKarmaCode) {
$hash = $this->buildActivationHash($this->mxKarma['session']->sessionSeed, $mxKarmaCode);
@ -323,8 +323,8 @@ class KarmaPlugin implements CallbackListener, TimerListener, Plugin {
/**
* Builds a sha512 activation Hash for the MX-Karma
*
* @param $sessionSeed
* @param $mxKey
* @param string $sessionSeed
* @param string $mxKey
* @return string
*/
private function buildActivationHash($sessionSeed, $mxKey) {
@ -756,11 +756,9 @@ class KarmaPlugin implements CallbackListener, TimerListener, Plugin {
}
/**
* Handle ManiaControl 1 Second callback
*
* @param $time
* Handle ManiaControl 1 Second Callback
*/
public function handle1Second($time) {
public function handle1Second() {
if (!$this->updateManialink) {
return;
}

13
application/plugins/MCTeam/LocalRecordsPlugin.php
View File

@ -15,7 +15,6 @@ use ManiaControl\Callbacks\CallbackManager;
use ManiaControl\Callbacks\Callbacks;
use ManiaControl\Callbacks\TimerListener;
use ManiaControl\Commands\CommandListener;
use ManiaControl\Utils\Formatter;
use ManiaControl\ManiaControl;
use ManiaControl\Manialinks\ManialinkManager;
use ManiaControl\Maps\Map;
@ -24,6 +23,7 @@ use ManiaControl\Players\PlayerManager;
use ManiaControl\Plugins\Plugin;
use ManiaControl\Settings\Setting;
use ManiaControl\Settings\SettingManager;
use ManiaControl\Utils\Formatter;
/**
* ManiaControl Local Records Plugin
@ -182,11 +182,9 @@ class LocalRecordsPlugin implements CallbackListener, CommandListener, TimerList
}
/**
* Handle 1Second callback
*
* @param $time
* Handle 1 Second Callback
*/
public function handle1Second($time) {
public function handle1Second() {
if (!$this->updateManialink) {
return;
}
@ -352,12 +350,13 @@ class LocalRecordsPlugin implements CallbackListener, CommandListener, TimerList
/**
* Handle PlayerCheckpoint callback
*
* @param $callback
* @param array $callback
*/
public function handlePlayerCheckpoint($callback) {
public function handlePlayerCheckpoint(array $callback) {
$data = $callback[1];
$login = $data[1];
$time = $data[2];
// TODO: lap
// $lap = $data[3];
$cpIndex = $data[4];
if (!isset($this->checkpoints[$login]) || $cpIndex <= 0) {