/
PHPExcel.php
executable file
·601 lines (484 loc) · 18.9 KB
/
PHPExcel.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
<?php
if (!defined('PHPEXCEL_ROOT')) {
define('PHPEXCEL_ROOT', dirname(__FILE__) . '/');
require(PHPEXCEL_ROOT . 'PHPExcel/Autoloader.php');
}
class PHPExcel {
private $_uniqueID;
private $_properties;
private $_security;
private $_workSheetCollection = array();
private $_calculationEngine = NULL;
private $_activeSheetIndex = 0;
private $_namedRanges = array();
private $_cellXfSupervisor;
private $_cellXfCollection = array();
private $_cellStyleXfCollection = array();
private $_hasMacros = FALSE;
private $_macrosCode = NULL;
private $_macrosCertificate = NULL;
private $_ribbonXMLData = NULL;
private $_ribbonBinObjects = NULL;
public function hasMacros() {
return $this->_hasMacros;
}
public function setHasMacros($hasMacros = false) {
$this->_hasMacros = (bool) $hasMacros;
}
public function setMacrosCode($MacrosCode) {
$this->_macrosCode = $MacrosCode;
$this->setHasMacros(!is_null($MacrosCode));
}
public function getMacrosCode() {
return $this->_macrosCode;
}
public function setMacrosCertificate($Certificate = NULL) {
$this->_macrosCertificate = $Certificate;
}
public function hasMacrosCertificate() {
return !is_null($this->_macrosCertificate);
}
public function getMacrosCertificate() {
return $this->_macrosCertificate;
}
public function discardMacros() {
$this->_hasMacros = false;
$this->_macrosCode = NULL;
$this->_macrosCertificate = NULL;
}
public function setRibbonXMLData($Target = NULL, $XMLData = NULL) {
if (!is_null($Target) && !is_null($XMLData)) {
$this->_ribbonXMLData = array('target' => $Target, 'data' => $XMLData);
} else {
$this->_ribbonXMLData = NULL;
}
}
public function getRibbonXMLData($What = 'all') {
$ReturnData = NULL;
$What = strtolower($What);
switch ($What) {
case 'all':
$ReturnData = $this->_ribbonXMLData;
break;
case 'target':
case 'data':
if (is_array($this->_ribbonXMLData) && array_key_exists($What, $this->_ribbonXMLData)) {
$ReturnData = $this->_ribbonXMLData[$What];
}
break;
}
return $ReturnData;
}
public function setRibbonBinObjects($BinObjectsNames = NULL, $BinObjectsData = NULL) {
if (!is_null($BinObjectsNames) && !is_null($BinObjectsData)) {
$this->_ribbonBinObjects = array('names' => $BinObjectsNames, 'data' => $BinObjectsData);
} else {
$this->_ribbonBinObjects = NULL;
}
}
private function _getExtensionOnly($ThePath) {
return pathinfo($ThePath, PATHINFO_EXTENSION);
}
public function getRibbonBinObjects($What = 'all') {
$ReturnData = NULL;
$What = strtolower($What);
switch ($What) {
case 'all':
return $this->_ribbonBinObjects;
break;
case 'names':
case 'data':
if (is_array($this->_ribbonBinObjects) && array_key_exists($What, $this->_ribbonBinObjects)) {
$ReturnData = $this->_ribbonBinObjects[$What];
}
break;
case 'types':
if (is_array($this->_ribbonBinObjects) && array_key_exists('data', $this->_ribbonBinObjects) && is_array($this->_ribbonBinObjects['data'])) {
$tmpTypes = array_keys($this->_ribbonBinObjects['data']);
$ReturnData = array_unique(array_map(array($this, '_getExtensionOnly'), $tmpTypes));
} else
$ReturnData = array(); //the caller want an array... not null if empty
break;
}
return $ReturnData;
}
public function hasRibbon() {
return !is_null($this->_ribbonXMLData);
}
public function hasRibbonBinObjects() {
return !is_null($this->_ribbonBinObjects);
}
public function sheetCodeNameExists($pSheetCodeName) {
return ($this->getSheetByCodeName($pSheetCodeName) !== NULL);
}
public function getSheetByCodeName($pName = '') {
$worksheetCount = count($this->_workSheetCollection);
for ($i = 0; $i < $worksheetCount; ++$i) {
if ($this->_workSheetCollection[$i]->getCodeName() == $pName) {
return $this->_workSheetCollection[$i];
}
}
return null;
}
public function __construct() {
$this->_uniqueID = uniqid();
$this->_calculationEngine = PHPExcel_Calculation::getInstance($this);
$this->_workSheetCollection = array();
$this->_workSheetCollection[] = new PHPExcel_Worksheet($this);
$this->_activeSheetIndex = 0;
$this->_properties = new PHPExcel_DocumentProperties();
$this->_security = new PHPExcel_DocumentSecurity();
$this->_namedRanges = array();
$this->_cellXfSupervisor = new PHPExcel_Style(true);
$this->_cellXfSupervisor->bindParent($this);
$this->addCellXf(new PHPExcel_Style);
$this->addCellStyleXf(new PHPExcel_Style);
}
public function __destruct() {
PHPExcel_Calculation::unsetInstance($this);
$this->disconnectWorksheets();
}
public function disconnectWorksheets() {
$worksheet = NULL;
foreach ($this->_workSheetCollection as $k => &$worksheet) {
$worksheet->disconnectCells();
$this->_workSheetCollection[$k] = null;
}
unset($worksheet);
$this->_workSheetCollection = array();
}
public function getCalculationEngine() {
return $this->_calculationEngine;
}
public function getProperties() {
return $this->_properties;
}
public function setProperties(PHPExcel_DocumentProperties $pValue) {
$this->_properties = $pValue;
}
public function getSecurity() {
return $this->_security;
}
public function setSecurity(PHPExcel_DocumentSecurity $pValue) {
$this->_security = $pValue;
}
public function getActiveSheet() {
return $this->_workSheetCollection[$this->_activeSheetIndex];
}
public function createSheet($iSheetIndex = NULL) {
$newSheet = new PHPExcel_Worksheet($this);
$this->addSheet($newSheet, $iSheetIndex);
return $newSheet;
}
public function sheetNameExists($pSheetName) {
return ($this->getSheetByName($pSheetName) !== NULL);
}
public function addSheet(PHPExcel_Worksheet $pSheet, $iSheetIndex = NULL) {
if ($this->sheetNameExists($pSheet->getTitle())) {
throw new PHPExcel_Exception(
"Workbook already contains a worksheet named '{$pSheet->getTitle()}'. Rename this worksheet first."
);
}
if ($iSheetIndex === NULL) {
if ($this->_activeSheetIndex < 0) {
$this->_activeSheetIndex = 0;
}
$this->_workSheetCollection[] = $pSheet;
} else {
array_splice(
$this->_workSheetCollection, $iSheetIndex, 0, array($pSheet)
);
if ($this->_activeSheetIndex >= $iSheetIndex) {
++$this->_activeSheetIndex;
}
}
if ($pSheet->getParent() === null) {
$pSheet->rebindParent($this);
}
return $pSheet;
}
public function removeSheetByIndex($pIndex = 0) {
$numSheets = count($this->_workSheetCollection);
if ($pIndex > $numSheets - 1) {
throw new PHPExcel_Exception(
"You tried to remove a sheet by the out of bounds index: {$pIndex}. The actual number of sheets is {$numSheets}."
);
} else {
array_splice($this->_workSheetCollection, $pIndex, 1);
}
if (($this->_activeSheetIndex >= $pIndex) &&
($pIndex > count($this->_workSheetCollection) - 1)) {
--$this->_activeSheetIndex;
}
}
public function getSheet($pIndex = 0) {
$numSheets = count($this->_workSheetCollection);
if ($pIndex > $numSheets - 1) {
throw new PHPExcel_Exception(
"Your requested sheet index: {$pIndex} is out of bounds. The actual number of sheets is {$numSheets}."
);
} else {
return $this->_workSheetCollection[$pIndex];
}
}
public function getAllSheets() {
return $this->_workSheetCollection;
}
public function getSheetByName($pName = '') {
$worksheetCount = count($this->_workSheetCollection);
for ($i = 0; $i < $worksheetCount; ++$i) {
if ($this->_workSheetCollection[$i]->getTitle() === $pName) {
return $this->_workSheetCollection[$i];
}
}
return NULL;
}
public function getIndex(PHPExcel_Worksheet $pSheet) {
foreach ($this->_workSheetCollection as $key => $value) {
if ($value->getHashCode() == $pSheet->getHashCode()) {
return $key;
}
}
throw new PHPExcel_Exception("Sheet does not exist.");
}
public function setIndexByName($sheetName, $newIndex) {
$oldIndex = $this->getIndex($this->getSheetByName($sheetName));
$pSheet = array_splice(
$this->_workSheetCollection, $oldIndex, 1
);
array_splice(
$this->_workSheetCollection, $newIndex, 0, $pSheet
);
return $newIndex;
}
public function getSheetCount() {
return count($this->_workSheetCollection);
}
public function getActiveSheetIndex() {
return $this->_activeSheetIndex;
}
public function setActiveSheetIndex($pIndex = 0) {
$numSheets = count($this->_workSheetCollection);
if ($pIndex > $numSheets - 1) {
throw new PHPExcel_Exception(
"You tried to set a sheet active by the out of bounds index: {$pIndex}. The actual number of sheets is {$numSheets}."
);
} else {
$this->_activeSheetIndex = $pIndex;
}
return $this->getActiveSheet();
}
public function setActiveSheetIndexByName($pValue = '') {
if (($worksheet = $this->getSheetByName($pValue)) instanceof PHPExcel_Worksheet) {
$this->setActiveSheetIndex($this->getIndex($worksheet));
return $worksheet;
}
throw new PHPExcel_Exception('Workbook does not contain sheet:' . $pValue);
}
public function getSheetNames() {
$returnValue = array();
$worksheetCount = $this->getSheetCount();
for ($i = 0; $i < $worksheetCount; ++$i) {
$returnValue[] = $this->getSheet($i)->getTitle();
}
return $returnValue;
}
public function addExternalSheet(PHPExcel_Worksheet $pSheet, $iSheetIndex = null) {
if ($this->sheetNameExists($pSheet->getTitle())) {
throw new PHPExcel_Exception("Workbook already contains a worksheet named '{$pSheet->getTitle()}'. Rename the external sheet first.");
}
$countCellXfs = count($this->_cellXfCollection);
foreach ($pSheet->getParent()->getCellXfCollection() as $cellXf) {
$this->addCellXf(clone $cellXf);
}
$pSheet->rebindParent($this);
foreach ($pSheet->getCellCollection(false) as $cellID) {
$cell = $pSheet->getCell($cellID);
$cell->setXfIndex($cell->getXfIndex() + $countCellXfs);
}
return $this->addSheet($pSheet, $iSheetIndex);
}
public function getNamedRanges() {
return $this->_namedRanges;
}
public function addNamedRange(PHPExcel_NamedRange $namedRange) {
if ($namedRange->getScope() == null) {
// global scope
$this->_namedRanges[$namedRange->getName()] = $namedRange;
} else {
// local scope
$this->_namedRanges[$namedRange->getScope()->getTitle() . '!' . $namedRange->getName()] = $namedRange;
}
return true;
}
public function getNamedRange($namedRange, PHPExcel_Worksheet $pSheet = null) {
$returnValue = null;
if ($namedRange != '' && ($namedRange !== NULL)) {
if (isset($this->_namedRanges[$namedRange])) {
$returnValue = $this->_namedRanges[$namedRange];
}
if (($pSheet !== NULL) && isset($this->_namedRanges[$pSheet->getTitle() . '!' . $namedRange])) {
$returnValue = $this->_namedRanges[$pSheet->getTitle() . '!' . $namedRange];
}
}
return $returnValue;
}
public function removeNamedRange($namedRange, PHPExcel_Worksheet $pSheet = null) {
if ($pSheet === NULL) {
if (isset($this->_namedRanges[$namedRange])) {
unset($this->_namedRanges[$namedRange]);
}
} else {
if (isset($this->_namedRanges[$pSheet->getTitle() . '!' . $namedRange])) {
unset($this->_namedRanges[$pSheet->getTitle() . '!' . $namedRange]);
}
}
return $this;
}
public function getWorksheetIterator() {
return new PHPExcel_WorksheetIterator($this);
}
public function copy() {
$copied = clone $this;
$worksheetCount = count($this->_workSheetCollection);
for ($i = 0; $i < $worksheetCount; ++$i) {
$this->_workSheetCollection[$i] = $this->_workSheetCollection[$i]->copy();
$this->_workSheetCollection[$i]->rebindParent($this);
}
return $copied;
}
public function __clone() {
foreach ($this as $key => $val) {
if (is_object($val) || (is_array($val))) {
$this->{$key} = unserialize(serialize($val));
}
}
}
public function getCellXfCollection() {
return $this->_cellXfCollection;
}
public function getCellXfByIndex($pIndex = 0) {
return $this->_cellXfCollection[$pIndex];
}
public function getCellXfByHashCode($pValue = '') {
foreach ($this->_cellXfCollection as $cellXf) {
if ($cellXf->getHashCode() == $pValue) {
return $cellXf;
}
}
return false;
}
public function cellXfExists($pCellStyle = null) {
return in_array($pCellStyle, $this->_cellXfCollection, true);
}
public function getDefaultStyle() {
if (isset($this->_cellXfCollection[0])) {
return $this->_cellXfCollection[0];
}
throw new PHPExcel_Exception('No default style found for this workbook');
}
public function addCellXf(PHPExcel_Style $style) {
$this->_cellXfCollection[] = $style;
$style->setIndex(count($this->_cellXfCollection) - 1);
}
public function removeCellXfByIndex($pIndex = 0) {
if ($pIndex > count($this->_cellXfCollection) - 1) {
throw new PHPExcel_Exception("CellXf index is out of bounds.");
} else {
array_splice($this->_cellXfCollection, $pIndex, 1);
foreach ($this->_workSheetCollection as $worksheet) {
foreach ($worksheet->getCellCollection(false) as $cellID) {
$cell = $worksheet->getCell($cellID);
$xfIndex = $cell->getXfIndex();
if ($xfIndex > $pIndex) {
$cell->setXfIndex($xfIndex - 1);
} else if ($xfIndex == $pIndex) {
$cell->setXfIndex(0);
}
}
}
}
}
public function getCellXfSupervisor() {
return $this->_cellXfSupervisor;
}
public function getCellStyleXfCollection() {
return $this->_cellStyleXfCollection;
}
public function getCellStyleXfByIndex($pIndex = 0) {
return $this->_cellStyleXfCollection[$pIndex];
}
public function getCellStyleXfByHashCode($pValue = '') {
foreach ($this->_cellXfStyleCollection as $cellStyleXf) {
if ($cellStyleXf->getHashCode() == $pValue) {
return $cellStyleXf;
}
}
return false;
}
public function addCellStyleXf(PHPExcel_Style $pStyle) {
$this->_cellStyleXfCollection[] = $pStyle;
$pStyle->setIndex(count($this->_cellStyleXfCollection) - 1);
}
public function removeCellStyleXfByIndex($pIndex = 0) {
if ($pIndex > count($this->_cellStyleXfCollection) - 1) {
throw new PHPExcel_Exception("CellStyleXf index is out of bounds.");
} else {
array_splice($this->_cellStyleXfCollection, $pIndex, 1);
}
}
public function garbageCollect() {
$countReferencesCellXf = array();
foreach ($this->_cellXfCollection as $index => $cellXf) {
$countReferencesCellXf[$index] = 0;
}
foreach ($this->getWorksheetIterator() as $sheet) {
foreach ($sheet->getCellCollection(false) as $cellID) {
$cell = $sheet->getCell($cellID);
++$countReferencesCellXf[$cell->getXfIndex()];
}
foreach ($sheet->getRowDimensions() as $rowDimension) {
if ($rowDimension->getXfIndex() !== null) {
++$countReferencesCellXf[$rowDimension->getXfIndex()];
}
}
foreach ($sheet->getColumnDimensions() as $columnDimension) {
++$countReferencesCellXf[$columnDimension->getXfIndex()];
}
}
$countNeededCellXfs = 0;
foreach ($this->_cellXfCollection as $index => $cellXf) {
if ($countReferencesCellXf[$index] > 0 || $index == 0) {
++$countNeededCellXfs;
} else {
unset($this->_cellXfCollection[$index]);
}
$map[$index] = $countNeededCellXfs - 1;
}
$this->_cellXfCollection = array_values($this->_cellXfCollection);
foreach ($this->_cellXfCollection as $i => $cellXf) {
$cellXf->setIndex($i);
}
if (empty($this->_cellXfCollection)) {
$this->_cellXfCollection[] = new PHPExcel_Style();
}
foreach ($this->getWorksheetIterator() as $sheet) {
foreach ($sheet->getCellCollection(false) as $cellID) {
$cell = $sheet->getCell($cellID);
$cell->setXfIndex($map[$cell->getXfIndex()]);
}
foreach ($sheet->getRowDimensions() as $rowDimension) {
if ($rowDimension->getXfIndex() !== null) {
$rowDimension->setXfIndex($map[$rowDimension->getXfIndex()]);
}
}
foreach ($sheet->getColumnDimensions() as $columnDimension) {
$columnDimension->setXfIndex($map[$columnDimension->getXfIndex()]);
}
$sheet->garbageCollect();
}
}
public function getID() {
return $this->_uniqueID;
}
}