Improved PHPDoc, Type Hints & Parameter Names

application/core/Maps/Map.php

@@ -2,8 +2,8 @@
 
 namespace ManiaControl\Maps;
 
-use ManiaControl\Utils\Formatter;
 use ManiaControl\ManiaExchange\MXMapInfo;
+use ManiaControl\Utils\Formatter;
 
 /**
  * Map Model Class

application/core/Maps/MapActions.php

@@ -1,4 +1,10 @@
 <?php
+
+namespace ManiaControl\Maps;
+
+use ManiaControl\ManiaControl;
+use Maniaplanet\DedicatedServer\Xmlrpc\ChangeInProgressException;
+
 /**
  * Map Actions Class
  *
@@ -6,12 +12,6 @@
  * @copyright 2014 ManiaControl Team
  * @license   http://www.gnu.org/licenses/ GNU General Public License, Version 3
  */
-namespace ManiaControl\Maps;
-
-
-use ManiaControl\ManiaControl;
-use Maniaplanet\DedicatedServer\Xmlrpc\ChangeInProgressException;
-
 class MapActions {
 	/*
 	 * Private Properties

application/core/Maps/MapManager.php

@@ -359,10 +359,10 @@ class MapManager implements CallbackListener {
 	}
 
 	/**
-	 * Returns map By UID
+	 * Get Map by UID
 	 *
-	 * @param $uid
-	 * @return Map array
+	 * @param string $uid
+	 * @return Map
 	 */
 	public function getMapByUid($uid) {
 		if (!isset($this->maps[$uid])) {
@@ -417,7 +417,7 @@ class MapManager implements CallbackListener {
 	/**
 	 * Initializes a Map
 	 *
-	 * @param $rpcMap
+	 * @param mixed $rpcMap
 	 * @return Map
 	 */
 	public function initializeMap($rpcMap) {

application/core/Maps/MapQueue.php

@@ -7,9 +7,9 @@ use ManiaControl\Callbacks\CallbackListener;
 use ManiaControl\Callbacks\CallbackManager;
 use ManiaControl\Callbacks\Callbacks;
 use ManiaControl\Commands\CommandListener;
-use ManiaControl\Utils\Formatter;
 use ManiaControl\ManiaControl;
 use ManiaControl\Players\Player;
+use ManiaControl\Utils\Formatter;
 use Maniaplanet\DedicatedServer\Xmlrpc\NextMapException;
 
 /**
@@ -45,13 +45,6 @@ class MapQueue implements CallbackListener, CommandListener {
 	private $buffer = array();
 	private $nextNoQueue = false;
 
-	/**
-	 * Don't queue on the next MapChange
-	 */
-	public function dontQueueNextMapChange() {
-		$this->nextNoQueue = true;
-	}
-
 	/**
 	 * Create a new server MapQueue
 	 *
@@ -80,6 +73,13 @@ class MapQueue implements CallbackListener, CommandListener {
 		$this->maniaControl->commandManager->registerCommandListener(array('jb', 'jukebox', 'mapqueue'), $this, 'command_MapQueue', false, 'Shows current maps in Map-Queue.');
 	}
 
+	/**
+	 * Don't queue on the next MapChange
+	 */
+	public function dontQueueNextMapChange() {
+		$this->nextNoQueue = true;
+	}
+
 	/**
 	 * Adds current map to buffer on startup
 	 */
@@ -201,7 +201,7 @@ class MapQueue implements CallbackListener, CommandListener {
 	 * Adds map as first map in queue (for /replay)
 	 *
 	 * @param Player $player
-	 * @param Map   $map
+	 * @param Map    $map
 	 */
 	public function addFirstMapToMapQueue(Player $player, Map $map) {
 		if ($map) {
@@ -303,7 +303,7 @@ class MapQueue implements CallbackListener, CommandListener {
 	 */
 	public function endMap(Map $map = null) {
 		//Don't queue next map (for example on skip to map)
-		if($this->nextNoQueue){
+		if ($this->nextNoQueue) {
 			$this->nextNoQueue = false;
 			return;
 		}
@@ -316,7 +316,7 @@ class MapQueue implements CallbackListener, CommandListener {
 				$player = $queuedMap[0];
 
 				// Check if map is added via replay vote/command
-				if(isset($queuedMap[2]) && $queuedMap[2] === true) {
+				if (isset($queuedMap[2]) && $queuedMap[2] === true) {
 					break;
 				}
 
@@ -352,9 +352,9 @@ class MapQueue implements CallbackListener, CommandListener {
 		/** @var Map $map */
 		$this->maniaControl->chat->sendInformation('$fa0Next map will be $<$fff' . $map->name . '$> as requested by $<' . $this->nextMap[0]->nickname . '$>.');
 
-		try{
+		try {
 			$this->maniaControl->client->setNextMapIdent($map->uid);
-		}catch (NextMapException $e){
+		} catch (NextMapException $e) {
 		}
 	}
 
@@ -415,9 +415,9 @@ class MapQueue implements CallbackListener, CommandListener {
 	}
 
 	/**
-	 * Returns the Queuer of a Map
+	 * Return the Queuer of a Map
 	 *
-	 * @param $uid
+	 * @param string $uid
 	 * @return mixed
 	 */
 	public function getQueuer($uid) {