Support adding images in Templates (#1170)

* setImageValue() + fix adding files via ZipArchive
* fix phpdoc variable name
* Changed logic that determines extension image file extension for document to depend on MIME type. This same logic is used in Element/Image.php
* support <w:t> tags with arguments
* allow setup size of image into template variable
* support of 'ratio' replace attribute + documentation

Author: SailorMax

.travis.yml

@@ -24,8 +24,6 @@ matrix:
         - php: 5.3
         - php: 7.0
         - php: 7.3
-    allow_failures:
-        - php: 7.3
 
 cache:
     directories:

CHANGELOG.md

@@ -10,6 +10,7 @@ v0.16.0 (xx dec 2018)
 - Add setting Chart Title and Legend visibility @Tom-Magill #1433
 - Add ability to pass a Style object in Section constructor @ndench #1416
 - Add support for hidden text @Alexmg86 #1527
+- Add support for setting images in TemplateProcessor @SailorMax #1170
 
 ### Fixed
 - Fix regex in `cloneBlock` function @nicoder #1269

docs/templates-processing.rst

@@ -7,14 +7,32 @@ You can create an OOXML document template with included search-patterns (macros)
 
 To deal with a template file, use ``new TemplateProcessor`` statement. After TemplateProcessor instance creation the document template is copied into the temporary directory. Then you can use ``TemplateProcessor::setValue`` method to change the value of a search pattern. The search-pattern model is: ``${search-pattern}``.
 
+The search-pattern model for images can be like:
+- ``${search-image-pattern}``
+- ``${search-image-pattern:[width]:[height]:[ratio]}``
+- ``${search-image-pattern:[width]x[height]}``
+- ``${search-image-pattern:size=[width]x[height]}``
+- ``${search-image-pattern:width=[width]:height=[height]:ratio=false}``
+Where:
+- [width] and [height] can be just numbers or numbers with measure, which supported by Word (cm|mm|in|pt|pc|px|%|em|ex)
+- [ratio] uses only for ``false``, ``-`` or ``f`` to turn off respect aspect ration of image. By default template image size uses as 'container' size.
+
 Example:
 
+.. code-block:: doc
+
+	${CompanyLogo}
+    ${UserLogo:50:50} ${Name} - ${City} - ${Street}
+
 .. code-block:: php
 
     $templateProcessor = new TemplateProcessor('Template.docx');
     $templateProcessor->setValue('Name', 'John Doe');
     $templateProcessor->setValue(array('City', 'Street'), array('Detroit', '12th Street'));
 
+	$templateProcessor->setImageValue('CompanyLogo', 'path/to/company/logo.png');
+	$templateProcessor->setImageValue('UserLogo', array('path' => 'path/to/logo.png', 'width' => 100, 'height' => 100, 'ratio' => false));
+
 It is not possible to directly add new OOXML elements to the template file being processed, but it is possible to transform headers, main document part, and footers of the template using XSLT (see ``TemplateProcessor::applyXslStyleSheet``).
 
 See ``Sample_07_TemplateCloneRow.php`` for example on how to create

src/PhpWord/Shared/ZipArchive.php

@@ -129,6 +129,7 @@ public function open($filename, $flags = null)
     {
         $result = true;
         $this->filename = $filename;
+        $this->tempDir = Settings::getTempDir();
 
         if (!$this->usePclzip) {
             $zip = new \ZipArchive();
@@ -139,7 +140,6 @@ public function open($filename, $flags = null)
             $this->numFiles = $zip->numFiles;
         } else {
             $zip = new \PclZip($this->filename);
-            $this->tempDir = Settings::getTempDir();
             $zipContent = $zip->listContent();
             $this->numFiles = is_array($zipContent) ? count($zipContent) : 0;
         }
@@ -245,7 +245,13 @@ public function pclzipAddFile($filename, $localname = null)
         $pathRemoved = $filenameParts['dirname'];
         $pathAdded = $localnameParts['dirname'];
 
-        $res = $zip->add($filename, PCLZIP_OPT_REMOVE_PATH, $pathRemoved, PCLZIP_OPT_ADD_PATH, $pathAdded);
+        if (!$this->usePclzip) {
+            $pathAdded = $pathAdded . '/' . ltrim(str_replace('\\', '/', substr($filename, strlen($pathRemoved))), '/');
+            //$res = $zip->addFile($filename, $pathAdded);
+            $res = $zip->addFromString($pathAdded, file_get_contents($filename));       // addFile can't use subfolders in some cases
+        } else {
+            $res = $zip->add($filename, PCLZIP_OPT_REMOVE_PATH, $pathRemoved, PCLZIP_OPT_ADD_PATH, $pathAdded);
+        }
 
         if ($tempFile) {
             // Remove temp file, if created