Skip to content
This repository has been archived by the owner on May 26, 2022. It is now read-only.

Add column width settings #872

Closed
wants to merge 1 commit into from
Closed
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
23 changes: 23 additions & 0 deletions src/Spout/Writer/Common/Entity/Sheet.php
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,10 @@ class Sheet

/** @var SheetManager Sheet manager */
private $sheetManager;
/**
* @var array<int, int>
*/
private $columnWidths = [];

/**
* @param int $sheetIndex Index of the sheet, based on order in the workbook (zero-based)
Expand Down Expand Up @@ -108,4 +112,23 @@ public function setIsVisible($isVisible)

return $this;
}

/**
* @return array<int, int>
*/
public function getColumnWidths()
{
return $this->columnWidths;
}

/**
* @param array<int, int> $columnWidths
* @return Sheet
*/
public function setColumnWidths(array $columnWidths)
{
$this->columnWidths = $columnWidths;

return $this;
}
}
37 changes: 36 additions & 1 deletion src/Spout/Writer/XLSX/Manager/WorksheetManager.php
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,9 @@ class WorksheetManager implements WorksheetManagerInterface
/** @var StringHelper String helper */
private $stringHelper;

/** @var bool */
private $isSheetDataStarted = false;

/**
* WorksheetManager constructor.
*
Expand Down Expand Up @@ -107,7 +110,35 @@ public function startSheet(Worksheet $worksheet)
$worksheet->setFilePointer($sheetFilePointer);

\fwrite($sheetFilePointer, self::SHEET_XML_FILE_HEADER);
\fwrite($sheetFilePointer, '<sheetData>');
}

/**
* @param Worksheet $worksheet The worksheet to start data to
* @return void
*/
private function startSheetData(Worksheet $worksheet)
{
if ($this->isSheetDataStarted) {
return;
}

$columnWidths = $worksheet->getExternalSheet()->getColumnWidths();
if ($columnWidths !== []) {
$columnWidthsSpec = '<cols>';
foreach ($columnWidths as $columnIndex => $columnWidth) {
$columnWidthsSpec .= sprintf(
'<col min="%1$s" max="%1$s" width="%2$s" customWidth="true"/>',
$columnIndex,
$columnWidth
);
}
$columnWidthsSpec .= '</cols>';
\fwrite($worksheet->getFilePointer(), $columnWidthsSpec);
}

\fwrite($worksheet->getFilePointer(), '<sheetData>');

$this->isSheetDataStarted = true;
}

/**
Expand Down Expand Up @@ -147,6 +178,8 @@ public function addRow(Worksheet $worksheet, Row $row)
*/
private function addNonEmptyRow(Worksheet $worksheet, Row $row)
{
$this->startSheetData($worksheet);

$rowStyle = $row->getStyle();
$rowIndexOneBased = $worksheet->getLastWrittenRowIndex() + 1;
$numCells = $row->getNumCells();
Expand Down Expand Up @@ -286,6 +319,8 @@ public function close(Worksheet $worksheet)
return;
}

$this->startSheetData($worksheet);

\fwrite($worksheetFilePointer, '</sheetData>');
\fwrite($worksheetFilePointer, '</worksheet>');
\fclose($worksheetFilePointer);
Expand Down
28 changes: 28 additions & 0 deletions tests/Spout/Writer/XLSX/SheetTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,34 @@ public function testSetSheetVisibilityShouldCreateSheetHidden()
$this->assertStringContainsString(' state="hidden"', $xmlContents, 'The sheet visibility should have been changed to "hidden"');
}

/**
* @return void
*/
public function testSetSheetColumnWidthsShouldCreateSheetWidthCustomWidths()
{
$fileName = 'test_set_column_widths.xlsx';
$this->createGeneratedFolderIfNeeded($fileName);
$resourcePath = $this->getGeneratedResourcePath($fileName);

$writer = WriterEntityFactory::createXLSXWriter();
$writer->openToFile($resourcePath);

$sheet = $writer->getCurrentSheet();
$sheet->setColumnWidths([
1 => 10,
3 => 40,
]);

$writer->addRow($this->createRowFromValues(['xlsx--11', 'xlsx--12']));
$writer->close();

$resourcePath = $this->getGeneratedResourcePath($fileName);
$pathToWorkbookFile = $resourcePath . '#xl/worksheets/sheet1.xml';
$xmlContents = file_get_contents('zip://' . $pathToWorkbookFile);

$this->assertStringContainsString('<cols>', $xmlContents);
}

/**
* @param string $fileName
* @param string $sheetName
Expand Down