Merge pull request #42 from ingenerator/1.x-support-php-81

craig410 · web-flow · commit 530d88109de4 · 2022-10-10T08:45:11.000+01:00
Support PHP8.1
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -17,15 +17,15 @@ jobs:
       fail-fast: false
       matrix:
         php_version:
-          - '7.4'
           - '8.0'
+          - '8.1'
         dependencies:
           - 'default'
         include:
-          - php_version: '7.4'
-            dependencies: 'lowest'
           - php_version: '8.0'
             dependencies: 'lowest'
+          - php_version: '8.1'
+            dependencies: 'lowest'
     steps:
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,10 @@
 ### Unreleased
 
+### v1.16.0 (2022-10-10)
+
+* Support PHP 8.1
+* Drop support for PHP 7.4
+
 ### v1.15.0 (2021-11-24)
 
 * Optionally report the count of log entries to a MetricsAgent- see `StackdriverApplicationLogger::withMetrics()`
diff --git a/composer.json b/composer.json
@@ -16,16 +16,16 @@
   ],
   "require": {
     "ext-json": "*",
-    "ext-mbstring": "^7 || ~8.0.0",
-    "ext-pdo": "^7 || ~8.0.0",
-    "ext-sodium": "^7.4 || ~8.0.0",
-    "php": "^7.4 || ~8.0.0",
+    "ext-mbstring": "~8.0.0 || ~8.1.0",
+    "ext-pdo": "~8.0.0 || ~8.1.0",
+    "ext-sodium": "~8.0.0 || ~8.1.0",
+    "php": "~8.0.0 || ~8.1.0",
     "psr/log": "^1.1"
   },
   "require-dev": {
     "johnkary/phpunit-speedtrap": "^3.3",
-    "mikey179/vfsstream": "^1.6.8",
-    "phpunit/phpunit": "^9.5"
+    "mikey179/vfsstream": "^1.6.10",
+    "phpunit/phpunit": "^9.5.5"
   },
   "support": {
     "source": "https://github.com/ingenerator/php-utils",
diff --git a/src/DateTime/InvalidUserDateTime.php b/src/DateTime/InvalidUserDateTime.php
@@ -30,27 +30,27 @@ public function __construct($input_string)
         $this->input_string = $input_string;
     }
 
-    public static function createFromFormat($format, $time, $timezone = NULL)
+    public static function createFromFormat($format, $time, $timezone = NULL): \DateTimeImmutable
     {
         throw new \BadMethodCallException('Invalid call to '.__METHOD__);
     }
 
-    public static function createFromMutable($dateTime)
+    public static function createFromMutable($dateTime): \DateTimeImmutable
     {
         throw new \BadMethodCallException('Invalid call to '.__METHOD__);
     }
 
-    public static function getLastErrors()
+    public static function getLastErrors(): array|false
     {
         throw new \BadMethodCallException('Invalid call to '.__METHOD__);
     }
 
-    public static function __set_state(array $array)
+    public static function __set_state(array $array): \DateTimeImmutable
     {
         throw new \BadMethodCallException('Invalid call to '.__METHOD__);
     }
 
-    public function format($format)
+    public function format($format): string
     {
         return $this->input_string;
     }
@@ -60,7 +60,7 @@ public function __toString()
         return $this->input_string;
     }
 
-    public function add($interval)
+    public function add($interval): \DateTimeImmutable
     {
         throw new \RuntimeException(
             'Cannot '.__METHOD__.' on invalid user date/time `'.$this->input_string.'`'
@@ -78,84 +78,84 @@ public function add($interval)
      * @return static
      * Returns the {@link http://www.php.net/manual/en/class.datetimeimmutable.php DateTimeImmutable} object for method chaining or <b>FALSE</b> on failure.
      */
-    public function modify($modify)
+    public function modify($modify): \DateTimeImmutable
     {
         throw new \RuntimeException(
             'Cannot '.__METHOD__.' on invalid user date/time `'.$this->input_string.'`'
         );
     }
 
-    public function setDate($year, $month, $day)
+    public function setDate($year, $month, $day): \DateTimeImmutable
     {
         throw new \RuntimeException(
             'Cannot '.__METHOD__.' on invalid user date/time `'.$this->input_string.'`'
         );
     }
 
-    public function setISODate($year, $week, $day = 1)
+    public function setISODate($year, $week, $day = 1): \DateTimeImmutable
     {
         throw new \RuntimeException(
             'Cannot '.__METHOD__.' on invalid user date/time `'.$this->input_string.'`'
         );
     }
 
-    public function setTime($hour, $minute, $second = 0, $microseconds = 0)
+    public function setTime($hour, $minute, $second = 0, $microseconds = 0): \DateTimeImmutable
     {
         throw new \RuntimeException(
             'Cannot '.__METHOD__.' on invalid user date/time `'.$this->input_string.'`'
         );
     }
 
-    public function setTimestamp($unixtimestamp)
+    public function setTimestamp($unixtimestamp): \DateTimeImmutable
     {
         throw new \RuntimeException(
             'Cannot '.__METHOD__.' on invalid user date/time `'.$this->input_string.'`'
         );
     }
 
-    public function setTimezone($timezone)
+    public function setTimezone($timezone): \DateTimeImmutable
     {
         throw new \RuntimeException(
             'Cannot '.__METHOD__.' on invalid user date/time `'.$this->input_string.'`'
         );
     }
 
-    public function sub($interval)
+    public function sub($interval): \DateTimeImmutable
     {
         throw new \RuntimeException(
             'Cannot '.__METHOD__.' on invalid user date/time `'.$this->input_string.'`'
         );
     }
 
-    public function diff($datetime2, $absolute = FALSE)
+    public function diff($datetime2, $absolute = FALSE): \DateInterval
     {
         throw new \RuntimeException(
             'Cannot '.__METHOD__.' on invalid user date/time `'.$this->input_string.'`'
         );
     }
 
-    public function getOffset()
+    public function getOffset(): int
     {
         throw new \RuntimeException(
             'Cannot '.__METHOD__.' on invalid user date/time `'.$this->input_string.'`'
         );
     }
 
-    public function getTimestamp()
+    public function getTimestamp(): int
     {
         throw new \RuntimeException(
             'Cannot '.__METHOD__.' on invalid user date/time `'.$this->input_string.'`'
         );
     }
 
-    public function getTimezone()
+    public function getTimezone(): \DateTimeZone|false
     {
         throw new \RuntimeException(
             'Cannot '.__METHOD__.' on invalid user date/time `'.$this->input_string.'`'
         );
     }
 
-    public function __wakeup()
+    public function __wakeup(): void
     {
         throw new \RuntimeException(
             'Cannot '.__METHOD__.' on invalid user date/time `'.$this->input_string.'`'
diff --git a/src/Session/MysqlSession.php b/src/Session/MysqlSession.php
@@ -72,7 +72,7 @@ public function __construct(PDO $db, $hash_salt, $lock_timeout = 20)
     /**
      * @return void
      */
-    public function initialise()
+    public function initialise(): void
     {
         // strict mode is required both for general security, and to enable the create_sid and
         // validateId methods in this handler interface, which won't otherwise be called.
@@ -83,15 +83,15 @@ public function initialise()
     /**
      * {@inheritdoc}
      */
-    public function close()
+    public function close(): bool
     {
         return $this->releaseLock();
     }
 
     /**
      * {@inheritdoc}
      */
-    public function destroy($session_id)
+    public function destroy($session_id): bool
     {
         return $this->db->prepare("DELETE FROM `sessions` WHERE `id` = :id")
             ->execute(['id' => $session_id]);
@@ -102,15 +102,15 @@ public function destroy($session_id)
      *
      * @return int
      */
-    public function garbageCollect()
+    public function garbageCollect(): bool|int
     {
         return $this->gc($this->session_lifetime);
     }
 
     /**
      * {@inheritdoc}
      */
-    public function gc($maxlifetime)
+    public function gc($maxlifetime): int|false
     {
         $now = new \DateTimeImmutable();
         $gc  = $this->db->prepare("DELETE FROM `sessions` WHERE `last_active` < :expire");
@@ -124,7 +124,7 @@ public function gc($maxlifetime)
     /**
      * {@inheritdoc}
      */
-    public function open($save_path, $name)
+    public function open($save_path, $name): bool
     {
         return TRUE;
     }
@@ -134,7 +134,7 @@ public function open($save_path, $name)
      *
      * {@inheritDoc}
      */
-    public function create_sid()
+    public function create_sid(): string
     {
         $session_id = \session_create_id();
 
@@ -183,7 +183,7 @@ public function create_sid()
     /**
      * {@inheritDoc}
      */
-    public function validateId($session_id)
+    public function validateId($session_id): bool
     {
         $now = new \DateTimeImmutable();
         $this->getLock($session_id);
@@ -232,7 +232,7 @@ public function validateId($session_id)
     /**
      * {@inheritdoc}
      */
-    public function read($session_id)
+    public function read($session_id): string|false
     {
         if ( ! isset($this->data_cache[$session_id])) {
             // This cannot realistically ever happen in real life. PHP will *always* have called
@@ -258,7 +258,7 @@ public function read($session_id)
      *
      * {@inheritdoc}
      */
-    public function write($session_id, $session_data)
+    public function write($session_id, $session_data): bool
     {
         // There is no reason to update user_agent or hash
         // If user_agent has changed the hash will have changed
@@ -282,7 +282,7 @@ public function write($session_id, $session_data)
     /**
      * Called to mark a session still active even if the data hasn't changed
      */
-    public function updateTimestamp($session_id, $session_data)
+    public function updateTimestamp($session_id, $session_data): bool
     {
         // There is no reason to update user_agent or hash
         // If user_agent has changed the hash will have changed
@@ -305,7 +305,7 @@ public function updateTimestamp($session_id, $session_data)
     /**
      * @return string
      */
-    protected function calculateHash()
+    protected function calculateHash(): string
     {
         $hash = $this->client_user_agent.$this->hash_salt;
 
@@ -318,7 +318,7 @@ protected function calculateHash()
      * @return bool
      * @throws \ErrorException
      */
-    protected function getLock($session_id)
+    protected function getLock($session_id): bool
     {
         $this->session_lock = 'session_'.$session_id;
 
@@ -336,7 +336,7 @@ protected function getLock($session_id)
     /**
      * @return bool
      */
-    protected function releaseLock()
+    protected function releaseLock(): bool
     {
         if ( ! $this->session_lock) {
             // The lock has already been released e.g. due to validateSid releasing it because
diff --git a/src/StringEncoding/JSON.php b/src/StringEncoding/JSON.php
@@ -3,13 +3,18 @@
 namespace Ingenerator\PHPUtils\StringEncoding;
 
 use Ingenerator\PHPUtils\StringEncoding\InvalidJSONException;
+use function json_last_error_msg;
 
 class JSON
 {
 
     public static function decode(?string $json)
     {
-        $result = json_decode($json, TRUE);
+        try {
+            $result = json_decode($json, TRUE);
+        } catch (\ErrorException $e){
+            throw new InvalidJSONException('Invalid JSON: ' . json_last_error_msg());
+        }
         if (json_last_error() !== JSON_ERROR_NONE) {
             throw new InvalidJSONException('Invalid JSON: ' . json_last_error_msg());
         }
diff --git a/test/unit/Mutex/BasicPDOStatementStub.php b/test/unit/Mutex/BasicPDOStatementStub.php
@@ -3,6 +3,7 @@
 namespace test\unit\Ingenerator\PHPUtils\unit\Mutex;
 
 use PDO;
+use function array_map;
 use const PHP_MAJOR_VERSION;
 
 if (PHP_MAJOR_VERSION < 8) {
@@ -12,7 +13,7 @@ class BasicPDOStatementStub extends \PDOStatement
 
         public function __construct(array $result) { $this->result = $result; }
 
-        public function fetchAll($fetch_style = NULL, $fetch_argument = NULL, $ctor_args = NULL)
+        public function fetchAll($fetch_style = NULL, $fetch_argument = NULL, $ctor_args = NULL): array
         {
             if ($fetch_style === NULL) {
                 return $this->result;
@@ -37,7 +38,7 @@ class BasicPDOStatementStub extends \PDOStatement
 
         public function __construct(array $result) { $this->result = $result; }
 
-        public function fetchAll(int $fetch_style = NULL, mixed ...$fetch_argument)
+        public function fetchAll(int $fetch_style = NULL, mixed ...$fetch_argument): array
         {
             if ($fetch_style === NULL) {
                 return $this->result;
diff --git a/test/unit/Mutex/BasicPDOStub.php b/test/unit/Mutex/BasicPDOStub.php
@@ -3,6 +3,7 @@
 namespace test\unit\Ingenerator\PHPUtils\unit\Mutex;
 
 use PDO;
+use PDOStatement;
 use PHPUnit\Framework\Assert;
 use const PHP_MAJOR_VERSION;
 
@@ -59,16 +60,13 @@ public static function withQueryStack(array $stack)
 
         public function __construct() { }
 
-        public function quote($string, $type = PDO::PARAM_STR)
+        public function quote($string, $type = PDO::PARAM_STR): string|false
         {
             return '{quoted-'.$string.'}';
         }
 
-        public function query(
-            string $statement,
-            ?int $fetchMode = PDO::ATTR_DEFAULT_FETCH_MODE,
-            mixed ...$fetchModeArgs
-        ) {
+        public function query($statement, $mode = PDO::ATTR_DEFAULT_FETCH_MODE, ...$fetch_mode_args): PDOStatement|false
+        {
             Assert::assertNotEmpty($this->query_stack, 'No expectation defined for query '.$statement);
             $next_query = array_shift($this->query_stack);
             Assert::assertSame($next_query['sql'], $statement);

Original file line number	Diff line number	Diff line change
`@@ -30,27 +30,27 @@ public function __construct($input_string)`
`30`	`30`	`$this->input_string = $input_string;`
`31`	`31`	`}`
`32`	`32`
`33`		`- public static function createFromFormat($format, $time, $timezone = NULL)`
	`33`	`+ public static function createFromFormat($format, $time, $timezone = NULL): \DateTimeImmutable`
`34`	`34`	`{`
`35`	`35`	`throw new \BadMethodCallException('Invalid call to '.__METHOD__);`
`36`	`36`	`}`
`37`	`37`
`38`		`- public static function createFromMutable($dateTime)`
	`38`	`+ public static function createFromMutable($dateTime): \DateTimeImmutable`
`39`	`39`	`{`
`40`	`40`	`throw new \BadMethodCallException('Invalid call to '.__METHOD__);`
`41`	`41`	`}`
`42`	`42`
`43`		`- public static function getLastErrors()`
	`43`	`+ public static function getLastErrors(): array\|false`
`44`	`44`	`{`
`45`	`45`	`throw new \BadMethodCallException('Invalid call to '.__METHOD__);`
`46`	`46`	`}`
`47`	`47`
`48`		`- public static function __set_state(array $array)`
	`48`	`+ public static function __set_state(array $array): \DateTimeImmutable`
`49`	`49`	`{`
`50`	`50`	`throw new \BadMethodCallException('Invalid call to '.__METHOD__);`
`51`	`51`	`}`
`52`	`52`
`53`		`- public function format($format)`
	`53`	`+ public function format($format): string`
`54`	`54`	`{`
`55`	`55`	`return $this->input_string;`
`56`	`56`	`}`
`@@ -60,7 +60,7 @@ public function __toString()`
`60`	`60`	`return $this->input_string;`
`61`	`61`	`}`
`62`	`62`
`63`		`- public function add($interval)`
	`63`	`+ public function add($interval): \DateTimeImmutable`
`64`	`64`	`{`
`65`	`65`	`throw new \RuntimeException(`
`66`	`66`	'Cannot '.__METHOD__.' on invalid user date/time `'.$this->input_string.'`'
`@@ -78,84 +78,84 @@ public function add($interval)`
`78`	`78`	`* @return static`
`79`	`79`	`* Returns the {@link http://www.php.net/manual/en/class.datetimeimmutable.php DateTimeImmutable} object for method chaining or <b>FALSE</b> on failure.`
`80`	`80`	`*/`
`81`		`- public function modify($modify)`
	`81`	`+ public function modify($modify): \DateTimeImmutable`
`82`	`82`	`{`
`83`	`83`	`throw new \RuntimeException(`
`84`	`84`	'Cannot '.__METHOD__.' on invalid user date/time `'.$this->input_string.'`'
`85`	`85`	`);`
`86`	`86`	`}`
`87`	`87`
`88`		`- public function setDate($year, $month, $day)`
	`88`	`+ public function setDate($year, $month, $day): \DateTimeImmutable`
`89`	`89`	`{`
`90`	`90`	`throw new \RuntimeException(`
`91`	`91`	'Cannot '.__METHOD__.' on invalid user date/time `'.$this->input_string.'`'
`92`	`92`	`);`
`93`	`93`	`}`
`94`	`94`
`95`		`- public function setISODate($year, $week, $day = 1)`
	`95`	`+ public function setISODate($year, $week, $day = 1): \DateTimeImmutable`
`96`	`96`	`{`
`97`	`97`	`throw new \RuntimeException(`
`98`	`98`	'Cannot '.__METHOD__.' on invalid user date/time `'.$this->input_string.'`'
`99`	`99`	`);`
`100`	`100`	`}`
`101`	`101`
`102`		`- public function setTime($hour, $minute, $second = 0, $microseconds = 0)`
	`102`	`+ public function setTime($hour, $minute, $second = 0, $microseconds = 0): \DateTimeImmutable`
`103`	`103`	`{`
`104`	`104`	`throw new \RuntimeException(`
`105`	`105`	'Cannot '.__METHOD__.' on invalid user date/time `'.$this->input_string.'`'
`106`	`106`	`);`
`107`	`107`	`}`
`108`	`108`
`109`		`- public function setTimestamp($unixtimestamp)`
	`109`	`+ public function setTimestamp($unixtimestamp): \DateTimeImmutable`
`110`	`110`	`{`
`111`	`111`	`throw new \RuntimeException(`
`112`	`112`	'Cannot '.__METHOD__.' on invalid user date/time `'.$this->input_string.'`'
`113`	`113`	`);`
`114`	`114`	`}`
`115`	`115`
`116`		`- public function setTimezone($timezone)`
	`116`	`+ public function setTimezone($timezone): \DateTimeImmutable`
`117`	`117`	`{`
`118`	`118`	`throw new \RuntimeException(`
`119`	`119`	'Cannot '.__METHOD__.' on invalid user date/time `'.$this->input_string.'`'
`120`	`120`	`);`
`121`	`121`	`}`
`122`	`122`
`123`		`- public function sub($interval)`
	`123`	`+ public function sub($interval): \DateTimeImmutable`
`124`	`124`	`{`
`125`	`125`	`throw new \RuntimeException(`
`126`	`126`	'Cannot '.__METHOD__.' on invalid user date/time `'.$this->input_string.'`'
`127`	`127`	`);`
`128`	`128`	`}`
`129`	`129`
`130`		`- public function diff($datetime2, $absolute = FALSE)`
	`130`	`+ public function diff($datetime2, $absolute = FALSE): \DateInterval`
`131`	`131`	`{`
`132`	`132`	`throw new \RuntimeException(`
`133`	`133`	'Cannot '.__METHOD__.' on invalid user date/time `'.$this->input_string.'`'
`134`	`134`	`);`
`135`	`135`	`}`
`136`	`136`
`137`		`- public function getOffset()`
	`137`	`+ public function getOffset(): int`
`138`	`138`	`{`
`139`	`139`	`throw new \RuntimeException(`
`140`	`140`	'Cannot '.__METHOD__.' on invalid user date/time `'.$this->input_string.'`'
`141`	`141`	`);`
`142`	`142`	`}`
`143`	`143`
`144`		`- public function getTimestamp()`
	`144`	`+ public function getTimestamp(): int`
`145`	`145`	`{`
`146`	`146`	`throw new \RuntimeException(`
`147`	`147`	'Cannot '.__METHOD__.' on invalid user date/time `'.$this->input_string.'`'
`148`	`148`	`);`
`149`	`149`	`}`
`150`	`150`
`151`		`- public function getTimezone()`
	`151`	`+ public function getTimezone(): \DateTimeZone\|false`
`152`	`152`	`{`
`153`	`153`	`throw new \RuntimeException(`
`154`	`154`	'Cannot '.__METHOD__.' on invalid user date/time `'.$this->input_string.'`'
`155`	`155`	`);`
`156`	`156`	`}`
`157`	`157`
`158`		`- public function __wakeup()`
	`158`	`+ public function __wakeup(): void`
`159`	`159`	`{`
`160`	`160`	`throw new \RuntimeException(`
`161`	`161`	'Cannot '.__METHOD__.' on invalid user date/time `'.$this->input_string.'`'
Original file line number	Diff line number	Diff line change
`@@ -3,13 +3,18 @@`
`3`	`3`	`namespace Ingenerator\PHPUtils\StringEncoding;`
`4`	`4`
`5`	`5`	`use Ingenerator\PHPUtils\StringEncoding\InvalidJSONException;`
	`6`	`+use function json_last_error_msg;`
`6`	`7`
`7`	`8`	`class JSON`
`8`	`9`	`{`
`9`	`10`
`10`	`11`	`public static function decode(?string $json)`
`11`	`12`	`{`
`12`		`- $result = json_decode($json, TRUE);`
	`13`	`+ try {`
	`14`	`+ $result = json_decode($json, TRUE);`
	`15`	`+ } catch (\ErrorException $e){`
	`16`	`+ throw new InvalidJSONException('Invalid JSON: ' . json_last_error_msg());`
	`17`	`+ }`
`13`	`18`	`if (json_last_error() !== JSON_ERROR_NONE) {`
`14`	`19`	`throw new InvalidJSONException('Invalid JSON: ' . json_last_error_msg());`
`15`	`20`	`}`