Not just another custom column widths PR

.gitignore

@@ -1,7 +1,7 @@
 /.idea
 *.iml
 
-/tests/resources/generated
+/tests/**/resources/generated
 /tests/coverage
 /vendor
 /composer.lock

src/Spout/Writer/Common/Entity/Options.php

@@ -20,4 +20,9 @@ abstract class Options
 
     // XLSX specific options
     const SHOULD_USE_INLINE_STRINGS = 'shouldUseInlineStrings';
+
+    // Cell size options
+    const DEFAULT_COLUMN_WIDTH = 'defaultColumnWidth';
+    const DEFAULT_ROW_HEIGHT = 'defaultRowHeight';
+    const COLUMN_WIDTHS = 'columnWidthDefinition';
 }

src/Spout/Writer/Common/Entity/Worksheet.php

@@ -23,6 +23,9 @@ class Worksheet
     /** @var int Index of the last written row */
     private $lastWrittenRowIndex;
 
+    /** @var bool has the sheet data header been written */
+    private $sheetDataStarted = false;
+
     /**
      * Worksheet constructor.
      *
@@ -36,6 +39,7 @@ public function __construct($worksheetFilePath, Sheet $externalSheet)
         $this->externalSheet = $externalSheet;
         $this->maxNumColumns = 0;
         $this->lastWrittenRowIndex = 0;
+        $this->sheetDataStarted = false;
     }
 
     /**
@@ -110,4 +114,20 @@ public function getId()
         // sheet index is zero-based, while ID is 1-based
         return $this->externalSheet->getIndex() + 1;
     }
+
+    /**
+     * @return bool
+     */
+    public function getSheetDataStarted()
+    {
+        return $this->sheetDataStarted;
+    }
+
+    /**
+     * @param bool $sheetDataStarted
+     */
+    public function setSheetDataStarted($sheetDataStarted)
+    {
+        $this->sheetDataStarted = $sheetDataStarted;
+    }
 }

src/Spout/Writer/Common/Manager/ManagesCellSize.php

@@ -0,0 +1,63 @@
+<?php
+
+namespace Box\Spout\Writer\Common\Manager;
+
+trait ManagesCellSize
+{
+    /** @var float|null The default column width to use */
+    private $defaultColumnWidth;
+
+    /** @var float|null The default row height to use */
+    private $defaultRowHeight;
+
+    /** @var array Array of min-max-width arrays */
+    private $columnWidths = [];
+
+    /**
+     * @param float|null $width
+     */
+    public function setDefaultColumnWidth($width)
+    {
+        $this->defaultColumnWidth = $width;
+    }
+
+    /**
+     * @param float|null $height
+     */
+    public function setDefaultRowHeight($height)
+    {
+        $this->defaultRowHeight = $height;
+    }
+
+    /**
+     * @param float $width
+     * @param array $columns One or more columns with this width
+     */
+    public function setColumnWidth(float $width, ...$columns)
+    {
+        // Gather sequences
+        $sequence = [];
+        foreach ($columns as $i) {
+            $sequenceLength = count($sequence);
+            if ($sequenceLength > 0) {
+                $previousValue = $sequence[$sequenceLength - 1];
+                if ($i !== $previousValue + 1) {
+                    $this->setColumnWidthForRange($width, $sequence[0], $previousValue);
+                    $sequence = [];
+                }
+            }
+            $sequence[] = $i;
+        }
+        $this->setColumnWidthForRange($width, $sequence[0], $sequence[count($sequence) - 1]);
+    }
+
+    /**
+     * @param float $width The width to set
+     * @param int $start First column index of the range
+     * @param int $end Last column index of the range
+     */
+    public function setColumnWidthForRange(float $width, int $start, int $end)
+    {
+        $this->columnWidths[] = [$start, $end, $width];
+    }
+}

src/Spout/Writer/Common/Manager/WorkbookManagerAbstract.php

@@ -15,7 +15,6 @@
 use Box\Spout\Writer\Common\Manager\Style\StyleManagerInterface;
 use Box\Spout\Writer\Common\Manager\Style\StyleMerger;
 use Box\Spout\Writer\Exception\SheetNotFoundException;
-use Box\Spout\Writer\Exception\WriterException;
 
 /**
  * Class WorkbookManagerAbstract
@@ -103,7 +102,6 @@ public function getWorkbook()
      * Creates a new sheet in the workbook and make it the current sheet.
      * The writing will resume where it stopped (i.e. data won't be truncated).
      *
-     * @throws IOException If unable to open the sheet for writing
      * @return Worksheet The created sheet
      */
     public function addNewSheetAndMakeItCurrent()
@@ -117,7 +115,7 @@ public function addNewSheetAndMakeItCurrent()
     /**
      * Creates a new sheet in the workbook. The current sheet remains unchanged.
      *
-     * @throws \Box\Spout\Common\Exception\IOException If unable to open the sheet for writing
+     * @throws IOException
      * @return Worksheet The created sheet
      */
     private function addNewSheet()
@@ -157,6 +155,16 @@ public function getCurrentWorksheet()
         return $this->currentWorksheet;
     }
 
+    /**
+     * Starts the current sheet and opens the file pointer
+     *
+     * @throws IOException
+     */
+    public function startCurrentSheet()
+    {
+        $this->worksheetManager->startSheet($this->getCurrentWorksheet());
+    }
+
     /**
      * Sets the given sheet as the current one. New data will be written to this sheet.
      * The writing will resume where it stopped (i.e. data won't be truncated).
@@ -210,8 +218,9 @@ private function getWorksheetFromExternalSheet($sheet)
      * with the creation of new worksheets if one worksheet has reached its maximum capicity.
      *
      * @param Row $row The row to be added
+     *
      * @throws IOException If trying to create a new sheet and unable to open the sheet for writing
-     * @throws WriterException If unable to write data
+     * @throws \Box\Spout\Common\Exception\InvalidArgumentException
      * @return void
      */
     public function addRowToCurrentWorksheet(Row $row)
@@ -249,7 +258,9 @@ private function hasCurrentWorksheetReachedMaxRows()
      *
      * @param Worksheet $worksheet Worksheet to write the row to
      * @param Row $row The row to be added
-     * @throws WriterException If unable to write data
+     *
+     * @throws IOException
+     * @throws \Box\Spout\Common\Exception\InvalidArgumentException
      * @return void
      */
     private function addRowToWorksheet(Worksheet $worksheet, Row $row)
@@ -276,6 +287,41 @@ private function applyDefaultRowStyle(Row $row)
         }
     }
 
+    /**
+     * @param float $width
+     */
+    public function setDefaultColumnWidth(float $width)
+    {
+        $this->worksheetManager->setDefaultColumnWidth($width);
+    }
+
+    /**
+     * @param float $height
+     */
+    public function setDefaultRowHeight(float $height)
+    {
+        $this->worksheetManager->setDefaultRowHeight($height);
+    }
+
+    /**
+     * @param float $width
+     * @param array $columns One or more columns with this width
+     */
+    public function setColumnWidth(float $width, ...$columns)
+    {
+        $this->worksheetManager->setColumnWidth($width, ...$columns);
+    }
+
+    /**
+     * @param float $width The width to set
+     * @param int $start First column index of the range
+     * @param int $end Last column index of the range
+     */
+    public function setColumnWidthForRange(float $width, int $start, int $end)
+    {
+        $this->worksheetManager->setColumnWidthForRange($width, $start, $end);
+    }
+
     /**
      * Closes the workbook and all its associated sheets.
      * All the necessary files are written to disk and zipped together to create the final file.

src/Spout/Writer/Common/Manager/WorkbookManagerInterface.php

@@ -42,6 +42,21 @@ public function getWorksheets();
      */
     public function getCurrentWorksheet();
 
+    /**
+     * Starts the current sheet and opens its file pointer
+     */
+    public function startCurrentSheet();
+
+    /**
+     * @param float $width
+     */
+    public function setDefaultColumnWidth(float $width);
+
+    /**
+     * @param float $height
+     */
+    public function setDefaultRowHeight(float $height);
+
     /**
      * Sets the given sheet as the current one. New data will be written to this sheet.
      * The writing will resume where it stopped (i.e. data won't be truncated).

src/Spout/Writer/Common/Manager/WorksheetManagerInterface.php

@@ -11,6 +11,29 @@
  */
 interface WorksheetManagerInterface
 {
+    /**
+     * @param float|null $width
+     */
+    public function setDefaultColumnWidth($width);
+
+    /**
+     * @param float|null $height
+     */
+    public function setDefaultRowHeight($height);
+
+    /**
+     * @param float $width
+     * @param array $columns One or more columns with this width
+     */
+    public function setColumnWidth(float $width, ...$columns);
+
+    /**
+     * @param float $width The width to set
+     * @param int $start First column index of the range
+     * @param int $end Last column index of the range
+     */
+    public function setColumnWidthForRange(float $width, int $start, int $end);
+
     /**
      * Adds a row to the worksheet.
      *

src/Spout/Writer/ODS/Creator/ManagerFactory.php

@@ -93,7 +93,7 @@ private function createStyleManager(OptionsManagerInterface $optionsManager)
     {
         $styleRegistry = $this->createStyleRegistry($optionsManager);
 
-        return new StyleManager($styleRegistry);
+        return new StyleManager($styleRegistry, $optionsManager);
     }
 
     /**

src/Spout/Writer/ODS/Manager/OptionsManager.php

@@ -34,6 +34,9 @@ protected function getSupportedOptions()
             Options::TEMP_FOLDER,
             Options::DEFAULT_ROW_STYLE,
             Options::SHOULD_CREATE_NEW_SHEETS_AUTOMATICALLY,
+            Options::DEFAULT_COLUMN_WIDTH,
+            Options::DEFAULT_ROW_HEIGHT,
+            Options::COLUMN_WIDTHS,
         ];
     }