Merge pull request #183 from Progi1984/issue125

#125 : PR

Author: Progi1984

docs/general.rst

@@ -53,7 +53,7 @@ Document information
 --------------------
 
 You can set the document information such as title, creator, and company
-name. Use the following functions:
+name. Use the following functions :
 
 .. code-block:: php
 
@@ -69,3 +69,37 @@ name. Use the following functions:
     $properties->setSubject('My subject');
     $properties->setKeywords('my, key, word');
 
+
+Presentation Properties
+-----------------------
+
+You can define some properties which are relative to the presentation, like the zoom or the thumbnail.
+
+
+Thumbnail
+`````````
+
+You can define the thumbnail of the presentation with the method ``setThumbnailPath``.
+
+.. code-block:: php
+
+    $oPresentation = new PhpPresentation();
+    $oProperties = $oPresentation->getPresentationProperties();
+    // Set path of the thumbnail
+    $oProperties->setThumbnailPath(__DIR__.'\resources\phppowerpoint_logo.gif');
+    // Get path of the thumbnail
+    echo $oProperties->getThumbnailPath();
+
+Zoom
+````
+
+You can define the zoom of the presentation with the method ``setZoom``.
+
+.. code-block:: php
+
+    $oPresentation = new PhpPresentation();
+    $oProperties = $oPresentation->getPresentationProperties();
+    // Set zoom of the presentation (3 = 300%)
+    $oProperties->setZoom(3);
+    // Get zoom of the presentation
+    echo $oProperties->getZoom();

samples/Sample_14_Zoom.php

@@ -11,7 +11,7 @@
 $objPHPPresentation = new PhpPresentation();
 
 // Set the zoom to 200%
-$objPHPPresentation->setZoom(3);
+$objPHPPresentation->getPresentationProperties()->setZoom(3);
 
 // Create slide
 echo date('H:i:s') . ' Create slide'.EOL;

samples/Sample_16_Thumbnail.php

@@ -0,0 +1,27 @@
+<?php
+
+include_once 'Sample_Header.php';
+
+use PhpOffice\PhpPresentation\PhpPresentation;
+use PhpOffice\PhpPresentation\Slide\Background\Color;
+use PhpOffice\PhpPresentation\Style\Color as StyleColor;
+use \PhpOffice\PhpPresentation\Slide\Background\Image;
+
+// Create new PHPPresentation object
+echo date('H:i:s') . ' Create new PHPPresentation object' . EOL;
+$objPHPPresentation = new PhpPresentation();
+
+// Set Thumbnail
+$objPHPPresentation->getPresentationProperties()->setThumbnailPath(__DIR__.'\resources\phppowerpoint_logo.gif');
+
+// Create slide
+echo date('H:i:s') . ' Create slide'.EOL;
+$oSlide1 = $objPHPPresentation->getActiveSlide();
+$oSlide1->addShape(clone $oShapeDrawing);
+$oSlide1->addShape(clone $oShapeRichText);
+
+// Save file
+echo write($objPHPPresentation, basename(__FILE__, '.php'), $writers);
+if (!CLI) {
+	include_once 'Sample_Footer.php';
+}

src/PhpPresentation/PhpPresentation.php

@@ -60,18 +60,6 @@ class PhpPresentation
      */
     private $activeSlideIndex = 0;
 
-    /**
-     * Mark as final
-     * @var bool
-     */
-    private $markAsFinal = false;
-
-    /**
-     * Zoom
-     * @var float
-     */
-    private $zoom = 1;
-
     /**
      * Create a new PhpPresentation with one Slide
      */
@@ -361,43 +349,41 @@ public function copy()
      * Mark a document as final
      * @param bool $state
      * @return PhpPresentation
+     * @deprecated for getPresentationProperties()->markAsFinal()
      */
     public function markAsFinal($state = true)
     {
-        if (is_bool($state)) {
-            $this->markAsFinal = $state;
-        }
-        return $this;
+        return $this->getPresentationProperties()->markAsFinal($state);
     }
 
     /**
      * Return if this document is marked as final
      * @return bool
+     * @deprecated for getPresentationProperties()->isMarkedAsFinal()
      */
     public function isMarkedAsFinal()
     {
-        return $this->markAsFinal;
+        return $this->getPresentationProperties()->isMarkedAsFinal();
     }
 
     /**
      * Set the zoom of the document (in percentage)
      * @param float $zoom
      * @return PhpPresentation
+     * @deprecated for getPresentationProperties()->setZoom()
      */
     public function setZoom($zoom = 1)
     {
-        if (is_numeric($zoom)) {
-            $this->zoom = $zoom;
-        }
-        return $this;
+        return $this->getPresentationProperties()->setZoom($zoom);
     }
 
     /**
      * Return the zoom (in percentage)
      * @return float
+     * @deprecated for getPresentationProperties()->getZoom()
      */
     public function getZoom()
     {
-        return $this->zoom;
+        return $this->getPresentationProperties()->getZoom();
     }
 }

src/PhpPresentation/PresentationProperties.php

@@ -25,6 +25,23 @@ class PresentationProperties
      * @var boolean
      */
     protected $isLoopUntilEsc = false;
+
+    /**
+     * Mark as final
+     * @var bool
+     */
+    protected $markAsFinal = false;
+
+    /*
+     * @var string
+     */
+    protected $thumbnail;
+
+    /**
+     * Zoom
+     * @var float
+     */
+    protected $zoom = 1;
 
     /**
      * @return bool
@@ -40,7 +57,75 @@ public function isLoopContinuouslyUntilEsc()
      */
     public function setLoopContinuouslyUntilEsc($value = false)
     {
-        $this->isLoopUntilEsc = $value;
+        if (is_bool($value)) {
+            $this->isLoopUntilEsc = $value;
+        }
+        return $this;
+    }
+    
+    /**
+     * Return the thumbnail file path
+     * @return string
+     */
+    public function getThumbnailPath()
+    {
+        return $this->thumbnail;
+    }
+    
+    /**
+     * Define the path for the thumbnail file / preview picture
+     * @param string $value
+     * @return \PhpOffice\PhpPresentation\PresentationProperties
+     */
+    public function setThumbnailPath($path = '')
+    {
+        if (file_exists($path)) {
+            $this->thumbnail = $path;
+        }
+        return $this;
+    }
+
+    /**
+     * Mark a document as final
+     * @param bool $state
+     * @return PhpPresentation
+     */
+    public function markAsFinal($state = true)
+    {
+        if (is_bool($state)) {
+            $this->markAsFinal = $state;
+        }
+        return $this;
+    }
+
+    /**
+     * Return if this document is marked as final
+     * @return bool
+     */
+    public function isMarkedAsFinal()
+    {
+        return $this->markAsFinal;
+    }
+
+    /**
+     * Set the zoom of the document (in percentage)
+     * @param float $zoom
+     * @return PhpPresentation
+     */
+    public function setZoom($zoom = 1)
+    {
+        if (is_numeric($zoom)) {
+            $this->zoom = $zoom;
+        }
         return $this;
     }
+
+    /**
+     * Return the zoom (in percentage)
+     * @return float
+     */
+    public function getZoom()
+    {
+        return $this->zoom;
+    }
 }

src/PhpPresentation/Writer/ODPresentation.php

@@ -185,6 +185,35 @@ public function save($pFilename)
 
             // Add META-INF/manifest.xml
             $objZip->addFromString('META-INF/manifest.xml', $writerPartManifest->writePart());
+            
+            // Add Thumbnail
+            if ($this->presentation->getPresentationProperties()->getThumbnailPath()) {
+                $pathThumbnail = $this->presentation->getPresentationProperties()->getThumbnailPath();
+                // Size : 128x128 pixel
+                // PNG : 8bit, non-interlaced with full alpha transparency
+                $gdImage = imagecreatefromstring(file_get_contents($pathThumbnail));
+                if ($gdImage) {
+                    list($width, $height) = getimagesize($pathThumbnail);
+                    
+                    $gdRender = imagecreatetruecolor(128, 128);
+                    $colorBgAlpha = imagecolorallocatealpha($gdRender, 0, 0, 0, 127);
+                    imagecolortransparent($gdRender, $colorBgAlpha);
+                    imagefill($gdRender, 0, 0, $colorBgAlpha);
+                    imagecopyresampled($gdRender, $gdImage, 0, 0, 0, 0, 128, 128, $width, $height);
+                    imagetruecolortopalette($gdRender, false, 255);
+                    imagesavealpha($gdRender, true);
+                    
+                    ob_start();
+                    imagepng($gdRender);
+                    $imageContents = ob_get_contents();
+                    ob_end_clean();
+                    
+                    imagedestroy($gdRender);
+                    imagedestroy($gdImage);
+
+                    $objZip->addFromString('Thumbnails/thumbnail.png', $imageContents);
+                }
+            }
 
             // Add charts
             foreach ($this->chartArray as $keyChart => $shapeChart) {

src/PhpPresentation/Writer/ODPresentation/Manifest.php

@@ -125,6 +125,20 @@ public function writePart()
             }
         }
 
+        if ($parentWriter->getPhpPresentation()->getPresentationProperties()->getThumbnailPath()) {
+            $pathThumbnail = $parentWriter->getPhpPresentation()->getPresentationProperties()->getThumbnailPath();
+            // Size : 128x128 pixel
+            // PNG : 8bit, non-interlaced with full alpha transparency
+            $gdImage = imagecreatefromstring(file_get_contents($pathThumbnail));
+            if ($gdImage) {
+                imagedestroy($gdImage);
+                $objWriter->startElement('manifest:file-entry');
+                $objWriter->writeAttribute('manifest:media-type', 'image/png');
+                $objWriter->writeAttribute('manifest:full-path', 'Thumbnails/thumbnail.png');
+                $objWriter->endElement();
+            }
+        }
+
         $objWriter->endElement();
 
         // Return

src/PhpPresentation/Writer/PowerPoint2007.php

@@ -220,13 +220,27 @@ public function save($pFilename)
             $objZip->addFromString('ppt/viewProps.xml', $wPptProps->writeViewProps($this->presentation));
 
             // Add relationships to ZIP file
-            $objZip->addFromString('_rels/.rels', $wPartRels->writeRelationships());
+            $objZip->addFromString('_rels/.rels', $wPartRels->writeRelationships($this->presentation));
             $objZip->addFromString('ppt/_rels/presentation.xml.rels', $wPartRels->writePresentationRelationships($this->presentation));
 
             // Add document properties to ZIP file
             $objZip->addFromString('docProps/app.xml', $wPartDocProps->writeDocPropsApp($this->presentation));
             $objZip->addFromString('docProps/core.xml', $wPartDocProps->writeDocPropsCore($this->presentation));
             $objZip->addFromString('docProps/custom.xml', $wPartDocProps->writeDocPropsCustom($this->presentation));
+            // Add Thumbnail to ZIP file
+            if ($this->presentation->getPresentationProperties()->getThumbnailPath()) {
+                $pathThumbnail = file_get_contents($this->presentation->getPresentationProperties()->getThumbnailPath());
+                $gdImage = imagecreatefromstring($pathThumbnail);
+                if ($gdImage) {
+                    ob_start();
+                    imagejpeg($gdImage);
+                    $imageContents = ob_get_contents();
+                    ob_end_clean();
+                    imagedestroy($gdImage);
+
+                    $objZip->addFromString('docProps/thumbnail.jpeg', $imageContents);
+                }
+            }
 
             $masterSlides = $this->getLayoutPack()->getMasterSlides();
             foreach ($masterSlides as $masterSlide) {