Skip to content

Limit of setImageValue #1950

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Limit of setImageValue #1950

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions src/PhpWord/TemplateProcessor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -585,6 +585,9 @@ public function setImageValue($search, $replace, $limit = self::MAXIMUM_REPLACEM
return ($partVar == $searchString) || preg_match('/^' . preg_quote($searchString) . ':/', $partVar);
});

// Exclude multiple same variable name
$varsToReplace = array_unique($varsToReplace);

foreach ($varsToReplace as $varNameWithArgs) {
$varInlineArgs = $this->getImageArgs($varNameWithArgs);
$preparedImageAttrs = $this->prepareImageAttrs($replaceImage, $varInlineArgs);
Expand Down
78 changes: 78 additions & 0 deletions tests/PhpWord/TemplateProcessorTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -844,4 +844,82 @@ public function testShouldMakeFieldsUpdateOnOpen()
$templateProcessor->setUpdateFields(false);
$this->assertContains('<w:updateFields w:val="false"/>', $templateProcessor->getSettingsPart());
}

/**
* @covers ::setImageValue
* @test
*/
public function testSetImageValueLimit()
{
$templateProcessor = new TemplateProcessor(__DIR__ . '/_files/templates/setImageValue-limit.docx');
$imagePath = __DIR__ . '/_files/images/earth.jpg';

$variablesReplace = array(
'picture' => array('path' => $imagePath, 'width' => 500, 'height' => 500),
);
$templateProcessor->setImageValue(array_keys($variablesReplace), $variablesReplace, 2);

$docName = 'setImageValue-limit-test-result.docx';
$templateProcessor->saveAs($docName);

$this->assertFileExists($docName, "Generated file '{$docName}' not found!");

$expectedDocumentZip = new \ZipArchive();
$expectedDocumentZip->open($docName);
$expectedContentTypesXml = $expectedDocumentZip->getFromName('[Content_Types].xml');
$expectedDocumentRelationsXml = $expectedDocumentZip->getFromName('word/_rels/document.xml.rels');
$expectedMainPartXml = $expectedDocumentZip->getFromName('word/document.xml');
$expectedImage = $expectedDocumentZip->getFromName('word/media/image_rId14_document.jpeg');
if (false === $expectedDocumentZip->close()) {
throw new \Exception("Could not close zip file \"{$docName}\".");
}

$this->assertNotEmpty($expectedImage, 'Embed image doesn\'t found.');
$this->assertContains('/word/media/image_rId14_document.jpeg', $expectedContentTypesXml, '[Content_Types].xml missed "/word/media/image5_document.jpeg"');

$this->assertContains('${picture}', $expectedMainPartXml, 'word/document.xml has replace second item.');

$this->assertSame(1, substr_count($expectedMainPartXml, '${picture}'), 'word/document.xml only first item has been replaced.');
$this->assertContains('media/image_rId14_document.jpeg', $expectedDocumentRelationsXml, 'word/_rels/document.xml.rels missed "media/image5_document.jpeg"');

unlink($docName);
}

/**
* @covers ::setImageValue
* @test
*/
public function testSetImageValueNoLimit()
{
$templateProcessor = new TemplateProcessor(__DIR__ . '/_files/templates/setImageValue-limit.docx');
$imagePath = __DIR__ . '/_files/images/earth.jpg';

$variablesReplace = array(
'picture' => array('path' => $imagePath, 'width' => 500, 'height' => 500),
);
$templateProcessor->setImageValue(array_keys($variablesReplace), $variablesReplace);

$docName = 'setImageValue-limit-test-result.docx';
$templateProcessor->saveAs($docName);

$this->assertFileExists($docName, "Generated file '{$docName}' not found!");

$expectedDocumentZip = new \ZipArchive();
$expectedDocumentZip->open($docName);
$expectedContentTypesXml = $expectedDocumentZip->getFromName('[Content_Types].xml');
$expectedDocumentRelationsXml = $expectedDocumentZip->getFromName('word/_rels/document.xml.rels');
$expectedMainPartXml = $expectedDocumentZip->getFromName('word/document.xml');
$expectedImage = $expectedDocumentZip->getFromName('word/media/image_rId14_document.jpeg');
if (false === $expectedDocumentZip->close()) {
throw new \Exception("Could not close zip file \"{$docName}\".");
}

$this->assertNotEmpty($expectedImage, 'Embed image doesn\'t found.');
$this->assertContains('/word/media/image_rId14_document.jpeg', $expectedContentTypesXml, '[Content_Types].xml missed "/word/media/image5_document.jpeg"');

$this->assertNotContains('${picture}', $expectedMainPartXml, 'word/document.xml has replace second item.');
$this->assertContains('media/image_rId14_document.jpeg', $expectedDocumentRelationsXml, 'word/_rels/document.xml.rels missed "media/image5_document.jpeg"');

unlink($docName);
}
}