thedudeguy / PHP-Minecraft-Rcon

src/Rcon.php

Doc Comments +1 added lines, -1 removed lines

@@ -157,7 +157,7 @@
 	 *
 	 * @param $packet_id
 	 * @param $packet_type
-	 * @param $packet_body
+	 * @param string $packet_body
 	 *
 	 * @return void
 	 */

Indentation +214 added lines, -214 removed lines

@@ -13,157 +13,157 @@ 
 namespace Thedudeguy;
 
 class Rcon {
-	private $host;
-	private $port;
-	private $password;
-	private $timeout;
-
-	private $socket;
-
-	private $authorized;
-	private $last_response;
-
-	const PACKET_AUTHORIZE = 5;
-	const PACKET_COMMAND = 6;
-
-	const SERVERDATA_AUTH = 3;
-	const SERVERDATA_AUTH_RESPONSE = 2;
-	const SERVERDATA_EXECCOMMAND = 2;
-	const SERVERDATA_RESPONSE_VALUE = 0;
-
-	/**
-	 * Create a new instance of the Rcon class.
-	 *
-	 * @param string $host
-	 * @param integer $port
-	 * @param string $password
-	 * @param integer $timeout
-	 */
-	public function __construct($host, $port, $password, $timeout) 
-	{
-	    $this->host = $host;
-		$this->port = $port;
-		$this->password = $password;
-		$this->timeout = $timeout;
-	}
-
-	/**
-	 * Get the latest response from the server.
-	 *
-	 * @return string
-	 */
-	public function getResponse() 
-	{
-		return $this->last_response;
-	}
-
-	/**
-	 * Connect to a server.
-	 *
-	 * @return boolean
-	 */
-	public function connect() 
-	{
-		$this->socket = fsockopen($this->host, $this->port, $errno, $errstr, $this->timeout);
-
-		if (!$this->socket) {
-			$this->last_response = $errstr;
-			return false;
-		}
-
-		//set timeout
-		stream_set_timeout($this->socket, 3, 0);
-
-		// check authorization
-		if ($this->authorize())
-			return true;
-
-		return false;
-	}
-
-	/**
-	 * Disconnect from server.
-	 *
-	 * @return void
-	 */
-	public function disconnect() 
-	{
-		if ($this->socket)
-			fclose($this->socket);
-	}
-
-	/**
-	 * True if socket is connected and authorized.
-	 *
-	 * @return boolean
-	 */
-	public function isConnected() 
-	{
-		return $this->authorized;
-	}
-
-	/**
-	 * Send a command to the connected server.
-	 *
-	 * @param string $command
-	 *
-	 * @return boolean|mixed
-	 */
-	public function sendCommand($command) 
-	{
-		if (!$this->isConnected())
-			return false;
-
-		// send command packet
-		$this->writePacket(Rcon::PACKET_COMMAND, Rcon::SERVERDATA_EXECCOMMAND, $command);
-
-		// get response
-		$response_packet = $this->readPacket();
-		if ($response_packet['id'] == Rcon::PACKET_COMMAND) {
-			if ($response_packet['type'] == Rcon::SERVERDATA_RESPONSE_VALUE) {
-				$this->last_response = $response_packet['body'];
-
-				return $response_packet['body'];
-			}
-		}
-
-		return false;
-	}
-
-	/**
-	 * Log into the server with the given credentials.
-	 *
-	 * @return boolean
-	 */
-	private function authorize() 
-	{
-		$this->writePacket(Rcon::PACKET_AUTHORIZE, Rcon::SERVERDATA_AUTH, $this->password);
-		$response_packet = $this->readPacket();
-
-		if ($response_packet['type'] == Rcon::SERVERDATA_AUTH_RESPONSE) {
-			if ($response_packet['id'] == Rcon::PACKET_AUTHORIZE) {
-				$this->authorized = true;
-
-				return true;
-			}
-		}
-
-		$this->disconnect();
-		return false;
-	}
-
-	/**
-	 * Writes a packet to the socket stream.
-	 *
-	 * @param $packet_id
-	 * @param $packet_type
-	 * @param $packet_body
-	 *
-	 * @return void
-	 */
-	private function writePacket($packet_id, $packet_type, $packet_body)
-	{
-		/*
+    private $host;
+    private $port;
+    private $password;
+    private $timeout;
+
+    private $socket;
+
+    private $authorized;
+    private $last_response;
+
+    const PACKET_AUTHORIZE = 5;
+    const PACKET_COMMAND = 6;
+
+    const SERVERDATA_AUTH = 3;
+    const SERVERDATA_AUTH_RESPONSE = 2;
+    const SERVERDATA_EXECCOMMAND = 2;
+    const SERVERDATA_RESPONSE_VALUE = 0;
+
+    /**
+     * Create a new instance of the Rcon class.
+     *
+     * @param string $host
+     * @param integer $port
+     * @param string $password
+     * @param integer $timeout
+     */
+    public function __construct($host, $port, $password, $timeout) 
+    {
+        $this->host = $host;
+        $this->port = $port;
+        $this->password = $password;
+        $this->timeout = $timeout;
+    }
+
+    /**
+     * Get the latest response from the server.
+     *
+     * @return string
+     */
+    public function getResponse() 
+    {
+        return $this->last_response;
+    }
+
+    /**
+     * Connect to a server.
+     *
+     * @return boolean
+     */
+    public function connect() 
+    {
+        $this->socket = fsockopen($this->host, $this->port, $errno, $errstr, $this->timeout);
+
+        if (!$this->socket) {
+            $this->last_response = $errstr;
+            return false;
+        }
+
+        //set timeout
+        stream_set_timeout($this->socket, 3, 0);
+
+        // check authorization
+        if ($this->authorize())
+            return true;
+
+        return false;
+    }
+
+    /**
+     * Disconnect from server.
+     *
+     * @return void
+     */
+    public function disconnect() 
+    {
+        if ($this->socket)
+            fclose($this->socket);
+    }
+
+    /**
+     * True if socket is connected and authorized.
+     *
+     * @return boolean
+     */
+    public function isConnected() 
+    {
+        return $this->authorized;
+    }
+
+    /**
+     * Send a command to the connected server.
+     *
+     * @param string $command
+     *
+     * @return boolean|mixed
+     */
+    public function sendCommand($command) 
+    {
+        if (!$this->isConnected())
+            return false;
+
+        // send command packet
+        $this->writePacket(Rcon::PACKET_COMMAND, Rcon::SERVERDATA_EXECCOMMAND, $command);
+
+        // get response
+        $response_packet = $this->readPacket();
+        if ($response_packet['id'] == Rcon::PACKET_COMMAND) {
+            if ($response_packet['type'] == Rcon::SERVERDATA_RESPONSE_VALUE) {
+                $this->last_response = $response_packet['body'];
+
+                return $response_packet['body'];
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * Log into the server with the given credentials.
+     *
+     * @return boolean
+     */
+    private function authorize() 
+    {
+        $this->writePacket(Rcon::PACKET_AUTHORIZE, Rcon::SERVERDATA_AUTH, $this->password);
+        $response_packet = $this->readPacket();
+
+        if ($response_packet['type'] == Rcon::SERVERDATA_AUTH_RESPONSE) {
+            if ($response_packet['id'] == Rcon::PACKET_AUTHORIZE) {
+                $this->authorized = true;
+
+                return true;
+            }
+        }
+
+        $this->disconnect();
+        return false;
+    }
+
+    /**
+     * Writes a packet to the socket stream.
+     *
+     * @param $packet_id
+     * @param $packet_type
+     * @param $packet_body
+     *
+     * @return void
+     */
+    private function writePacket($packet_id, $packet_type, $packet_body)
+    {
+        /*
 		Size			32-bit little-endian Signed Integer	 	Varies, see below.
 		ID				32-bit little-endian Signed Integer		Varies, see below.
 		Type	        32-bit little-endian Signed Integer		Varies, see below.
@@ -171,71 +171,71 @@ 
 		Empty String    Null-terminated ASCII String			0x00
 		*/
 
-		//create packet
-		$packet = pack("VV", $packet_id, $packet_type);
-		$packet = $packet . $packet_body . "\x00";
-		$packet = $packet . "\x00";
-
-		// get packet size.
-		$packet_size = strlen($packet);
-
-		// attach size to packet.
-		$packet = pack("V", $packet_size) . $packet;
-
-		// write packet.
-		fwrite($this->socket, $packet, strlen($packet));
-	}
-
-	/**
-	 * Read a packet from the socket stream.
-	 *
-	 * @return array
-	 */
-	private function readPacket() 
-	{
-		//get packet size.
-		$size_data = fread($this->socket, 4);
-		$size_pack = unpack("V1size", $size_data);
-		$size = $size_pack['size'];
-
-		// if size is > 4096, the response will be in multiple packets.
-		// this needs to be address. get more info about multi-packet responses
-		// from the RCON protocol specification at
-		// https://developer.valvesoftware.com/wiki/Source_RCON_Protocol
-		// currently, this script does not support multi-packet responses.
-
-		$packet_data = fread($this->socket, $size);
-		$packet_pack = unpack("V1id/V1type/a*body", $packet_data);
-
-		return $packet_pack;
-	}
+        //create packet
+        $packet = pack("VV", $packet_id, $packet_type);
+        $packet = $packet . $packet_body . "\x00";
+        $packet = $packet . "\x00";
+
+        // get packet size.
+        $packet_size = strlen($packet);
+
+        // attach size to packet.
+        $packet = pack("V", $packet_size) . $packet;
+
+        // write packet.
+        fwrite($this->socket, $packet, strlen($packet));
+    }
+
+    /**
+     * Read a packet from the socket stream.
+     *
+     * @return array
+     */
+    private function readPacket() 
+    {
+        //get packet size.
+        $size_data = fread($this->socket, 4);
+        $size_pack = unpack("V1size", $size_data);
+        $size = $size_pack['size'];
+
+        // if size is > 4096, the response will be in multiple packets.
+        // this needs to be address. get more info about multi-packet responses
+        // from the RCON protocol specification at
+        // https://developer.valvesoftware.com/wiki/Source_RCON_Protocol
+        // currently, this script does not support multi-packet responses.
+
+        $packet_data = fread($this->socket, $size);
+        $packet_pack = unpack("V1id/V1type/a*body", $packet_data);
+
+        return $packet_pack;
+    }
 	
-	// Below are the deprecated functions for reverse compatibility
+    // Below are the deprecated functions for reverse compatibility
 	
-	/**
-	 * @deprecated
-	 * @see Rcon::getResponse()
-	 */
-	public function get_response()
-	{
-		return $this->getResponse();
-	}
+    /**
+     * @deprecated
+     * @see Rcon::getResponse()
+     */
+    public function get_response()
+    {
+        return $this->getResponse();
+    }
 	
-	/**
-	 * @deprecated
-	 * @see Rcon::isConnected()
-	 */
-	public function is_connected()
-	{
-		return $this->isConnected();
-	}
+    /**
+     * @deprecated
+     * @see Rcon::isConnected()
+     */
+    public function is_connected()
+    {
+        return $this->isConnected();
+    }
 	
-	/**
-	 * @deprecated
-	 * @see Rcon::sendCommand()
-	 */
-	public function send_command($command) 
-	{
-		return $this->sendCommand($command);
-	}
+    /**
+     * @deprecated
+     * @see Rcon::sendCommand()
+     */
+    public function send_command($command) 
+    {
+        return $this->sendCommand($command);
+    }
 }

Spacing +3 added lines, -3 removed lines

@@ -173,14 +173,14 @@
 
 		//create packet
 		$packet = pack("VV", $packet_id, $packet_type);
-		$packet = $packet . $packet_body . "\x00";
-		$packet = $packet . "\x00";
+		$packet = $packet.$packet_body."\x00";
+		$packet = $packet."\x00";
 
 		// get packet size.
 		$packet_size = strlen($packet);
 
 		// attach size to packet.
-		$packet = pack("V", $packet_size) . $packet;
+		$packet = pack("V", $packet_size).$packet;
 
 		// write packet.
 		fwrite($this->socket, $packet, strlen($packet));

Braces +20 added lines, -16 removed lines

@@ -12,7 +12,8 @@ 
 
 namespace Thedudeguy;
 
-class Rcon {
+class Rcon
+{
 	private $host;
 	private $port;
 	private $password;
@@ -39,7 +40,7 @@ 
 	 * @param string $password
 	 * @param integer $timeout
 	 */
-	public function __construct($host, $port, $password, $timeout) 
+	public function __construct($host, $port, $password, $timeout)
 	{
 	    $this->host = $host;
 		$this->port = $port;
@@ -52,7 +53,7 @@ 
 	 *
 	 * @return string
 	 */
-	public function getResponse() 
+	public function getResponse()
 	{
 		return $this->last_response;
 	}
@@ -62,7 +63,7 @@ 
 	 *
 	 * @return boolean
 	 */
-	public function connect() 
+	public function connect()
 	{
 		$this->socket = fsockopen($this->host, $this->port, $errno, $errstr, $this->timeout);
 
@@ -75,8 +76,9 @@ 
 		stream_set_timeout($this->socket, 3, 0);
 
 		// check authorization
-		if ($this->authorize())
-			return true;
+		if ($this->authorize()) {
+					return true;
+		}
 
 		return false;
 	}
@@ -86,10 +88,11 @@ 
 	 *
 	 * @return void
 	 */
-	public function disconnect() 
+	public function disconnect()
 	{
-		if ($this->socket)
-			fclose($this->socket);
+		if ($this->socket) {
+					fclose($this->socket);
+		}
 	}
 
 	/**
@@ -97,7 +100,7 @@ 
 	 *
 	 * @return boolean
 	 */
-	public function isConnected() 
+	public function isConnected()
 	{
 		return $this->authorized;
 	}
@@ -109,10 +112,11 @@ 
 	 *
 	 * @return boolean|mixed
 	 */
-	public function sendCommand($command) 
+	public function sendCommand($command)
 	{
-		if (!$this->isConnected())
-			return false;
+		if (!$this->isConnected()) {
+					return false;
+		}
 
 		// send command packet
 		$this->writePacket(Rcon::PACKET_COMMAND, Rcon::SERVERDATA_EXECCOMMAND, $command);
@@ -135,7 +139,7 @@ 
 	 *
 	 * @return boolean
 	 */
-	private function authorize() 
+	private function authorize()
 	{
 		$this->writePacket(Rcon::PACKET_AUTHORIZE, Rcon::SERVERDATA_AUTH, $this->password);
 		$response_packet = $this->readPacket();
@@ -191,7 +195,7 @@ 
 	 *
 	 * @return array
 	 */
-	private function readPacket() 
+	private function readPacket()
 	{
 		//get packet size.
 		$size_data = fread($this->socket, 4);
@@ -234,7 +238,7 @@ 
 	 * @deprecated
 	 * @see Rcon::sendCommand()
 	 */
-	public function send_command($command) 
+	public function send_command($command)
 	{
 		return $this->sendCommand($command);
 	}