XLSX-Image-Background-In-Comments (PHPOffice#1547)

docs/references/features-cross-reference.md

@@ -1255,7 +1255,7 @@
         <td></td>
     </tr>
     <tr>
-        <td style="padding-left: 1em;">Rich Text</td>
+        <td style="padding-left: 2em;">Rich Text</td>
         <td style="text-align: center; color: red;">✖ <sup>2</sup></td>
         <td style="text-align: center; color: green;">✔</td>
         <td style="text-align: center; color: red;">✖</td>
@@ -1273,7 +1273,7 @@
         <td></td>
     </tr>
     <tr>
-        <td style="padding-left: 1em;">Alignment</td>
+        <td style="padding-left: 2em;">Alignment</td>
         <td style="text-align: center; color: red;">✖ <sup>3</sup></td>
         <td style="text-align: center; color: red;">✖</td>
         <td style="text-align: center; color: red;">✖</td>
@@ -1290,6 +1290,24 @@
         <td></td>
         <td></td>
     </tr>
+    <tr>
+        <td style="padding-left: 2em;">Background Image</td>
+        <td style="text-align: center; color: red;">✖</td>
+        <td style="text-align: center; color: green;">✔</td>
+        <td style="text-align: center; color: red;">✖</td>
+        <td style="text-align: center; color: red;">✖</td>
+        <td style="text-align: center; color: red;">✖</td>
+        <td style="text-align: center; color: red;">✖</td>
+        <td style="text-align: center; color: red;">✖</td>
+        <td style="text-align: center; color: red;">✖</td>
+        <td style="text-align: center; color: green;">✔</td>
+        <td style="text-align: center; color: red;">✖</td>
+        <td style="text-align: center; color: red;">✖</td>
+        <td style="text-align: center; color: red;">✖</td>
+        <td style="text-align: center; color: red;">✖</td>
+        <td>$comment->getBackgroundImage()</td>
+        <td>$comment->setBackgroundImage()</td>
+    </tr>
     <tr>
         <td><strong>Cell Validation</strong></td>
         <td style="text-align: center; color: green;">✔</td>

docs/topics/recipes.md

@@ -957,9 +957,26 @@ $spreadsheet->getActiveSheet()
     ->getComment('E11')
     ->getText()->createTextRun('Total amount on the current invoice, excluding VAT.');
 ```
-
 ![08-cell-comment.png](./images/08-cell-comment.png)
 
+## Add a comment with background image to a cell
+
+To add a comment with background image to a cell, use the following code:
+
+```php
+$sheet = $spreadsheet->getActiveSheet();
+$sheet->setCellValue('B5', 'Gibli Chromo');
+// Add png image to comment background
+$drawing = new Drawing();
+$drawing->setName('Gibli Chromo');
+$drawing->setPath('/tmp/gibli_chromo.png');
+$comment = $sheet->getComment('B5');
+$comment->setBackgroundImage($drawing);
+// Set the size of the comment equal to the size of the image 
+$comment->setSizeAsBackgroundImage();
+```
+![08-cell-comment-with-image.png](./images/08-cell-comment-with-image.png)
+
 ## Apply autofilter to a range of cells
 
 To apply an autofilter to a range of cells, use the following code:

src/PhpSpreadsheet/Comment.php

@@ -282,6 +282,7 @@ public function getHashCode(): string
             ($this->visible ? 1 : 0) .
             $this->fillColor->getHashCode() .
             $this->alignment .
+            ($this->hasBackgroundImage() ? $this->backgroundImage->getHashCode() : '') .
             __CLASS__
         );
     }
@@ -311,8 +312,6 @@ public function __toString(): string
 
     /**
      * Check is background image exists.
-     *
-     * @return bool
      */
     public function hasBackgroundImage(): bool
     {
@@ -321,8 +320,6 @@ public function hasBackgroundImage(): bool
 
     /**
      * Returns background image.
-     *
-     * @return Drawing
      */
     public function getBackgroundImage(): Drawing
     {
@@ -331,22 +328,24 @@ public function getBackgroundImage(): Drawing
 
     /**
      * Sets background image.
-     *
-     * @param Drawing $objDrawing
      */
-    public function setBackgroundImage(Drawing $objDrawing): void
+    public function setBackgroundImage(Drawing $objDrawing): self
     {
         $this->backgroundImage = $objDrawing;
+
+        return $this;
     }
 
     /**
      * Sets size of comment as size of background image.
      */
-    public function setSizeAsBackgroundImage(): void
+    public function setSizeAsBackgroundImage(): self
     {
         if ($this->hasBackgroundImage()) {
             $this->setWidth((string) $this->backgroundImage->getWidth());
             $this->setHeight((string) $this->backgroundImage->getHeight());
         }
+
+        return $this;
     }
 }