-
Notifications
You must be signed in to change notification settings - Fork 19
/
EExcelView.php
420 lines (378 loc) · 13.2 KB
/
EExcelView.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
<?php
/** @noinspection PhpUnhandledExceptionInspection */
use PhpOffice\PhpSpreadsheet\Spreadsheet;
Yii::import('zii.widgets.grid.CGridView');
/**
* @authors Nikola Kostadinov, Dan Straw, Ilya Sheershoff
* @license MIT License
* @version 0.3
*/
class EExcelView extends CGridView
{
// Document properties
/**
* The creator of the document
* @var string
*/
public $creator = '';
/**
* Title of the document
* @var string|null
*/
public $title = null;
/**
* Spreadsheet Subject
* @var string
*/
public $subject = '';
/**
* Spreadsheet Description
* @var string
*/
public $description = '';
/**
* Spreadsheet Categories
* @var string
*/
public $category = '';
/**
* This sheet's title
* @var string
*/
public $sheetTitle = 'Sheet1';
/**
* Whether the cells are auto width
* @var bool
*/
public $autoWidth = true;
const EXPORT_TYPE_XLS = 'Xls';
const EXPORT_TYPE_XLSX = 'Xlsx';
/**
* The format the file will be created in.
* See the $writerTypes array for the full list of valid values
* @var string
*/
public $exportType = self::EXPORT_TYPE_XLS;
/**
* if needed, disable paging to export all data
* @var bool
*/
public $disablePaging = true;
/**
* The filename to export to
* @var string|null
*/
public $filename = null;
/**
* Stream output to browser
* @var bool
*/
public $stream = true;
const GRID_MODE_EXPORT = 'export';
const GRID_MODE_GRID = 'grid';
/**
* Whether to display grid ot export it to selected format. Possible values(grid, export)
* @var string
*/
public $grid_mode = self::GRID_MODE_GRID;
/**
* GET variable name which contains thegrid mode
* @var string
*/
public $grid_mode_var = 'grid_mode';
/**
* Set sheet as right-to-left
* @var bool
*/
public $rtl_sheet = false;
// buttons config
public $exportButtonsCSS = 'summary';
public $exportButtons = array(self::EXPORT_TYPE_XLSX);
public $exportText = 'Export to: ';
// callbacks
public $onRenderHeaderCell = null;
public $onRenderDataCell = null;
public $onRenderFooterCell = null;
// Constants used by the mimeTypes
const CONTENT_TYPE = 'Content-type';
const FILE_EXTENSION = 'extension';
const FILE_CAPTION = 'caption';
/**
* Writer Types used for streaming.
* See PhpOffice\PhpSpreadsheet\IOFactory::writers
* @var array
*/
private static $writerTypes = [
self::EXPORT_TYPE_XLS => array(
self::CONTENT_TYPE=>'application/vnd.ms-excel',
self::FILE_EXTENSION=>'xls',
self::FILE_CAPTION=>'Excel(*.xls)',
),
self::EXPORT_TYPE_XLSX => array(
self::CONTENT_TYPE=>'application/vnd.ms-excel',
self::FILE_EXTENSION=>'xlsx',
self::FILE_CAPTION=>'Excel(*.xlsx)',
),
'Ods' => array(
self::CONTENT_TYPE => 'application/vnd.oasis.opendocument.spreadsheet',
self::FILE_EXTENSION=>'ods',
self::FILE_CAPTION=>'OpenDocument Spreadsheet(*.ods)',
),
'Csv' =>array(
self::CONTENT_TYPE=>'application/csv',
self::FILE_EXTENSION=>'csv',
self::FILE_CAPTION=>'CSV(*.csv)',
),
'Html' => array(
self::CONTENT_TYPE=>'text/html',
self::FILE_EXTENSION=>'html',
self::FILE_CAPTION=>'HTML(*.html)',
),
'Tcpdf' => array(
self::CONTENT_TYPE=>'application/pdf',
self::FILE_EXTENSION=>'pdf',
self::FILE_CAPTION=>'PDF(*.pdf)',
),
'Dompdf' => array(
self::CONTENT_TYPE=>'application/pdf',
self::FILE_EXTENSION=>'pdf',
self::FILE_CAPTION=>'PDF(*.pdf)',
),
'Mpdf' => array(
self::CONTENT_TYPE=>'application/pdf',
self::FILE_EXTENSION=>'pdf',
self::FILE_CAPTION=>'PDF(*.pdf)',
),
];
/** @var PhpOffice\PhpSpreadsheet\Spreadsheet $objPhpSpreadsheet */
protected $objPhpSpreadsheet = null;
/**
* @throws CException
* @throws \PhpOffice\PhpSpreadsheet\Exception
*/
public function init()
{
$this->assignGetParameters();
if($this->disablePaging) //if needed disable paging to export all data
$this->dataProvider->pagination = false;
if($this->grid_mode == self::GRID_MODE_EXPORT && ! class_exists("\PhpOffice\PhpSpreadsheet\Spreadsheet") ) {
$this->grid_mode = self::GRID_MODE_GRID;
Yii::log('PHPSpreadsheet not found in the vendor directory, please add "phpoffice/phpspreadsheet": ">= 1.10.1" to your composer.json. Export disabled !', CLogger::LEVEL_WARNING, 'EExcelview');
}
if($this->grid_mode == self::GRID_MODE_EXPORT)
{
$this->title = $this->title ? $this->title : Yii::app()->getController()->getPageTitle();
$this->initColumns();
// Create PHPSpreadsheet object
$this->objPhpSpreadsheet = new Spreadsheet();
// Setting workbook properties
$spreadsheetProperties = $this->objPhpSpreadsheet->getProperties();
$spreadsheetProperties->setCreator($this->creator);
$spreadsheetProperties->setTitle($this->title);
$spreadsheetProperties->setSubject($this->subject);
$spreadsheetProperties->setDescription($this->description);
$spreadsheetProperties->setCategory($this->category);
$this->objPhpSpreadsheet->setProperties($spreadsheetProperties);
if($this->rtl_sheet === true)
$this->objPhpSpreadsheet->getActiveSheet()->setRightToLeft (true);
} else {
// grid mode grid - i.e. render as CGridView.
parent::init();
}
}
/**
* Fetches and validates GET parameters passed in
*/
protected function assignGetParameters()
{
if(isset($_GET[$this->grid_mode_var]) && preg_match('/^(export|grid)$/', $_GET[$this->grid_mode_var]) ) {
$this->grid_mode = $_GET[$this->grid_mode_var];
}
if(isset($_GET['exportType']) && key_exists($_GET['exportType'], self::$writerTypes)) {
$this->exportType = $_GET['exportType'];
}
}
/**
* @throws \PhpOffice\PhpSpreadsheet\Exception
* @throws Exception
*/
public function renderHeader()
{
$a=0;
foreach($this->columns as $column)
{
$a=$a+1;
if($column instanceof CButtonColumn) {
$head = $column->header;
}
elseif($column->header===null && $column->name!==null)
{
if($column->grid->dataProvider instanceof CActiveDataProvider) {
$head = $column->grid->dataProvider->model->getAttributeLabel($column->name);
} else {
$head = $column->name;
}
} else {
$head = trim($column->header) !== '' ? $column->header : $column->grid->blankDisplay;
}
$cell = $this->objPhpSpreadsheet->getActiveSheet()->setCellValue($this->columnName($a)."1" ,$head);
if(is_callable($this->onRenderHeaderCell)) {
call_user_func_array($this->onRenderHeaderCell, array($cell, $head));
}
}
}
/**
* @return int
* @throws \PhpOffice\PhpSpreadsheet\Exception
*/
public function renderBody()
{
$data=$this->dataProvider->getData();
$n=count($data);
if($n>0) {
for($row=0;$row<$n;++$row) {
$this->renderRow($row);
}
}
return $n;
}
/**
* @param integer $row
* @throws \PhpOffice\PhpSpreadsheet\Exception
* @throws Exception
*/
public function renderRow($row)
{
$data=$this->dataProvider->getData();
$a=0;
foreach($this->columns as $n=>$column)
{
if($column instanceof CLinkColumn)
{
if($column->labelExpression!==null)
$value=$column->evaluateExpression($column->labelExpression,array('data'=>$data[$row],'row'=>$row));
else
$value=$column->label;
} elseif($column instanceof CButtonColumn)
$value = ""; //Dont know what to do with buttons
elseif($column->value!==null)
$value=$this->evaluateExpression($column->value ,array('data'=>$data[$row]));
elseif($column->name!==null) {
//$value=$data[$row][$column->name];
$value= CHtml::value($data[$row], $column->name);
$value=$value===null ? "" : $column->grid->getFormatter()->format($value,'raw');
}
$a++;
$cell = $this->objPhpSpreadsheet->getActiveSheet()->setCellValue($this->columnName($a).($row+2) , strip_tags($value));
if(is_callable($this->onRenderDataCell))
call_user_func_array($this->onRenderDataCell, array($cell, $data[$row], $value));
}
}
/**
* @param $row
* @throws \PhpOffice\PhpSpreadsheet\Exception
* @throws Exception
*/
public function renderFooter($row)
{
$a=0;
foreach($this->columns as $n=>$column)
{
$a=$a+1;
if($column->footer)
{
$footer =trim($column->footer)!=='' ? $column->footer : $column->grid->blankDisplay;
$cell = $this->objPhpSpreadsheet->getActiveSheet()->setCellValue($this->columnName($a).($row+2) ,$footer);
if(is_callable($this->onRenderFooterCell))
call_user_func_array($this->onRenderFooterCell, array($cell, $footer));
}
}
}
/**
* @throws \PhpOffice\PhpSpreadsheet\Exception
* @throws Exception
*/
public function run()
{
if($this->grid_mode == self::GRID_MODE_EXPORT)
{
$this->renderHeader();
$row = $this->renderBody();
$this->renderFooter($row);
//set auto width
if($this->autoWidth) {
foreach($this->columns as $n=>$column) {
$this->objPhpSpreadsheet->getActiveSheet()->getColumnDimension($this->columnName($n + 1))->setAutoSize(true);
}
}
$this->objPhpSpreadsheet->getActiveSheet()->setTitle($this->sheetTitle);
//create writer for saving
$writer = PhpOffice\PhpSpreadsheet\IOFactory::createWriter($this->objPhpSpreadsheet, $this->exportType);
if(!$this->stream) {
// save to filename
$writer->save($this->filename);
} else {
//output to browser
if(!$this->filename)
$this->filename = $this->title;
$this->cleanOutput();
header('Cache-Control: must-revalidate, post-check=0, pre-check=0');
header('Pragma: public');
header('Content-type: '.self::$writerTypes[$this->exportType][self::CONTENT_TYPE]);
header('Content-Disposition: attachment; filename="'.$this->filename.'.'.self::$writerTypes[$this->exportType][self::FILE_EXTENSION].'"');
header('Cache-Control: max-age=0');
$writer->save('php://output');
ob_start();
Yii::app()->end();
ob_end_clean();
}
} else
parent::run();
}
/**
* Returns the coresponding excel column.(Abdul Rehman from yii forum)
*
* @param int $index
* @return string
* @throws Exception
*/
public function columnName($index)
{
--$index;
if($index >= 0 && $index < 26)
return chr(ord('A') + $index);
else if ($index > 25)
return ($this->columnName($index / 26)).($this->columnName($index%26 + 1));
else
throw new Exception("Invalid Column # ".($index + 1));
}
public function renderExportButtons()
{
foreach($this->exportButtons as $key=>$button)
{
$item = is_array($button) ? CMap::mergeArray(self::$writerTypes[$key], $button) : self::$writerTypes[$button];
$type = is_array($button) ? $key : $button;
$url = parse_url(Yii::app()->request->requestUri);
if (key_exists('query', $url))
$content[] = CHtml::link($item[self::FILE_CAPTION], '?'.$url['query'].'&exportType='.$type.'&'.$this->grid_mode_var.'=export');
else
$content[] = CHtml::link($item[self::FILE_CAPTION], '?exportType='.$type.'&'.$this->grid_mode_var.'=export');
}
if($content) {
echo CHtml::tag('div', array('class' => $this->exportButtonsCSS), $this->exportText . implode(', ', $content));
}
}
/**
* Performs cleaning on multiple levels.
*
* From le_top @ yiiframework.com
*
*/
protected static function cleanOutput()
{
for($level=ob_get_level();$level>0;--$level)
{
@ob_end_clean();
}
}
}