Merge pull request #991 from mike42/thicolares-add-strict-types

Add strict types (w/ modifications)

Author: mike42

src/Mike42/Escpos/CodePage.php

@@ -1,5 +1,4 @@
-<?php
-
+<?php declare(strict_types=1);
 /**
  * This file is part of escpos-php: PHP receipt printer library for use with
  * ESC/POS-compatible thermal and impact printers.
@@ -166,7 +165,7 @@ protected static function generateEncodingArray(string $encodingName) : array
             // Try to identify the UTF-8 character at this position in the code page
             $encodingChar = chr($char);
             $utf8 = $converter ->convert($encodingChar, false);
-            if ($utf8 === $missingChar) {
+            if ($utf8 === $missingChar || $utf8 === false) {
                 // Cannot be mapped to unicode
                 continue;
             }

src/Mike42/Escpos/ImagickEscposImage.php

@@ -1,5 +1,4 @@
-<?php
-
+<?php declare(strict_types=1);
 /**
  * This file is part of escpos-php: PHP receipt printer library for use with
  * ESC/POS-compatible thermal and impact printers.
@@ -117,7 +116,7 @@ private function getColumnFormatFromImage(Imagick $im, int $lineHeight)
             return [$this -> getRasterBlobFromImage($im)];
         } elseif ($imgWidth > $lineHeight) {
             // Calculations
-            $slicesLeft = ceil($imgWidth / $lineHeight / 2);
+            $slicesLeft = (int)ceil($imgWidth / $lineHeight / 2); // TODO avoid use of floats with intdiv()
             $widthLeft = $slicesLeft * $lineHeight;
             $widthRight = $imgWidth - $widthLeft;
             // Slice up (left)
@@ -149,11 +148,11 @@ private function getImageFromFile($filename)
     {
         $im = new Imagick();
         try {
-            $im->setResourceLimit(6, 1); // Prevent libgomp1 segfaults, grumble grumble.
+            $im -> setResourceLimit(6, 1); // Prevent libgomp1 segfaults, grumble grumble.
             $im -> readimage($filename);
         } catch (\ImagickException $e) {
             /* Re-throw as normal exception */
-            throw new Exception($e);
+            throw new Exception($e -> getMessage());
         }
         return $im;
     }
@@ -247,7 +246,7 @@ public static function loadPdf($pdfFile, int $pageWidth = 550)
         } catch (\ImagickException $e) {
             /* Wrap in normal exception, so that classes which call this do not
              * themselves require imagick as a dependency. */
-            throw new Exception($e);
+            throw new Exception($e -> getMessage());
         }
     }
 

src/Mike42/Escpos/PrintConnectors/NetworkPrintConnector.php

@@ -1,5 +1,4 @@
-<?php
-
+<?php declare(strict_types=1);
 /**
  * This file is part of escpos-php: PHP receipt printer library for use with
  * ESC/POS-compatible thermal and impact printers.
@@ -24,17 +23,19 @@ class NetworkPrintConnector extends FilePrintConnector
      * Construct a new NetworkPrintConnector
      *
      * @param string $ip IP address or hostname to use.
-     * @param string $port The port number to connect on.
-     * @param string $timeout The connection timeout, in seconds.
+     * @param int $port The port number to connect on.
+     * @param int $timeout The connection timeout, in seconds.
      * @throws Exception Where the socket cannot be opened.
      */
-    public function __construct(string $ip, int $port = 9100, bool $timeout = false)
+    public function __construct(string $ip, int $port = 9100, int $timeout = -1)
     {
-        // Default to 60 if default_socket_timeout isn't defined in the ini
-        $defaultSocketTimeout = ini_get("default_socket_timeout") ?: 60;
-        $timeout = $timeout ?: $defaultSocketTimeout;
-
-        $this -> fp = @fsockopen($ip, $port, $errno, $errstr, $timeout);
+        // Note: Once the minimum PHP version is PHP 7.0 or higher, we can type $timeout as '?int' to make it optional
+        // instead of using -1.
+        if ($timeout == -1) {
+            $this -> fp = @fsockopen($ip, $port, $errno, $errstr);
+        } else {
+            $this -> fp = @fsockopen($ip, $port, $errno, $errstr, (float)$timeout);
+        }
         if ($this -> fp === false) {
             throw new Exception("Cannot initialise NetworkPrintConnector: " . $errstr);
         }

src/Mike42/Escpos/Printer.php

@@ -1,5 +1,4 @@
-<?php
-
+<?php declare(strict_types=1);
 /**
  * This file is part of escpos-php: PHP receipt printer library for use with
  * ESC/POS-compatible thermal and impact printers.
@@ -691,7 +690,10 @@ public function pulse(int $pin = 0, int $on_ms = 120, int $off_ms = 240)
         self::validateInteger($pin, 0, 1, __FUNCTION__);
         self::validateInteger($on_ms, 1, 511, __FUNCTION__);
         self::validateInteger($off_ms, 1, 511, __FUNCTION__);
-        $this -> connector -> write(self::ESC . "p" . chr($pin + 48) . chr($on_ms / 2) . chr($off_ms / 2));
+        $pin_value = $pin + 48; // Character '0' or '1'.
+        $on_value = intdiv($on_ms, 2);
+        $off_value = intdiv($off_ms, 2);
+        $this -> connector -> write(self::ESC . "p" . chr($pin_value) . chr($on_value) . chr($off_value));
     }
 
     /**

test/integration/ExampleTest.php

@@ -194,7 +194,7 @@ private function runExample($fn, $syntaxCheck = false)
     protected function requireGraphicsLibrary()
     {
         if (!EscposImage::isGdLoaded() && !EscposImage::isImagickLoaded()) {
-            $this -> markTestSkipped("This test requires a graphics library.");
+            $this -> markTestSkipped("gd or imagick plugin is required for this test");
         }
     }
 }

test/unit/GdEscposImageTest.php

@@ -69,7 +69,7 @@ public function testGdWhite()
     private function loadAndCheckImg($fn, $width, $height, $rasterFormat = null, $columnFormat = null)
     {
         if (!EscposImage::isGdLoaded()) {
-            $this -> markTestSkipped("imagick plugin is required for this test");
+            $this -> markTestSkipped("gd plugin is required for this test");
         }
         $onDisk = ($fn === null ? null : (dirname(__FILE__) . "/resources/$fn"));
         // With optimisations