Refactor Element\Image and some samples

Author: ivanlanin

samples/Sample_07_TemplateCloneRow.php

@@ -60,4 +60,8 @@
 $document->saveAs($name);
 rename($name, "results/{$name}");
 
-include_once 'Sample_Footer.php';
+$writers = array('Word2007' => 'docx');
+echo getEndingNotes($writers);
+if (!CLI) {
+    include_once 'Sample_Footer.php';
+}

samples/Sample_23_TemplateBlock.php

@@ -18,4 +18,8 @@
 $document->saveAs($name);
 rename($name, "results/{$name}");
 
-include_once 'Sample_Footer.php';
+$writers = array('Word2007' => 'docx');
+echo getEndingNotes($writers);
+if (!CLI) {
+    include_once 'Sample_Footer.php';
+}

samples/Sample_Header.php

@@ -46,18 +46,17 @@
 }
 
 /**
- * Get results
+ * Write documents
  *
  * @param \PhpOffice\PhpWord\PhpWord $phpWord
  * @param string $filename
  * @param array $writers
- * @return string
  */
 function write($phpWord, $filename, $writers)
 {
     $result = '';
 
-    // Write
+    // Write documents
     foreach ($writers as $writer => $extension) {
         $result .= date('H:i:s') . " Write to {$writer} format";
         if (!is_null($extension)) {
@@ -70,6 +69,20 @@ function write($phpWord, $filename, $writers)
         $result .= EOL;
     }
 
+    $result .= getEndingNotes($writers);
+
+    return $result;
+}
+
+/**
+ * Get ending notes
+ *
+ * @param array $writers
+ */
+function getEndingNotes($writers)
+{
+    $result = '';
+
     // Do not show execution time for index
     if (!IS_INDEX) {
         $result .= date('H:i:s') . " Done writing file(s)" . EOL;

src/PhpWord/Element/Image.php

@@ -18,13 +18,27 @@
  */
 class Image extends AbstractElement
 {
+    /**
+     * Image source type constants
+     */
+    const SOURCE_LOCAL = 'local'; // Local images
+    const SOURCE_GD = 'gd'; // Generated using GD
+    const SOURCE_ARCHIVE = 'archive'; // Image in archives zip://$archive#$image
+
     /**
      * Image source
      *
      * @var string
      */
     private $source;
 
+    /**
+     * Source type: local|gd|archive
+     *
+     * @var string
+     */
+    private $sourceType;
+
     /**
      * Image style
      *
@@ -199,49 +213,87 @@ public function getIsMemImage()
      */
     private function checkImage($source)
     {
-        $isArchive = strpos($source, 'zip://') !== false;
+        $this->setSourceType($source);
 
-        // Check is memory image
-        if (stripos(strrev($source), strrev('.php')) === 0) {
-            $this->isMemImage = true;
-        } elseif ($isArchive) {
-            $this->isMemImage = false;
-        } else {
-            $this->isMemImage = (filter_var($source, FILTER_VALIDATE_URL) !== false);
-        }
-
-        // Define supported types
-        if ($this->isMemImage) {
-            $supportedTypes = array(
-                IMAGETYPE_JPEG, IMAGETYPE_GIF, IMAGETYPE_PNG
-            );
-        } else {
-            $supportedTypes = array(
-                IMAGETYPE_JPEG, IMAGETYPE_GIF, IMAGETYPE_PNG,
-                IMAGETYPE_BMP, IMAGETYPE_TIFF_II, IMAGETYPE_TIFF_MM
-            );
-        }
-
-        // Check from zip file or actual file
-        if ($isArchive) {
-            $imageData = $this->getArchivedImageSize($source);
+        // Check image data
+        if ($this->sourceType == self::SOURCE_ARCHIVE) {
+            $imageData = $this->getArchiveImageSize($source);
         } else {
             $imageData = @getimagesize($source);
         }
-
-        // Check if image exists by detecting image data
         if (!is_array($imageData)) {
             throw new InvalidImageException();
         }
-        // Put image data into variables
         list($actualWidth, $actualHeight, $imageType) = $imageData;
-        // Check if image type is supported
+
+        // Check image type support
+        $supportedTypes = array(IMAGETYPE_JPEG, IMAGETYPE_GIF, IMAGETYPE_PNG);
+        if ($this->sourceType != self::SOURCE_GD) {
+            $supportedTypes = array_merge($supportedTypes, array(IMAGETYPE_BMP, IMAGETYPE_TIFF_II, IMAGETYPE_TIFF_MM));
+        }
         if (!in_array($imageType, $supportedTypes)) {
             throw new UnsupportedImageTypeException();
         }
 
         // Define image functions
         $this->imageType = image_type_to_mime_type($imageType);
+        $this->setFunctions();
+        $this->setProportionalSize($actualWidth, $actualHeight);
+    }
+
+    /**
+     * Set source type
+     *
+     * @param string $source
+     */
+    private function setSourceType($source)
+    {
+        if (stripos(strrev($source), strrev('.php')) === 0) {
+            $this->isMemImage = true;
+            $this->sourceType = self::SOURCE_GD;
+        } elseif (strpos($source, 'zip://') !== false) {
+            $this->isMemImage = false;
+            $this->sourceType = self::SOURCE_ARCHIVE;
+        } else {
+            $this->isMemImage = (filter_var($source, FILTER_VALIDATE_URL) !== false);
+            $this->sourceType = $this->isMemImage ? self::SOURCE_GD : self::SOURCE_LOCAL;
+        }
+    }
+
+    /**
+     * Get image size from archive
+     *
+     * @param string $source
+     * @return array|null
+     */
+    private function getArchiveImageSize($source)
+    {
+        $imageData = null;
+        $source = substr($source, 6);
+        list($zipFilename, $imageFilename) = explode('#', $source);
+        $tempFilename = tempnam(sys_get_temp_dir(), 'PHPWordImage');
+
+        $zip = new \ZipArchive();
+        if ($zip->open($zipFilename) !== false) {
+            if ($zip->locateName($imageFilename)) {
+                $imageContent = $zip->getFromName($imageFilename);
+                if ($imageContent !== false) {
+                    file_put_contents($tempFilename, $imageContent);
+                    $imageData = @getimagesize($tempFilename);
+                    unlink($tempFilename);
+                }
+            }
+            $zip->close();
+        }
+
+        return $imageData;
+    }
+
+    /**
+     * Set image functions and extensions
+     */
+    private function setFunctions()
+    {
         switch ($this->imageType) {
             case 'image/png':
                 $this->imageCreateFunc = 'imagecreatefrompng';
@@ -254,6 +306,7 @@ private function checkImage($source)
                 $this->imageExtension = 'gif';
                 break;
             case 'image/jpeg':
+            case 'image/jpg':
                 $this->imageCreateFunc = 'imagecreatefromjpeg';
                 $this->imageFunc = 'imagejpeg';
                 $this->imageExtension = 'jpg';
@@ -267,8 +320,13 @@ private function checkImage($source)
                 $this->imageExtension = 'tif';
                 break;
         }
+    }
 
-        // Check image width & height
+    /**
+     * Set proportional width/height if one dimension not available
+     */
+    private function setProportionalSize($actualWidth, $actualHeight)
+    {
         $styleWidth = $this->style->getWidth();
         $styleHeight = $this->style->getHeight();
         if (!($styleWidth && $styleHeight)) {
@@ -281,35 +339,5 @@ private function checkImage($source)
                 $this->style->setWidth($actualWidth * ($styleHeight / $actualHeight));
             }
         }
-
-    }
-
-    /**
-     * Get image size from archive
-     *
-     * @param string $source
-     * @return array|null
-     */
-    private function getArchivedImageSize($source)
-    {
-        $imageData = null;
-        $source = substr($source, 6);
-        list($zipFilename, $imageFilename) = explode('#', $source);
-        $tempFilename = tempnam(sys_get_temp_dir(), 'PHPWordImage');
-
-        $zip = new \ZipArchive();
-        if ($zip->open($zipFilename) !== false) {
-            if ($zip->locateName($imageFilename)) {
-                $imageContent = $zip->getFromName($imageFilename);
-                if ($imageContent !== false) {
-                    file_put_contents($tempFilename, $imageContent);
-                    $imageData = @getimagesize($tempFilename);
-                    unlink($tempFilename);
-                }
-            }
-            $zip->close();
-        }
-
-        return $imageData;
     }
 }