[Summary view]

Differences Between: [Versions 310 and 311] [Versions 311 and 400] [Versions 311 and 401] [Versions 311 and 402] [Versions 311 and 403] [Versions 39 and 311]

   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  
 163          // unparsed defaults
 164          if (isset($unparsedLoadedData['default_content_types'])) {
 165              foreach ($unparsedLoadedData['default_content_types'] as $extName => $contentType) {
 166                  $this->writeDefaultContentType($objWriter, $extName, $contentType);
 167              }
 168          }
 169  
 170          // unparsed overrides
 171          if (isset($unparsedLoadedData['override_content_types'])) {
 172              foreach ($unparsedLoadedData['override_content_types'] as $partName => $overrideType) {
 173                  $this->writeOverrideContentType($objWriter, $partName, $overrideType);
 174              }
 175          }
 176  
 177          $objWriter->endElement();
 178  
 179          // Return
 180          return $objWriter->getData();
 181      }
 182  
 183      /**
 184       * Get image mime type.
 185       *
 186       * @param string $pFile Filename
 187       *
 188       * @return string Mime Type
 189       */
 190      private function getImageMimeType($pFile)
 191      {
 192          if (File::fileExists($pFile)) {
 193              $image = getimagesize($pFile);
 194  
 195              return image_type_to_mime_type($image[2]);
 196          }
 197  
 198          throw new WriterException("File $pFile does not exist");
 199      }
 200  
 201      /**
 202       * Write Default content type.
 203       *
 204       * @param XMLWriter $objWriter XML Writer
 205       * @param string $pPartname Part name
 206       * @param string $pContentType Content type
 207       */
 208      private function writeDefaultContentType(XMLWriter $objWriter, $pPartname, $pContentType): void
 209      {
 210          if ($pPartname != '' && $pContentType != '') {
 211              // Write content type
 212              $objWriter->startElement('Default');
 213              $objWriter->writeAttribute('Extension', $pPartname);
 214              $objWriter->writeAttribute('ContentType', $pContentType);
 215              $objWriter->endElement();
 216          } else {
 217              throw new WriterException('Invalid parameters passed.');
 218          }
 219      }
 220  
 221      /**
 222       * Write Override content type.
 223       *
 224       * @param XMLWriter $objWriter XML Writer
 225       * @param string $pPartname Part name
 226       * @param string $pContentType Content type
 227       */
 228      private function writeOverrideContentType(XMLWriter $objWriter, $pPartname, $pContentType): void
 229      {
 230          if ($pPartname != '' && $pContentType != '') {
 231              // Write content type
 232              $objWriter->startElement('Override');
 233              $objWriter->writeAttribute('PartName', $pPartname);
 234              $objWriter->writeAttribute('ContentType', $pContentType);
 235              $objWriter->endElement();
 236          } else {
 237              throw new WriterException('Invalid parameters passed.');
 238          }
 239      }
 240  }