ContentTypes.php 9.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232
  1. <?php
  2. namespace PhpOffice\PhpSpreadsheet\Writer\Xlsx;
  3. use PhpOffice\PhpSpreadsheet\Shared\File;
  4. use PhpOffice\PhpSpreadsheet\Shared\XMLWriter;
  5. use PhpOffice\PhpSpreadsheet\Spreadsheet;
  6. use PhpOffice\PhpSpreadsheet\Worksheet\MemoryDrawing;
  7. use PhpOffice\PhpSpreadsheet\Writer\Exception as WriterException;
  8. class ContentTypes extends WriterPart
  9. {
  10. /**
  11. * Write content types to XML format.
  12. *
  13. * @param Spreadsheet $spreadsheet
  14. * @param bool $includeCharts Flag indicating if we should include drawing details for charts
  15. *
  16. * @throws WriterException
  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. // XML header
  30. $objWriter->startDocument('1.0', 'UTF-8', 'yes');
  31. // Types
  32. $objWriter->startElement('Types');
  33. $objWriter->writeAttribute('xmlns', 'http://schemas.openxmlformats.org/package/2006/content-types');
  34. // Theme
  35. $this->writeOverrideContentType($objWriter, '/xl/theme/theme1.xml', 'application/vnd.openxmlformats-officedocument.theme+xml');
  36. // Styles
  37. $this->writeOverrideContentType($objWriter, '/xl/styles.xml', 'application/vnd.openxmlformats-officedocument.spreadsheetml.styles+xml');
  38. // Rels
  39. $this->writeDefaultContentType($objWriter, 'rels', 'application/vnd.openxmlformats-package.relationships+xml');
  40. // XML
  41. $this->writeDefaultContentType($objWriter, 'xml', 'application/xml');
  42. // VML
  43. $this->writeDefaultContentType($objWriter, 'vml', 'application/vnd.openxmlformats-officedocument.vmlDrawing');
  44. // Workbook
  45. if ($spreadsheet->hasMacros()) { //Macros in workbook ?
  46. // Yes : not standard content but "macroEnabled"
  47. $this->writeOverrideContentType($objWriter, '/xl/workbook.xml', 'application/vnd.ms-excel.sheet.macroEnabled.main+xml');
  48. //... and define a new type for the VBA project
  49. $this->writeDefaultContentType($objWriter, 'bin', 'application/vnd.ms-office.vbaProject');
  50. if ($spreadsheet->hasMacrosCertificate()) {
  51. // signed macros ?
  52. // Yes : add needed information
  53. $this->writeOverrideContentType($objWriter, '/xl/vbaProjectSignature.bin', 'application/vnd.ms-office.vbaProjectSignature');
  54. }
  55. } else {
  56. // no macros in workbook, so standard type
  57. $this->writeOverrideContentType($objWriter, '/xl/workbook.xml', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet.main+xml');
  58. }
  59. // DocProps
  60. $this->writeOverrideContentType($objWriter, '/docProps/app.xml', 'application/vnd.openxmlformats-officedocument.extended-properties+xml');
  61. $this->writeOverrideContentType($objWriter, '/docProps/core.xml', 'application/vnd.openxmlformats-package.core-properties+xml');
  62. $customPropertyList = $spreadsheet->getProperties()->getCustomProperties();
  63. if (!empty($customPropertyList)) {
  64. $this->writeOverrideContentType($objWriter, '/docProps/custom.xml', 'application/vnd.openxmlformats-officedocument.custom-properties+xml');
  65. }
  66. // Worksheets
  67. $sheetCount = $spreadsheet->getSheetCount();
  68. for ($i = 0; $i < $sheetCount; ++$i) {
  69. $this->writeOverrideContentType($objWriter, '/xl/worksheets/sheet' . ($i + 1) . '.xml', 'application/vnd.openxmlformats-officedocument.spreadsheetml.worksheet+xml');
  70. }
  71. // Shared strings
  72. $this->writeOverrideContentType($objWriter, '/xl/sharedStrings.xml', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sharedStrings+xml');
  73. // Add worksheet relationship content types
  74. $chart = 1;
  75. for ($i = 0; $i < $sheetCount; ++$i) {
  76. $drawings = $spreadsheet->getSheet($i)->getDrawingCollection();
  77. $drawingCount = count($drawings);
  78. $chartCount = ($includeCharts) ? $spreadsheet->getSheet($i)->getChartCount() : 0;
  79. // We need a drawing relationship for the worksheet if we have either drawings or charts
  80. if (($drawingCount > 0) || ($chartCount > 0)) {
  81. $this->writeOverrideContentType($objWriter, '/xl/drawings/drawing' . ($i + 1) . '.xml', 'application/vnd.openxmlformats-officedocument.drawing+xml');
  82. }
  83. // If we have charts, then we need a chart relationship for every individual chart
  84. if ($chartCount > 0) {
  85. for ($c = 0; $c < $chartCount; ++$c) {
  86. $this->writeOverrideContentType($objWriter, '/xl/charts/chart' . $chart++ . '.xml', 'application/vnd.openxmlformats-officedocument.drawingml.chart+xml');
  87. }
  88. }
  89. }
  90. // Comments
  91. for ($i = 0; $i < $sheetCount; ++$i) {
  92. if (count($spreadsheet->getSheet($i)->getComments()) > 0) {
  93. $this->writeOverrideContentType($objWriter, '/xl/comments' . ($i + 1) . '.xml', 'application/vnd.openxmlformats-officedocument.spreadsheetml.comments+xml');
  94. }
  95. }
  96. // Add media content-types
  97. $aMediaContentTypes = [];
  98. $mediaCount = $this->getParentWriter()->getDrawingHashTable()->count();
  99. for ($i = 0; $i < $mediaCount; ++$i) {
  100. $extension = '';
  101. $mimeType = '';
  102. if ($this->getParentWriter()->getDrawingHashTable()->getByIndex($i) instanceof \PhpOffice\PhpSpreadsheet\Worksheet\Drawing) {
  103. $extension = strtolower($this->getParentWriter()->getDrawingHashTable()->getByIndex($i)->getExtension());
  104. $mimeType = $this->getImageMimeType($this->getParentWriter()->getDrawingHashTable()->getByIndex($i)->getPath());
  105. } elseif ($this->getParentWriter()->getDrawingHashTable()->getByIndex($i) instanceof MemoryDrawing) {
  106. $extension = strtolower($this->getParentWriter()->getDrawingHashTable()->getByIndex($i)->getMimeType());
  107. $extension = explode('/', $extension);
  108. $extension = $extension[1];
  109. $mimeType = $this->getParentWriter()->getDrawingHashTable()->getByIndex($i)->getMimeType();
  110. }
  111. if (!isset($aMediaContentTypes[$extension])) {
  112. $aMediaContentTypes[$extension] = $mimeType;
  113. $this->writeDefaultContentType($objWriter, $extension, $mimeType);
  114. }
  115. }
  116. if ($spreadsheet->hasRibbonBinObjects()) {
  117. // Some additional objects in the ribbon ?
  118. // we need to write "Extension" but not already write for media content
  119. $tabRibbonTypes = array_diff($spreadsheet->getRibbonBinObjects('types'), array_keys($aMediaContentTypes));
  120. foreach ($tabRibbonTypes as $aRibbonType) {
  121. $mimeType = 'image/.' . $aRibbonType; //we wrote $mimeType like customUI Editor
  122. $this->writeDefaultContentType($objWriter, $aRibbonType, $mimeType);
  123. }
  124. }
  125. $sheetCount = $spreadsheet->getSheetCount();
  126. for ($i = 0; $i < $sheetCount; ++$i) {
  127. if (count($spreadsheet->getSheet($i)->getHeaderFooter()->getImages()) > 0) {
  128. foreach ($spreadsheet->getSheet($i)->getHeaderFooter()->getImages() as $image) {
  129. if (!isset($aMediaContentTypes[strtolower($image->getExtension())])) {
  130. $aMediaContentTypes[strtolower($image->getExtension())] = $this->getImageMimeType($image->getPath());
  131. $this->writeDefaultContentType($objWriter, strtolower($image->getExtension()), $aMediaContentTypes[strtolower($image->getExtension())]);
  132. }
  133. }
  134. }
  135. }
  136. $objWriter->endElement();
  137. // Return
  138. return $objWriter->getData();
  139. }
  140. /**
  141. * Get image mime type.
  142. *
  143. * @param string $pFile Filename
  144. *
  145. * @throws WriterException
  146. *
  147. * @return string Mime Type
  148. */
  149. private function getImageMimeType($pFile)
  150. {
  151. if (File::fileExists($pFile)) {
  152. $image = getimagesize($pFile);
  153. return image_type_to_mime_type($image[2]);
  154. }
  155. throw new WriterException("File $pFile does not exist");
  156. }
  157. /**
  158. * Write Default content type.
  159. *
  160. * @param XMLWriter $objWriter XML Writer
  161. * @param string $pPartname Part name
  162. * @param string $pContentType Content type
  163. *
  164. * @throws WriterException
  165. */
  166. private function writeDefaultContentType(XMLWriter $objWriter, $pPartname, $pContentType)
  167. {
  168. if ($pPartname != '' && $pContentType != '') {
  169. // Write content type
  170. $objWriter->startElement('Default');
  171. $objWriter->writeAttribute('Extension', $pPartname);
  172. $objWriter->writeAttribute('ContentType', $pContentType);
  173. $objWriter->endElement();
  174. } else {
  175. throw new WriterException('Invalid parameters passed.');
  176. }
  177. }
  178. /**
  179. * Write Override content type.
  180. *
  181. * @param XMLWriter $objWriter XML Writer
  182. * @param string $pPartname Part name
  183. * @param string $pContentType Content type
  184. *
  185. * @throws WriterException
  186. */
  187. private function writeOverrideContentType(XMLWriter $objWriter, $pPartname, $pContentType)
  188. {
  189. if ($pPartname != '' && $pContentType != '') {
  190. // Write content type
  191. $objWriter->startElement('Override');
  192. $objWriter->writeAttribute('PartName', $pPartname);
  193. $objWriter->writeAttribute('ContentType', $pContentType);
  194. $objWriter->endElement();
  195. } else {
  196. throw new WriterException('Invalid parameters passed.');
  197. }
  198. }
  199. }