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

Enable est column width calculation #866

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open

Enable est column width calculation #866

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
4f0e72c
Enable est column width calculation
xwiz Feb 4, 2022
d53be7b
Improve logic
xwiz Feb 4, 2022
8ba78df
Improve fixed width settings
xwiz Feb 5, 2022
a41040d
Minor fixes
xwiz Feb 5, 2022
88afc3d
Merge branch 'master' into width_fix
xwiz Feb 5, 2022
1b45aff
Change to mb_strlen
xwiz Feb 12, 2022
ea22cac
Merge branch 'width_fix' of github.com:xwiz/spout into width_fix
xwiz Feb 12, 2022
0a56c40
Add alternative width calculation option with empty space
xwiz Feb 12, 2022
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: 2 additions & 0 deletions src/Spout/Writer/Common/Entity/Options.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ abstract class Options
// Multisheets options
public const TEMP_FOLDER = 'tempFolder';
public const DEFAULT_ROW_STYLE = 'defaultRowStyle';
public const ROWWIDTH_CALC_STYLE = 'rowCalcMethod';
public const ROWWIDTH_FIXED = 'rowFixedWith';
public const SHOULD_CREATE_NEW_SHEETS_AUTOMATICALLY = 'shouldCreateNewSheetsAutomatically';

// XLSX specific options
Expand Down
113 changes: 113 additions & 0 deletions src/Spout/Writer/Common/Entity/Worksheet.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,21 @@ class Worksheet

/** @var int Index of the last written row */
private $lastWrittenRowIndex;

/** @var array Array of the column widths */
protected $columnWidths;

/** @var int Width calculation style */
protected $widthCalcuationStyle;

/** @var int Fixed sheet width for fixed width calculation style */
protected $fixedSheetWidth;

public const W_FULL = 1;
public const W_FIXED = 2;
public const W_NONE = 0;
public const DEFAULT_COL_WIDTH = 30;
public const DEFAULT_FIXED_WIDTH = 320;

/**
* Worksheet constructor.
Expand All @@ -36,6 +51,8 @@ public function __construct($worksheetFilePath, Sheet $externalSheet)
$this->externalSheet = $externalSheet;
$this->maxNumColumns = 0;
$this->lastWrittenRowIndex = 0;
$this->columnWidths = [];
$this->widthCalcuationStyle = 0;
}

/**
Expand Down Expand Up @@ -78,6 +95,79 @@ public function getMaxNumColumns()
return $this->maxNumColumns;
}

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

/**
* Gets the calculated max column width for the specified index
* @param int $zeroBasedIndex
* @return int
*/
public function getMaxColumnWidth($zeroBasedIndex)
{
if (isset($this->columnWidths[$zeroBasedIndex])) {
return $this->columnWidths[$zeroBasedIndex];
}

$this->columnWidths[$zeroBasedIndex] = self::DEFAULT_COL_WIDTH;
return $this->columnWidths[$zeroBasedIndex];
}

/**
* Sets the calculated max column width for the specified index
* @param int $zeroBasedIndex
* @param int $value Value to set to
* @return void
*/
public function setMaxColumnWidth($zeroBasedIndex, $value)
{
$curSize = $this->columnWidths[$zeroBasedIndex] ?? 0;
if ($curSize < $value) {
$this->columnWidths[$zeroBasedIndex] = $value;
}
}

/**
* Automatically calculates and sets the max column width for the specified cell
* @param Cell $cell The cell
* @param Style $style Row/Cell style
* @param int $zeroBasedIndex of cell
* @return void
*/
public function autoSetWidth($cell, $style, $zeroBasedIndex)
{
$size = 1 + strlen($cell->getValue());//ensure we have at least 1 space
$size *= $style->isFontBold() ? 1.2 : 1.0;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How did you come up with the 1.2 ratio?

Copy link
Author

@xwiz xwiz Feb 12, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's actually meant to be 700/400.. but the 1.2 seemed to fit better.. and that may be because tinier letters like 'i', like you rightly pointed out; occupy less space..

$this->setMaxColumnWidth($zeroBasedIndex, $size);
}

/**
* Gets the fixed sheet width or returns the default if not available
* @return int
*/
public function getFixedSheetWidth()
{
if (!$this->fixedSheetWidth) {
return Worksheet::DEFAULT_FIXED_WIDTH;
}
return $this->fixedSheetWidth;
}

/**
* Sets the fixed sheet width
* @param int $width
* @return void
*/
public function setFixedSheetWidth($width)
{
$this->fixedSheetWidth = $width;
}

/**
* @param int $maxNumColumns
*/
Expand All @@ -86,6 +176,29 @@ public function setMaxNumColumns($maxNumColumns)
$this->maxNumColumns = $maxNumColumns;
}

/**
* Set the with calculation style for this sheet.
* 1=FullExpand,2=FixedWidth,0=None
*
* @return Worksheet Enable method chaining for easy set width
*/
public function setWidthCalculation($widthStyle)
{
$this->widthCalcuationStyle = $widthStyle;
return $this;
}

/**
* Get the with calculation style for this sheet.
* 1=FullExpand,2=FixedWidth,0=None
*
* @return void
*/
public function getWidthCalculation()
{
return $this->widthCalcuationStyle;
}

/**
* @return int
*/
Expand Down
31 changes: 31 additions & 0 deletions src/Spout/Writer/Common/Helper/AppendHelper.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
<?php

namespace Box\Spout\Writer\Common\Helper;

class AppendHelper {

/**
* Instead of seeking and re-writing from position, a better hack might be to write dummy empty data
* Enough to take care of any length, then carefully overwrite
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, that's the strategy I've used elsewhere

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@adrilo Benchmark result with overwriting empty spaces... (negligible again but may be useful)

image

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tested 5,000 rows, 500,000 rows and 50,000 rows... The script is included below..

<?php

use Box\Spout\Common\Type;
use Box\Spout\Writer\Common\Creator\Style\StyleBuilder;
use Box\Spout\Writer\Common\Creator\WriterEntityFactory;

require __DIR__ . '/vendor/autoload.php';
ini_set('memory_limit', -1);

function generateRows()
{
    $headers = [];
    for($i=0;$i<10;$i++) {
        $n = $i+1;
        $headers[] = "COL-$n";
    }
    
    yield $headers;
    
    for($i=0; $i< 500000; $i++) {
        $row = [];
        $rand = mt_rand(1, 30);
        foreach ($headers as $header) {
            $randLen = mt_rand(1, $rand);
            $row[] = generateRandomString($randLen);
        }
        yield $row;
    }
}

function generateRandomString($length = 10) {
    $characters = 'aaaaeeeeiiiiiiiioooouuuubcdefghijklmnopqrstuvwxyz';
    $charactersLength = strlen($characters);
    $randomString = '';
    for ($i = 0; $i < $length; $i++) {
        $randomString .= $characters[rand(0, $charactersLength - 1)];
    }
    return $randomString;
}

$data = generateRows();
$defaultStyle = (new StyleBuilder())
    ->setFontSize(36)
    ->build();
$boldtyle = (new StyleBuilder())
    ->setFontSize(42)
    ->setFontBold()
    ->build();
//$writer = WriterEntityFactory::createWriter(Type::ODS);
$start = hrtime(true);
$writer = WriterEntityFactory::createWriter(Type::XLSX);
$writer->setWidthCalculation(1)->setDefaultRowStyle($defaultStyle)->openToFile('spout_trunk.xlsx');
//$writer->openToFile('spouter.xlsx');

foreach ($data as $i => $row) {
    if ($i == 0) {
        $writer->addRow(WriterEntityFactory::createRowFromArray($row, $boldtyle));
    } else {
        $writer->addRow(WriterEntityFactory::createRowFromArray($row));
    }
}

$writer->close();

$end = hrtime(true);
$elapsed = ($end - $start)/1000000.0;
echo "$elapsed ms counted with truncate".PHP_EOL;


$data = generateRows();
$start = hrtime(true);
$writer = WriterEntityFactory::createWriter(Type::XLSX);
//width calculation style 3 just for testing purposes
$writer->setWidthCalculation(3)->setDefaultRowStyle($defaultStyle)->openToFile('spout_over.xlsx');
//$writer->openToFile('spouter.xlsx');

foreach ($data as $i => $row) {
    if ($i == 0) {
        $writer->addRow(WriterEntityFactory::createRowFromArray($row, $boldtyle));
    } else {
        $writer->addRow(WriterEntityFactory::createRowFromArray($row));
    }
}

$writer->close();

$end = hrtime(true);
$elapsed = ($end - $start)/1000000.0;

echo "$elapsed ms counted with overwrite";

*
*/

/**
* This function will truncate from specified position
* Write data to be inserted and re-append the truncated data
*
* @param $fp Pointer to file only
* @param $pos Position to insert
* @param $content Content to insert
*/
public static function insertToFile($fp, $pos, $content)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can be very costly to rewrite the contents, especially with large spreadsheet

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

True, I will try both approaches and do a benchmark today. It didn't seem to matter for small files.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@adrilo So I ran some tests and this is not actually a bad solution at all... (performance differences range from 3% to 7% and seems to get better for larger amount of rows).. (Only tested 100,000, 500,000 and 1 million rows though)

The difference are quite negligible most likely because the file is still in memory the whole time and the only costly operation here is really calling stream_get_contents.

image
image

{
fseek($fp, $pos);
$trailer = stream_get_contents($fp);
ftruncate($fp, $pos);
fseek($fp, $pos);
fwrite($fp, $content);
fwrite($fp, $trailer);
return $fp;
}
}
7 changes: 4 additions & 3 deletions src/Spout/Writer/ODS/Creator/ManagerFactory.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ public function createWorkbookManager(OptionsManagerInterface $optionsManager)

$styleMerger = $this->createStyleMerger();
$styleManager = $this->createStyleManager($optionsManager);
$worksheetManager = $this->createWorksheetManager($styleManager, $styleMerger);
$worksheetManager = $this->createWorksheetManager($optionsManager, $styleManager, $styleMerger);

return new WorkbookManager(
$workbook,
Expand All @@ -63,16 +63,17 @@ public function createWorkbookManager(OptionsManagerInterface $optionsManager)
}

/**
* @param OptionsManagerInterface $optionsManager
* @param StyleManager $styleManager
* @param StyleMerger $styleMerger
* @return WorksheetManager
*/
private function createWorksheetManager(StyleManager $styleManager, StyleMerger $styleMerger)
private function createWorksheetManager(OptionsManagerInterface $optionsManager, StyleManager $styleManager, StyleMerger $styleMerger)
{
$stringsEscaper = $this->helperFactory->createStringsEscaper();
$stringsHelper = $this->helperFactory->createStringHelper();

return new WorksheetManager($styleManager, $styleMerger, $stringsEscaper, $stringsHelper);
return new WorksheetManager($optionsManager, $styleManager, $styleMerger, $stringsEscaper, $stringsHelper);
}

/**
Expand Down
2 changes: 1 addition & 1 deletion src/Spout/Writer/ODS/Helper/FileSystemHelper.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ public function createContentFile($worksheetManager, $styleManager, $worksheets)
EOD;

$contentXmlFileContents .= $styleManager->getContentXmlFontFaceSectionContent();
$contentXmlFileContents .= $styleManager->getContentXmlAutomaticStylesSectionContent($worksheets);
$contentXmlFileContents .= $styleManager->getContentXmlAutomaticStylesSectionContent($worksheetManager, $worksheets);

$contentXmlFileContents .= '<office:body><office:spreadsheet>';

Expand Down
3 changes: 3 additions & 0 deletions src/Spout/Writer/ODS/Manager/OptionsManager.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ protected function getSupportedOptions()
return [
Options::TEMP_FOLDER,
Options::DEFAULT_ROW_STYLE,
Options::ROWWIDTH_CALC_STYLE,
Options::ROWWIDTH_FIXED,
Options::SHOULD_CREATE_NEW_SHEETS_AUTOMATICALLY,
];
}
Expand All @@ -45,5 +47,6 @@ protected function setDefaultOptions()
$this->setOption(Options::TEMP_FOLDER, \sys_get_temp_dir());
$this->setOption(Options::DEFAULT_ROW_STYLE, $this->styleBuilder->build());
$this->setOption(Options::SHOULD_CREATE_NEW_SHEETS_AUTOMATICALLY, true);
$this->setOption(Options::ROWWIDTH_CALC_STYLE, 0);
}
}
5 changes: 4 additions & 1 deletion src/Spout/Writer/ODS/Manager/Style/StyleManager.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,13 +151,16 @@ public function getContentXmlFontFaceSectionContent()
/**
* Returns the contents of the "<office:automatic-styles>" section, inside "content.xml" file.
*
* @param WorksheetManager $manager
* @param Worksheet[] $worksheets
* @return string
*/
public function getContentXmlAutomaticStylesSectionContent($worksheets)
public function getContentXmlAutomaticStylesSectionContent($manager, $worksheets)
{
$content = '<office:automatic-styles>';

$content .= $manager->getWidthStylesContent($worksheets[0]);

foreach ($this->styleRegistry->getRegisteredStyles() as $style) {
$content .= $this->getStyleSectionContent($style);
}
Expand Down
74 changes: 72 additions & 2 deletions src/Spout/Writer/ODS/Manager/WorksheetManager.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@
use Box\Spout\Common\Exception\IOException;
use Box\Spout\Common\Helper\Escaper\ODS as ODSEscaper;
use Box\Spout\Common\Helper\StringHelper;
use Box\Spout\Common\Manager\OptionsManagerInterface;
use Box\Spout\Writer\Common\Helper\AppendHelper;
use Box\Spout\Writer\Common\Entity\Options;
use Box\Spout\Writer\Common\Entity\Worksheet;
use Box\Spout\Writer\Common\Manager\RegisteredStyle;
use Box\Spout\Writer\Common\Manager\Style\StyleMerger;
Expand All @@ -33,20 +36,33 @@ class WorksheetManager implements WorksheetManagerInterface
/** @var StyleMerger Helper to merge styles together */
private $styleMerger;

/** $int file pointer head position */
private $headWritePosition;

/** @var int Width calculation style */
protected $widthCalcuationStyle;

/** @var int Fixed Width */
protected $fixedWidth;

/**
* WorksheetManager constructor.
*
* @param OptionsManagerInterface $optionsManager
* @param StyleManager $styleManager
* @param StyleMerger $styleMerger
* @param ODSEscaper $stringsEscaper
* @param StringHelper $stringHelper
*/
public function __construct(
OptionsManagerInterface $optionsManager,
StyleManager $styleManager,
StyleMerger $styleMerger,
ODSEscaper $stringsEscaper,
StringHelper $stringHelper
) {
$this->widthCalcuationStyle = $optionsManager->getOption(Options::ROWWIDTH_CALC_STYLE);
$this->fixedWidth = $optionsManager->getOption(Options::ROWWIDTH_FIXED);
$this->styleManager = $styleManager;
$this->styleMerger = $styleMerger;
$this->stringsEscaper = $stringsEscaper;
Expand All @@ -62,9 +78,15 @@ public function __construct(
*/
public function startSheet(Worksheet $worksheet)
{
$sheetFilePointer = \fopen($worksheet->getFilePath(), 'w');
$sheetFilePointer = \fopen($worksheet->getFilePath(), 'w+');
$this->throwIfSheetFilePointerIsNotAvailable($sheetFilePointer);

$worksheet->setWidthCalculation($this->widthCalcuationStyle);
$worksheet->setFixedSheetWidth($this->fixedWidth);
if ($worksheet->getWidthCalculation() != Worksheet::W_NONE) {
$this->headWritePosition = ftell($sheetFilePointer);
}

$worksheet->setFilePointer($sheetFilePointer);
}

Expand Down Expand Up @@ -95,7 +117,15 @@ public function getTableElementStartAsString(Worksheet $worksheet)
$tableStyleName = 'ta' . ($externalSheet->getIndex() + 1);

$tableElement = '<table:table table:style-name="' . $tableStyleName . '" table:name="' . $escapedSheetName . '">';
$tableElement .= '<table:table-column table:default-cell-style-name="ce1" table:style-name="co1" table:number-columns-repeated="' . $worksheet->getMaxNumColumns() . '"/>';

if ($worksheet->getWidthCalculation() != Worksheet::W_NONE) {
foreach ($worksheet->getColumnWidths() as $i => $w){
$colNo = $i + 1;
$tableElement .= '<table:table-column table:default-cell-style-name="ce1" table:style-name="co'.$colNo.'"/>';
}
} else {
$tableElement .= '<table:table-column table:default-cell-style-name="ce1" table:style-name="co1" table:number-columns-repeated="' . $worksheet->getMaxNumColumns() . '"/>';
}

return $tableElement;
}
Expand Down Expand Up @@ -125,6 +155,10 @@ public function addRow(Worksheet $worksheet, Row $row)
/** @var Cell|null $nextCell */
$nextCell = isset($cells[$nextCellIndex]) ? $cells[$nextCellIndex] : null;

if ($worksheet->getWidthCalculation() != Worksheet::W_NONE) {
$worksheet->autoSetWidth($cell, $rowStyle, $i);
}

if ($nextCell === null || $cell->getValue() !== $nextCell->getValue()) {
$registeredStyle = $this->applyStyleAndRegister($cell, $rowStyle);
$cellStyle = $registeredStyle->getStyle();
Expand Down Expand Up @@ -249,6 +283,42 @@ private function getCellXML(Cell $cell, $styleIndex, $numTimesValueRepeated)
return $data;
}

/**
* Generate the related column widths style xml to be inserted in content.xml
* @param Worksheet $worksheet
* @return string
*/
public function getWidthStylesContent($worksheet)
{
if ($worksheet->getWidthCalculation() != Worksheet::W_NONE) {
//create the col styles
$style = '';
$widths = $worksheet->getColumnWidths();
//todo: this may not be adequate for multiple worksheets

//re-calculate width for fixed sets
if ($worksheet->getWidthCalculation() == Worksheet::W_FIXED) {
$total = array_sum($widths);
foreach($widths as $i => $w) {
$wr = ($w / $total) * $worksheet->getFixedSheetWidth();
$widths[$i] = $wr;
}
}

foreach ($widths as $i => $width){
//this is a rough equivalent based on pixel density,
$win = round($width / 9.6, 2);//convert to inches
$colNo = $i + 1;
$style .= '<style:style style:name="co'.$colNo.
'" style:family="table-column"><style:table-column-properties fo:break-before="auto" style:column-width="'.
$win.
'in"/></style:style>';
}
return $style;
}
return "";
}

/**
* Closes the worksheet
*
Expand Down
Loading