-
-
Notifications
You must be signed in to change notification settings - Fork 1.9k
/
LaravelExcelWriter.php
707 lines (595 loc) · 17.4 KB
/
LaravelExcelWriter.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
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
<?php namespace Maatwebsite\Excel\Writers;
use Closure;
use Carbon\Carbon;
use PHPExcel_IOFactory;
use Illuminate\Filesystem\Filesystem;
use Illuminate\Support\Facades\Response;
use Maatwebsite\Excel\Classes\FormatIdentifier;
use Maatwebsite\Excel\Classes\LaravelExcelWorksheet;
use Maatwebsite\Excel\Exceptions\LaravelExcelException;
use Symfony\Component\Finder\Exception\AccessDeniedException;
/**
*
* LaravelExcel Excel writer
*
* @category Laravel Excel
* @version 1.0.0
* @package maatwebsite/excel
* @copyright Copyright (c) 2013 - 2014 Maatwebsite (http://www.maatwebsite.nl)
* @author Maatwebsite <info@maatwebsite.nl>
* @license http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt LGPL
*/
class LaravelExcelWriter {
/**
* Spreadsheet filename
* @var string
*/
public $filename;
/**
* Spreadsheet title
* @var string
*/
public $title;
/**
* Excel object
* @var \PHPExcel
*/
public $excel;
/**
* Laravel response
* @var Response
*/
protected $response;
/**
* Spreadsheet writer
* @var object
*/
public $writer;
/**
* Excel sheet
* @var LaravelExcelWorksheet
*/
protected $sheet;
/**
* Parser
* @var ViewParser
*/
public $parser;
/**
* Default extension
* @var string
*/
public $ext = 'xls';
/**
* Valid file extensions.
* @var array
*/
private $validExtensions = [
'xlsx', 'xlsm', 'xltx', 'xltm', //Excel 2007
'xls', 'xlt', //Excel5
'ods', 'ots', //OOCalc
'slk', //SYLK
'xml', //Excel2003XML
'gnumeric', //gnumeric
'htm', 'html', //HTML
'csv','txt' //CSV
,'pdf' //PDF
];
/**
* Path the file will be stored to
* @var string
*/
public $storagePath = 'exports';
/**
* Header Content-type
* @var string
*/
protected $contentType;
/**
* Spreadsheet is rendered
* @var boolean
*/
protected $rendered = false;
/**
* Construct writer
* @param Response $response
* @param FileSystem $filesystem
* @param FormatIdentifier $identifier
*/
public function __construct(Response $response, FileSystem $filesystem, FormatIdentifier $identifier)
{
$this->response = $response;
$this->filesystem = $filesystem;
$this->identifier = $identifier;
}
/**
* Inject the excel object
* @param PHPExcel $excel
* @param bool $reset
* @return void
*/
public function injectExcel($excel, $reset = true)
{
$this->excel = $excel;
if ($reset)
$this->_reset();
}
/**
* Set the spreadsheet title
* @param string $title
* @return LaravelExcelWriter
*/
public function setTitle($title)
{
$this->title = $title;
$this->getProperties()->setTitle($title);
return $this;
}
/**
* Set the filename
* @param $name
* @return $this
*/
public function setFileName($name)
{
$this->filename = $name;
return $this;
}
/**
* Get the title
* @return string
*/
public function getTitle()
{
return $this->title;
}
/**
* Get the filename
* @return string
*/
public function getFileName()
{
return $this->filename;
}
/**
* Share view with all sheets
* @param string $view
* @param array $data
* @param array $mergeData
* @return LaravelExcelWriter
*/
public function shareView($view, $data = [], $mergeData = [])
{
// Get the parser
$this->getParser();
// Set the view inside the parser
$this->parser->setView($view);
$this->parser->setData($data);
$this->parser->setMergeData($mergeData);
return $this;
}
/**
* Set the view
* @return LaravelExcelWriter
*/
public function setView()
{
return call_user_func_array([$this, 'shareView'], func_get_args());
}
/**
* Load the view
* @return LaravelExcelWriter
*/
public function loadView()
{
return call_user_func_array([$this, 'shareView'], func_get_args());
}
/**
* Create a new sheet
* @param string $title
* @param callback|null $callback
* @return LaravelExcelWriter
*/
public function sheet($title, $callback = null)
{
// Clone the active sheet
$this->sheet = $this->excel->createSheet(null, $title);
// If a parser was set, inject it
if ($this->parser)
$this->sheet->setParser($this->parser);
// Set the sheet title
$this->sheet->setTitle($title);
// Set the default page setup
$this->sheet->setDefaultPageSetup();
// Do the callback
if (is_callable($callback))
call_user_func($callback, $this->sheet);
// Autosize columns when no user didn't change anything about column sizing
if (!$this->sheet->hasFixedSizeColumns())
$this->sheet->setAutosize(config('excel.export.autosize', false));
// Parse the sheet
$this->sheet->parsed();
return $this;
}
/**
* Set data for the current sheet
* @param array $array
* @return LaravelExcelWriter
*/
public function with(Array $array)
{
// Add the vars
$this->fromArray($array);
return $this;
}
/**
* Export the spreadsheet
* @param string $ext
* @param array $headers
* @throws LaravelExcelException
*/
public function export($ext = 'xls', Array $headers = [])
{
// Set the extension
$this->ext = mb_strtolower($ext);
// Render the file
$this->_render();
// Download the file
$this->_download($headers);
}
/**
* Check if input file extension is valid.
* @param $ext
*/
private function checkExtensionIsValid($ext)
{
// Check file extension is valid
if (!in_array($ext, $this->validExtensions))
{
throw new \InvalidArgumentException("Invalid file extension `$ext`, expected "
.implode(", ", $this->validExtensions).".");
}
}
/**
* Convert and existing file to newly requested extension
* @param $ext
* @param array $headers
*/
public function convert($ext, Array $headers = [])
{
$this->export($ext, $headers);
}
/**
* Export and download the spreadsheet
* @param string $ext
* @param array $headers
*/
public function download($ext = 'xls', Array $headers = [])
{
$this->export($ext, $headers);
}
/**
* Return the spreadsheet file as a string
* @param string $ext
* @return string
* @throws LaravelExcelException
*/
public function string($ext = 'xls')
{
// Set the extension
$this->ext = $ext;
// Render the file
$this->_render();
// Check if writer isset
if (!$this->writer)
throw new LaravelExcelException('[ERROR] No writer was set.');
//Capture the content as a string and return it
ob_start();
$this->writer->save('php://output');
return ob_get_clean();
}
/**
* Download a file
* @param array $headers
* @throws LaravelExcelException
*/
protected function _download(Array $headers = [])
{
// Set the headers
$this->_setHeaders(
$headers,
[
'Content-Type' => $this->contentType,
'Content-Disposition' => 'attachment; filename="' . $this->filename . '.' . $this->ext . '"',
'Expires' => 'Mon, 26 Jul 1997 05:00:00 GMT', // Date in the past
'Last-Modified' => Carbon::now()->format('D, d M Y H:i:s'),
'Cache-Control' => 'cache, must-revalidate',
'Pragma' => 'public'
]
);
// Check if writer isset
if (!$this->writer)
throw new LaravelExcelException('[ERROR] No writer was set.');
// Download
$this->writer->save('php://output');
// End the script to prevent corrupted xlsx files
exit;
}
/**
* Store the excel file to the server
* @param string $ext
* @param boolean $path
* @param boolean $returnInfo
* @return LaravelExcelWriter|array
*/
public function store($ext = 'xls', $path = false, $returnInfo = false)
{
// Set the storage path
$this->_setStoragePath($path);
// Set the extension
$this->ext = mb_strtolower($ext);
// Render the XLS
$this->_render();
// Set the storage path and file
$toStore = $this->storagePath . DIRECTORY_SEPARATOR . $this->filename . '.' . $this->ext;
// Save the file to specified location
$this->writer->save($toStore);
// Return file info
if ($this->returnInfo($returnInfo))
{
// Send back information about the stored file
return [
'full' => $toStore,
'path' => $this->storagePath,
'file' => $this->filename . '.' . $this->ext,
'title' => $this->filename,
'ext' => $this->ext
];
}
// Return itself
return $this;
}
/**
* Check if we want to return info or itself
* @param boolean $returnInfo
* @return boolean
*/
public function returnInfo($returnInfo = false)
{
return $returnInfo ? $returnInfo : config('excel.export.store.returnInfo', false);
}
/**
* Store the excel file to the server
* @param str|string $ext The file extension
* @param bool|str $path The save path
* @param bool $returnInfo
* @return LaravelExcelWriter
*/
public function save($ext = 'xls', $path = false, $returnInfo = false)
{
return $this->store($ext, $path, $returnInfo);
}
/**
* Start render of a new spreadsheet
* @throws LaravelExcelException
* @return void
*/
protected function _render()
{
// Preserve any existing active sheet index
$activeIndex = $this->getExcel()->getActiveSheetIndex();
// getAllSheets() returns $this if no sheets were added to the excel file
if ($this->getAllSheets() instanceof $this) {
throw new LaravelExcelException('[ERROR] Aborting spreadsheet render: a minimum of 1 sheet is required.');
}
//Fix borders for merged cells
foreach($this->getAllSheets() as $sheet){
foreach($sheet->getMergeCells() as $cells){
$style = $sheet->getStyle(explode(':', $cells)[0]);
$sheet->duplicateStyle($style, $cells);
}
}
// Restore active sheet index.
$this->setActiveSheetIndex($activeIndex);
// There should be enough sheets to continue rendering
if ($this->excel->getSheetCount() < 0)
throw new LaravelExcelException('[ERROR] Aborting spreadsheet render: no sheets were created.');
// Set the format
$this->_setFormat();
// Set the writer
$this->_setWriter();
// File has been rendered
$this->rendered = true;
}
/**
* Get the excel object
* @return PHPExcel
*/
public function getExcel()
{
return $this->excel;
}
/**
* Get the view parser
* @return ViewParser
*/
public function getParser()
{
// Init the parser
if (!$this->parser)
$this->parser = app('excel.parsers.view');
return $this->parser;
}
/**
* Get the sheet
* @return LaravelExcelWorksheet
*/
public function getSheet()
{
return $this->sheet;
}
/**
* Set the active sheet index
* @param integer $index
* @return LaravelExcelWriter
*/
public function setActiveSheetIndex($index)
{
$this->sheet = $this->excel->setActiveSheetIndex($index);
return $this;
}
/**
* Set attributes
* @param string $setter
* @param array $params
*/
protected function _setAttribute($setter, $params)
{
// Get the key
$key = lcfirst(str_replace('set', '', $setter));
// If is an allowed property
if ($this->excel->isChangeableProperty($setter))
{
// Set the properties
call_user_func_array([$this->excel->getProperties(), $setter], $params);
}
}
/**
* Set the write format
* @return void
*/
protected function _setFormat()
{
// Get extension
$this->ext = strtolower($this->ext);
// get the file format
$this->format = $this->identifier->getFormatByExtension($this->ext);
// Get content type
$this->contentType = $this->identifier->getContentTypeByFormat($this->format);
}
/**
* Set the writer
* @return PHPExcel_***_Writer
*/
protected function _setWriter()
{
// Check if input file extension is valid
$this->checkExtensionIsValid($this->ext);
// Set pdf renderer
if ($this->format == 'PDF')
{
$this->setPdfRenderer();
}
// Create the writer
$this->writer = PHPExcel_IOFactory::createWriter($this->excel, $this->format);
// Set CSV delimiter
if ($this->format == 'CSV')
{
$this->writer->setDelimiter(config('excel.csv.delimiter', ','));
$this->writer->setEnclosure(config('excel.csv.enclosure', '"'));
$this->writer->setLineEnding(config('excel.csv.line_ending', "\r\n"));
$this->writer->setUseBOM(config('excel.csv.use_bom', false));
}
// Set CSV delimiter
if ($this->format == 'PDF')
{
$this->writer->writeAllSheets();
}
// Calculation settings
$this->writer->setPreCalculateFormulas(config('excel.export.calculate', false));
// Include Charts
$this->writer->setIncludeCharts(config('excel.export.includeCharts', false));
return $this->writer;
}
/**
* Set the pdf renderer
* @throws \Exception
*/
protected function setPdfRenderer()
{
// Get the driver name
$driver = config('excel.export.pdf.driver');
$path = config('excel.export.pdf.drivers.' . $driver . '.path');
// Disable autoloading for dompdf
if(! defined("DOMPDF_ENABLE_AUTOLOAD")){
define("DOMPDF_ENABLE_AUTOLOAD", false);
}
// Set the pdf renderer
if (!\PHPExcel_Settings::setPdfRenderer($driver, $path))
throw new \Exception("{$driver} could not be found. Make sure you've included it in your composer.json");
}
/**
* Set the headers
* @param $headers
* @throws LaravelExcelException
*/
protected function _setHeaders(Array $headers = [], Array $default)
{
if (headers_sent()) throw new LaravelExcelException('[ERROR]: Headers already sent');
// Merge the default headers with the overruled headers
$headers = array_merge($default, $headers);
foreach ($headers as $header => $value)
{
header($header . ': ' . $value);
}
}
/**
* Set the storage path
* @param bool $path
* @return void
*/
protected function _setStoragePath($path = false)
{
// Get the default path
$path = $path ? $path : config('excel.export.store.path', storage_path($this->storagePath));
// Trim of slashes, to makes sure we won't add them double
$this->storagePath = rtrim($path, DIRECTORY_SEPARATOR);
// Make sure the storage path exists
if (!$this->filesystem->exists($this->storagePath)) {
$this->filesystem->makeDirectory($this->storagePath, 0777, true);
}
if (!$this->filesystem->isWritable($this->storagePath)) {
throw new LaravelExcelException("Permission denied to the storage path");
}
}
/**
* Reset the writer
* @return void
*/
protected function _reset()
{
$this->excel->disconnectWorksheets();
}
/**
* Dynamically call methods
* @param string $method
* @param array $params
* @throws LaravelExcelException
* @return LaravelExcelWriter
*/
public function __call($method, $params)
{
// If the dynamic call starts with "set"
if (starts_with($method, 'set') && $this->excel->isChangeableProperty($method))
{
$this->_setAttribute($method, $params);
return $this;
}
// Call a php excel method
elseif (method_exists($this->excel, $method))
{
// Call the method from the excel object with the given params
$return = call_user_func_array([$this->excel, $method], $params);
return $return ? $return : $this;
}
throw new LaravelExcelException('[ERROR] Writer method [' . $method . '] does not exist.');
}
/**
* Valid file extensions.
* @return array
*/
public function getValidExtensions()
{
return $this->validExtensions;
}
}