Merge pull request #4142 from oleibman/imgtransparent

Image Transparency/Opacity Including Html Reader Changes

Author: oleibman

CHANGELOG.md

@@ -29,6 +29,7 @@ and this project adheres to [Semantic Versioning](https://semver.org).
 - Xlsx Writer Duplicate ContentTypes Entry for Background Image. [Issue #4179](https://github.com/PHPOffice/PhpSpreadsheet/issues/4179) [PR #4180](https://github.com/PHPOffice/PhpSpreadsheet/pull/4180)
 - Check strictNullComparison outside of loops. [PR #3347](https://github.com/PHPOffice/PhpSpreadsheet/pull/3347)
 - SUMIFS Does Not Require xlfn. [Issue #4182](https://github.com/PHPOffice/PhpSpreadsheet/issues/4182) [PR #4186](https://github.com/PHPOffice/PhpSpreadsheet/pull/4186)
+- Image Transparency/Opacity with Html Reader Changes. [Discussion #4117](https://github.com/PHPOffice/PhpSpreadsheet/discussions/4117) [PR #4142](https://github.com/PHPOffice/PhpSpreadsheet/pull/4142)
 
 ## 2024-09-29 - 3.3.0 (no 3.0.\*, 3.1.\*, 3.2.\*)
 

samples/Basic4/53_ImageOpacity.php

@@ -0,0 +1,69 @@
+<?php
+
+require __DIR__ . '/../Header.php';
+
+use PhpOffice\PhpSpreadsheet\Spreadsheet;
+use PhpOffice\PhpSpreadsheet\Worksheet\Drawing;
+
+//var_dump(realpath(__DIR__ . '/../images/blue_square.png'));
+//exit();
+
+$path = __DIR__ . DIRECTORY_SEPARATOR . '..' . DIRECTORY_SEPARATOR . 'images/blue_square.png';
+$spreadsheet = new Spreadsheet();
+$spreadsheet->getProperties()->setTitle('53_ImageOpacity');
+
+$helper->log('Add image to spreadsheet 6 times with different opacities');
+$sheet = $spreadsheet->getActiveSheet();
+$sheet->setTitle('Squares different opacities');
+$sheet->setShowGridLines(false);
+
+$drawing = new Drawing();
+$drawing->setName('Blue Square opacity not specified');
+$drawing->setPath($path);
+$drawing->setCoordinates('A1');
+$drawing->setCoordinates2('B5');
+$drawing->setWorksheet($sheet);
+
+$drawing = new Drawing();
+$drawing->setName('Blue Square opacity 80%');
+$drawing->setPath($path);
+$drawing->setCoordinates('C1');
+$drawing->setCoordinates2('D5');
+$drawing->setOpacity(80000);
+$drawing->setWorksheet($sheet);
+
+$drawing = new Drawing();
+$drawing->setName('Blue Square opacity 60%');
+$drawing->setPath($path);
+$drawing->setCoordinates('E1');
+$drawing->setCoordinates2('F5');
+$drawing->setOpacity(60000);
+$drawing->setWorksheet($sheet);
+
+$drawing = new Drawing();
+$drawing->setName('Blue Square opacity 40%');
+$drawing->setPath($path);
+$drawing->setCoordinates('A8');
+$drawing->setCoordinates2('B12');
+$drawing->setOpacity(40000);
+$drawing->setWorksheet($sheet);
+
+$drawing = new Drawing();
+$drawing->setName('Blue Square opacity 20%');
+$drawing->setPath($path);
+$drawing->setCoordinates('C8');
+$drawing->setCoordinates2('D12');
+$drawing->setOpacity(20000);
+$drawing->setWorksheet($sheet);
+
+$drawing = new Drawing();
+$drawing->setName('Blue Square opacity 0%');
+$drawing->setPath($path);
+$drawing->setCoordinates('E8');
+$drawing->setCoordinates2('F12');
+$drawing->setOpacity(0);
+$drawing->setWorksheet($sheet);
+
+// Save
+$helper->write($spreadsheet, __FILE__, ['Xlsx', 'Html', 'Dompdf', 'Mpdf']);
+$spreadsheet->disconnectWorksheets();

samples/images/blue_square.png

@@ -120,6 +120,9 @@ public function write(Spreadsheet $spreadsheet, string $filename, array $writers
         // Write documents
         foreach ($writers as $writerType) {
             $path = $this->getFilename($filename, mb_strtolower($writerType));
+            if (preg_match('/(mpdf|tcpdf)$/', $path)) {
+                $path .= '.pdf';
+            }
             $writer = IOFactory::createWriter($spreadsheet, $writerType);
             $writer->setIncludeCharts($withCharts);
             if ($writerCallback !== null) {

samples/templates/27template.xlsx

@@ -315,6 +315,7 @@ private function processDomElementTitle(Worksheet $sheet, int &$row, string &$co
 
             try {
                 $sheet->setTitle($cellContent, true, true);
+                $sheet->getParent()?->getProperties()?->setTitle($cellContent);
             } catch (SpreadsheetException) {
                 // leave default title if too long or illegal chars
             }
@@ -476,6 +477,11 @@ private function processDomElementImg(Worksheet $sheet, int &$row, string &$colu
     private function processDomElementTable(Worksheet $sheet, int &$row, string &$column, string &$cellContent, DOMElement $child, array &$attributeArray): void
     {
         if ($child->nodeName === 'table') {
+            if (isset($attributeArray['class'])) {
+                $classes = explode(' ', $attributeArray['class']);
+                $sheet->setShowGridlines(in_array('gridlines', $classes, true));
+                $sheet->setPrintGridlines(in_array('gridlinesp', $classes, true));
+            }
             $this->currentColumn = 'A';
             $this->flushCell($sheet, $column, $row, $cellContent, $attributeArray);
             $column = $this->setTableStartColumn($column);
@@ -1038,14 +1044,21 @@ private function insertImage(Worksheet $sheet, string $column, int $row, array $
         if (!isset($attributes['src'])) {
             return;
         }
+        $styleArray = self::getStyleArray($attributes);
 
-        $src = urldecode($attributes['src']);
-        $width = isset($attributes['width']) ? (float) $attributes['width'] : null;
-        $height = isset($attributes['height']) ? (float) $attributes['height'] : null;
+        $src = $attributes['src'];
+        if (substr($src, 0, 5) !== 'data:') {
+            $src = urldecode($src);
+        }
+        $width = isset($attributes['width']) ? (float) $attributes['width'] : ($styleArray['width'] ?? null);
+        $height = isset($attributes['height']) ? (float) $attributes['height'] : ($styleArray['height'] ?? null);
         $name = $attributes['alt'] ?? null;
 
         $drawing = new Drawing();
-        $drawing->setPath($src);
+        $drawing->setPath($src, false);
+        if ($drawing->getPath() === '') {
+            return;
+        }
         $drawing->setWorksheet($sheet);
         $drawing->setCoordinates($column . $row);
         $drawing->setOffsetX(0);
@@ -1057,10 +1070,12 @@ private function insertImage(Worksheet $sheet, string $column, int $row, array $
         }
 
         if ($width) {
-            $drawing->setWidth((int) $width);
-        }
-
-        if ($height) {
+            if ($height) {
+                $drawing->setWidthAndHeight((int) $width, (int) $height);
+            } else {
+                $drawing->setWidth((int) $width);
+            }
+        } elseif ($height) {
             $drawing->setHeight((int) $height);
         }
 
@@ -1071,6 +1086,44 @@ private function insertImage(Worksheet $sheet, string $column, int $row, array $
         $sheet->getRowDimension($row)->setRowHeight(
             $drawing->getHeight() * 0.9
         );
+
+        if (isset($styleArray['opacity'])) {
+            $opacity = $styleArray['opacity'];
+            if (is_numeric($opacity)) {
+                $drawing->setOpacity((int) ($opacity * 100000));
+            }
+        }
+    }
+
+    private static function getStyleArray(array $attributes): array
+    {
+        $styleArray = [];
+        if (isset($attributes['style'])) {
+            $styles = explode(';', $attributes['style']);
+            foreach ($styles as $style) {
+                $value = explode(':', $style);
+                if (count($value) === 2) {
+                    $arrayKey = trim($value[0]);
+                    $arrayValue = trim($value[1]);
+                    if ($arrayKey === 'width') {
+                        if (substr($arrayValue, -2) === 'px') {
+                            $arrayValue = (string) (((float) substr($arrayValue, 0, -2)));
+                        } else {
+                            $arrayValue = (new CssDimension($arrayValue))->width();
+                        }
+                    } elseif ($arrayKey === 'height') {
+                        if (substr($arrayValue, -2) === 'px') {
+                            $arrayValue = substr($arrayValue, 0, -2);
+                        } else {
+                            $arrayValue = (new CssDimension($arrayValue))->height();
+                        }
+                    }
+                    $styleArray[$arrayKey] = $arrayValue;
+                }
+            }
+        }
+
+        return $styleArray;
     }
 
     private const BORDER_MAPPINGS = [

src/PhpSpreadsheet/Helper/Sample.php

@@ -231,7 +231,6 @@ public function listWorksheetInfo(string $filename): array
                 if ($xmlWorkbook->sheets) {
                     $dir = dirname($relTarget);
 
-                    /** @var SimpleXMLElement $eleSheet */
                     foreach ($xmlWorkbook->sheets->sheet as $eleSheet) {
                         $tmpInfo = [
                             'worksheetName' => (string) self::getAttributes($eleSheet)['name'],
@@ -743,7 +742,6 @@ protected function loadSpreadsheetFromFile(string $filename): Spreadsheet
                     $charts = $chartDetails = [];
 
                     if ($xmlWorkbookNS->sheets) {
-                        /** @var SimpleXMLElement $eleSheet */
                         foreach ($xmlWorkbookNS->sheets->sheet as $eleSheet) {
                             $eleSheetAttr = self::getAttributes($eleSheet);
                             ++$oldSheetId;
@@ -1428,14 +1426,17 @@ protected function loadSpreadsheetFromFile(string $filename): Spreadsheet
                                             foreach ($xmlDrawingChildren->oneCellAnchor as $oneCellAnchor) {
                                                 $oneCellAnchor = self::testSimpleXml($oneCellAnchor);
                                                 if ($oneCellAnchor->pic->blipFill) {
-                                                    /** @var SimpleXMLElement $blip */
+                                                    $objDrawing = new \PhpOffice\PhpSpreadsheet\Worksheet\Drawing();
                                                     $blip = $oneCellAnchor->pic->blipFill->children(Namespaces::DRAWINGML)->blip;
-                                                    /** @var SimpleXMLElement $xfrm */
+                                                    if (isset($blip, $blip->alphaModFix)) {
+                                                        $temp = (string) $blip->alphaModFix->attributes()->amt;
+                                                        if (is_numeric($temp)) {
+                                                            $objDrawing->setOpacity((int) $temp);
+                                                        }
+                                                    }
                                                     $xfrm = $oneCellAnchor->pic->spPr->children(Namespaces::DRAWINGML)->xfrm;
-                                                    /** @var SimpleXMLElement $outerShdw */
                                                     $outerShdw = $oneCellAnchor->pic->spPr->children(Namespaces::DRAWINGML)->effectLst->outerShdw;
 
-                                                    $objDrawing = new \PhpOffice\PhpSpreadsheet\Worksheet\Drawing();
                                                     $objDrawing->setName(self::getArrayItemString(self::getAttributes($oneCellAnchor->pic->nvPicPr->cNvPr), 'name'));
                                                     $objDrawing->setDescription(self::getArrayItemString(self::getAttributes($oneCellAnchor->pic->nvPicPr->cNvPr), 'descr'));
                                                     $embedImageKey = self::getArrayItemString(
@@ -1498,7 +1499,6 @@ protected function loadSpreadsheetFromFile(string $filename): Spreadsheet
                                                     $height = Drawing::EMUToPixels(self::getArrayItemIntOrSxml(self::getAttributes($oneCellAnchor->ext), 'cy'));
 
                                                     $graphic = $oneCellAnchor->graphicFrame->children(Namespaces::DRAWINGML)->graphic;
-                                                    /** @var SimpleXMLElement $chartRef */
                                                     $chartRef = $graphic->graphicData->children(Namespaces::CHART)->chart;
                                                     $thisChart = (string) self::getAttributes($chartRef, $xmlNamespaceBase);
 
@@ -1520,6 +1520,12 @@ protected function loadSpreadsheetFromFile(string $filename): Spreadsheet
                                                 if ($twoCellAnchor->pic->blipFill) {
                                                     $objDrawing = new \PhpOffice\PhpSpreadsheet\Worksheet\Drawing();
                                                     $blip = $twoCellAnchor->pic->blipFill->children(Namespaces::DRAWINGML)->blip;
+                                                    if (isset($blip, $blip->alphaModFix)) {
+                                                        $temp = (string) $blip->alphaModFix->attributes()->amt;
+                                                        if (is_numeric($temp)) {
+                                                            $objDrawing->setOpacity((int) $temp);
+                                                        }
+                                                    }
                                                     if (isset($twoCellAnchor->pic->blipFill->children(Namespaces::DRAWINGML)->srcRect)) {
                                                         $objDrawing->setSrcRect($twoCellAnchor->pic->blipFill->children(Namespaces::DRAWINGML)->srcRect->attributes());
                                                     }
@@ -1597,7 +1603,6 @@ protected function loadSpreadsheetFromFile(string $filename): Spreadsheet
                                                     $toOffsetX = Drawing::EMUToPixels($twoCellAnchor->to->colOff);
                                                     $toOffsetY = Drawing::EMUToPixels($twoCellAnchor->to->rowOff);
                                                     $graphic = $twoCellAnchor->graphicFrame->children(Namespaces::DRAWINGML)->graphic;
-                                                    /** @var SimpleXMLElement $chartRef */
                                                     $chartRef = $graphic->graphicData->children(Namespaces::CHART)->chart;
                                                     $thisChart = (string) self::getAttributes($chartRef, $xmlNamespaceBase);
 
@@ -1617,7 +1622,6 @@ protected function loadSpreadsheetFromFile(string $filename): Spreadsheet
                                             foreach ($xmlDrawingChildren->absoluteAnchor as $absoluteAnchor) {
                                                 if (($this->includeCharts) && ($absoluteAnchor->graphicFrame)) {
                                                     $graphic = $absoluteAnchor->graphicFrame->children(Namespaces::DRAWINGML)->graphic;
-                                                    /** @var SimpleXMLElement $chartRef */
                                                     $chartRef = $graphic->graphicData->children(Namespaces::CHART)->chart;
                                                     $thisChart = (string) self::getAttributes($chartRef, $xmlNamespaceBase);
                                                     $width = Drawing::EMUToPixels((int) self::getArrayItemString(self::getAttributes($absoluteAnchor->ext), 'cx')[0]);
@@ -1900,7 +1904,6 @@ private function parseRichText(?SimpleXMLElement $is): RichText
             $value->createText(StringHelper::controlCharacterOOXML2PHP((string) $is->t));
         } elseif ($is !== null) {
             if (is_object($is->r)) {
-                /** @var SimpleXMLElement $run */
                 foreach ($is->r as $run) {
                     if (!isset($run->rPr)) {
                         $value->createText(StringHelper::controlCharacterOOXML2PHP((string) $run->t));

src/PhpSpreadsheet/Reader/Html.php

@@ -131,6 +131,12 @@ class BaseDrawing implements IComparable
     /** @var null|SimpleXMLElement|string[] */
     protected $srcRect = [];
 
+    /**
+     * Percentage multiplied by 100,000, e.g. 40% = 40,000.
+     * Opacity=x is the same as transparency=100000-x.
+     */
+    protected ?int $opacity = null;
+
     /**
      * Create a new BaseDrawing.
      */
@@ -344,19 +350,19 @@ public function setHeight(int $height): self
      */
     public function setWidthAndHeight(int $width, int $height): self
     {
-        $xratio = $width / ($this->width != 0 ? $this->width : 1);
-        $yratio = $height / ($this->height != 0 ? $this->height : 1);
-        if ($this->resizeProportional && !($width == 0 || $height == 0)) {
+        if ($this->width === 0 || $this->height === 0 || $width === 0 || $height === 0 || !$this->resizeProportional) {
+            $this->width = $width;
+            $this->height = $height;
+        } else {
+            $xratio = $width / $this->width;
+            $yratio = $height / $this->height;
             if (($xratio * $this->height) < $height) {
                 $this->height = (int) ceil($xratio * $this->height);
                 $this->width = $width;
             } else {
                 $this->width = (int) ceil($yratio * $this->width);
                 $this->height = $height;
             }
-        } else {
-            $this->width = $width;
-            $this->height = $height;
         }
 
         return $this;
@@ -546,4 +552,16 @@ public function getFlipVertical(): bool
     {
         return $this->flipVertical;
     }
+
+    public function setOpacity(?int $opacity): self
+    {
+        $this->opacity = $opacity;
+
+        return $this;
+    }
+
+    public function getOpacity(): ?int
+    {
+        return $this->opacity;
+    }
 }

src/PhpSpreadsheet/Reader/Xlsx.php

@@ -622,6 +622,14 @@ private function writeImageInCell(string $coordinates): string
         // Write images
         $drawing = $this->sheetDrawings[$coordinates] ?? null;
         if ($drawing !== null) {
+            $opacity = '';
+            $opacityValue = $drawing->getOpacity();
+            if ($opacityValue !== null) {
+                $opacityValue = $opacityValue / 100000;
+                if ($opacityValue >= 0.0 && $opacityValue <= 1.0) {
+                    $opacity = "opacity:$opacityValue; ";
+                }
+            }
             $filedesc = $drawing->getDescription();
             $filedesc = $filedesc ? htmlspecialchars($filedesc, ENT_QUOTES) : 'Embedded image';
             if ($drawing instanceof Drawing && $drawing->getPath() !== '') {
@@ -655,7 +663,7 @@ private function writeImageInCell(string $coordinates): string
                     }
                 }
 
-                $html .= '<img style="position: absolute; z-index: 1; left: '
+                $html .= '<img style="' . $opacity . 'position: absolute; z-index: 1; left: '
                     . $drawing->getOffsetX() . 'px; top: ' . $drawing->getOffsetY() . 'px; width: '
                     . $drawing->getWidth() . 'px; height: ' . $drawing->getHeight() . 'px;" src="'
                     . $imageData . '" alt="' . $filedesc . '" />';
@@ -678,7 +686,7 @@ private function writeImageInCell(string $coordinates): string
                     //    Its use here is suspect and is being eliminated.
                     //  width: X sets width of supplied image.
                     //  As a result, images bigger than cell will be contained and images smaller will not get stretched
-                    $html .= '<img alt="' . $filedesc . '" src="' . $dataUri . '" style="width:' . $drawing->getWidth() . 'px;left: '
+                    $html .= '<img alt="' . $filedesc . '" src="' . $dataUri . '" style="' . $opacity . 'width:' . $drawing->getWidth() . 'px;left: '
                         . $drawing->getOffsetX() . 'px; top: ' . $drawing->getOffsetY() . 'px;position: absolute; z-index: 1;" />';
                 }
             }

src/PhpSpreadsheet/Worksheet/BaseDrawing.php

@@ -263,7 +263,13 @@ public function writeDrawing(XMLWriter $objWriter, BaseDrawing $drawing, int $re
             $objWriter->startElement('a:blip');
             $objWriter->writeAttribute('xmlns:r', Namespaces::SCHEMA_OFFICE_DOCUMENT);
             $objWriter->writeAttribute('r:embed', 'rId' . $relationId);
-            $objWriter->endElement();
+            $temp = $drawing->getOpacity();
+            if (is_int($temp) && $temp >= 0 && $temp <= 100000) {
+                $objWriter->startElement('a:alphaModFix');
+                $objWriter->writeAttribute('amt', "$temp");
+                $objWriter->endElement(); // a:alphaModFix
+            }
+            $objWriter->endElement(); // a:blip
 
             $srcRect = $drawing->getSrcRect();
             if (!empty($srcRect)) {