1 |
efrain |
1 |
<?php
|
|
|
2 |
|
|
|
3 |
namespace PhpOffice\PhpSpreadsheet\Writer\Xlsx;
|
|
|
4 |
|
|
|
5 |
use PhpOffice\PhpSpreadsheet\Reader\Xlsx\Namespaces;
|
|
|
6 |
use PhpOffice\PhpSpreadsheet\Shared\File;
|
|
|
7 |
use PhpOffice\PhpSpreadsheet\Shared\XMLWriter;
|
|
|
8 |
use PhpOffice\PhpSpreadsheet\Spreadsheet;
|
|
|
9 |
use PhpOffice\PhpSpreadsheet\Worksheet\MemoryDrawing;
|
|
|
10 |
use PhpOffice\PhpSpreadsheet\Writer\Exception as WriterException;
|
|
|
11 |
|
|
|
12 |
class ContentTypes extends WriterPart
|
|
|
13 |
{
|
|
|
14 |
/**
|
|
|
15 |
* Write content types to XML format.
|
|
|
16 |
*
|
|
|
17 |
* @param bool $includeCharts Flag indicating if we should include drawing details for charts
|
|
|
18 |
*
|
|
|
19 |
* @return string XML Output
|
|
|
20 |
*/
|
|
|
21 |
public function writeContentTypes(Spreadsheet $spreadsheet, $includeCharts = false)
|
|
|
22 |
{
|
|
|
23 |
// Create XML writer
|
|
|
24 |
$objWriter = null;
|
|
|
25 |
if ($this->getParentWriter()->getUseDiskCaching()) {
|
|
|
26 |
$objWriter = new XMLWriter(XMLWriter::STORAGE_DISK, $this->getParentWriter()->getDiskCachingDirectory());
|
|
|
27 |
} else {
|
|
|
28 |
$objWriter = new XMLWriter(XMLWriter::STORAGE_MEMORY);
|
|
|
29 |
}
|
|
|
30 |
|
|
|
31 |
// XML header
|
|
|
32 |
$objWriter->startDocument('1.0', 'UTF-8', 'yes');
|
|
|
33 |
|
|
|
34 |
// Types
|
|
|
35 |
$objWriter->startElement('Types');
|
|
|
36 |
$objWriter->writeAttribute('xmlns', Namespaces::CONTENT_TYPES);
|
|
|
37 |
|
|
|
38 |
// Theme
|
|
|
39 |
$this->writeOverrideContentType($objWriter, '/xl/theme/theme1.xml', 'application/vnd.openxmlformats-officedocument.theme+xml');
|
|
|
40 |
|
|
|
41 |
// Styles
|
|
|
42 |
$this->writeOverrideContentType($objWriter, '/xl/styles.xml', 'application/vnd.openxmlformats-officedocument.spreadsheetml.styles+xml');
|
|
|
43 |
|
|
|
44 |
// Rels
|
|
|
45 |
$this->writeDefaultContentType($objWriter, 'rels', 'application/vnd.openxmlformats-package.relationships+xml');
|
|
|
46 |
|
|
|
47 |
// XML
|
|
|
48 |
$this->writeDefaultContentType($objWriter, 'xml', 'application/xml');
|
|
|
49 |
|
|
|
50 |
// VML
|
|
|
51 |
$this->writeDefaultContentType($objWriter, 'vml', 'application/vnd.openxmlformats-officedocument.vmlDrawing');
|
|
|
52 |
|
|
|
53 |
// Workbook
|
|
|
54 |
if ($spreadsheet->hasMacros()) { //Macros in workbook ?
|
|
|
55 |
// Yes : not standard content but "macroEnabled"
|
|
|
56 |
$this->writeOverrideContentType($objWriter, '/xl/workbook.xml', 'application/vnd.ms-excel.sheet.macroEnabled.main+xml');
|
|
|
57 |
//... and define a new type for the VBA project
|
|
|
58 |
// Better use Override, because we can use 'bin' also for xl\printerSettings\printerSettings1.bin
|
|
|
59 |
$this->writeOverrideContentType($objWriter, '/xl/vbaProject.bin', 'application/vnd.ms-office.vbaProject');
|
|
|
60 |
if ($spreadsheet->hasMacrosCertificate()) {
|
|
|
61 |
// signed macros ?
|
|
|
62 |
// Yes : add needed information
|
|
|
63 |
$this->writeOverrideContentType($objWriter, '/xl/vbaProjectSignature.bin', 'application/vnd.ms-office.vbaProjectSignature');
|
|
|
64 |
}
|
|
|
65 |
} else {
|
|
|
66 |
// no macros in workbook, so standard type
|
|
|
67 |
$this->writeOverrideContentType($objWriter, '/xl/workbook.xml', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet.main+xml');
|
|
|
68 |
}
|
|
|
69 |
|
|
|
70 |
// DocProps
|
|
|
71 |
$this->writeOverrideContentType($objWriter, '/docProps/app.xml', 'application/vnd.openxmlformats-officedocument.extended-properties+xml');
|
|
|
72 |
|
|
|
73 |
$this->writeOverrideContentType($objWriter, '/docProps/core.xml', 'application/vnd.openxmlformats-package.core-properties+xml');
|
|
|
74 |
|
|
|
75 |
$customPropertyList = $spreadsheet->getProperties()->getCustomProperties();
|
|
|
76 |
if (!empty($customPropertyList)) {
|
|
|
77 |
$this->writeOverrideContentType($objWriter, '/docProps/custom.xml', 'application/vnd.openxmlformats-officedocument.custom-properties+xml');
|
|
|
78 |
}
|
|
|
79 |
|
|
|
80 |
// Worksheets
|
|
|
81 |
$sheetCount = $spreadsheet->getSheetCount();
|
|
|
82 |
for ($i = 0; $i < $sheetCount; ++$i) {
|
|
|
83 |
$this->writeOverrideContentType($objWriter, '/xl/worksheets/sheet' . ($i + 1) . '.xml', 'application/vnd.openxmlformats-officedocument.spreadsheetml.worksheet+xml');
|
|
|
84 |
}
|
|
|
85 |
|
|
|
86 |
// Shared strings
|
|
|
87 |
$this->writeOverrideContentType($objWriter, '/xl/sharedStrings.xml', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sharedStrings+xml');
|
|
|
88 |
|
|
|
89 |
// Table
|
|
|
90 |
$table = 1;
|
|
|
91 |
for ($i = 0; $i < $sheetCount; ++$i) {
|
|
|
92 |
$tableCount = $spreadsheet->getSheet($i)->getTableCollection()->count();
|
|
|
93 |
|
|
|
94 |
for ($t = 1; $t <= $tableCount; ++$t) {
|
|
|
95 |
$this->writeOverrideContentType($objWriter, '/xl/tables/table' . $table++ . '.xml', 'application/vnd.openxmlformats-officedocument.spreadsheetml.table+xml');
|
|
|
96 |
}
|
|
|
97 |
}
|
|
|
98 |
|
|
|
99 |
// Add worksheet relationship content types
|
|
|
100 |
$unparsedLoadedData = $spreadsheet->getUnparsedLoadedData();
|
|
|
101 |
$chart = 1;
|
|
|
102 |
for ($i = 0; $i < $sheetCount; ++$i) {
|
|
|
103 |
$drawings = $spreadsheet->getSheet($i)->getDrawingCollection();
|
|
|
104 |
$drawingCount = count($drawings);
|
|
|
105 |
$chartCount = ($includeCharts) ? $spreadsheet->getSheet($i)->getChartCount() : 0;
|
|
|
106 |
$hasUnparsedDrawing = isset($unparsedLoadedData['sheets'][$spreadsheet->getSheet($i)->getCodeName()]['drawingOriginalIds']);
|
|
|
107 |
|
|
|
108 |
// We need a drawing relationship for the worksheet if we have either drawings or charts
|
|
|
109 |
if (($drawingCount > 0) || ($chartCount > 0) || $hasUnparsedDrawing) {
|
|
|
110 |
$this->writeOverrideContentType($objWriter, '/xl/drawings/drawing' . ($i + 1) . '.xml', 'application/vnd.openxmlformats-officedocument.drawing+xml');
|
|
|
111 |
}
|
|
|
112 |
|
|
|
113 |
// If we have charts, then we need a chart relationship for every individual chart
|
|
|
114 |
if ($chartCount > 0) {
|
|
|
115 |
for ($c = 0; $c < $chartCount; ++$c) {
|
|
|
116 |
$this->writeOverrideContentType($objWriter, '/xl/charts/chart' . $chart++ . '.xml', 'application/vnd.openxmlformats-officedocument.drawingml.chart+xml');
|
|
|
117 |
}
|
|
|
118 |
}
|
|
|
119 |
}
|
|
|
120 |
|
|
|
121 |
// Comments
|
|
|
122 |
for ($i = 0; $i < $sheetCount; ++$i) {
|
|
|
123 |
if (count($spreadsheet->getSheet($i)->getComments()) > 0) {
|
|
|
124 |
$this->writeOverrideContentType($objWriter, '/xl/comments' . ($i + 1) . '.xml', 'application/vnd.openxmlformats-officedocument.spreadsheetml.comments+xml');
|
|
|
125 |
}
|
|
|
126 |
}
|
|
|
127 |
|
|
|
128 |
// Add media content-types
|
|
|
129 |
$aMediaContentTypes = [];
|
|
|
130 |
$mediaCount = $this->getParentWriter()->getDrawingHashTable()->count();
|
|
|
131 |
for ($i = 0; $i < $mediaCount; ++$i) {
|
|
|
132 |
$extension = '';
|
|
|
133 |
$mimeType = '';
|
|
|
134 |
|
|
|
135 |
if ($this->getParentWriter()->getDrawingHashTable()->getByIndex($i) instanceof \PhpOffice\PhpSpreadsheet\Worksheet\Drawing) {
|
|
|
136 |
$extension = strtolower($this->getParentWriter()->getDrawingHashTable()->getByIndex($i)->getExtension());
|
|
|
137 |
$mimeType = $this->getImageMimeType($this->getParentWriter()->getDrawingHashTable()->getByIndex($i)->getPath());
|
|
|
138 |
} elseif ($this->getParentWriter()->getDrawingHashTable()->getByIndex($i) instanceof MemoryDrawing) {
|
|
|
139 |
$extension = strtolower($this->getParentWriter()->getDrawingHashTable()->getByIndex($i)->getMimeType());
|
|
|
140 |
$extension = explode('/', $extension);
|
|
|
141 |
$extension = $extension[1];
|
|
|
142 |
|
|
|
143 |
$mimeType = $this->getParentWriter()->getDrawingHashTable()->getByIndex($i)->getMimeType();
|
|
|
144 |
}
|
|
|
145 |
|
|
|
146 |
if (!isset($aMediaContentTypes[$extension])) {
|
|
|
147 |
$aMediaContentTypes[$extension] = $mimeType;
|
|
|
148 |
|
|
|
149 |
$this->writeDefaultContentType($objWriter, $extension, $mimeType);
|
|
|
150 |
}
|
|
|
151 |
}
|
|
|
152 |
if ($spreadsheet->hasRibbonBinObjects()) {
|
|
|
153 |
// Some additional objects in the ribbon ?
|
|
|
154 |
// we need to write "Extension" but not already write for media content
|
|
|
155 |
$tabRibbonTypes = array_diff($spreadsheet->getRibbonBinObjects('types') ?? [], array_keys($aMediaContentTypes));
|
|
|
156 |
foreach ($tabRibbonTypes as $aRibbonType) {
|
|
|
157 |
$mimeType = 'image/.' . $aRibbonType; //we wrote $mimeType like customUI Editor
|
|
|
158 |
$this->writeDefaultContentType($objWriter, $aRibbonType, $mimeType);
|
|
|
159 |
}
|
|
|
160 |
}
|
|
|
161 |
$sheetCount = $spreadsheet->getSheetCount();
|
|
|
162 |
for ($i = 0; $i < $sheetCount; ++$i) {
|
|
|
163 |
if (count($spreadsheet->getSheet($i)->getHeaderFooter()->getImages()) > 0) {
|
|
|
164 |
foreach ($spreadsheet->getSheet($i)->getHeaderFooter()->getImages() as $image) {
|
|
|
165 |
if (!isset($aMediaContentTypes[strtolower($image->getExtension())])) {
|
|
|
166 |
$aMediaContentTypes[strtolower($image->getExtension())] = $this->getImageMimeType($image->getPath());
|
|
|
167 |
|
|
|
168 |
$this->writeDefaultContentType($objWriter, strtolower($image->getExtension()), $aMediaContentTypes[strtolower($image->getExtension())]);
|
|
|
169 |
}
|
|
|
170 |
}
|
|
|
171 |
}
|
|
|
172 |
|
|
|
173 |
if (count($spreadsheet->getSheet($i)->getComments()) > 0) {
|
|
|
174 |
foreach ($spreadsheet->getSheet($i)->getComments() as $comment) {
|
|
|
175 |
if (!$comment->hasBackgroundImage()) {
|
|
|
176 |
continue;
|
|
|
177 |
}
|
|
|
178 |
|
|
|
179 |
$bgImage = $comment->getBackgroundImage();
|
|
|
180 |
$bgImageExtentionKey = strtolower($bgImage->getImageFileExtensionForSave(false));
|
|
|
181 |
|
|
|
182 |
if (!isset($aMediaContentTypes[$bgImageExtentionKey])) {
|
|
|
183 |
$aMediaContentTypes[$bgImageExtentionKey] = $bgImage->getImageMimeType();
|
|
|
184 |
|
|
|
185 |
$this->writeDefaultContentType($objWriter, $bgImageExtentionKey, $aMediaContentTypes[$bgImageExtentionKey]);
|
|
|
186 |
}
|
|
|
187 |
}
|
|
|
188 |
}
|
|
|
189 |
}
|
|
|
190 |
|
|
|
191 |
// unparsed defaults
|
|
|
192 |
if (isset($unparsedLoadedData['default_content_types'])) {
|
|
|
193 |
foreach ($unparsedLoadedData['default_content_types'] as $extName => $contentType) {
|
|
|
194 |
$this->writeDefaultContentType($objWriter, $extName, $contentType);
|
|
|
195 |
}
|
|
|
196 |
}
|
|
|
197 |
|
|
|
198 |
// unparsed overrides
|
|
|
199 |
if (isset($unparsedLoadedData['override_content_types'])) {
|
|
|
200 |
foreach ($unparsedLoadedData['override_content_types'] as $partName => $overrideType) {
|
|
|
201 |
$this->writeOverrideContentType($objWriter, $partName, $overrideType);
|
|
|
202 |
}
|
|
|
203 |
}
|
|
|
204 |
|
|
|
205 |
$objWriter->endElement();
|
|
|
206 |
|
|
|
207 |
// Return
|
|
|
208 |
return $objWriter->getData();
|
|
|
209 |
}
|
|
|
210 |
|
|
|
211 |
/**
|
|
|
212 |
* Get image mime type.
|
|
|
213 |
*
|
|
|
214 |
* @param string $filename Filename
|
|
|
215 |
*
|
|
|
216 |
* @return string Mime Type
|
|
|
217 |
*/
|
|
|
218 |
private function getImageMimeType($filename)
|
|
|
219 |
{
|
|
|
220 |
if (File::fileExists($filename)) {
|
|
|
221 |
$image = getimagesize($filename);
|
|
|
222 |
|
|
|
223 |
return image_type_to_mime_type((is_array($image) && count($image) >= 3) ? $image[2] : 0);
|
|
|
224 |
}
|
|
|
225 |
|
|
|
226 |
throw new WriterException("File $filename does not exist");
|
|
|
227 |
}
|
|
|
228 |
|
|
|
229 |
/**
|
|
|
230 |
* Write Default content type.
|
|
|
231 |
*
|
|
|
232 |
* @param string $partName Part name
|
|
|
233 |
* @param string $contentType Content type
|
|
|
234 |
*/
|
|
|
235 |
private function writeDefaultContentType(XMLWriter $objWriter, $partName, $contentType): void
|
|
|
236 |
{
|
|
|
237 |
if ($partName != '' && $contentType != '') {
|
|
|
238 |
// Write content type
|
|
|
239 |
$objWriter->startElement('Default');
|
|
|
240 |
$objWriter->writeAttribute('Extension', $partName);
|
|
|
241 |
$objWriter->writeAttribute('ContentType', $contentType);
|
|
|
242 |
$objWriter->endElement();
|
|
|
243 |
} else {
|
|
|
244 |
throw new WriterException('Invalid parameters passed.');
|
|
|
245 |
}
|
|
|
246 |
}
|
|
|
247 |
|
|
|
248 |
/**
|
|
|
249 |
* Write Override content type.
|
|
|
250 |
*
|
|
|
251 |
* @param string $partName Part name
|
|
|
252 |
* @param string $contentType Content type
|
|
|
253 |
*/
|
|
|
254 |
private function writeOverrideContentType(XMLWriter $objWriter, $partName, $contentType): void
|
|
|
255 |
{
|
|
|
256 |
if ($partName != '' && $contentType != '') {
|
|
|
257 |
// Write content type
|
|
|
258 |
$objWriter->startElement('Override');
|
|
|
259 |
$objWriter->writeAttribute('PartName', $partName);
|
|
|
260 |
$objWriter->writeAttribute('ContentType', $contentType);
|
|
|
261 |
$objWriter->endElement();
|
|
|
262 |
} else {
|
|
|
263 |
throw new WriterException('Invalid parameters passed.');
|
|
|
264 |
}
|
|
|
265 |
}
|
|
|
266 |
}
|