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

improved phpdoc & returns

Browse Source
This commit is contained in:
Steffen Schröder
2014-05-07 22:59:09 +02:00
parent 51651623f2
commit a79b6a3156
1 changed files with 16 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
application/plugins/MCTeam/DonationPlugin.php
View File

@@ -55,9 +55,7 @@ class DonationPlugin implements CallbackListener, CommandListener, Plugin {
/* /*
* Private Properties * Private Properties
*/ */
/** /** @var ManiaControl $maniaControl */
* @var maniaControl $maniaControl
*/
private $maniaControl = null; private $maniaControl = null;
/** /**
@@ -98,7 +96,7 @@ class DonationPlugin implements CallbackListener, CommandListener, Plugin {
* @see \ManiaControl\Plugins\Plugin::getDescription() * @see \ManiaControl\Plugins\Plugin::getDescription()
*/ */
public static function getDescription() { public static function getDescription() {
return 'Plugin offering commands like /donate, /pay and /planets and a donation widget.'; return 'Plugin offering Commands like /donate, /pay and /planets and a Donation Widget.';
} }
/** /**
@@ -136,9 +134,7 @@ class DonationPlugin implements CallbackListener, CommandListener, Plugin {
} }
/** /**
* Handle ManiaControl OnStartup * Display the widget
*
* @param array $callback
*/ */
public function displayWidget() { public function displayWidget() {
if ($this->maniaControl->settingManager->getSetting($this, self::SETTING_DONATE_WIDGET_ACTIVATED)) { if ($this->maniaControl->settingManager->getSetting($this, self::SETTING_DONATE_WIDGET_ACTIVATED)) {
@@ -149,7 +145,7 @@ class DonationPlugin implements CallbackListener, CommandListener, Plugin {
/** /**
* Displays the Donate Widget * Displays the Donate Widget
* *
* @param bool $login * @param string $login
*/ */
public function displayDonateWidget($login = false) { public function displayDonateWidget($login = false) {
$posX = $this->maniaControl->settingManager->getSetting($this, self::SETTING_DONATE_WIDGET_POSX); $posX = $this->maniaControl->settingManager->getSetting($this, self::SETTING_DONATE_WIDGET_POSX);
@@ -273,7 +269,7 @@ class DonationPlugin implements CallbackListener, CommandListener, Plugin {
* Handles a Player Donate * Handles a Player Donate
* *
* @param Player $player * @param Player $player
* @param $value * @param int $value
*/ */
private function handleDonation(Player $player, $amount, $receiver = '', $receiverName = false) { private function handleDonation(Player $player, $amount, $receiver = '', $receiverName = false) {
@@ -313,8 +309,6 @@ class DonationPlugin implements CallbackListener, CommandListener, Plugin {
break; break;
} }
}, $player, $amount, $message); }, $player, $amount, $message);
return true;
} }
/** /**
@@ -334,19 +328,18 @@ class DonationPlugin implements CallbackListener, CommandListener, Plugin {
* *
* @param array $chatCallback * @param array $chatCallback
* @param Player $player * @param Player $player
* @return bool
*/ */
public function command_Donate(array $chatCallback, Player $player) { public function command_Donate(array $chatCallback, Player $player) {
$text = $chatCallback[1][2]; $text = $chatCallback[1][2];
$params = explode(' ', $text); $params = explode(' ', $text);
if (count($params) < 2) { if (count($params) < 2) {
$this->sendDonateUsageExample($player); $this->sendDonateUsageExample($player);
return false; return;
} }
$amount = (int)$params[1]; $amount = (int)$params[1];
if (!$amount || $amount <= 0) { if (!$amount || $amount <= 0) {
$this->sendDonateUsageExample($player); $this->sendDonateUsageExample($player);
return false; return;
} }
if (count($params) >= 3) { if (count($params) >= 3) {
$receiver = $params[2]; $receiver = $params[2];
@@ -357,18 +350,17 @@ class DonationPlugin implements CallbackListener, CommandListener, Plugin {
$receiverName = $this->maniaControl->client->getServerName(); $receiverName = $this->maniaControl->client->getServerName();
} }
return $this->handleDonation($player, $amount, $receiver, $receiverName); $this->handleDonation($player, $amount, $receiver, $receiverName);
} }
/** /**
* Send an usage example for /donate to the player * Send an usage example for /donate to the player
* *
* @param Player $player * @param Player $player
* @return boolean
*/ */
private function sendDonateUsageExample(Player $player) { private function sendDonateUsageExample(Player $player) {
$message = "Usage Example: '/donate 100'"; $message = "Usage Example: '/donate 100'";
return $this->maniaControl->chat->sendChat($message, $player->login); $this->maniaControl->chat->sendChat($message, $player->login);
} }
/** /**
@@ -376,23 +368,22 @@ class DonationPlugin implements CallbackListener, CommandListener, Plugin {
* *
* @param array $chatCallback * @param array $chatCallback
* @param Player $player * @param Player $player
* @return bool
*/ */
public function command_Pay(array $chatCallback, Player $player) { public function command_Pay(array $chatCallback, Player $player) {
if (!$this->maniaControl->authenticationManager->checkRight($player, AuthenticationManager::AUTH_LEVEL_SUPERADMIN)) { if (!$this->maniaControl->authenticationManager->checkRight($player, AuthenticationManager::AUTH_LEVEL_SUPERADMIN)) {
$this->maniaControl->authenticationManager->sendNotAllowed($player); $this->maniaControl->authenticationManager->sendNotAllowed($player);
return false; return;
} }
$text = $chatCallback[1][2]; $text = $chatCallback[1][2];
$params = explode(' ', $text); $params = explode(' ', $text);
if (count($params) < 2) { if (count($params) < 2) {
$this->sendPayUsageExample($player); $this->sendPayUsageExample($player);
return false; return;
} }
$amount = (int)$params[1]; $amount = (int)$params[1];
if (!$amount || $amount <= 0) { if (!$amount || $amount <= 0) {
$this->sendPayUsageExample($player); $this->sendPayUsageExample($player);
return false; return;
} }
if (count($params) >= 3) { if (count($params) >= 3) {
$receiver = $params[2]; $receiver = $params[2];
@@ -418,19 +409,16 @@ class DonationPlugin implements CallbackListener, CommandListener, Plugin {
break; break;
} }
}, $receiver, $amount, $message); }, $receiver, $amount, $message);
return true;
} }
/** /**
* Send an usage example for /pay to the player * Send an usage example for /pay to the player
* *
* @param Player $player * @param Player $player
* @return boolean
*/ */
private function sendPayUsageExample(Player $player) { private function sendPayUsageExample(Player $player) {
$message = "Usage Example: '/pay 100 login'"; $message = "Usage Example: '/pay 100 login'";
return $this->maniaControl->chat->sendChat($message, $player->login); $this->maniaControl->chat->sendChat($message, $player->login);
} }
/** /**
@@ -438,16 +426,15 @@ class DonationPlugin implements CallbackListener, CommandListener, Plugin {
* *
* @param array $chatCallback * @param array $chatCallback
* @param Player $player * @param Player $player
* @return bool
*/ */
public function command_GetPlanets(array $chatCallback, Player $player) { public function command_GetPlanets(array $chatCallback, Player $player) {
if (!$this->maniaControl->authenticationManager->checkRight($player, AuthenticationManager::AUTH_LEVEL_ADMIN)) { if (!$this->maniaControl->authenticationManager->checkRight($player, AuthenticationManager::AUTH_LEVEL_ADMIN)) {
$this->maniaControl->authenticationManager->sendNotAllowed($player); $this->maniaControl->authenticationManager->sendNotAllowed($player);
return false; return;
} }
$planets = $this->maniaControl->client->getServerPlanets(); $planets = $this->maniaControl->client->getServerPlanets();
$message = "This Server has {$planets} Planets!"; $message = "This Server has {$planets} Planets!";
return $this->maniaControl->chat->sendInformation($message, $player->login); $this->maniaControl->chat->sendInformation($message, $player->login);
} }
/** /**
@@ -461,10 +448,9 @@ class DonationPlugin implements CallbackListener, CommandListener, Plugin {
} }
/** /**
* Provides a ManiaLink overview with donators. * Provide an overview ManiaLink with donators
* *
* @param Player $player * @param Player $player
* @return null
*/ */
private function showTopDonsList(Player $player) { private function showTopDonsList(Player $player) {
$stats = $this->maniaControl->statisticManager->getStatsRanking(self::STAT_PLAYER_DONATIONS); $stats = $this->maniaControl->statisticManager->getStatsRanking(self::STAT_PLAYER_DONATIONS);