如何在PHPWord模板处理器的cloneBlock中插入图片？

我在DOCX模板中定义了如下区块：

${evidence}
${date}
${image:720:480}
${/evidence}

尝试通过PHP代码替换字符串和本地服务器图片，字符串替换成功，但图片仅显示路径未插入。

使用的PHP代码：

$filepath = './uploads/image.png';
$replacements = array(
    array('date' => '25-06-2022', 'image' => $filepath),
);
$templateProcessor->cloneBlock('evidence', 0, true, false, $replacements);

输出的DOCX内容：

25-06-2022
./uploads/image.png

环境：PHPWord 0.18.3、PHP 8.1

解决方法 #

PHPWord的cloneBlock方法无法直接通过数组替换值完成图片插入，需要单独处理图片变量的替换逻辑，以下是具体方案：

1. 调整模板变量格式 #

先将模板中的带尺寸参数的图片变量改为普通变量，尺寸参数移到代码中定义：

${evidence}
${date}
${image}
${/evidence}

2. 两种可行的代码实现方式 #

方式一：使用回调函数处理克隆后的区块

在克隆区块时通过回调，为每个克隆实例单独设置图片：

$filepath = './uploads/image.png';
$replacements = array(
    array('date' => '25-06-2022'),
);

$templateProcessor->cloneBlock('evidence', 0, true, false, $replacements, function($template, $index) use ($filepath) {
    $template->setImageValue('image#' . $index, array(
        'path' => realpath($filepath), // 使用绝对路径避免文件找不到
        'width' => 720,
        'height' => 480
    ));
});

方式二：先克隆再逐个替换图片

如果已知克隆次数，可先完成区块克隆，再循环替换每个实例的图片：

$filepath = './uploads/image.png';
$replaceCount = 1; // 对应你要克隆的次数，与replacements数组长度一致
$replacements = array(
    array('date' => '25-06-2022'),
);

// 克隆区块
$templateProcessor->cloneBlock('evidence', $replaceCount, true, false, $replacements);

// 逐个替换图片
for ($i = 1; $i <= $replaceCount; $i++) {
    $templateProcessor->setImageValue('image#' . $i, array(
        'path' => realpath($filepath),
        'width' => 720,
        'height' => 480
    ));
}

关键注意事项 #

• 务必使用绝对路径指定图片位置，realpath()函数可以将相对路径转为绝对路径，避免PHPWord无法定位文件。
• PHPWord 0.18.x版本中，cloneBlock克隆后的变量会自动添加索引后缀（如image#1），必须针对带索引的变量调用setImageValue才能完成图片插入。
• 模板中的图片变量不要携带尺寸参数，统一在setImageValue的参数数组中定义宽高。

内容的提问来源于stack exchange，提问作者Sigfredo Olmedo