clean up php 8.4 and other changes (#156)

Author: ewood-ac

CHANGELOG.md

@@ -0,0 +1,30 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+- Full PHP 8.4 compatibility and support
+- Explicit nullable parameter type declarations for better type safety
+
+### Changed
+- Upgraded PHPUnit from ^9 to ^10.0 for better PHP 8.4 compatibility
+- Updated PHPDoc type annotations to match actual method signatures
+- Fixed all implicit nullable parameter deprecation warnings in PHP 8.4
+
+### Fixed
+- Resolved 20+ PHP 8.4 deprecation warnings related to implicit nullable parameters
+- Fixed PHPStan static analysis issues with type mismatches
+- Corrected return type declaration for `processRestRequest()` method
+
+### Technical Details
+- Updated `PostmarkAdminClient.php` - Fixed 15+ method parameters with explicit nullable types
+- Updated `PostmarkAttachment.php` - Fixed constructor and static method parameters
+- Updated `WebhookConfiguration.php` and `WebhookConfigurationTriggers.php` - Fixed nullable parameters
+- Updated various model classes with proper nullable type declarations
+- All tests pass on PHP 8.1, 8.2, 8.3, and 8.4
+- Zero deprecation warnings on PHP 8.4 

README.md

@@ -4,6 +4,13 @@
 
 With Postmark, you can send and _receive_ emails effortlessly.
 
+## Requirements
+
+- PHP 8.1, 8.2, 8.3, or 8.4
+- Guzzle HTTP client
+
+## Getting Started
+
 [Check out our wiki](https://github.com/ActiveCampaign/postmark-php/wiki/Getting-Started) to get started using Postmark-PHP now.
 
 [![Build Status](https://circleci.com/gh/ActiveCampaign/postmark-php.svg?style=shield)](https://circleci.com/gh/ActiveCampaign/postmark-php)

composer.json

@@ -13,7 +13,7 @@
     "guzzlehttp/guzzle": "^7.8"
   },
   "require-dev": {
-    "phpunit/phpunit": "^9",
+    "phpunit/phpunit": "^10.0",
     "phpstan/phpstan": "^1.10",
     "friendsofphp/php-cs-fixer": "^3.40"
   },

phpunit.xml.dist

@@ -9,6 +9,7 @@
     <testsuites>
         <testsuite name="unit">
             <directory>tests/</directory>
+            <exclude>tests/PostmarkClientBaseTest.php</exclude>
         </testsuite>
     </testsuites>
 

src/Postmark/Models/PostmarkAttachment.php

@@ -12,25 +12,25 @@ class PostmarkAttachment implements JsonSerializable
     private $data;
     private $contentId;
 
-    private function __construct($base64EncodedData, $attachmentName, $mimeType = 'application/octet-stream', $contentId = null)
+    private function __construct($base64EncodedData, $attachmentName, $mimeType = 'application/octet-stream', ?string $contentId = null)
     {
         $this->name = $attachmentName;
         $this->data = $base64EncodedData;
         $this->mimeType = $mimeType;
         $this->contentId = $contentId;
     }
 
-    public static function fromRawData($data, $attachmentName, $mimeType = null, $contentId = null)
+    public static function fromRawData($data, $attachmentName, ?string $mimeType = null, ?string $contentId = null)
     {
         return new PostmarkAttachment(base64_encode($data), $attachmentName, $mimeType, $contentId);
     }
 
-    public static function fromBase64EncodedData($base64EncodedData, $attachmentName, $mimeType = null, $contentId = null)
+    public static function fromBase64EncodedData($base64EncodedData, $attachmentName, ?string $mimeType = null, ?string $contentId = null)
     {
         return new PostmarkAttachment($base64EncodedData, $attachmentName, $mimeType, $contentId);
     }
 
-    public static function fromFile($filePath, $attachmentName, $mimeType = null, $contentId = null)
+    public static function fromFile($filePath, $attachmentName, ?string $mimeType = null, ?string $contentId = null)
     {
         return new PostmarkAttachment(base64_encode(file_get_contents($filePath)), $attachmentName, $mimeType, $contentId);
     }

src/Postmark/Models/PostmarkClick.php

@@ -155,15 +155,15 @@ public function setOS(mixed $OS): PostmarkClick
     }
 
     /**
-     * @return mixed|string
+     * @return string
      */
     public function getReceivedAt(): string
     {
         return $this->ReceivedAt;
     }
 
     /**
-     * @param mixed|string $ReceivedAt
+     * @param string $ReceivedAt
      */
     public function setReceivedAt(string $ReceivedAt): PostmarkClick
     {

src/Postmark/Models/PostmarkMessageBase.php

@@ -179,7 +179,7 @@ public function getMetadata(): array
     /**
      * @param ?array $Metadata
      */
-    public function setMetadata(array $Metadata = null): PostmarkMessageBase
+    public function setMetadata(?array $Metadata = null): PostmarkMessageBase
     {
         $this->Metadata = $Metadata;
 

src/Postmark/Models/Suppressions/SuppressionChangeRequest.php

@@ -16,7 +16,7 @@ class SuppressionChangeRequest implements JsonSerializable
      *
      * @param string $emailAddress address of the recipient whose suppression status should be changed
      */
-    public function __construct($emailAddress = null)
+    public function __construct(?string $emailAddress = null)
     {
         $this->EmailAddress = $emailAddress;
     }

src/Postmark/Models/Webhooks/HttpAuth.php

@@ -18,7 +18,7 @@ class HttpAuth implements JsonSerializable
      * @param string $username username to use
      * @param string $password password to use
      */
-    public function __construct($username = null, $password = null)
+    public function __construct(?string $username = null, ?string $password = null)
     {
         $this->username = $username;
         $this->password = $password;

src/Postmark/Models/Webhooks/WebhookConfiguration.php

@@ -55,11 +55,11 @@ public function __construct()
 
     public function Build(
         int $ID = 0,
-        string $Url = null,
-        string $MessageStream = null,
+        ?string $Url = null,
+        ?string $MessageStream = null,
         ?HttpAuth $HttpAuth = null,
         array $HttpHeaders = [],
-        WebhookConfigurationTriggers $Triggers = null
+        ?WebhookConfigurationTriggers $Triggers = null
     ) {
         $this->ID = $ID;
         $this->Url = $Url;