feature #32917 [Mime] Add AbstractPart::asDebugString() (fabpot)

fabpot · fabpot · commit 1ce83dab3464 · 2019-08-04T06:58:40.000+02:00
This PR was merged into the 4.4 branch. Discussion ---------- [Mime] Add AbstractPart::asDebugString() | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | no | New feature? | yes | BC breaks? | no  | Deprecations? | no  | Tests pass? | yes  | Fixed tickets | n/a | License | MIT | Doc PR | n/a That helps debugging issues and will be displayed in the web profiler Mailer panel. Commits ------- f36c8c9 [Mime] added AbstractPart::asDebugString()
diff --git a/src/Symfony/Component/Mime/CHANGELOG.md b/src/Symfony/Component/Mime/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+4.4.0
+-----
+
+ * Added `AbstractPart::asDebugString()`
+
 4.3.3
 -----
 
diff --git a/src/Symfony/Component/Mime/Part/AbstractMultipartPart.php b/src/Symfony/Component/Mime/Part/AbstractMultipartPart.php
@@ -74,6 +74,20 @@ public function bodyToIterable(): iterable
         yield '--'.$this->getBoundary()."--\r\n";
     }
 
+    public function asDebugString(): string
+    {
+        $str = parent::asDebugString();
+        foreach ($this->getParts() as $part) {
+            $lines = explode("\n", $part->asDebugString());
+            $str .= "\n  └ ".array_shift($lines);
+            foreach ($lines as $line) {
+                $str .= "\n  |".$line;
+            }
+        }
+
+        return $str;
+    }
+
     private function getBoundary(): string
     {
         if (null === $this->boundary) {
diff --git a/src/Symfony/Component/Mime/Part/AbstractPart.php b/src/Symfony/Component/Mime/Part/AbstractPart.php
@@ -50,6 +50,11 @@ public function toIterable(): iterable
         yield from $this->bodyToIterable();
     }
 
+    public function asDebugString(): string
+    {
+        return $this->getMediaType().'/'.$this->getMediaSubtype();
+    }
+
     abstract public function bodyToString(): string;
 
     abstract public function bodyToIterable(): iterable;
diff --git a/src/Symfony/Component/Mime/Part/DataPart.php b/src/Symfony/Component/Mime/Part/DataPart.php
@@ -103,6 +103,16 @@ public function getPreparedHeaders(): Headers
         return $headers;
     }
 
+    public function asDebugString(): string
+    {
+        $str = parent::asDebugString();
+        if (null !== $this->filename) {
+            $str .= ' filename: '.$this->filename;
+        }
+
+        return $str;
+    }
+
     private function generateContentId(): string
     {
         return bin2hex(random_bytes(16)).'@symfony';
diff --git a/src/Symfony/Component/Mime/Part/TextPart.php b/src/Symfony/Component/Mime/Part/TextPart.php
@@ -144,6 +144,19 @@ public function getPreparedHeaders(): Headers
         return $headers;
     }
 
+    public function asDebugString(): string
+    {
+        $str = parent::asDebugString();
+        if (null !== $this->charset) {
+            $str .= ' charset: '.$this->charset;
+        }
+        if (null !== $this->disposition) {
+            $str .= ' disposition: '.$this->disposition;
+        }
+
+        return $str;
+    }
+
     private function getEncoder(): ContentEncoderInterface
     {
         if ('8bit' === $this->encoding) {
