1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
namespace PhpOffice\PhpSpreadsheet\Writer\Xlsx; |
4
|
|
|
|
5
|
|
|
/** |
6
|
|
|
* Copyright (c) 2006 - 2016 PhpSpreadsheet |
7
|
|
|
* |
8
|
|
|
* This library is free software; you can redistribute it and/or |
9
|
|
|
* modify it under the terms of the GNU Lesser General Public |
10
|
|
|
* License as published by the Free Software Foundation; either |
11
|
|
|
* version 2.1 of the License, or (at your option) any later version. |
12
|
|
|
* |
13
|
|
|
* This library is distributed in the hope that it will be useful, |
14
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
15
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
16
|
|
|
* Lesser General Public License for more details. |
17
|
|
|
* |
18
|
|
|
* You should have received a copy of the GNU Lesser General Public |
19
|
|
|
* License along with this library; if not, write to the Free Software |
20
|
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
21
|
|
|
* |
22
|
|
|
* @category PhpSpreadsheet |
23
|
|
|
* @copyright Copyright (c) 2006 - 2016 PhpSpreadsheet (https://github.com/PHPOffice/PhpSpreadsheet) |
24
|
|
|
* @license http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt LGPL |
25
|
|
|
* @version ##VERSION##, ##DATE## |
26
|
|
|
*/ |
27
|
|
|
class ContentTypes extends WriterPart |
28
|
|
|
{ |
29
|
|
|
/** |
30
|
|
|
* Write content types to XML format |
31
|
|
|
* |
32
|
|
|
* @param \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet |
33
|
|
|
* @param bool $includeCharts Flag indicating if we should include drawing details for charts |
34
|
|
|
* @throws \PhpOffice\PhpSpreadsheet\Writer\Exception |
35
|
|
|
* @return string XML Output |
36
|
|
|
*/ |
37
|
56 |
|
public function writeContentTypes(\PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet = null, $includeCharts = false) |
38
|
|
|
{ |
39
|
|
|
// Create XML writer |
40
|
56 |
|
$objWriter = null; |
|
|
|
|
41
|
56 |
View Code Duplication |
if ($this->getParentWriter()->getUseDiskCaching()) { |
|
|
|
|
42
|
|
|
$objWriter = new \PhpOffice\PhpSpreadsheet\Shared\XMLWriter(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter::STORAGE_DISK, $this->getParentWriter()->getDiskCachingDirectory()); |
|
|
|
|
43
|
|
|
} else { |
44
|
56 |
|
$objWriter = new \PhpOffice\PhpSpreadsheet\Shared\XMLWriter(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter::STORAGE_MEMORY); |
45
|
|
|
} |
46
|
|
|
|
47
|
|
|
// XML header |
48
|
56 |
|
$objWriter->startDocument('1.0', 'UTF-8', 'yes'); |
49
|
|
|
|
50
|
|
|
// Types |
51
|
56 |
|
$objWriter->startElement('Types'); |
52
|
56 |
|
$objWriter->writeAttribute('xmlns', 'http://schemas.openxmlformats.org/package/2006/content-types'); |
53
|
|
|
|
54
|
|
|
// Theme |
55
|
56 |
|
$this->writeOverrideContentType($objWriter, '/xl/theme/theme1.xml', 'application/vnd.openxmlformats-officedocument.theme+xml'); |
56
|
|
|
|
57
|
|
|
// Styles |
58
|
56 |
|
$this->writeOverrideContentType($objWriter, '/xl/styles.xml', 'application/vnd.openxmlformats-officedocument.spreadsheetml.styles+xml'); |
59
|
|
|
|
60
|
|
|
// Rels |
61
|
56 |
|
$this->writeDefaultContentType($objWriter, 'rels', 'application/vnd.openxmlformats-package.relationships+xml'); |
62
|
|
|
|
63
|
|
|
// XML |
64
|
56 |
|
$this->writeDefaultContentType($objWriter, 'xml', 'application/xml'); |
65
|
|
|
|
66
|
|
|
// VML |
67
|
56 |
|
$this->writeDefaultContentType($objWriter, 'vml', 'application/vnd.openxmlformats-officedocument.vmlDrawing'); |
68
|
|
|
|
69
|
|
|
// Workbook |
70
|
56 |
|
if ($spreadsheet->hasMacros()) { //Macros in workbook ? |
71
|
|
|
// Yes : not standard content but "macroEnabled" |
72
|
|
|
$this->writeOverrideContentType($objWriter, '/xl/workbook.xml', 'application/vnd.ms-excel.sheet.macroEnabled.main+xml'); |
73
|
|
|
//... and define a new type for the VBA project |
74
|
|
|
$this->writeDefaultContentType($objWriter, 'bin', 'application/vnd.ms-office.vbaProject'); |
75
|
|
|
if ($spreadsheet->hasMacrosCertificate()) { |
|
|
|
|
76
|
|
|
// signed macros ? |
77
|
|
|
// Yes : add needed information |
78
|
|
|
$this->writeOverrideContentType($objWriter, '/xl/vbaProjectSignature.bin', 'application/vnd.ms-office.vbaProjectSignature'); |
79
|
|
|
} |
80
|
|
|
} else { |
81
|
|
|
// no macros in workbook, so standard type |
82
|
56 |
|
$this->writeOverrideContentType($objWriter, '/xl/workbook.xml', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet.main+xml'); |
83
|
|
|
} |
84
|
|
|
|
85
|
|
|
// DocProps |
86
|
56 |
|
$this->writeOverrideContentType($objWriter, '/docProps/app.xml', 'application/vnd.openxmlformats-officedocument.extended-properties+xml'); |
87
|
|
|
|
88
|
56 |
|
$this->writeOverrideContentType($objWriter, '/docProps/core.xml', 'application/vnd.openxmlformats-package.core-properties+xml'); |
89
|
|
|
|
90
|
56 |
|
$customPropertyList = $spreadsheet->getProperties()->getCustomProperties(); |
91
|
56 |
|
if (!empty($customPropertyList)) { |
92
|
2 |
|
$this->writeOverrideContentType($objWriter, '/docProps/custom.xml', 'application/vnd.openxmlformats-officedocument.custom-properties+xml'); |
93
|
|
|
} |
94
|
|
|
|
95
|
|
|
// Worksheets |
96
|
56 |
|
$sheetCount = $spreadsheet->getSheetCount(); |
97
|
56 |
|
for ($i = 0; $i < $sheetCount; ++$i) { |
98
|
56 |
|
$this->writeOverrideContentType($objWriter, '/xl/worksheets/sheet' . ($i + 1) . '.xml', 'application/vnd.openxmlformats-officedocument.spreadsheetml.worksheet+xml'); |
99
|
|
|
} |
100
|
|
|
|
101
|
|
|
// Shared strings |
102
|
56 |
|
$this->writeOverrideContentType($objWriter, '/xl/sharedStrings.xml', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sharedStrings+xml'); |
103
|
|
|
|
104
|
|
|
// Add worksheet relationship content types |
105
|
56 |
|
$chart = 1; |
106
|
56 |
|
for ($i = 0; $i < $sheetCount; ++$i) { |
107
|
56 |
|
$drawings = $spreadsheet->getSheet($i)->getDrawingCollection(); |
108
|
56 |
|
$drawingCount = count($drawings); |
109
|
56 |
|
$chartCount = ($includeCharts) ? $spreadsheet->getSheet($i)->getChartCount() : 0; |
110
|
|
|
|
111
|
|
|
// We need a drawing relationship for the worksheet if we have either drawings or charts |
112
|
56 |
|
if (($drawingCount > 0) || ($chartCount > 0)) { |
113
|
21 |
|
$this->writeOverrideContentType($objWriter, '/xl/drawings/drawing' . ($i + 1) . '.xml', 'application/vnd.openxmlformats-officedocument.drawing+xml'); |
114
|
|
|
} |
115
|
|
|
|
116
|
|
|
// If we have charts, then we need a chart relationship for every individual chart |
117
|
56 |
|
if ($chartCount > 0) { |
118
|
13 |
|
for ($c = 0; $c < $chartCount; ++$c) { |
119
|
13 |
|
$this->writeOverrideContentType($objWriter, '/xl/charts/chart' . $chart++ . '.xml', 'application/vnd.openxmlformats-officedocument.drawingml.chart+xml'); |
120
|
|
|
} |
121
|
|
|
} |
122
|
|
|
} |
123
|
|
|
|
124
|
|
|
// Comments |
125
|
56 |
|
for ($i = 0; $i < $sheetCount; ++$i) { |
126
|
56 |
|
if (count($spreadsheet->getSheet($i)->getComments()) > 0) { |
127
|
9 |
|
$this->writeOverrideContentType($objWriter, '/xl/comments' . ($i + 1) . '.xml', 'application/vnd.openxmlformats-officedocument.spreadsheetml.comments+xml'); |
128
|
|
|
} |
129
|
|
|
} |
130
|
|
|
|
131
|
|
|
// Add media content-types |
132
|
56 |
|
$aMediaContentTypes = []; |
133
|
56 |
|
$mediaCount = $this->getParentWriter()->getDrawingHashTable()->count(); |
|
|
|
|
134
|
56 |
|
for ($i = 0; $i < $mediaCount; ++$i) { |
135
|
9 |
|
$extension = ''; |
136
|
9 |
|
$mimeType = ''; |
137
|
|
|
|
138
|
9 |
|
if ($this->getParentWriter()->getDrawingHashTable()->getByIndex($i) instanceof \PhpOffice\PhpSpreadsheet\Worksheet\Drawing) { |
|
|
|
|
139
|
6 |
|
$extension = strtolower($this->getParentWriter()->getDrawingHashTable()->getByIndex($i)->getExtension()); |
|
|
|
|
140
|
6 |
|
$mimeType = $this->getImageMimeType($this->getParentWriter()->getDrawingHashTable()->getByIndex($i)->getPath()); |
|
|
|
|
141
|
3 |
|
} elseif ($this->getParentWriter()->getDrawingHashTable()->getByIndex($i) instanceof \PhpOffice\PhpSpreadsheet\Worksheet\MemoryDrawing) { |
|
|
|
|
142
|
3 |
|
$extension = strtolower($this->getParentWriter()->getDrawingHashTable()->getByIndex($i)->getMimeType()); |
|
|
|
|
143
|
3 |
|
$extension = explode('/', $extension); |
144
|
3 |
|
$extension = $extension[1]; |
145
|
|
|
|
146
|
3 |
|
$mimeType = $this->getParentWriter()->getDrawingHashTable()->getByIndex($i)->getMimeType(); |
|
|
|
|
147
|
|
|
} |
148
|
|
|
|
149
|
9 |
|
if (!isset($aMediaContentTypes[$extension])) { |
150
|
9 |
|
$aMediaContentTypes[$extension] = $mimeType; |
151
|
|
|
|
152
|
9 |
|
$this->writeDefaultContentType($objWriter, $extension, $mimeType); |
153
|
|
|
} |
154
|
|
|
} |
155
|
56 |
|
if ($spreadsheet->hasRibbonBinObjects()) { |
156
|
|
|
// Some additional objects in the ribbon ? |
157
|
|
|
// we need to write "Extension" but not already write for media content |
158
|
|
|
$tabRibbonTypes = array_diff($spreadsheet->getRibbonBinObjects('types'), array_keys($aMediaContentTypes)); |
159
|
|
|
foreach ($tabRibbonTypes as $aRibbonType) { |
160
|
|
|
$mimeType = 'image/.' . $aRibbonType; //we wrote $mimeType like customUI Editor |
161
|
|
|
$this->writeDefaultContentType($objWriter, $aRibbonType, $mimeType); |
162
|
|
|
} |
163
|
|
|
} |
164
|
56 |
|
$sheetCount = $spreadsheet->getSheetCount(); |
165
|
56 |
|
for ($i = 0; $i < $sheetCount; ++$i) { |
166
|
56 |
|
if (count($spreadsheet->getSheet()->getHeaderFooter()->getImages()) > 0) { |
167
|
1 |
|
foreach ($spreadsheet->getSheet()->getHeaderFooter()->getImages() as $image) { |
168
|
1 |
|
if (!isset($aMediaContentTypes[strtolower($image->getExtension())])) { |
169
|
1 |
|
$aMediaContentTypes[strtolower($image->getExtension())] = $this->getImageMimeType($image->getPath()); |
170
|
|
|
|
171
|
1 |
|
$this->writeDefaultContentType($objWriter, strtolower($image->getExtension()), $aMediaContentTypes[strtolower($image->getExtension())]); |
172
|
|
|
} |
173
|
|
|
} |
174
|
|
|
} |
175
|
|
|
} |
176
|
|
|
|
177
|
56 |
|
$objWriter->endElement(); |
178
|
|
|
|
179
|
|
|
// Return |
180
|
56 |
|
return $objWriter->getData(); |
181
|
|
|
} |
182
|
|
|
|
183
|
|
|
/** |
184
|
|
|
* Get image mime type |
185
|
|
|
* |
186
|
|
|
* @param string $pFile Filename |
187
|
|
|
* @throws \PhpOffice\PhpSpreadsheet\Writer\Exception |
188
|
|
|
* @return string Mime Type |
189
|
|
|
*/ |
190
|
7 |
|
private function getImageMimeType($pFile = '') |
191
|
|
|
{ |
192
|
7 |
|
if (\PhpOffice\PhpSpreadsheet\Shared\File::fileExists($pFile)) { |
193
|
7 |
|
$image = getimagesize($pFile); |
194
|
|
|
|
195
|
7 |
|
return image_type_to_mime_type($image[2]); |
196
|
|
|
} else { |
197
|
|
|
throw new \PhpOffice\PhpSpreadsheet\Writer\Exception("File $pFile does not exist"); |
198
|
|
|
} |
199
|
|
|
} |
200
|
|
|
|
201
|
|
|
/** |
202
|
|
|
* Write Default content type |
203
|
|
|
* |
204
|
|
|
* @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer |
205
|
|
|
* @param string $pPartname Part name |
206
|
|
|
* @param string $pContentType Content type |
207
|
|
|
* @throws \PhpOffice\PhpSpreadsheet\Writer\Exception |
208
|
|
|
*/ |
209
|
56 |
View Code Duplication |
private function writeDefaultContentType(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter = null, $pPartname = '', $pContentType = '') |
|
|
|
|
210
|
|
|
{ |
211
|
56 |
|
if ($pPartname != '' && $pContentType != '') { |
212
|
|
|
// Write content type |
213
|
56 |
|
$objWriter->startElement('Default'); |
|
|
|
|
214
|
56 |
|
$objWriter->writeAttribute('Extension', $pPartname); |
215
|
56 |
|
$objWriter->writeAttribute('ContentType', $pContentType); |
216
|
56 |
|
$objWriter->endElement(); |
217
|
|
|
} else { |
218
|
|
|
throw new \PhpOffice\PhpSpreadsheet\Writer\Exception('Invalid parameters passed.'); |
219
|
|
|
} |
220
|
56 |
|
} |
221
|
|
|
|
222
|
|
|
/** |
223
|
|
|
* Write Override content type |
224
|
|
|
* |
225
|
|
|
* @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer |
226
|
|
|
* @param string $pPartname Part name |
227
|
|
|
* @param string $pContentType Content type |
228
|
|
|
* @throws \PhpOffice\PhpSpreadsheet\Writer\Exception |
229
|
|
|
*/ |
230
|
56 |
View Code Duplication |
private function writeOverrideContentType(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter = null, $pPartname = '', $pContentType = '') |
|
|
|
|
231
|
|
|
{ |
232
|
56 |
|
if ($pPartname != '' && $pContentType != '') { |
233
|
|
|
// Write content type |
234
|
56 |
|
$objWriter->startElement('Override'); |
|
|
|
|
235
|
56 |
|
$objWriter->writeAttribute('PartName', $pPartname); |
236
|
56 |
|
$objWriter->writeAttribute('ContentType', $pContentType); |
237
|
56 |
|
$objWriter->endElement(); |
238
|
|
|
} else { |
239
|
|
|
throw new \PhpOffice\PhpSpreadsheet\Writer\Exception('Invalid parameters passed.'); |
240
|
|
|
} |
241
|
56 |
|
} |
242
|
|
|
} |
243
|
|
|
|
This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.
Both the
$myVar
assignment in line 1 and the$higher
assignment in line 2 are dead. The first because$myVar
is never used and the second because$higher
is always overwritten for every possible time line.