Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement per cell styling for openspout #359

Merged
merged 6 commits into from
Jun 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"require": {
"php": "^8.0",
"illuminate/support": "^6.0 || ^7.0 || ^8.0 || ^9.0 || ^10.0 || ^11.0",
"openspout/openspout": "^4.1.1"
"openspout/openspout": "^4.24"
},
"require-dev": {
"illuminate/database": "^6.20.12 || ^7.30.4 || ^8.24.0 || ^9.0 || ^10.0 || ^11.0",
Expand Down
36 changes: 29 additions & 7 deletions src/Exportable.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

namespace Rap2hpoutre\FastExcel;

use DateTimeInterface;
use Generator;
use Illuminate\Support\Collection;
use Illuminate\Support\Str;
Expand All @@ -26,13 +27,24 @@ trait Exportable
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
Expand Down Expand Up @@ -182,19 +194,19 @@ private function writeRowsFromCollection($writer, Collection $collection, ?calla
$all_rows = $collection->map(function ($value) {
return Row::fromValues($value);
})->toArray();
if ($this->rows_style) {
$this->addRowsWithStyle($writer, $all_rows, $this->rows_style);
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)
private function addRowsWithStyle($writer, $all_rows, $rows_style, $column_styles)
{
$styled_rows = [];
// Style rows one by one
foreach ($all_rows as $row) {
$styled_rows[] = Row::fromValues($row->toArray(), $rows_style);
$styled_rows[] = $this->createRow($row->toArray(), $rows_style, $column_styles);
}
$writer->addRows($styled_rows);
}
Expand All @@ -215,7 +227,7 @@ private function writeRowsFromGenerator($writer, Generator $generator, ?callable
$this->writeHeader($writer, $item);
}
// Write rows (one by one).
$writer->addRow(Row::fromValues($item->toArray(), $this->rows_style));
$writer->addRow($this->createRow($item->toArray(), $this->rows_style, $this->column_styles));
}
}

Expand All @@ -236,7 +248,7 @@ private function writeHeader($writer, $first_row)
}

$keys = array_keys(is_array($first_row) ? $first_row : $first_row->toArray());
$writer->addRow(Row::fromValues($keys, $this->header_style));
$writer->addRow($this->createRow($keys, $this->header_style));
// $writer->addRow(WriterEntityFactory::createRowFromArray($keys, $this->header_style));
}

Expand Down Expand Up @@ -280,7 +292,7 @@ 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);
return is_string($value) || is_int($value) || is_float($value) || $value instanceof DateTimeInterface;
});
}

Expand All @@ -307,4 +319,14 @@ public function rowsStyle(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);
}
}
26 changes: 26 additions & 0 deletions tests/FastExcelTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

use OpenSpout\Common\Entity\Style\Color;
use OpenSpout\Common\Entity\Style\Style;
use OpenSpout\Common\Exception\IOException;
use OpenSpout\Reader\XLSX\Options;
use Rap2hpoutre\FastExcel\FastExcel;
use Rap2hpoutre\FastExcel\SheetCollection;
Expand All @@ -13,6 +14,31 @@
*/
class FastExcelTest extends TestCase
{
/**
* @throws IOException
* @throws \OpenSpout\Writer\Exception\WriterNotOpenedException
* @throws \OpenSpout\Reader\Exception\ReaderNotOpenedException
* @throws \OpenSpout\Common\Exception\UnsupportedTypeException
* @throws \OpenSpout\Common\Exception\InvalidArgumentException
*/
public function testExportXlsxWithDates()
{
$collection = collect([
['col1' => new \DateTimeImmutable('1980-09-18 00:00:00.000000')],
['col1' => new \DateTimeImmutable('2018-07-02 00:00:00.000000')],
]);

$file = __DIR__.'/test-dates-export.xlsx';
(new FastExcel(clone $collection))
->setColumnStyles([
0 => (new Style())->setFormat('mm/dd/yyyy'),
])
->export($file);

$this->assertEquals($collection, (new FastExcel())->import($file));
unlink($file);
}

/**
* @throws \OpenSpout\Common\Exception\IOException
* @throws \OpenSpout\Common\Exception\UnsupportedTypeException
Expand Down
Loading