Merge pull request #1716 from enflow/allowImageClosure

Allow a closure to be passed with image replacement tags

Author: troosan

docs/templates-processing.rst

@@ -63,6 +63,11 @@ Example:
 
     $templateProcessor->setImageValue('CompanyLogo', 'path/to/company/logo.png');
     $templateProcessor->setImageValue('UserLogo', array('path' => 'path/to/logo.png', 'width' => 100, 'height' => 100, 'ratio' => false));
+    $templateProcessor->setImageValue('FeatureImage', function () {
+        // Closure will only be executed if the replacement tag is found in the template
+
+        return array('path' => SlowFeatureImageGenerator::make(), 'width' => 100, 'height' => 100, 'ratio' => false);
+    });
 
 cloneBlock
 """"""""""

src/PhpWord/TemplateProcessor.php

@@ -456,6 +456,13 @@ private function prepareImageAttrs($replaceImage, $varInlineArgs)
         $width = null;
         $height = null;
         $ratio = null;
+
+        // a closure can be passed as replacement value which after resolving, can contain the replacement info for the image
+        // use case: only when a image if found, the replacement tags can be generated
+        if (is_callable($replaceImage)) {
+            $replaceImage = $replaceImage();
+        }
+
         if (is_array($replaceImage) && isset($replaceImage['path'])) {
             $imgPath = $replaceImage['path'];
             if (isset($replaceImage['width'])) {

tests/PhpWord/TemplateProcessorTest.php

@@ -397,9 +397,11 @@ public function testSetImageValue()
         $imagePath = __DIR__ . '/_files/images/earth.jpg';
 
         $variablesReplace = array(
-                                'headerValue'       => $imagePath,
-                                'documentContent'   => array('path' => $imagePath, 'width' => 500, 'height' => 500),
-                                'footerValue'       => array('path' => $imagePath, 'width' => 100, 'height' => 50, 'ratio' => false),
+                                'headerValue' => function () use ($imagePath) {
+                                    return $imagePath;
+                                },
+                                'documentContent' => array('path' => $imagePath, 'width' => 500, 'height' => 500),
+                                'footerValue' => array('path' => $imagePath, 'width' => 100, 'height' => 50, 'ratio' => false),
         );
         $templateProcessor->setImageValue(array_keys($variablesReplace), $variablesReplace);