Changeset 887 for trunk/Modules/NetworkConfigRouterOS/RouterboardAPI.php

Timestamp:

Nov 20, 2020, 12:08:12 AM (4 years ago)

Author:

chronos

Message:

• Added: Static types added to almost all classes, methods and function. Supported by PHP 7.4.
• Fixed: Various found code issues.

File:

• trunk/Modules/NetworkConfigRouterOS/RouterboardAPI.php (modified) (11 diffs)

trunk/Modules/NetworkConfigRouterOS/RouterboardAPI.php

@@ -25 +25 @@
   }
 
-  function EncodeLength($Length)
-  {
-    if ($Length < 0x80) {
+  function EncodeLength(int $Length): int
+  {
+    if ($Length < 0x80)
+    {
       $Length = chr($Length);
-    } else if ($Length < 0x4000) {
+    } else if ($Length < 0x4000)
+    {
       $Length |= 0x8000;
       $Length = chr(($Length >> 8) & 0xFF).chr($Length & 0xFF);
-    } else if ($Length < 0x200000) {
+    } else if ($Length < 0x200000)
+    {
       $Length |= 0xC00000;
       $Length = chr(($Length >> 16) & 0xFF).chr(($Length >> 8) & 0xFF).chr($Length & 0xFF);
-    } else if ($Length < 0x10000000) {
+    } else if ($Length < 0x10000000)
+    {
       $Length |= 0xE0000000;
       $Length = chr(($Length >> 24) & 0xFF).chr(($Length >> 16) & 0xFF).chr(($Length >> 8) & 0xFF).chr($Length & 0xFF);
@@ -43 +47 @@
   }
 
-  function ConnectOnce($IP, $Login, $Password)
+  function ConnectOnce(string $IP, string $Login, string $Password): void
   {
     if ($this->Connected) $this->Disconnect();
@@ -63 +67 @@
   }
 
-  function Connect($IP, $Login, $Password)
+  function Connect(string $IP, string $Login, string $Password): bool
   {
     for ($Attempt = 1; $Attempt <= $this->Attempts; $Attempt++)
@@ -74 +78 @@
   }
 
-  function Disconnect()
+  function Disconnect(): void
   {
     if ($this->Connected)
@@ -83 +87 @@
   }
 
-  function ParseResponse($Response)
-  {
-    if (is_array($Response)) {
+  function ParseResponse(array $Response): array
+  {
+    if (is_array($Response))
+    {
       $Parsed      = array();
       $Current     = null;
       $SingleValue = null;
       $count       = 0;
-      foreach ($Response as $x) {
+      foreach ($Response as $x)
+      {
         if (in_array($x, array(
             '!fatal',
             '!re',
             '!trap'
-        ))) {
-          if ($x == '!re') {
+        )))
+        {
+          if ($x == '!re')
+          {
             $Current =& $Parsed[];
           } else
             $Current =& $Parsed[$x][];
-        } else if ($x != '!done') {
-          if (preg_match_all('/[^=]+/i', $x, $Matches)) {
+        } else if ($x != '!done')
+        {
+          if (preg_match_all('/[^=]+/i', $x, $Matches))
+          {
             if ($Matches[0][0] == 'ret') {
               $SingleValue = $Matches[0][1];
@@ -109 +119 @@
         }
       }
-      if (empty($Parsed) && !is_null($SingleValue)) {
+      if (empty($Parsed) && !is_null($SingleValue))
+      {
         $Parsed = $SingleValue;
       }
@@ -117 +128 @@
   }
 
-  function ArrayChangeKeyName(&$array)
-  {
-    if (is_array($array)) {
-      foreach ($array as $k => $v) {
+  function ArrayChangeKeyName(array &$array): array
+  {
+    if (is_array($array))
+    {
+      foreach ($array as $k => $v)
+      {
         $tmp = str_replace("-", "_", $k);
         $tmp = str_replace("/", "_", $tmp);
-        if ($tmp) {
+        if ($tmp)
+        {
           $array_new[$tmp] = $v;
-        } else {
+        } else
+        {
           $array_new[$k] = $v;
         }
       }
       return $array_new;
-    } else {
+    } else
+    {
       return $array;
     }
   }
 
-  function Read($Parse = true)
+  function Read(bool $Parse = true): array
   {
     $Line = '';
     $Response = array();
-    while (true) {
+    while (true)
+    {
       // Read the first byte of input which gives us some or all of the length
       // of the remaining reply.
@@ -149 +166 @@
       // If the fourth bit is set, we need to remove anything left in the first byte
       // and then read in yet another byte.
-      if ($Byte & 0x80) {
-        if (($Byte & 0xc0) == 0x80) {
+      if ($Byte & 0x80)
+      {
+        if (($Byte & 0xc0) == 0x80)
+        {
           $Length = (($Byte & 63) << 8) + ord(fread($this->Socket, 1));
-        } else {
-          if (($Byte & 0xe0) == 0xc0) {
+        } else
+        {
+          if (($Byte & 0xe0) == 0xc0)
+          {
             $Length = (($Byte & 31) << 8) + ord(fread($this->Socket, 1));
             $Length = ($Length << 8) + ord(fread($this->Socket, 1));
-          } else {
-            if (($Byte & 0xf0) == 0xe0) {
+          } else
+          {
+            if (($Byte & 0xf0) == 0xe0)
+            {
               $Length = (($Byte & 15) << 8) + ord(fread($this->Socket, 1));
               $Length = ($Length << 8) + ord(fread($this->Socket, 1));
               $Length = ($Length << 8) + ord(fread($this->Socket, 1));
-            } else {
+            } else
+            {
               $Length = ord(fread($this->Socket, 1));
               $Length = ($Length << 8) + ord(fread($this->Socket, 1));
@@ -169 +193 @@
           }
         }
-      } else {
+      } else
+      {
         $Length = $Byte;
       }
       // If we have got more characters to read, read them in.
-      if ($Length > 0) {
+      if ($Length > 0)
+      {
         $Line = '';
         $RetLen = 0;
-        while ($RetLen < $Length) {
+        while ($RetLen < $Length)
+        {
           $ToRead = $Length - $RetLen;
           $Line .= fread($this->Socket, $ToRead);
@@ -196 +223 @@
   }
 
-  function Write($Command, $Param2 = true)
+  function Write(string $Command, bool $Param2 = true): bool
   {
     if ($Command)
     {
       $Data = explode("\n", $Command);
-      foreach ($Data as $Com) {
+      foreach ($Data as $Com)
+      {
         $Com = trim($Com);
         fwrite($this->Socket, $this->EncodeLength(strlen($Com)).$Com);
       }
-      if (gettype($Param2) == 'integer') {
+      if (gettype($Param2) == 'integer')
+      {
         fwrite($this->Socket, $this->EncodeLength(strlen('.tag='.$Param2)).'.tag='.$Param2.chr(0));
       } else if (gettype($Param2) == 'boolean')
@@ -214 +243 @@
   }
 
-  function Comm($Com, $Arr = array())
+  function Comm(string $Com, array $Arr = array()): array
   {
     $Count = count($Arr);
     $this->write($Com, !$Arr);
     $i = 0;
-    foreach ($Arr as $k => $v) {
-      switch ($k[0]) {
+    foreach ($Arr as $k => $v)
+    {
+      switch ($k[0])
+      {
         case "?":
           $el = "$k=$v";