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