PSR-4 support for #70 plus PhpDoc

timmw · timmw · commit 9af9cf4f6b71 · 2015-10-10T18:48:52.000+01:00
diff --git a/Examples/Example.php b/Examples/Example.php
@@ -1,5 +1,7 @@
 <?php
-	require __DIR__ . '/SourceQuery/SourceQuery.class.php';
+	require __DIR__ . '/../SourceQuery/bootstrap.php';
+
+	use xPaw\SourceQuery\SourceQuery;
 	
 	// For the sake of this example
 	Header( 'Content-Type: text/plain' );
diff --git a/Examples/RconExample.php b/Examples/RconExample.php
@@ -1,5 +1,7 @@
 <?php
-	require __DIR__ . '/SourceQuery/SourceQuery.class.php';
+	require __DIR__ . '/../SourceQuery/bootstrap.php';
+
+	use xPaw\SourceQuery\SourceQuery;
 	
 	// For the sake of this example
 	Header( 'Content-Type: text/plain' );
diff --git a/Examples/View.php b/Examples/View.php
@@ -1,5 +1,7 @@
 <?php
-	require __DIR__ . '/SourceQuery/SourceQuery.class.php';
+	require __DIR__ . '/../SourceQuery/bootstrap.php';
+
+	use xPaw\SourceQuery\SourceQuery;
 	
 	// Edit this ->
 	define( 'SQ_SERVER_ADDR', 'localhost' );
@@ -56,7 +58,7 @@
 </head>
 
 <body>
-    <div class="container">
+	<div class="container">
 		<div class="jumbotron">
 			<h1>Source Query PHP Class</h1>
 			
diff --git a/SourceQuery/Buffer.php b/SourceQuery/Buffer.php
@@ -1,12 +1,23 @@
 <?php
 	/**
-	 * Class written by xPaw
+	 * @author Pavel Djundik <sourcequery@xpaw.me>
 	 *
-	 * Website: https://xpaw.me
-	 * GitHub: https://github.com/xPaw/PHP-Source-Query-Class
+	 * @link https://xpaw.me
+	 * @link https://github.com/xPaw/PHP-Source-Query-Class
+	 *
+	 * @license GNU Lesser General Public License, version 2.1
+	 *
+	 * @internal
+	 */
+
+	namespace xPaw\SourceQuery;
+
+	/**
+	 * Class Buffer
+	 *
+	 * @package xPaw\SourceQuery
 	 */
-	
-	class SourceQueryBuffer
+	class Buffer
 	{
 		/**
 		 * Buffer
diff --git a/SourceQuery/Exception/AuthenticationException.php b/SourceQuery/Exception/AuthenticationException.php
@@ -0,0 +1,19 @@
+<?php
+	/**
+	 * @author Pavel Djundik <sourcequery@xpaw.me>
+	 *
+	 * @link https://xpaw.me
+	 * @link https://github.com/xPaw/PHP-Source-Query-Class
+	 *
+	 * @license GNU Lesser General Public License, version 2.1
+	 *
+	 * @internal
+	 */
+
+	namespace xPaw\SourceQuery\Exception;
+
+	class AuthenticationException extends SourceQueryException
+	{
+		const BAD_PASSWORD = 1;
+		const BANNED = 2;
+	}
diff --git a/SourceQuery/Exception/InvalidArgumentException.php b/SourceQuery/Exception/InvalidArgumentException.php
@@ -0,0 +1,18 @@
+<?php
+	/**
+	 * @author Pavel Djundik <sourcequery@xpaw.me>
+	 *
+	 * @link https://xpaw.me
+	 * @link https://github.com/xPaw/PHP-Source-Query-Class
+	 *
+	 * @license GNU Lesser General Public License, version 2.1
+	 *
+	 * @internal
+	 */
+
+	namespace xPaw\SourceQuery\Exception;
+
+	class InvalidArgumentException extends SourceQueryException
+	{
+		const TIMEOUT_NOT_INTEGER = 1;
+	}
diff --git a/SourceQuery/Exception/InvalidPacketException.php b/SourceQuery/Exception/InvalidPacketException.php
@@ -0,0 +1,21 @@
+<?php
+	/**
+	 * @author Pavel Djundik <sourcequery@xpaw.me>
+	 *
+	 * @link https://xpaw.me
+	 * @link https://github.com/xPaw/PHP-Source-Query-Class
+	 *
+	 * @license GNU Lesser General Public License, version 2.1
+	 *
+	 * @internal
+	 */
+
+	namespace xPaw\SourceQuery\Exception;
+
+	class InvalidPacketException extends SourceQueryException
+	{
+		const PACKET_HEADER_MISMATCH = 1;
+		const BUFFER_EMPTY = 2;
+		const BUFFER_NOT_EMPTY = 3;
+		const CHECKSUM_MISMATCH = 4;
+	}
diff --git a/SourceQuery/Exception/SocketException.php b/SourceQuery/Exception/SocketException.php
@@ -0,0 +1,18 @@
+<?php
+	/**
+	 * @author Pavel Djundik <sourcequery@xpaw.me>
+	 *
+	 * @link https://xpaw.me
+	 * @link https://github.com/xPaw/PHP-Source-Query-Class
+	 *
+	 * @license GNU Lesser General Public License, version 2.1
+	 *
+	 * @internal
+	 */
+
+	namespace xPaw\SourceQuery\Exception;
+
+	class SocketException extends SourceQueryException
+	{
+		const COULD_NOT_CREATE_SOCKET = 1;
+	}
diff --git a/SourceQuery/Exception/SourceQueryException.php b/SourceQuery/Exception/SourceQueryException.php
@@ -0,0 +1,18 @@
+<?php
+	/**
+	 * @author Pavel Djundik <sourcequery@xpaw.me>
+	 *
+	 * @link https://xpaw.me
+	 * @link https://github.com/xPaw/PHP-Source-Query-Class
+	 *
+	 * @license GNU Lesser General Public License, version 2.1
+	 *
+	 * @internal
+	 */
+
+	namespace xPaw\SourceQuery\Exception;
+
+	abstract class SourceQueryException extends \Exception
+	{
+		// Base exception class
+	}
diff --git a/SourceQuery/Exception/TimeoutException.php b/SourceQuery/Exception/TimeoutException.php
@@ -0,0 +1,18 @@
+<?php
+	/**
+	 * @author Pavel Djundik <sourcequery@xpaw.me>
+	 *
+	 * @link https://xpaw.me
+	 * @link https://github.com/xPaw/PHP-Source-Query-Class
+	 *
+	 * @license GNU Lesser General Public License, version 2.1
+	 *
+	 * @internal
+	 */
+
+	namespace xPaw\SourceQuery\Exception;
+
+	class TimeoutException extends SourceQueryException
+	{
+		const TIMEOUT_CONNECT = 1;
+	}
diff --git a/SourceQuery/Exceptions.class.php b/SourceQuery/Exceptions.class.php
diff --git a/SourceQuery/GoldSourceRcon.php b/SourceQuery/GoldSourceRcon.php
@@ -1,26 +1,39 @@
 <?php
 	/**
-	 * Class written by xPaw
+	 * @author Pavel Djundik <sourcequery@xpaw.me>
 	 *
-	 * Website: https://xpaw.me
-	 * GitHub: https://github.com/xPaw/PHP-Source-Query-Class
+	 * @link https://xpaw.me
+	 * @link https://github.com/xPaw/PHP-Source-Query-Class
+	 *
+	 * @license GNU Lesser General Public License, version 2.1
+	 *
+	 * @internal
 	 */
+
+	namespace xPaw\SourceQuery;
 	
 	use xPaw\SourceQuery\Exception\AuthenticationException;
-	
-	class SourceQueryGoldSourceRcon
+
+	/**
+	 * Class GoldSourceRcon
+	 *
+	 * @package xPaw\SourceQuery
+	 *
+	 * @uses xPaw\SourceQuery\Exception\AuthenticationException
+	 */
+	class GoldSourceRcon
 	{
 		/**
 		 * Points to buffer class
 		 * 
-		 * @var SourceQueryBuffer
+		 * @var Buffer
 		 */
 		private $Buffer;
 		
 		/**
 		 * Points to socket class
 		 * 
-		 * @var SourceQuerySocket
+		 * @var Socket
 		 */
 		private $Socket;
 		
@@ -57,6 +70,7 @@ public function Write( $Header, $String = '' )
 		/**
 		 * @param int $Length
 		 * @throws AuthenticationException
+		 * @return bool
 		 */
 		public function Read( $Length = 1400 )
 		{
diff --git a/SourceQuery/Socket.php b/SourceQuery/Socket.php
@@ -1,15 +1,29 @@
 <?php
 	/**
-	 * Class written by xPaw
+	 * @author Pavel Djundik <sourcequery@xpaw.me>
 	 *
-	 * Website: https://xpaw.me
-	 * GitHub: https://github.com/xPaw/PHP-Source-Query-Class
+	 * @link https://xpaw.me
+	 * @link https://github.com/xPaw/PHP-Source-Query-Class
+	 *
+	 * @license GNU Lesser General Public License, version 2.1
+	 *
+	 * @internal
 	 */
+
+	namespace xPaw\SourceQuery;
 	
 	use xPaw\SourceQuery\Exception\InvalidPacketException;
 	use xPaw\SourceQuery\Exception\SocketException;
-	
-	class SourceQuerySocket
+
+	/**
+	 * Class Socket
+	 *
+	 * @package xPaw\SourceQuery
+	 *
+	 * @uses xPaw\SourceQuery\Exception\InvalidPacketException
+	 * @uses xPaw\SourceQuery\Exception\SocketException
+	 */
+	class Socket
 	{
 		public $Socket;
 		public $Engine;
@@ -21,7 +35,7 @@ class SourceQuerySocket
 		/**
 		 * Points to buffer class
 		 * 
-		 * @var SourceQueryBuffer
+		 * @var Buffer
 		 */
 		private $Buffer;
 		
@@ -144,7 +158,7 @@ protected function ReadBuffer( $Buffer, $Length )
 					// Let's make sure this function exists, it's not included in PHP by default
 					if( !Function_Exists( 'bzdecompress' ) )
 					{
-						throw new RuntimeException( 'Received compressed packet, PHP doesn\'t have Bzip2 library installed, can\'t decompress.' );
+						throw new \RuntimeException( 'Received compressed packet, PHP doesn\'t have Bzip2 library installed, can\'t decompress.' );
 					}
 					
 					$Buffer = bzdecompress( $Buffer );
diff --git a/SourceQuery/SourceQuery.php b/SourceQuery/SourceQuery.php
diff --git a/SourceQuery/SourceRcon.php b/SourceQuery/SourceRcon.php
diff --git a/SourceQuery/bootstrap.php b/SourceQuery/bootstrap.php
diff --git a/composer.json b/composer.json
