Cleaned up the code, fixed broken phpdoc tags, formatting

.gitignore

@@ -1,4 +1,5 @@
 /vendor
 composer.lock
+.idea/
 
 *~

composer.json

@@ -1,5 +1,5 @@
 {
-  "name": "MightyPork/phpmodbus",
+  "name": "mightypork/phpmodbus",
   "keywords": ["phpmodbus","modbus"],
   "description": "PhpModbus with namespaces and updated to PHP 7",
   "license": "LGPL",

src/IecType.php

@@ -26,18 +26,19 @@ namespace PHPModbus;
  * @copyright  Copyright (c) 2004, 2010 Jan Krakora
  * @package    Phpmodbus
  */
-class IecType {
-
+class IecType
+{
 	/**
 	 * iecBYTE
 	 *
 	 * Converts a value to IEC-1131 BYTE data type
 	 *
-     * @param value value from 0 to 255
-     * @return value IEC BYTE data type
+	 * @param int $value from 0 to 255
+	 * @return int IEC BYTE data type
 	 *
 	 */
-    public static function iecBYTE($value) {
+	public static function iecBYTE($value)
+	{
 		return chr($value & 0xFF);
 	}
 
@@ -46,11 +47,12 @@ class IecType {
 	 *
 	 * Converts a value to IEC-1131 INT data type
 	 *
-     * @param value value to be converted
-     * @return value IEC-1131 INT data type
+	 * @param int $value to be converted
+	 * @return int IEC-1131 INT data type
 	 *
 	 */
-    public static function iecINT($value) {
+	public static function iecINT($value)
+	{
 		return self::iecBYTE(($value >> 8) & 0x00FF) .
 		self::iecBYTE(($value & 0x00FF));
 	}
@@ -60,14 +62,15 @@ class IecType {
 	 *
 	 * Converts a value to IEC-1131 DINT data type
 	 *
-     * @param value value to be converted
-     * @param value endianness defines endian codding (little endian == 0, big endian == 1)
-     * @return value IEC-1131 INT data type
+	 * @param int $value     to be converted
+	 * @param int $bigEndian defines endian codding (little endian == 0, big endian == 1)
+	 * @return int IEC-1131 INT data type
 	 *
 	 */
-    public static function iecDINT($value, $endianness = 0) {
+	public static function iecDINT($value, $bigEndian = 0)
+	{
 		// result with right endianness
-        return self::endianness($value, $endianness);
+		return self::endianness($value, $bigEndian);
 	}
 
 	/**
@@ -75,15 +78,16 @@ class IecType {
 	 *
 	 * Converts a value to IEC-1131 REAL data type. The function uses function  @use float2iecReal.
 	 *
-     * @param value value to be converted
-     * @param value endianness defines endian codding (little endian == 0, big endian == 1)
-     * @return value IEC-1131 REAL data type
+	 * @param int  $value     to be converted
+	 * @param bool $bigEndian defines endian codding (little endian == 0, big endian == 1)
+	 * @return int IEC-1131 REAL data type
 	 */
-    public static function iecREAL($value, $endianness = 0) {
+	public static function iecREAL($value, $bigEndian = 0)
+	{
 		// iecREAL representation
 		$real = self::float2iecReal($value);
 		// result with right endianness
-        return self::endianness($real, $endianness);
+		return self::endianness($real, $bigEndian);
 	}
 
 	/**
@@ -92,13 +96,15 @@ class IecType {
 	 * This function converts float value to IEC-1131 REAL single precision form.
 	 *
 	 * For more see [{@link http://en.wikipedia.org/wiki/Single_precision Single precision on Wiki}] or
-     * [{@link http://de.php.net/manual/en/function.base-convert.php PHP base_convert function commentary}, Todd Stokes @ Georgia Tech 21-Nov-2007] or
+	 * [{@link http://de.php.net/manual/en/function.base-convert.php PHP base_convert function commentary}, Todd Stokes
+	 * @ Georgia Tech 21-Nov-2007] or
 	 * [{@link http://www.php.net/manual/en/function.pack.php PHP pack/unpack functionality}]
 	 *
-     * @param float value to be converted
-     * @return value IEC REAL data type
+	 * @param float $value to be converted
+	 * @return int IEC REAL data type
 	 */
-    private static function float2iecReal($value) {
+	private static function float2iecReal($value)
+	{
 		// get float binary string
 		$float = pack("f", $value);
 		// set 32-bit unsigned integer of the float
@@ -113,24 +119,23 @@ class IecType {
 	 * For more see http://en.wikipedia.org/wiki/Endianness
 	 *
 	 * @param int  $value
-     * @param bool $endianness
+	 * @param bool $bigEndian
 	 * @return int
 	 */
-    private static function endianness($value, $endianness = 0) {
-        if ($endianness == 0)
+	private static function endianness($value, $bigEndian = 0)
+	{
+		if ($bigEndian == 0) {
 			return
 				self::iecBYTE(($value >> 8) & 0x000000FF) .
 				self::iecBYTE(($value & 0x000000FF)) .
 				self::iecBYTE(($value >> 24) & 0x000000FF) .
 				self::iecBYTE(($value >> 16) & 0x000000FF);
-        else
+		} else {
 			return
 				self::iecBYTE(($value >> 24) & 0x000000FF) .
 				self::iecBYTE(($value >> 16) & 0x000000FF) .
 				self::iecBYTE(($value >> 8) & 0x000000FF) .
 				self::iecBYTE(($value & 0x000000FF));
 		}
-
+	}
 }
-
-?>

src/ModbusMasterTcp.php

@@ -35,7 +35,8 @@ namespace PHPModbus;
  * @package    Phpmodbus
  *
  */
-class ModbusMasterTcp extends ModbusMaster {
+class ModbusMasterTcp extends ModbusMaster
+{
 	/**
 	 * ModbusMasterTcp
 	 *
@@ -43,8 +44,8 @@ class ModbusMasterTcp extends ModbusMaster {
 	 *
 	 * @param String $host An IP address of a Modbus TCP device. E.g. "192.168.1.1".
 	 */
-  function ModbusMasterTcp($host){
-    $this->host = $host;
-    $this->socket_protocol = "TCP";
+	public function __construct($host)
+	{
+		parent::__construct($host, "TCP");
 	}
 }

src/ModbusMasterUdp.php

@@ -35,8 +35,8 @@ namespace PHPModbus;
  * @package    Phpmodbus
  *
  */
-class ModbusMasterUdp extends ModbusMaster {
-  
+class ModbusMasterUdp extends ModbusMaster
+{
 	/**
 	 * ModbusMasterUdp
 	 *
@@ -44,8 +44,8 @@ class ModbusMasterUdp extends ModbusMaster {
 	 *
 	 * @param String $host An IP address of a Modbus UDP device. E.g. "192.168.1.1".
 	 */
-  function ModbusMasterUdp($host){
-    $this->host = $host;
-    $this->socket_protocol = "UDP";    
+	public function __construct($host)
+	{
+		parent::__construct($host, "UDP");
 	}
 }

src/PhpType.php

@@ -1,6 +1,7 @@
 <?php
 
 namespace PHPModbus;
+use Exception;
 
 /**
  * Phpmodbus Copyright (c) 2004, 2012 Jan Krakora
@@ -28,8 +29,8 @@ namespace PHPModbus;
  * @package    Phpmodbus
  *
  */
-class PhpType {
-
+class PhpType
+{
 	/**
 	 * bytes2float
 	 *
@@ -37,19 +38,17 @@ class PhpType {
 	 * depends on order of the input bytes (endianning).
 	 *
 	 * @param array $values
-     * @param bool $endianness
+	 * @param bool  $bigEndian
 	 * @return float
 	 */
-    public static function bytes2float($values, $endianness = 0) {
-        $data = array();
-        $real = 0;
-
+	public static function bytes2float($values, $bigEndian = 0)
+	{
 		// Set the array to correct form
 		$data = self::checkData($values);
 		// Combine bytes
-        $real = self::combineBytes($data, $endianness);
+		$real = self::combineBytes($data, $bigEndian);
 		// Convert the real value to float
-        return (float) self::real2float($real);
+		return (float)self::real2float($real);
 	}
 
 	/**
@@ -59,22 +58,23 @@ class PhpType {
 	 * The return value depends on order of the input bytes (endianning).
 	 *
 	 * @param array $values
-     * @param bool $endianness
+	 * @param bool  $bigEndian
 	 * @return int
 	 */
-    public static function bytes2signedInt($values, $endianness = 0) {
+	public static function bytes2signedInt($values, $bigEndian = 0)
+	{
 		$data = array();
 		$int = 0;
 		// Set the array to correct form
 		$data = self::checkData($values);
 		// Combine bytes
-        $int = self::combineBytes($data, $endianness);
+		$int = self::combineBytes($data, $bigEndian);
 		// In the case of signed 2 byte value convert it to 4 byte one
 		if ((count($values) == 2) && ((0x8000 & $int) > 0)) {
 			$int = 0xFFFF8000 | $int;
 		}
 		// Convert the value
-        return (int) self::dword2signedInt($int);
+		return (int)self::dword2signedInt($int);
 	}
 
 	/**
@@ -84,16 +84,17 @@ class PhpType {
 	 * The return value depends on order of the input bytes (endianning).
 	 *
 	 * @param array $values
-     * @param bool $endianness
+	 * @param bool  $bigEndian
 	 * @return int|float
 	 */
-    public static function bytes2unsignedInt($values, $endianness = 0) {
+	public static function bytes2unsignedInt($values, $bigEndian = 0)
+	{
 		$data = array();
 		$int = 0;
 		// Set the array to correct form
 		$data = self::checkData($values);
 		// Combine bytes
-        $int = self::combineBytes($data, $endianness);
+		$int = self::combineBytes($data, $bigEndian);
 		// Convert the value
 		return self::dword2unsignedInt($int);
 	}
@@ -105,35 +106,39 @@ class PhpType {
 	 * the end of the string by 0x00 character as defined by string standards.
 	 *
 	 * @param array $values
-     * @param bool $endianness
+	 * @param bool  $bigEndian
 	 * @return string
 	 */
-    public static function bytes2string($values, $endianness = 0) {
+	public static function bytes2string($values, $bigEndian = 0)
+	{
 		// Prepare string variable
 		$str = "";
 		// Parse the received data word array
-        for($i=0;$i<count($values);$i+=2) {
-            if ($endianness) {
-                if($values[$i] != 0)
+		for ($i = 0; $i < count($values); $i += 2) {
+			if ($bigEndian) {
+				if ($values[$i] != 0) {
 					$str .= chr($values[$i]);
-                else
-                    break;
-                if($values[$i+1] != 0)
-                    $str .= chr($values[$i+1]);
-                else
+				} else {
 					break;
 				}
-            else {
-                if($values[$i+1] != 0)
-                    $str .= chr($values[$i+1]);
-                else
+				if ($values[$i + 1] != 0) {
+					$str .= chr($values[$i + 1]);
+				} else {
 					break;
-                if($values[$i] != 0)
+				}
+			} else {
+				if ($values[$i + 1] != 0) {
+					$str .= chr($values[$i + 1]);
+				} else {
+					break;
+				}
+				if ($values[$i] != 0) {
 					$str .= chr($values[$i]);
-                else
+				} else {
 					break;
 				}
 			}
+		}
 		// return string
 		return $str;
 	}
@@ -144,13 +149,15 @@ class PhpType {
 	 * This function converts a value in IEC-1131 REAL single precision form to float.
 	 *
 	 * For more see [{@link http://en.wikipedia.org/wiki/Single_precision Single precision on Wiki}] or
-     * [{@link http://de.php.net/manual/en/function.base-convert.php PHP base_convert function commentary}, Todd Stokes @ Georgia Tech 21-Nov-2007] or
+	 * [{@link http://de.php.net/manual/en/function.base-convert.php PHP base_convert function commentary}, Todd Stokes
+	 * @ Georgia Tech 21-Nov-2007] or
 	 * [{@link http://www.php.net/manual/en/function.pack.php PHP pack/unpack functionality}]
 	 *
-     * @param value value in IEC REAL data type to be converted
+	 * @param int $value in IEC REAL data type to be converted
 	 * @return float float value
 	 */
-    private static function real2float($value) {
+	private static function real2float($value)
+	{
 		// get unsigned long
 		$ulong = pack("L", $value);
 		// set float
@@ -167,9 +174,10 @@ class PhpType {
 	 * @param int $value
 	 * @return int
 	 */
-    private static function dword2signedInt($value) {
+	private static function dword2signedInt($value)
+	{
 		if ((0x80000000 & $value) != 0) {
-            return -(0x7FFFFFFF & ~$value)-1;
+			return -(0x7FFFFFFF & ~$value) - 1;
 		} else {
 			return (0x7FFFFFFF & $value);
 		}
@@ -183,11 +191,12 @@ class PhpType {
 	 * @param int $value
 	 * @return int|float
 	 */
-    private static function dword2unsignedInt($value) {
+	private static function dword2unsignedInt($value)
+	{
 		if ((0x80000000 & $value) != 0) {
-            return ((float) (0x7FFFFFFF & $value)) + 2147483648;
+			return ((float)(0x7FFFFFFF & $value)) + 2147483648;
 		} else {
-            return (int) (0x7FFFFFFF & $value);
+			return (int)(0x7FFFFFFF & $value);
 		}
 	}
 
@@ -196,15 +205,18 @@ class PhpType {
 	 *
 	 * Check if the data variable is array, and check if the values are numeric
 	 *
-     * @param int $data
+	 * @param int[] $data
 	 * @return int
+	 * @throws Exception
 	 */
-    private static function checkData($data) {
+	private static function checkData($data)
+	{
 		// Check the data
 		if (!is_array($data) ||
-                count($data)<2 ||
-                count($data)>4 ||
-                count($data)==3) {
+			count($data) < 2 ||
+			count($data) > 4 ||
+			count($data) == 3
+		) {
 			throw new Exception('The input data should be an array of 2 or 4 bytes.');
 		}
 		// Fill the rest of array by zeroes
@@ -216,7 +228,8 @@ class PhpType {
 		if (!is_numeric($data[0]) ||
 			!is_numeric($data[1]) ||
 			!is_numeric($data[2]) ||
-                !is_numeric($data[3])) {
+			!is_numeric($data[3])
+		) {
 			throw new Exception('Data are not numeric or the array keys are not indexed by 0,1,2 and 3');
 		}
 
@@ -229,24 +242,25 @@ class PhpType {
 	 * Combine bytes together
 	 *
 	 * @param int  $data
-     * @param bool $endianness
+	 * @param bool $bigEndian
 	 * @return int
 	 */
-    private static function combineBytes($data, $endianness) {
+	private static function combineBytes($data, $bigEndian)
+	{
 		$value = 0;
 		// Combine bytes
-        if ($endianness == 0)
-            $value = (($data[3] & 0xFF)<<16) |
-                    (($data[2] & 0xFF)<<24) |
+		if ($bigEndian == 0) {
+			$value = (($data[3] & 0xFF) << 16) |
+				(($data[2] & 0xFF) << 24) |
 				(($data[1] & 0xFF)) |
-                    (($data[0] & 0xFF)<<8);
-        else
-            $value = (($data[3] & 0xFF)<<24) |
-                    (($data[2] & 0xFF)<<16) |
-                    (($data[1] & 0xFF)<<8) |
+				(($data[0] & 0xFF) << 8);
+		} else {
+			$value = (($data[3] & 0xFF) << 24) |
+				(($data[2] & 0xFF) << 16) |
+				(($data[1] & 0xFF) << 8) |
 				(($data[0] & 0xFF));
+		}
 
 		return $value;
 	}
 }
-?>