refactor: simplified code

Author: thorsten

phpmyfaq/src/phpMyFAQ/Mail.php

@@ -184,19 +184,19 @@ class Mail
      */
     public function __construct(Configuration $configuration)
     {
-        // Set default value for public properties
-        $this->agent = $configuration->get('mail.remoteSMTP') ? 'smtp' : 'built-in';
+        // Set the default value for public properties
+        $this->agent = $configuration->get(item: 'mail.remoteSMTP') ? 'smtp' : 'built-in';
         $this->boundary = self::createBoundary();
         $this->messageId =
             '<'
-            . Request::createFromGlobals()->server->get('REQUEST_TIME')
+            . Request::createFromGlobals()->server->get(key: 'REQUEST_TIME')
             . '.'
             . md5(microtime())
             . '@'
             . self::getServerName()
             . '>';
 
-        // Set default value for private properties
+        // Set the default value for private properties
         $this->configuration = $configuration;
 
         // Set phpMyFAQ related data
@@ -241,7 +241,7 @@ public static function getServerName(): string
      */
     public function setFrom(string $address, ?string $name = null): bool
     {
-        return $this->setEmailTo($this->from, 'From', $address, $name);
+        return $this->setEmailTo($this->from, targetAlias: 'From', address: $address, name: $name);
     }
 
     /**
@@ -260,8 +260,8 @@ private function setEmailTo(array &$target, string $targetAlias, string $address
         if (count($target) > 2) {
             $keys = array_keys($target);
             throw new Exception(
-                sprintf('<strong>Mail Class</strong>: too many e-mail addresses, %s, ', $keys[0])
-                . sprintf("have been already added as '%s'!", $targetAlias),
+                sprintf('Too many e-mail addresses, %s, ', $keys[0])
+                . sprintf(format: "have been already added as '%s'!", values: $targetAlias),
             );
         }
 
@@ -292,20 +292,20 @@ private function addEmailTo(array &$target, string $targetAlias, string $address
 
         if (isset($name)) {
             // Remove CR and LF characters to prevent header injection
-            $name = str_replace(["\n", "\r"], '', $name);
+            $name = str_replace(search: ["\n", "\r"], replace: '', subject: $name);
 
             // Encode any special characters in the displayed name
             $name = iconv_mime_encode($targetAlias, $name);
 
             // Wrap the displayed name in quotes (to fix problems with commas etc.),
             // and escape any existing quotes
-            $name = '"' . str_replace('"', '\"', $name) . '"';
+            $name = '"' . str_replace(search: '"', replace: '\"', subject: $name) . '"';
         }
 
         // Add the email address into the target array
         $target[$address] = $name;
-        // On Windows, when using PHP built-in mail drop any name, just use the e-mail address
-        if ('WIN' !== strtoupper(substr(PHP_OS, 0, 3))) {
+        // On Windows, when using PHP built-in mail drops any name, just use the e-mail address
+        if ('WIN' !== strtoupper(substr(string: PHP_OS, offset: 0, length: 3))) {
             return true;
         }
 
@@ -332,7 +332,7 @@ public static function validateEmail(string $address): bool
         }
 
         $unsafe = ["\r", "\n"];
-        if ($address !== str_replace($unsafe, '', $address)) {
+        if ($address !== str_replace(search: $unsafe, replace: '', subject: $address)) {
             return false;
         }
 
@@ -349,7 +349,7 @@ public static function validateEmail(string $address): bool
      */
     public function addCc(string $address, ?string $name = null): bool
     {
-        return $this->addEmailTo($this->cc, 'Cc', $address, $name);
+        return $this->addEmailTo($this->cc, targetAlias: 'Cc', address: $address, name: $name);
     }
 
     /**
@@ -362,7 +362,7 @@ public function addCc(string $address, ?string $name = null): bool
      */
     public function addTo(string $address, ?string $name = null): bool
     {
-        return $this->addEmailTo($this->to, 'To', $address, $name);
+        return $this->addEmailTo($this->to, targetAlias: 'To', address: $address, name: $name);
     }
 
     /**
@@ -374,9 +374,7 @@ public function send(): int
     {
         // Check
         if ((count($this->to) + count($this->cc) + count($this->bcc)) < 1) {
-            throw new Exception(
-                '<strong>Mail Class</strong>: you need at least to set one recipient among TO, CC and BCC!',
-            );
+            throw new Exception(message: 'You need at least to set one recipient among TO, CC and BCC!');
         }
 
         // Has any alternative message been provided?
@@ -393,7 +391,7 @@ public function send(): int
         $hasInlineAttachments = false;
         $idx = 0;
         while (!$hasInlineAttachments && $idx < count($this->attachments)) {
-            $hasInlineAttachments = 'inline' == $this->attachments[$idx]['disposition'];
+            $hasInlineAttachments = 'inline' === $this->attachments[$idx]['disposition'];
             ++$idx;
         }
 
@@ -410,9 +408,9 @@ public function send(): int
             $to[] = (empty($name) ? '' : $name . ' ') . '<' . $address . '>';
         }
 
-        $recipients = implode(',', $to);
+        $recipients = implode(separator: ',', array: $to);
         // Check for the need of undisclosed recipients outlook-like <TO:>
-        if (($recipients === '' || $recipients === '0') && 0 == count($this->cc)) {
+        if (($recipients === '' || $recipients === '0') && 0 === count($this->cc)) {
             $recipients = '<Undisclosed-Recipient:;>';
         }
 
@@ -425,13 +423,13 @@ public function send(): int
         // Send the email adopting to the given MUA
         $mua = self::getMUA($this->agent);
 
-        if (method_exists($mua, 'setAuthConfig')) {
+        if (method_exists($mua, method: 'setAuthConfig')) {
             $mua->setAuthConfig(
-                $this->configuration->get('mail.remoteSMTPServer'),
-                $this->configuration->get('mail.remoteSMTPUsername'),
-                $this->configuration->get('mail.remoteSMTPPassword'),
-                (int) $this->configuration->get('mail.remoteSMTPPort'),
-                $this->configuration->get('mail.remoteSMTPDisableTLSPeerVerification'),
+                $this->configuration->get(item: 'mail.remoteSMTPServer'),
+                $this->configuration->get(item: 'mail.remoteSMTPUsername'),
+                $this->configuration->get(item: 'mail.remoteSMTPPassword'),
+                (int) $this->configuration->get(item: 'mail.remoteSMTPPort'),
+                $this->configuration->get(item: 'mail.remoteSMTPDisableTLSPeerVerification'),
             );
         }
 
@@ -450,7 +448,7 @@ private function createHeaders(): void
         $this->headers = [];
 
         // Check if the message consists of just a "plain" single item
-        if (!str_contains($this->contentType, 'multipart')) {
+        if (!str_contains($this->contentType, needle: 'multipart')) {
             // Content-Disposition: inline
             $this->headers['Content-Disposition'] = $this->contentDisposition;
             // Content-Type
@@ -471,7 +469,7 @@ private function createHeaders(): void
             $notifyTos[] = (empty($name) ? '' : $name . ' ') . '<' . $address . '>';
         }
 
-        $notifyTo = implode(',', $notifyTos);
+        $notifyTo = implode(separator: ',', array: $notifyTos);
         if ($notifyTo !== '' && $notifyTo !== '0') {
             $this->headers['Disposition-Notification-To'] = $notifyTo;
         }
@@ -519,9 +517,9 @@ private function createHeaders(): void
         }
 
         // Subject. Note: it must be RFC 2047 compliant
-        // TODO: wrap mb_encode_mimeheader() to add other content encodings
+        // @todo: wrap mb_encode_mimeheader() to add other content encodings
         $this->headers['Subject'] = Utils::resolveMarkers(
-            html_entity_decode($this->subject, ENT_COMPAT, 'UTF-8'),
+            html_entity_decode($this->subject, ENT_COMPAT, encoding: 'UTF-8'),
             $this->configuration,
         );
 
@@ -551,7 +549,7 @@ private function createHeaders(): void
      */
     public static function getDate(int $date): string
     {
-        return date('r', $date);
+        return date(format: 'r', timestamp: $date);
     }
 
     /**
@@ -563,7 +561,7 @@ public static function getDate(int $date): string
      */
     public static function getTime(): int
     {
-        return Request::createFromGlobals()->server->get('REQUEST_TIME') ?? time();
+        return Request::createFromGlobals()->server->get(key: 'REQUEST_TIME') ?? time();
     }
 
     /**
@@ -578,19 +576,19 @@ private function createBody(): void
         $this->body = '';
 
         // Add lines
-        if (str_contains($this->contentType, 'multipart')) {
+        if (str_contains($this->contentType, needle: 'multipart')) {
             $lines[] = 'This is a multi-part message in MIME format.';
             $lines[] = '';
         }
 
-        if (in_array($this->contentType, ['multipart/mixed', 'multipart/related'])) {
+        if (in_array($this->contentType, ['multipart/mixed', 'multipart/related'], strict: true)) {
             $lines[] = '--' . $mainBoundary;
             $this->boundary = '--=alternative=' . self::createBoundary();
             $lines[] = 'Content-Type: multipart/alternative; boundary="' . $this->boundary . '"';
             $lines[] = '';
         }
 
-        if (str_contains($this->contentType, 'multipart')) {
+        if (str_contains($this->contentType, needle: 'multipart')) {
             // At least we have messageAlt and message
             if ($this->messageAlt !== '' && $this->messageAlt !== '0') {
                 // 1/2. messageAlt, supposed as plain text
@@ -614,15 +612,15 @@ private function createBody(): void
             $lines[] = self::wrapLines($this->message);
         }
 
-        if (in_array($this->contentType, ['multipart/mixed', 'multipart/related'])) {
+        if (in_array($this->contentType, ['multipart/mixed', 'multipart/related'], strict: true)) {
             // Back to the main boundary
             $this->boundary = $mainBoundary;
             // Add the attachments
             foreach ($this->attachments as $attachment) {
                 $lines[] = '--' . $this->boundary;
                 $lines[] = 'Content-Type: ' . $attachment['mimetype'] . '; name="' . $attachment['name'] . '"';
                 $lines[] = 'Content-Transfer-Encoding: base64';
-                if ('inline' == $attachment['disposition']) {
+                if ('inline' === $attachment['disposition']) {
                     $lines[] = 'Content-ID: <' . $attachment['cid'] . '>';
                 }
 
@@ -648,18 +646,17 @@ private function createBody(): void
      *
      * @param string $message Message.
      * @param int    $width Column width. Defaults to 72.
-     * @param bool   $cut Cutting a word is allowed. Defaults to false.
      * @return string The given message, wrapped as requested.
      */
-    public function wrapLines(string $message, int $width = 72, bool $cut = false): string
+    public function wrapLines(string $message, int $width = 72): string
     {
         $message = $this->fixEOL($message);
 
         $lines = explode($this->eol, $message);
         $wrapped = '';
         foreach ($lines as $line) {
             $wrapped .= $wrapped === '' || $wrapped === '0' ? '' : $this->eol;
-            $wrapped .= wordwrap($line, $width, $this->eol, $cut);
+            $wrapped .= wordwrap($line, $width, $this->eol);
         }
 
         return $wrapped;
@@ -677,18 +674,18 @@ public function fixEOL(string $text): string
     {
         // Assure that anything among CRLF, CR will be replaced with just LF
         $text = str_replace(
-            [
+            search: [
                 "\r\n",
                 // CRLF
                 "\r",
                 // CR
                 "\n",
             ],
-            "\n", // LF
-            $text,
+            replace: "\n", // LF
+            subject: $text,
         );
         // Set any LF to the RFC 2822 EOL
-        return str_replace("\n", $this->eol, $text);
+        return str_replace(search: "\n", replace: $this->eol, subject: $text);
     }
 
     /**
@@ -699,7 +696,7 @@ public function fixEOL(string $text): string
      */
     public static function getMUA(string $mua): Builtin|Smtp
     {
-        $className = ucfirst(str_replace('-', '', $mua));
+        $className = ucfirst(str_replace(search: '-', replace: '', subject: $mua));
         $class = 'phpMyFAQ\Mail\\' . $className;
 
         return new $class();
@@ -715,7 +712,7 @@ public static function getMUA(string $mua): Builtin|Smtp
      */
     public function setReplyTo(string $address, ?string $name = null): bool
     {
-        return $this->setEmailTo($this->replyTo, 'Reply-To', $address, $name);
+        return $this->setEmailTo($this->replyTo, targetAlias: 'Reply-To', address: $address, name: $name);
     }
 
     /**
@@ -729,7 +726,7 @@ public function setReplyTo(string $address, ?string $name = null): bool
      */
     public function safeEmail(string $email): string
     {
-        if ($this->configuration->get('spam.enableSafeEmail')) {
+        if ($this->configuration->get(item: 'spam.enableSafeEmail')) {
             return str_replace(['@', '.'], ['_AT_', '_DOT_'], $email);
         }
 

tests/phpMyFAQ/MailTest.php

@@ -149,7 +149,7 @@ public function testGetTimeWithNoRequestTime(): void
         $_SERVER['REQUEST_TIME'] = $requestTimeToRestore;
     }
 
-    public function testWrapLinesWithDefaultWidthAndNoCut(): void
+    public function testWrapLinesWithDefaultWidth(): void
     {
         $message = "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum acnunc quis neque tempor varius.";
         $result = $this->mail->wrapLines($message);
@@ -158,16 +158,7 @@ public function testWrapLinesWithDefaultWidthAndNoCut(): void
         $this->assertSame($expectedResult, $result);
     }
 
-    public function testWrapLinesWithCustomWidthAndCut(): void
-    {
-        $message = "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum ac nunc quis neque tempor varius.";
-        $result = $this->mail->wrapLines($message, 20, true);
-
-        $expectedResult = "Lorem ipsum dolor\r\nsit amet,\r\nconsectetur\r\nadipiscing elit.\r\nVestibulum ac nunc\r\nquis neque tempor\r\nvarius.";
-        $this->assertSame($expectedResult, $result);
-    }
-
-    public function testWrapLinesWithCustomWidthAndNoCut(): void
+    public function testWrapLinesWithCustomWidth(): void
     {
         $message = "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum ac nunc quis neque tempor varius.";
         $result = $this->mail->wrapLines($message, 30);