Update PHP minimum version to 8.0 and dependencies to latest compatible version

nguereza-tony · nguereza-tony · commit 04f388700fe7 · 2025-05-19T19:07:42.000+01:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -13,7 +13,7 @@ jobs:
       fail-fast: false
       matrix:
         operating-system: [ubuntu-latest, windows-latest, macOS-latest]
-        php-versions: ['7.4', '8.0', '8.1', '8.2', '8.3']
+        php-versions: ['8.0', '8.1', '8.2', '8.3', '8.4']
     name: PHP ${{ matrix.php-versions }} Test on ${{ matrix.operating-system }}
     steps:
     - name: Checkout
@@ -28,7 +28,7 @@ jobs:
       run: php -v
     - name: Cache Composer packages
       id: composer-cache
-      uses: actions/cache@v3
+      uses: actions/cache@v4
       with:
         path: vendor
         key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
diff --git a/.scrutinizer.yml b/.scrutinizer.yml
@@ -11,7 +11,7 @@ build:
                         command: phpcs-run
                         use_website_config: false
     environment:
-        php: 7.4.0
+        php: 8.0
 filter:
     excluded_paths:
         - 'tests/*'
diff --git a/README.MD b/README.MD
@@ -12,7 +12,7 @@
 [![Codacy Badge](https://app.codacy.com/project/badge/Coverage/77fcc5733a9f4f8d844bf43a09112387)](https://app.codacy.com/gh/platine-php/mail/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage)
 
 ### Requirements 
-- **PHP >= 7.4**, **PHP 8** 
+- **PHP >= 8.0** 
 
 ### Installation
 #### Using composer (recommended)
diff --git a/composer.json b/composer.json
@@ -19,15 +19,15 @@
     },
 	
     "require": {
-        "php": "^7.4 || ^8"
+        "php": "^8"
     },
 	
     "require-dev": {
         "mikey179/vfsstream": "~1.6",
         "phpmd/phpmd": "@stable",
-        "phpstan/phpstan": "^1.8",
-        "phpunit/phpunit": "^9.5",
-        "platine-php/dev": "^1.0",
+        "phpstan/phpstan": "^2.0",
+        "phpunit/phpunit": "^9.6",
+        "platine-php/dev": "^2.0",
         "squizlabs/php_codesniffer": "3.*"
     },
     
diff --git a/src/Exception/FileTransportException.php b/src/Exception/FileTransportException.php
@@ -37,7 +37,7 @@
 use Exception;
 
 /**
- * Class FileTransportException
+ * @class FileTransportException
  * @package Platine\Mail\Exception
  */
 class FileTransportException extends Exception
diff --git a/src/Exception/MailException.php b/src/Exception/MailException.php
@@ -37,7 +37,7 @@
 use Exception;
 
 /**
- * Class MailException
+ * @class MailException
  * @package Platine\Mail\Exception
  */
 class MailException extends Exception
diff --git a/src/Exception/SMTPException.php b/src/Exception/SMTPException.php
@@ -37,7 +37,7 @@
 use Exception;
 
 /**
- * Class SMTPException
+ * @class SMTPException
  * @package Platine\Mail\Exception
  */
 class SMTPException extends Exception
diff --git a/src/Exception/SMTPRetunCodeException.php b/src/Exception/SMTPRetunCodeException.php
@@ -35,7 +35,7 @@
 namespace Platine\Mail\Exception;
 
 /**
- * Class SMTPRetunCodeException
+ * @class SMTPRetunCodeException
  * @package Platine\Mail\Exception
  */
 class SMTPRetunCodeException extends SMTPException
diff --git a/src/Exception/SMTPSecureException.php b/src/Exception/SMTPSecureException.php
@@ -35,7 +35,7 @@
 namespace Platine\Mail\Exception;
 
 /**
- * Class SMTPException
+ * @class SMTPException
  * @package Platine\Mail\Exception
  */
 class SMTPSecureException extends SMTPException
diff --git a/src/Mailer.php b/src/Mailer.php
@@ -52,7 +52,7 @@
 use Platine\Mail\Transport\TransportInterface;
 
 /**
- * Class Mailer
+ * @class Mailer
  * @package Platine\Mail
  */
 class Mailer
@@ -69,7 +69,7 @@ class Mailer
      */
     public function __construct(?TransportInterface $transport = null)
     {
-        $this->transport = $transport ? $transport : new NullTransport();
+        $this->transport = $transport ?? new NullTransport();
     }
 
     /**
diff --git a/src/Message.php b/src/Message.php
@@ -51,7 +51,7 @@
 use InvalidArgumentException;
 
 /**
- * Class Message
+ * @class Message
  * @package Platine\Mail
  */
 class Message implements MessageInterface
@@ -167,7 +167,7 @@ public function reset(): self
      */
     public function addAttachment(string $path, ?string $filename = null): self
     {
-        if (!file_exists($path)) {
+        if (file_exists($path) === false) {
             throw new InvalidArgumentException(sprintf(
                 'The email attachment file [%s] does not exists.',
                 $path
@@ -178,12 +178,11 @@ public function addAttachment(string $path, ?string $filename = null): self
             $filename = basename($path);
         }
 
-        $filename = $this->encodeUtf8($this->filterString($filename));
         $data = $this->getAttachmentData($path);
 
         if ($data !== null) {
             $this->attachments[] = [
-                'file' => $filename,
+                'file' => $this->encodeUtf8($this->filterString($filename)),
                 'path' => $path,
                 'data' => chunk_split(base64_encode($data))
             ];
@@ -369,7 +368,7 @@ public function setPriority(int $priority = 3): self
     /**
      * {@inheritedoc}
      */
-    public function getHeader(string $name, $default = null)
+    public function getHeader(string $name, mixed $default = null): mixed
     {
         $this->prepareHeaders();
 
@@ -381,7 +380,7 @@ public function getHeader(string $name, $default = null)
     /**
      * {@inheritedoc}
      */
-    public function addHeader(string $name, $value): self
+    public function addHeader(string $name, mixed $value): self
     {
         $this->headers[$name] = $value;
 
@@ -471,10 +470,10 @@ protected function prepareHeaders(): self
 
         if ($this->hasAttachments()) {
             $this->addHeader('MIME-Version', '1.0')
-               ->addHeader(
-                   'Content-Type',
-                   sprintf('multipart/mixed; boundary="%s"', $this->uid)
-               );
+                 ->addHeader(
+                     'Content-Type',
+                     sprintf('multipart/mixed; boundary="%s"', $this->uid)
+                 );
         }
 
         return $this;
@@ -559,13 +558,15 @@ protected function getAttachmentMimeTemplate(array $attachment): string
      */
     protected function formatHeader(string $email, ?string $name = null): string
     {
-        $email = $this->filterEmail($email);
         if (empty($name)) {
             return $email;
         }
-        $name = $this->encodeUtf8($this->filterName($name));
 
-        return sprintf('"%s" <%s>', $name, $email);
+        return sprintf(
+            '"%s" <%s>',
+            $this->encodeUtf8($this->filterName($name)),
+            $this->filterEmail($email)
+        );
     }
 
     /**
@@ -585,10 +586,12 @@ protected function filterEmail(string $email): string
             '>'  => ''
         ];
 
-        $email = strtr($email, $rules);
-        $email = filter_var($email, FILTER_SANITIZE_EMAIL);
+        $emailFiltered = filter_var(
+            strtr($email, $rules),
+            FILTER_SANITIZE_EMAIL
+        );
 
-        return $email === false ? '' : $email;
+        return $emailFiltered === false ? '' : $emailFiltered;
     }
 
     /**
@@ -642,12 +645,12 @@ protected function filterString(string $value): string
      */
     protected function encodeUtf8(?string $value): string
     {
-        $value = trim((string)$value);
-        if (preg_match('/(\s)/', $value)) {
-            return $this->encodeUtf8Words($value);
+        $valueClean = trim((string)$value);
+        if (preg_match('/(\s)/', $valueClean)) {
+            return $this->encodeUtf8Words($valueClean);
         }
 
-        return $this->encodeUtf8Word($value);
+        return $this->encodeUtf8Word($valueClean);
     }
 
     /**
diff --git a/src/MessageInterface.php b/src/MessageInterface.php
@@ -50,7 +50,7 @@
 
 
 /**
- * Class MessageInterface
+ * @class MessageInterface
  * @package Platine\Mail
  */
 interface MessageInterface
@@ -196,7 +196,7 @@ public function hasAttachments(): bool;
      *
      * @return mixed
      */
-    public function getHeader(string $name, $default = null);
+    public function getHeader(string $name, mixed $default = null): mixed;
 
     /**
      * Add mail header
@@ -213,7 +213,7 @@ public function addMailHeader(string $header, string $email, ?string $name = nul
      * @param mixed $value
      * @return self
      */
-    public function addHeader(string $name, $value): self;
+    public function addHeader(string $name, mixed $value): self;
 
     /**
      * Add mail headers
diff --git a/src/Transport/File.php b/src/Transport/File.php
@@ -52,7 +52,7 @@
 use Platine\Mail\MessageInterface;
 
 /**
- * Class File
+ * @class File
  * @package Platine\Mail\Transport
  */
 class File implements TransportInterface
diff --git a/src/Transport/Mail.php b/src/Transport/Mail.php
@@ -51,7 +51,7 @@
 use Platine\Mail\MessageInterface;
 
 /**
- * Class Mail
+ * @class Mail
  * @package Platine\Mail\Transport
  */
 class Mail implements TransportInterface
diff --git a/src/Transport/NullTransport.php b/src/Transport/NullTransport.php
@@ -51,7 +51,7 @@
 use Platine\Mail\MessageInterface;
 
 /**
- * Class NullTransport
+ * @class NullTransport
  * @package Platine\Mail\Transport
  */
 class NullTransport implements TransportInterface
diff --git a/src/Transport/SMTP.php b/src/Transport/SMTP.php
@@ -54,7 +54,7 @@
 use Platine\Mail\MessageInterface;
 
 /**
- * Class SMTP
+ * @class SMTP
  * @package Platine\Mail\Transport
  */
 class SMTP implements TransportInterface
@@ -140,6 +140,8 @@ class SMTP implements TransportInterface
      * Create new instance
      * @param string $host
      * @param int $port
+     * @param int $timeout
+     * @param int $responseTimeout
      */
     public function __construct(
         string $host,
@@ -205,7 +207,7 @@ public function ssl(bool $status = true): self
      * Set authentication information
      * @param string $username
      * @param string $password
-     * @return self
+     * @return $this
      */
     public function setAuth(string $username, string $password): self
     {
@@ -278,7 +280,7 @@ protected function connect(): self
             $this->timeout
         );
 
-        if (!is_resource($this->smtp)) {
+        if (is_resource($this->smtp) === false) {
             throw new SMTPException(sprintf(
                 'Could not establish SMTP connection to server [%s] error: [%s: %s]',
                 $host,
@@ -368,15 +370,15 @@ protected function authLogin(): self
         }
 
         $command = base64_encode($this->username) . self::CRLF;
-        $code = $this->sendCommand($command);
-        if ($code !== 334) {
-            throw new SMTPRetunCodeException(334, $code, array_pop($this->responses));
+        $codeUsername = $this->sendCommand($command);
+        if ($codeUsername !== 334) {
+            throw new SMTPRetunCodeException(334, $codeUsername, array_pop($this->responses));
         }
 
         $command = base64_encode($this->password) . self::CRLF;
-        $code = $this->sendCommand($command);
-        if ($code !== 235) {
-            throw new SMTPRetunCodeException(235, $code, array_pop($this->responses));
+        $codePassword = $this->sendCommand($command);
+        if ($codePassword !== 235) {
+            throw new SMTPRetunCodeException(235, $codePassword, array_pop($this->responses));
         }
 
         return $this;
@@ -437,9 +439,9 @@ protected function data(): self
 
         $command = (string) $this->message;
         $command .= self::CRLF . '.' . self::CRLF;
-        $code = $this->sendCommand($command);
-        if ($code !== 250) {
-            throw new SMTPRetunCodeException(250, $code, array_pop($this->responses));
+        $codeMessage = $this->sendCommand($command);
+        if ($codeMessage !== 250) {
+            throw new SMTPRetunCodeException(250, $codeMessage, array_pop($this->responses));
         }
 
         return $this;
diff --git a/src/Transport/Sendmail.php b/src/Transport/Sendmail.php
@@ -52,7 +52,7 @@
 use Platine\Mail\MessageInterface;
 
 /**
- * Class Sendmail
+ * @class Sendmail
  * @package Platine\Mail\Transport
  */
 class Sendmail implements TransportInterface
diff --git a/src/Transport/TransportInterface.php b/src/Transport/TransportInterface.php
@@ -51,7 +51,7 @@
 use Platine\Mail\MessageInterface;
 
 /**
- * Class TransportInterface
+ * @class TransportInterface
  * @package Platine\Mail\Transport
  */
 interface TransportInterface
