-
-
Notifications
You must be signed in to change notification settings - Fork 246
/
Exportable.php
332 lines (292 loc) · 10.3 KB
/
Exportable.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
<?php
namespace Rap2hpoutre\FastExcel;
use DateTimeInterface;
use Generator;
use Illuminate\Support\Collection;
use Illuminate\Support\Str;
use InvalidArgumentException;
use OpenSpout\Common\Entity\Row;
use OpenSpout\Common\Entity\Style\Style;
use OpenSpout\Writer\Common\AbstractOptions;
use OpenSpout\Writer\Common\Creator\WriterEntityFactory;
/**
* Trait Exportable.
*
* @property bool $transpose
* @property bool $with_header
* @property \Illuminate\Support\Collection $data
*/
trait Exportable
{
/**
* @var Style
*/
private $header_style;
private $rows_style;
/** @var Style[] */
private $column_styles = [];
/**
* @param AbstractOptions $options
*
* @return mixed
*/
abstract protected function setOptions(&$options);
/** @param Style[] $styles */
public function setColumnStyles($styles): static
{
$this->column_styles = $styles;
return $this;
}
/**
* @param string $path
* @param callable|null $callback
*
* @throws \OpenSpout\Common\Exception\InvalidArgumentException
* @throws \OpenSpout\Common\Exception\UnsupportedTypeException
* @throws \OpenSpout\Writer\Exception\WriterNotOpenedException
* @throws \OpenSpout\Common\Exception\IOException
*
* @return string
*/
public function export($path, callable $callback = null)
{
self::exportOrDownload($path, 'openToFile', $callback);
return realpath($path) ?: $path;
}
/**
* @param $path
* @param callable|null $callback
*
* @throws \OpenSpout\Common\Exception\InvalidArgumentException
* @throws \OpenSpout\Common\Exception\UnsupportedTypeException
* @throws \OpenSpout\Writer\Exception\WriterNotOpenedException
* @throws \OpenSpout\Common\Exception\IOException
*
* @return \Symfony\Component\HttpFoundation\StreamedResponse|string
*/
public function download($path, callable $callback = null)
{
if (method_exists(response(), 'streamDownload')) {
return response()->streamDownload(function () use ($path, $callback) {
self::exportOrDownload($path, 'openToBrowser', $callback);
}, $path);
}
self::exportOrDownload($path, 'openToBrowser', $callback);
return '';
}
/**
* @param $path
* @param string $function
* @param callable|null $callback
*
* @throws \OpenSpout\Common\Exception\IOException
* @throws \OpenSpout\Common\Exception\InvalidArgumentException
* @throws \OpenSpout\Common\Exception\UnsupportedTypeException
* @throws \OpenSpout\Writer\Exception\WriterNotOpenedException
* @throws \OpenSpout\Common\Exception\SpoutException
*/
private function exportOrDownload($path, $function, callable $callback = null)
{
if (Str::endsWith($path, 'csv')) {
$options = new \OpenSpout\Writer\CSV\Options();
$writer = new \OpenSpout\Writer\CSV\Writer($options);
} elseif (Str::endsWith($path, 'ods')) {
$options = new \OpenSpout\Writer\ODS\Options();
$writer = new \OpenSpout\Writer\ODS\Writer($options);
} else {
$options = new \OpenSpout\Writer\XLSX\Options();
$writer = new \OpenSpout\Writer\XLSX\Writer($options);
}
$this->setOptions($options);
/* @var \OpenSpout\Writer\WriterInterface $writer */
$writer->$function($path);
$has_sheets = ($writer instanceof \OpenSpout\Writer\XLSX\Writer || $writer instanceof \OpenSpout\Writer\ODS\Writer);
// It can export one sheet (Collection) or N sheets (SheetCollection)
$data = $this->transpose ? $this->transposeData() : ($this->data instanceof SheetCollection ? $this->data : collect([$this->data]));
foreach ($data as $key => $collection) {
if ($collection instanceof Collection) {
$this->writeRowsFromCollection($writer, $collection, $callback);
} elseif ($collection instanceof Generator) {
$this->writeRowsFromGenerator($writer, $collection, $callback);
} elseif (is_array($collection)) {
$this->writeRowsFromArray($writer, $collection, $callback);
} else {
throw new InvalidArgumentException('Unsupported type for $data');
}
if (is_string($key)) {
$writer->getCurrentSheet()->setName($key);
}
if ($has_sheets && $data->keys()->last() !== $key) {
$writer->addNewSheetAndMakeItCurrent();
}
}
$writer->close();
}
/**
* Transpose data from rows to columns.
*
* @return SheetCollection
*/
private function transposeData()
{
$data = $this->data instanceof SheetCollection ? $this->data : collect([$this->data]);
$transposedData = [];
foreach ($data as $key => $collection) {
foreach ($collection as $row => $columns) {
foreach ($columns as $column => $value) {
data_set(
$transposedData,
implode('.', [
$key,
$column,
$row,
]),
$value
);
}
}
}
return new SheetCollection($transposedData);
}
private function writeRowsFromCollection($writer, Collection $collection, ?callable $callback = null)
{
// Apply callback
if ($callback) {
$collection->transform(function ($value) use ($callback) {
return $callback($value);
});
}
// Prepare collection (i.e remove non-string)
$this->prepareCollection($collection);
// Add header row.
if ($this->with_header) {
$this->writeHeader($writer, $collection->first());
}
// createRowFromArray works only with arrays
if (!is_array($collection->first())) {
$collection = $collection->map(function ($value) {
return $value->toArray();
});
}
// is_array($first_row) ? $first_row : $first_row->toArray())
$all_rows = $collection->map(function ($value) {
return Row::fromValues($value);
})->toArray();
if ($this->rows_style || count($this->column_styles)) {
$this->addRowsWithStyle($writer, $all_rows, $this->rows_style, $this->column_styles);
} else {
$writer->addRows($all_rows);
}
}
private function addRowsWithStyle($writer, $all_rows, $rows_style, $column_styles)
{
$styled_rows = [];
// Style rows one by one
foreach ($all_rows as $row) {
$styled_rows[] = $this->createRow($row->toArray(), $rows_style, $column_styles);
}
$writer->addRows($styled_rows);
}
private function writeRowsFromGenerator($writer, Generator $generator, ?callable $callback = null)
{
foreach ($generator as $key => $item) {
// Apply callback
if ($callback) {
$item = $callback($item);
}
// Prepare row (i.e remove non-string)
$item = $this->transformRow($item);
// Add header row.
if ($this->with_header && $key === 0) {
$this->writeHeader($writer, $item);
}
// Write rows (one by one).
$writer->addRow($this->createRow($item->toArray(), $this->rows_style, $this->column_styles));
}
}
private function writeRowsFromArray($writer, array $array, ?callable $callback = null)
{
$collection = collect($array);
if (is_object($collection->first()) || is_array($collection->first())) {
// provided $array was valid and could be converted to a collection
$this->writeRowsFromCollection($writer, $collection, $callback);
}
}
private function writeHeader($writer, $first_row)
{
if ($first_row === null) {
return;
}
$keys = array_keys(is_array($first_row) ? $first_row : $first_row->toArray());
$writer->addRow($this->createRow($keys, $this->header_style));
// $writer->addRow(WriterEntityFactory::createRowFromArray($keys, $this->header_style));
}
/**
* Prepare collection by removing non string if required.
*/
protected function prepareCollection(Collection $collection)
{
$need_conversion = false;
$first_row = $collection->first();
if (!$first_row) {
return;
}
foreach ($first_row as $item) {
if (!is_string($item)) {
$need_conversion = true;
}
}
if ($need_conversion) {
$this->transform($collection);
}
}
/**
* Transform the collection.
*/
private function transform(Collection $collection)
{
$collection->transform(function ($data) {
return $this->transformRow($data);
});
}
/**
* Transform one row (i.e remove non-string).
*/
private function transformRow($data)
{
return collect($data)->map(function ($value) {
return is_null($value) ? (string) $value : $value;
})->filter(function ($value) {
return is_string($value) || is_int($value) || is_float($value) || $value instanceof DateTimeInterface;
});
}
/**
* @param Style $style
*
* @return Exportable
*/
public function headerStyle(Style $style)
{
$this->header_style = $style;
return $this;
}
/**
* @param Style $style
*
* @return Exportable
*/
public function rowsStyle(Style $style)
{
$this->rows_style = $style;
return $this;
}
/**
* Create openspout row from values with optional row and cell styling.
*
* @SuppressWarnings(PHPMD.StaticAccess)
*/
private function createRow(array $values = [], ?Style $rows_style = null, array $column_styles = []): Row
{
return Row::fromValuesWithStyles($values, $rows_style, $column_styles);
}
}