Skip to content

Commit c72e237

Browse files
Sambit003Sambit003
committed
fix
1 parent 3a6b6c4 commit c72e237

File tree

6 files changed

+144
-53
lines changed

6 files changed

+144
-53
lines changed

‎src/PhpWord/Writer/WPS.php

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -63,25 +63,38 @@ public function save(string $filename): void
6363
{
6464
$filename = $this->getTempFile($filename);
6565
$zip = $this->getZipArchive($filename);
66+
$phpWord = $this->getPhpWord();
6667

67-
// Add section media files
68+
// Clear any previous media elements
69+
Media::clearElements();
70+
71+
// Collect media relations by traversing the document
72+
foreach ($phpWord->getSections() as $section) {
73+
Media::collectMediaRelations('section', $section);
74+
foreach ($section->getHeaders() as $header) {
75+
Media::collectMediaRelations('header', $header);
76+
}
77+
foreach ($section->getFooters() as $footer) {
78+
Media::collectMediaRelations('footer', $footer);
79+
}
80+
}
81+
82+
// Add collected media files to the package
6883
$sectionMedia = Media::getElements('section');
6984
if (!empty($sectionMedia)) {
7085
$this->addFilesToPackage($zip, $sectionMedia);
7186
}
72-
73-
// Add header/footer media files
7487
$headerMedia = Media::getElements('header');
7588
if (!empty($headerMedia)) {
7689
$this->addFilesToPackage($zip, $headerMedia);
7790
}
78-
7991
$footerMedia = Media::getElements('footer');
8092
if (!empty($footerMedia)) {
8193
$this->addFilesToPackage($zip, $footerMedia);
8294
}
8395

84-
// Make sure the META-INF directory exists
96+
// Make sure required directories exist
97+
$zip->addEmptyDir('Pictures'); // Ensure Pictures directory exists for images
8598
$zip->addEmptyDir('META-INF');
8699

87100
// Write parts

‎src/PhpWord/Writer/WPS/Media.php

Lines changed: 61 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -18,54 +18,88 @@
1818

1919
namespace PhpOffice\PhpWord\Writer\WPS;
2020

21-
use PhpOffice\PhpWord\Media as Word2007Media;
21+
use PhpOffice\PhpWord\Element\AbstractContainer;
22+
use PhpOffice\PhpWord\Element\AbstractElement;
23+
use PhpOffice\PhpWord\Element\Image;
2224

23-
class Media extends Word2007Media
25+
/**
26+
* WPS Media handler.
27+
*
28+
* @since 0.18.0
29+
*/
30+
class Media
2431
{
2532
/**
26-
* Media elements.
33+
* Media elements collection, categorized by document part (section, header, footer).
2734
*
28-
* @var array
35+
* @var array<string, array<int, array>>
2936
*/
30-
private static $elements = [
31-
'section' => [],
32-
'header' => [],
33-
'footer' => [],
34-
];
37+
private static $elements = [];
3538

3639
/**
37-
* Add new media element.
40+
* Add a media element to the collection.
41+
*
42+
* @param string $docPart e.g., 'section', 'header', 'footer'
43+
* @param AbstractElement $element The media element (e.g., Image)
3844
*/
39-
public static function addElement($container, $mediaType, $source, ?\PhpOffice\PhpWord\Element\Image $image = null): void
45+
public static function addElement(string $docPart, AbstractElement $element): void
4046
{
41-
if (!in_array($mediaType, ['header', 'footer', 'section'])) {
42-
return;
47+
if (!isset(self::$elements[$docPart])) {
48+
self::$elements[$docPart] = [];
4349
}
4450

45-
self::$elements[$mediaType][] = ['source' => $source, 'target' => $container, 'type' => $image];
51+
if ($element instanceof Image) {
52+
$mediaIndex = count(self::$elements[$docPart]) + 1;
53+
$element->setMediaIndex($mediaIndex);
54+
$element->setTarget("image{$mediaIndex}.{$element->getImageExtension()}");
55+
56+
self::$elements[$docPart][] = [
57+
'type' => 'image', // Add the missing 'type' index
58+
'source' => $element->getSource(),
59+
'target' => $element->getTarget(),
60+
'isMemImage' => $element->isMemImage(),
61+
'imageString' => $element->isMemImage() ? $element->getImageString() : null,
62+
];
63+
}
64+
// Add handling for other media types (OLEObject) if needed
4665
}
4766

4867
/**
49-
* Get media elements.
68+
* Get all media elements for a specific document part.
69+
*
70+
* @param string $docPart e.g., 'section', 'header', 'footer'
71+
*
72+
* @return array<int, array>
5073
*/
51-
public static function getElements($container, $type = null): array
74+
public static function getElements(string $docPart): array
5275
{
53-
if ($type !== null) {
54-
return self::$elements[$type] ?? [];
55-
}
56-
57-
return self::$elements;
76+
return self::$elements[$docPart] ?? [];
5877
}
5978

6079
/**
61-
* Clear media elements.
80+
* Clear all stored media elements.
6281
*/
6382
public static function clearElements(): void
6483
{
65-
self::$elements = [
66-
'section' => [],
67-
'header' => [],
68-
'footer' => [],
69-
];
84+
self::$elements = [];
85+
}
86+
87+
/**
88+
* Recursively collect media elements from a container.
89+
*
90+
* @param string $docPart The document part ('section', 'header', 'footer')
91+
* @param AbstractContainer $container The container element to traverse
92+
*/
93+
public static function collectMediaRelations(string $docPart, AbstractContainer $container): void
94+
{
95+
foreach ($container->getElements() as $element) {
96+
if ($element instanceof Image) {
97+
self::addElement($docPart, $element);
98+
} elseif ($element instanceof AbstractContainer) {
99+
// Recursively check sub-containers
100+
self::collectMediaRelations($docPart, $element);
101+
}
102+
// Add checks for other media types (OLEObject) if needed
103+
}
70104
}
71105
}

‎tests/PhpWordTests/Writer/WPS/MediaTest.php

Lines changed: 34 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
namespace PhpWordTests\Writer\WPS;
44

5+
use PhpOffice\PhpWord\Element\Image; // Add import
56
use PhpOffice\PhpWord\Writer\WPS\Media;
67
use PHPUnit\Framework\TestCase;
78

@@ -30,37 +31,60 @@ public function testGetElements(): void
3031

3132
public function testAddElement(): void
3233
{
34+
$imagePath = __DIR__ . 'tests/PhpWordTests/_files/images/earth.jpg';
35+
$imageElement = new Image($imagePath);
36+
3337
// Add section media
34-
Media::addElement('section', 'image', __DIR__ . '/../../_files/images/earth.jpg');
38+
Media::addElement('section', $imageElement);
3539
$elements = Media::getElements('section');
3640
self::assertCount(1, $elements);
3741
self::assertEquals('section', $elements[0]['target']);
38-
self::assertEquals(__DIR__ . '/../../_files/images/earth.jpg', $elements[0]['source']);
42+
self::assertEquals($imagePath, $elements[0]['source']);
43+
self::assertStringStartsWith('image1.', $elements[0]['target']);
3944

4045
// Add header media
41-
Media::addElement('header', 'image', __DIR__ . '/../../_files/images/earth.jpg');
46+
$headerImageElement = new Image($imagePath);
47+
Media::addElement('header', $headerImageElement);
4248
$headerElements = Media::getElements('header');
4349
self::assertCount(1, $headerElements);
50+
self::assertEquals('header', $headerElements[0]['target']);
51+
self::assertEquals($imagePath, $headerElements[0]['source']);
52+
self::assertStringStartsWith('image1.', $headerElements[0]['target']);
4453

4554
// Add footer media
46-
Media::addElement('footer', 'image', __DIR__ . '/../../_files/images/earth.jpg');
55+
$footerImageElement = new Image($imagePath);
56+
Media::addElement('footer', $footerImageElement);
4757
$footerElements = Media::getElements('footer');
4858
self::assertCount(1, $footerElements);
59+
self::assertEquals('footer', $footerElements[0]['target']);
60+
self::assertEquals($imagePath, $footerElements[0]['source']);
61+
self::assertStringStartsWith('image1.', $footerElements[0]['target']);
4962

50-
// Test invalid container type
51-
Media::addElement('invalid', 'image', __DIR__ . '/../../_files/images/earth.jpg');
52-
$allElements = ['section', 'header', 'footer'];
53-
foreach ($allElements as $container) {
63+
// Test invalid container type - Note: addElement doesn't validate docPart string anymore,
64+
// it just creates a new key in the $elements array.
65+
// This part of the test might need reconsideration based on desired behavior.
66+
$invalidImageElement = new Image($imagePath);
67+
Media::addElement('invalid', $invalidImageElement);
68+
$invalidElements = Media::getElements('invalid');
69+
self::assertCount(1, $invalidElements); // Element is added under 'invalid' key
70+
71+
// Check counts for valid types remain unchanged by the 'invalid' add
72+
$allValidElements = ['section', 'header', 'footer'];
73+
foreach ($allValidElements as $container) {
5474
$elements = Media::getElements($container);
5575
self::assertCount(1, $elements);
5676
}
5777
}
5878

5979
public function testClearElements(): void
6080
{
81+
$imagePath = __DIR__ . 'tests/PhpWordTests/_files/images/earth.jpg';
82+
$sectionImage = new Image($imagePath);
83+
$headerImage = new Image($imagePath);
84+
6185
// Add some elements
62-
Media::addElement('section', 'image', __DIR__ . '/../../_files/images/earth.jpg');
63-
Media::addElement('header', 'image', __DIR__ . '/../../_files/images/earth.jpg');
86+
Media::addElement('section', $sectionImage); // Pass Image element
87+
Media::addElement('header', $headerImage); // Pass Image element
6488

6589
// Verify elements exist
6690
self::assertNotEmpty(Media::getElements('section'));

‎tests/PhpWordTests/Writer/WPS/Part/ContentTest.php

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,27 @@
22

33
namespace PhpWordTests\Writer\WPS\Part;
44

5+
use PhpOffice\PhpWord\PhpWord;
6+
use PhpOffice\PhpWord\Writer\WPS;
57
use PhpOffice\PhpWord\Writer\WPS\Part\Content;
68
use PHPUnit\Framework\TestCase;
79

810
class ContentTest extends TestCase
911
{
1012
public function testWrite(): void
1113
{
12-
$content = new Content();
14+
// Arrange: Create necessary objects and set parent writer
15+
$phpWord = new PhpWord();
16+
$phpWord->addSection(); // Add a section to avoid errors during write
17+
$writer = new WPS($phpWord);
18+
/** @var Content $content */
19+
$content = $writer->getWriterPart('content'); // Get part from writer
20+
21+
// Act: Call the write method
1322
$result = $content->write();
1423

1524
// Assert that the result is a string
1625
self::assertIsString($result);
17-
1826
// Assert that the result contains expected XML structure
1927
self::assertStringContainsString('<office:document-content', $result);
2028
self::assertStringContainsString('xmlns:office="urn:oasis:names:tc:opendocument:xmlns:office:1.0"', $result);

‎tests/PhpWordTests/Writer/WPS/Part/MetaTest.php

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,26 @@
22

33
namespace PhpWordTests\Writer\WPS\Part;
44

5+
use PhpOffice\PhpWord\PhpWord;
6+
use PhpOffice\PhpWord\Writer\WPS;
57
use PhpOffice\PhpWord\Writer\WPS\Part\Meta;
68
use PHPUnit\Framework\TestCase;
79

810
class MetaTest extends TestCase
911
{
1012
public function testWrite(): void
1113
{
12-
$meta = new Meta();
14+
// Arrange: Create necessary objects and set parent writer
15+
$phpWord = new PhpWord();
16+
$writer = new WPS($phpWord);
17+
/** @var Meta $meta */
18+
$meta = $writer->getWriterPart('meta'); // Get part from writer
19+
20+
// Act: Call the write method
1321
$result = $meta->write();
1422

1523
// Assert that the result is a string
1624
self::assertIsString($result);
17-
1825
// Assert that the result contains expected XML structure
1926
self::assertStringContainsString('<office:document-meta', $result);
2027
self::assertStringContainsString('xmlns:office="urn:oasis:names:tc:opendocument:xmlns:office:1.0"', $result);

‎tests/PhpWordTests/Writer/WPSTest.php

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,9 @@ public function testWithMedia(): void
6464
$section = $phpWord->addSection();
6565

6666
// Add an image to the document
67-
$imagePath = __DIR__ . '../tests/PhpWordTests/_files/images/earth.jpg';
67+
// Correct the relative path
68+
$imagePath = realpath(__DIR__ . '/../../_files/images/earth.jpg');
69+
self::assertFileExists($imagePath, "Test image file not found at: {$imagePath}"); // Add assertion for debugging
6870
$section->addImage($imagePath);
6971

7072
// Create header and add an image to it
@@ -76,16 +78,19 @@ public function testWithMedia(): void
7678
$footer->addImage($imagePath);
7779

7880
$writer = new WPS($phpWord);
79-
$tempFile = tempnam(sys_get_temp_dir(), 'wps');
81+
$tempFile = tempnam(sys_get_temp_dir(), 'wps_media_'); // Use a distinct prefix
8082
$writer->save($tempFile);
8183

8284
// Test ZIP archive contains images
8385
$zip = new ZipArchive();
84-
$zip->open($tempFile);
85-
86-
// The exact path to images depends on the media handler implementation
87-
// Just verify the Pictures directory exists
88-
self::assertTrue($zip->locateName('Pictures/') !== false);
86+
self::assertTrue($zip->open($tempFile) === true, "Failed to open generated ZIP file: {$tempFile}");
87+
88+
// Verify the Pictures directory exists and contains images
89+
self::assertTrue($zip->locateName('Pictures/') !== false, "'Pictures/' directory not found in ZIP.");
90+
// Check for specific image files (names depend on Media implementation)
91+
self::assertTrue($zip->locateName('Pictures/image1.jpg') !== false, "Image 'Pictures/image1.jpg' not found.");
92+
self::assertTrue($zip->locateName('Pictures/image2.jpg') !== false, "Image 'Pictures/image2.jpg' not found.");
93+
self::assertTrue($zip->locateName('Pictures/image3.jpg') !== false, "Image 'Pictures/image3.jpg' not found.");
8994

9095
$zip->close();
9196
unlink($tempFile);

0 commit comments

Comments
 (0)