ODS writer

Added ODS writer
Refactored XLSX writer to abstract some pieces into an abstract multi-sheets writer
Created an abstract style helper
Moved shared components around

src/Spout/Common/Escaper/ODS.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace Box\Spout\Common\Escaper;
+
+/**
+ * Class ODS
+ * Provides functions to escape and unescape data for ODS files
+ *
+ * @package Box\Spout\Common\Escaper
+ */
+class ODS implements EscaperInterface
+{
+    /**
+     * Escapes the given string to make it compatible with XLSX
+     *
+     * @param string $string The string to escape
+     * @return string The escaped string
+     */
+    public function escape($string)
+    {
+        return htmlspecialchars($string, ENT_QUOTES);
+    }
+
+    /**
+     * Unescapes the given string to make it compatible with XLSX
+     *
+     * @param string $string The string to unescape
+     * @return string The unescaped string
+     */
+    public function unescape($string)
+    {
+        return htmlspecialchars_decode($string, ENT_QUOTES);
+    }
+}

src/Spout/Common/Type.php

@@ -8,6 +8,7 @@ namespace Box\Spout\Common;
  */
 abstract class Type
 {
-    const CSV = "csv";
-    const XLSX = "xlsx";
+    const CSV = 'csv';
+    const XLSX = 'xlsx';
+    const ODS = 'ods';
 }

src/Spout/Reader/Wrapper/XMLReader.php

@@ -104,6 +104,22 @@ class XMLReader extends \XMLReader
         return $wasReadSuccessful;
     }
 
+    /**
+     * Read until the element with the given name is found, or the end of the file.
+     *
+     * @param string $nodeName Name of the node to find
+     * @return bool TRUE on success or FALSE on failure
+     * @throws \Box\Spout\Reader\Exception\XMLProcessingException If an error/warning occurred
+     */
+    public function readUntilNodeFound($nodeName)
+    {
+        while (($wasReadSuccessful = $this->read()) && ($this->nodeType !== \XMLReader::ELEMENT || $this->name !== $nodeName)) {
+            // do nothing
+        }
+
+        return $wasReadSuccessful;
+    }
+
     /**
      * Move cursor to next node skipping all subtrees
      * @see \XMLReader::next

src/Spout/Reader/XLSX/Helper/SharedStringsHelper.php

@@ -79,6 +79,7 @@ class SharedStringsHelper
     {
         $xmlReader = new XMLReader();
         $sharedStringIndex = 0;
+        /** @noinspection PhpUnnecessaryFullyQualifiedNameInspection */
         $escaper = new \Box\Spout\Common\Escaper\XLSX();
 
         $sharedStringsFilePath = $this->getSharedStringsFilePath();
@@ -90,9 +91,7 @@ class SharedStringsHelper
             $sharedStringsUniqueCount = $this->getSharedStringsUniqueCount($xmlReader);
             $this->cachingStrategy = $this->getBestSharedStringsCachingStrategy($sharedStringsUniqueCount);
 
-            while ($xmlReader->read() && $xmlReader->name !== 'si') {
-                // do nothing until a 'si' tag is reached
-            }
+            $xmlReader->readUntilNodeFound('si');
 
             while ($xmlReader->name === 'si') {
                 $node = $this->getSimpleXmlElementNodeFromXMLReader($xmlReader);

src/Spout/Reader/XLSX/Helper/SheetHelper.php

@@ -126,6 +126,7 @@ class SheetHelper
                 $sheetId = (int) $sheetNode->getAttribute('sheetId');
                 $escapedSheetName = $sheetNode->getAttribute('name');
 
+                /** @noinspection PhpUnnecessaryFullyQualifiedNameInspection */
                 $escaper = new \Box\Spout\Common\Escaper\XLSX();
                 $sheetName = $escaper->unescape($escapedSheetName);
             }

src/Spout/Reader/XLSX/RowIterator.php

@@ -77,6 +77,7 @@ class RowIterator implements IteratorInterface
         $this->sharedStringsHelper = $sharedStringsHelper;
 
         $this->xmlReader = new XMLReader();
+        /** @noinspection PhpUnnecessaryFullyQualifiedNameInspection */
         $this->escaper = new \Box\Spout\Common\Escaper\XLSX();
     }
 

src/Spout/Writer/AbstractMultiSheetsWriter.php

@@ -0,0 +1,114 @@
+<?php
+
+namespace Box\Spout\Writer;
+
+use Box\Spout\Writer\Exception\WriterNotOpenedException;
+
+/**
+ * Class AbstractMultiSheetsWriter
+ *
+ * @package Box\Spout\Writer
+ * @abstract
+ */
+abstract class AbstractMultiSheetsWriter extends AbstractWriter
+{
+    /** @var bool Whether new sheets should be automatically created when the max rows limit per sheet is reached */
+    protected $shouldCreateNewSheetsAutomatically = true;
+
+    /**
+     * @return Common\WorkbookInterface The workbook representing the file to be written
+     */
+    abstract protected function getWorkbook();
+
+    /**
+     * Sets whether new sheets should be automatically created when the max rows limit per sheet is reached.
+     * This must be set before opening the writer.
+     *
+     * @param bool $shouldCreateNewSheetsAutomatically Whether new sheets should be automatically created when the max rows limit per sheet is reached
+     * @return AbstractMultiSheetsWriter
+     * @throws \Box\Spout\Writer\Exception\WriterAlreadyOpenedException If the writer was already opened
+     */
+    public function setShouldCreateNewSheetsAutomatically($shouldCreateNewSheetsAutomatically)
+    {
+        $this->throwIfWriterAlreadyOpened('Writer must be configured before opening it.');
+
+        $this->shouldCreateNewSheetsAutomatically = $shouldCreateNewSheetsAutomatically;
+        return $this;
+    }
+
+    /**
+     * Returns all the workbook's sheets
+     *
+     * @return Common\Sheet[] All the workbook's sheets
+     * @throws \Box\Spout\Writer\Exception\WriterNotOpenedException If the writer has not been opened yet
+     */
+    public function getSheets()
+    {
+        $this->throwIfBookIsNotAvailable();
+
+        $externalSheets = [];
+        $worksheets = $this->getWorkbook()->getWorksheets();
+
+        /** @var Common\WorksheetInterface $worksheet */
+        foreach ($worksheets as $worksheet) {
+            $externalSheets[] = $worksheet->getExternalSheet();
+        }
+
+        return $externalSheets;
+    }
+
+    /**
+     * Creates a new sheet and make it the current sheet. The data will now be written to this sheet.
+     *
+     * @return Common\Sheet The created sheet
+     * @throws \Box\Spout\Writer\Exception\WriterNotOpenedException If the writer has not been opened yet
+     */
+    public function addNewSheetAndMakeItCurrent()
+    {
+        $this->throwIfBookIsNotAvailable();
+        $worksheet = $this->getWorkbook()->addNewSheetAndMakeItCurrent();
+
+        return $worksheet->getExternalSheet();
+    }
+
+    /**
+     * Returns the current sheet
+     *
+     * @return Common\Sheet The current sheet
+     * @throws \Box\Spout\Writer\Exception\WriterNotOpenedException If the writer has not been opened yet
+     */
+    public function getCurrentSheet()
+    {
+        $this->throwIfBookIsNotAvailable();
+        return $this->getWorkbook()->getCurrentWorksheet()->getExternalSheet();
+    }
+
+    /**
+     * 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).
+     *
+     * @param Common\Sheet $sheet The sheet to set as current
+     * @return void
+     * @throws \Box\Spout\Writer\Exception\WriterNotOpenedException If the writer has not been opened yet
+     * @throws \Box\Spout\Writer\Exception\SheetNotFoundException If the given sheet does not exist in the workbook
+     */
+    public function setCurrentSheet($sheet)
+    {
+        $this->throwIfBookIsNotAvailable();
+        $this->getWorkbook()->setCurrentSheet($sheet);
+    }
+
+    /**
+     * Checks if the book has been created. Throws an exception if not created yet.
+     *
+     * @return void
+     * @throws \Box\Spout\Writer\Exception\WriterNotOpenedException If the book is not created yet
+     */
+    protected function throwIfBookIsNotAvailable()
+    {
+        if (!$this->getWorkbook()) {
+            throw new WriterNotOpenedException('The writer must be opened before performing this action.');
+        }
+    }
+}
+

src/Spout/Writer/AbstractWriter.php

@@ -4,6 +4,7 @@ namespace Box\Spout\Writer;
 
 use Box\Spout\Common\Exception\IOException;
 use Box\Spout\Common\Exception\InvalidArgumentException;
+use Box\Spout\Writer\Exception\WriterAlreadyOpenedException;
 use Box\Spout\Writer\Exception\WriterNotOpenedException;
 use Box\Spout\Writer\Style\StyleBuilder;
 
@@ -152,6 +153,21 @@ abstract class AbstractWriter implements WriterInterface
         }
     }
 
+    /**
+     * Checks if the writer has already been opened, since some actions must be done before it gets opened.
+     * Throws an exception if already opened.
+     *
+     * @param string $message Error message
+     * @return void
+     * @throws \Box\Spout\Writer\Exception\WriterAlreadyOpenedException If the writer was already opened and must not be.
+     */
+    protected function throwIfWriterAlreadyOpened($message)
+    {
+        if ($this->isWriterOpened) {
+            throw new WriterAlreadyOpenedException($message);
+        }
+    }
+
     /**
      * Write given data to the output. New data will be appended to end of stream.
      *

src/Spout/Writer/Common/Helper/AbstractStyleHelper.php

@@ -0,0 +1,136 @@
+<?php
+
+namespace Box\Spout\Writer\Common\Helper;
+
+/**
+ * Class AbstractStyleHelper
+ * This class provides helper functions to manage styles
+ *
+ * @package Box\Spout\Writer\Common\Helper
+ */
+abstract class AbstractStyleHelper
+{
+    /** @var array [SERIALIZED_STYLE] => [STYLE_ID] mapping table, keeping track of the registered styles */
+    protected $serializedStyleToStyleIdMappingTable = [];
+
+    /** @var array [STYLE_ID] => [STYLE] mapping table, keeping track of the registered styles */
+    protected $styleIdToStyleMappingTable = [];
+
+    /**
+     * @param \Box\Spout\Writer\Style\Style $defaultStyle
+     */
+    public function __construct($defaultStyle)
+    {
+        // This ensures that the default style is the first one to be registered
+        $this->registerStyle($defaultStyle);
+    }
+
+    /**
+     * Registers the given style as a used style.
+     * Duplicate styles won't be registered more than once.
+     *
+     * @param \Box\Spout\Writer\Style\Style $style The style to be registered
+     * @return \Box\Spout\Writer\Style\Style The registered style, updated with an internal ID.
+     */
+    public function registerStyle($style)
+    {
+        $serializedStyle = $style->serialize();
+
+        if (!$this->hasStyleAlreadyBeenRegistered($style)) {
+            $nextStyleId = count($this->serializedStyleToStyleIdMappingTable);
+            $style->setId($nextStyleId);
+
+            $this->serializedStyleToStyleIdMappingTable[$serializedStyle] = $nextStyleId;
+            $this->styleIdToStyleMappingTable[$nextStyleId] = $style;
+        }
+
+        return $this->getStyleFromSerializedStyle($serializedStyle);
+    }
+
+    /**
+     * Returns whether the given style has already been registered.
+     *
+     * @param \Box\Spout\Writer\Style\Style $style
+     * @return bool
+     */
+    protected function hasStyleAlreadyBeenRegistered($style)
+    {
+        $serializedStyle = $style->serialize();
+        return array_key_exists($serializedStyle, $this->serializedStyleToStyleIdMappingTable);
+    }
+
+    /**
+     * Returns the registered style associated to the given serialization.
+     *
+     * @param string $serializedStyle The serialized style from which the actual style should be fetched from
+     * @return \Box\Spout\Writer\Style\Style
+     */
+    protected function getStyleFromSerializedStyle($serializedStyle)
+    {
+        $styleId = $this->serializedStyleToStyleIdMappingTable[$serializedStyle];
+        return $this->styleIdToStyleMappingTable[$styleId];
+    }
+
+    /**
+     * @return \Box\Spout\Writer\Style\Style[] List of registered styles
+     */
+    protected function getRegisteredStyles()
+    {
+        return array_values($this->styleIdToStyleMappingTable);
+    }
+
+    /**
+     * Returns the default style
+     *
+     * @return \Box\Spout\Writer\Style\Style Default style
+     */
+    protected function getDefaultStyle()
+    {
+        // By construction, the default style has ID 0
+        return $this->styleIdToStyleMappingTable[0];
+    }
+
+    /**
+     * Apply additional styles if the given row needs it.
+     * Typically, set "wrap text" if a cell contains a new line.
+     *
+     * @param \Box\Spout\Writer\Style\Style $style The original style
+     * @param array $dataRow The row the style will be applied to
+     * @return \Box\Spout\Writer\Style\Style The updated style
+     */
+    public function applyExtraStylesIfNeeded($style, $dataRow)
+    {
+        $updatedStyle = $this->applyWrapTextIfCellContainsNewLine($style, $dataRow);
+        return $updatedStyle;
+    }
+
+    /**
+     * Set the "wrap text" option if a cell of the given row contains a new line.
+     *
+     * @NOTE: There is a bug on the Mac version of Excel (2011 and below) where new lines
+     *        are ignored even when the "wrap text" option is set. This only occurs with
+     *        inline strings (shared strings do work fine).
+     *        A workaround would be to encode "\n" as "_x000D_" but it does not work
+     *        on the Windows version of Excel...
+     *
+     * @param \Box\Spout\Writer\Style\Style $style The original style
+     * @param array $dataRow The row the style will be applied to
+     * @return \Box\Spout\Writer\Style\Style The eventually updated style
+     */
+    protected function applyWrapTextIfCellContainsNewLine($style, $dataRow)
+    {
+        // if the "wrap text" option is already set, no-op
+        if ($style->shouldWrapText()) {
+            return $style;
+        }
+
+        foreach ($dataRow as $cell) {
+            if (is_string($cell) && strpos($cell, "\n") !== false) {
+                $style->setShouldWrapText();
+                break;
+            }
+        }
+
+        return $style;
+    }
+}

src/Spout/Writer/Common/Helper/CellHelper.php

@@ -1,12 +1,12 @@
 <?php
 
-namespace Box\Spout\Writer\XLSX\Helper;
+namespace Box\Spout\Writer\Common\Helper;
 
 /**
  * Class CellHelper
  * This class provides helper functions when working with cells
  *
- * @package Box\Spout\Writer\XLSX\Helper
+ * @package Box\Spout\Writer\Common\Helper
  */
 class CellHelper
 {

src/Spout/Writer/Common/Helper/ZipHelper.php

@@ -1,15 +1,40 @@
 <?php
 
-namespace Box\Spout\Writer\XLSX\Helper;
+namespace Box\Spout\Writer\Common\Helper;
 
 /**
  * Class ZipHelper
  * This class provides helper functions to create zip files
  *
- * @package Box\Spout\Writer\XLSX\Helper
+ * @package Box\Spout\Writer\Common\Helper
  */
 class ZipHelper
 {
+    const ZIP_EXTENSION = '.zip';
+
+    /**
+     * Zips the root folder and streams the contents of the zip into the given stream
+     *
+     * @param string $folderPath Path to the folder to be zipped
+     * @param resource $streamPointer Pointer to the stream to copy the zip
+     * @return void
+     */
+    public function zipFolderAndCopyToStream($folderPath, $streamPointer)
+    {
+        $zipFilePath = $this->getZipFilePath($folderPath);
+        $this->zipFolder($folderPath, $zipFilePath);
+        $this->copyZipToStream($zipFilePath, $streamPointer);
+    }
+
+    /**
+     * @param string $folderPathToZip Path to the folder to be zipped
+     * @return string Path where the zip file of the given folder will be created
+     */
+    public function getZipFilePath($folderPathToZip)
+    {
+        return $folderPathToZip . self::ZIP_EXTENSION;
+    }
+
     /**
      * Zips the given folder
      *
@@ -59,4 +84,18 @@ class ZipHelper
         $realPath = realpath($path);
         return str_replace(DIRECTORY_SEPARATOR, '/', $realPath);
     }
+
+    /**
+     * Streams the contents of the zip file into the given stream
+     *
+     * @param string $zipFilePath Path to the zip file
+     * @param resource $pointer Pointer to the stream to copy the zip
+     * @return void
+     */
+    protected function copyZipToStream($zipFilePath, $pointer)
+    {
+        $zipFilePointer = fopen($zipFilePath, 'r');
+        stream_copy_to_stream($zipFilePointer, $pointer);
+        fclose($zipFilePointer);
+    }
 }

src/Spout/Writer/Common/Internal/AbstractWorkbook.php

@@ -0,0 +1,188 @@
+<?php
+
+namespace Box\Spout\Writer\Common\Internal;
+
+use Box\Spout\Writer\Exception\SheetNotFoundException;
+
+/**
+ * Class Workbook
+ * Represents a workbook within a spreadsheet file.
+ * It provides the functions to work with worksheets.
+ *
+ * @package Box\Spout\Writer\Common
+ */
+abstract class AbstractWorkbook implements WorkbookInterface
+{
+    /** @var bool Whether new sheets should be automatically created when the max rows limit per sheet is reached */
+    protected $shouldCreateNewSheetsAutomatically;
+
+    /** @var WorksheetInterface[] Array containing the workbook's sheets */
+    protected $worksheets = [];
+
+    /** @var WorksheetInterface The worksheet where data will be written to */
+    protected $currentWorksheet;
+
+    /**
+     * @param bool $shouldCreateNewSheetsAutomatically
+     * @param \Box\Spout\Writer\Style\Style $defaultRowStyle
+     * @throws \Box\Spout\Common\Exception\IOException If unable to create at least one of the base folders
+     */
+    public function __construct($shouldCreateNewSheetsAutomatically, $defaultRowStyle)
+    {
+        $this->shouldCreateNewSheetsAutomatically = $shouldCreateNewSheetsAutomatically;
+    }
+
+    /**
+     * @return \Box\Spout\Writer\Common\Helper\AbstractStyleHelper The specific style helper
+     */
+    abstract protected function getStyleHelper();
+
+    /**
+     * @return int Maximum number of rows/columns a sheet can contain
+     */
+    abstract protected function getMaxRowsPerWorksheet();
+
+    /**
+     * Creates a new sheet in the workbook. The current sheet remains unchanged.
+     *
+     * @return WorksheetInterface The created sheet
+     * @throws \Box\Spout\Common\Exception\IOException If unable to open the sheet for writing
+     */
+    abstract public function addNewSheet();
+
+    /**
+     * 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).
+     *
+     * @return WorksheetInterface The created sheet
+     * @throws \Box\Spout\Common\Exception\IOException If unable to open the sheet for writing
+     */
+    public function addNewSheetAndMakeItCurrent()
+    {
+        $worksheet = $this->addNewSheet();
+        $this->setCurrentWorksheet($worksheet);
+
+        return $worksheet;
+    }
+
+    /**
+     * @return WorksheetInterface[] All the workbook's sheets
+     */
+    public function getWorksheets()
+    {
+        return $this->worksheets;
+    }
+
+    /**
+     * Returns the current sheet
+     *
+     * @return WorksheetInterface The current sheet
+     */
+    public function getCurrentWorksheet()
+    {
+        return $this->currentWorksheet;
+    }
+
+    /**
+     * 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).
+     *
+     * @param \Box\Spout\Writer\Common\Sheet $sheet The "external" sheet to set as current
+     * @return void
+     * @throws \Box\Spout\Writer\Exception\SheetNotFoundException If the given sheet does not exist in the workbook
+     */
+    public function setCurrentSheet($sheet)
+    {
+        $worksheet = $this->getWorksheetFromExternalSheet($sheet);
+        if ($worksheet !== null) {
+            $this->currentWorksheet = $worksheet;
+        } else {
+            throw new SheetNotFoundException('The given sheet does not exist in the workbook.');
+        }
+    }
+
+    /**
+     * @param WorksheetInterface $worksheet
+     * @return void
+     */
+    protected function setCurrentWorksheet($worksheet)
+    {
+        $this->currentWorksheet = $worksheet;
+    }
+
+    /**
+     * Returns the worksheet associated to the given external sheet.
+     *
+     * @param \Box\Spout\Writer\Common\Sheet $sheet
+     * @return WorksheetInterface|null The worksheet associated to the given external sheet or null if not found.
+     */
+    protected function getWorksheetFromExternalSheet($sheet)
+    {
+        $worksheetFound = null;
+
+        foreach ($this->worksheets as $worksheet) {
+            if ($worksheet->getExternalSheet() === $sheet) {
+                $worksheetFound = $worksheet;
+                break;
+            }
+        }
+
+        return $worksheetFound;
+    }
+
+    /**
+     * Adds data to the current sheet.
+     * If shouldCreateNewSheetsAutomatically option is set to true, it will handle pagination
+     * with the creation of new worksheets if one worksheet has reached its maximum capicity.
+     *
+     * @param array $dataRow Array containing data to be written.
+     *          Example $dataRow = ['data1', 1234, null, '', 'data5'];
+     * @param \Box\Spout\Writer\Style\Style $style Style to be applied to the row.
+     * @return void
+     * @throws \Box\Spout\Common\Exception\IOException If trying to create a new sheet and unable to open the sheet for writing
+     * @throws \Box\Spout\Writer\Exception\WriterException If unable to write data
+     */
+    public function addRowToCurrentWorksheet($dataRow, $style)
+    {
+        $currentWorksheet = $this->getCurrentWorksheet();
+        $hasReachedMaxRows = $this->hasCurrentWorkseetReachedMaxRows();
+        $styleHelper = $this->getStyleHelper();
+
+        // if we reached the maximum number of rows for the current sheet...
+        if ($hasReachedMaxRows) {
+            // ... continue writing in a new sheet if option set
+            if ($this->shouldCreateNewSheetsAutomatically) {
+                $currentWorksheet = $this->addNewSheetAndMakeItCurrent();
+
+                $updatedStyle = $styleHelper->applyExtraStylesIfNeeded($style, $dataRow);
+                $registeredStyle = $styleHelper->registerStyle($updatedStyle);
+                $currentWorksheet->addRow($dataRow, $registeredStyle);
+            } else {
+                // otherwise, do nothing as the data won't be read anyways
+            }
+        } else {
+            $updatedStyle = $styleHelper->applyExtraStylesIfNeeded($style, $dataRow);
+            $registeredStyle = $styleHelper->registerStyle($updatedStyle);
+            $currentWorksheet->addRow($dataRow, $registeredStyle);
+        }
+    }
+
+    /**
+     * @return bool Whether the current worksheet has reached the maximum number of rows per sheet.
+     */
+    protected function hasCurrentWorkseetReachedMaxRows()
+    {
+        $currentWorksheet = $this->getCurrentWorksheet();
+        return ($currentWorksheet->getLastWrittenRowIndex() >= $this->getMaxRowsPerWorksheet());
+    }
+
+    /**
+     * Closes the workbook and all its associated sheets.
+     * All the necessary files are written to disk and zipped together to create the ODS file.
+     * All the temporary files are then deleted.
+     *
+     * @param resource $finalFilePointer Pointer to the ODS that will be created
+     * @return void
+     */
+    abstract public function close($finalFilePointer);
+}

src/Spout/Writer/Common/Internal/WorkbookInterface.php

@@ -0,0 +1,74 @@
+<?php
+
+namespace Box\Spout\Writer\Common\Internal;
+
+/**
+ * Interface WorkbookInterface
+ *
+ * @package Box\Spout\Writer\Common\Internal
+ */
+interface WorkbookInterface
+{
+    /**
+     * Creates a new sheet in the workbook. The current sheet remains unchanged.
+     *
+     * @return WorksheetInterface The created sheet
+     * @throws \Box\Spout\Common\Exception\IOException If unable to open the sheet for writing
+     */
+    public function addNewSheet();
+
+    /**
+     * 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).
+     *
+     * @return WorksheetInterface The created sheet
+     * @throws \Box\Spout\Common\Exception\IOException If unable to open the sheet for writing
+     */
+    public function addNewSheetAndMakeItCurrent();
+
+    /**
+     * @return WorksheetInterface[] All the workbook's sheets
+     */
+    public function getWorksheets();
+
+    /**
+     * Returns the current sheet
+     *
+     * @return WorksheetInterface The current sheet
+     */
+    public function 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).
+     *
+     * @param \Box\Spout\Writer\Common\Sheet $sheet The "external" sheet to set as current
+     * @return void
+     * @throws \Box\Spout\Writer\Exception\SheetNotFoundException If the given sheet does not exist in the workbook
+     */
+    public function setCurrentSheet($sheet);
+
+    /**
+     * Adds data to the current sheet.
+     * If shouldCreateNewSheetsAutomatically option is set to true, it will handle pagination
+     * with the creation of new worksheets if one worksheet has reached its maximum capicity.
+     *
+     * @param array $dataRow Array containing data to be written.
+     *          Example $dataRow = ['data1', 1234, null, '', 'data5'];
+     * @param \Box\Spout\Writer\Style\Style $style Style to be applied to the row.
+     * @return void
+     * @throws \Box\Spout\Common\Exception\IOException If trying to create a new sheet and unable to open the sheet for writing
+     * @throws \Box\Spout\Writer\Exception\WriterException If unable to write data
+     */
+    public function addRowToCurrentWorksheet($dataRow, $style);
+
+    /**
+     * Closes the workbook and all its associated sheets.
+     * All the necessary files are written to disk and zipped together to create the ODS file.
+     * All the temporary files are then deleted.
+     *
+     * @param resource $finalFilePointer Pointer to the ODS that will be created
+     * @return void
+     */
+    public function close($finalFilePointer);
+}

src/Spout/Writer/Common/Internal/WorksheetInterface.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace Box\Spout\Writer\Common\Internal;
+
+/**
+ * Interface WorksheetInterface
+ *
+ * @package Box\Spout\Writer\Common\Internal
+ */
+interface WorksheetInterface
+{
+    /**
+     * @return \Box\Spout\Writer\Common\Sheet The "external" sheet
+     */
+    public function getExternalSheet();
+
+    /**
+     * @return int The index of the last written row
+     */
+    public function getLastWrittenRowIndex();
+
+    /**
+     * Adds data to the worksheet.
+     *
+     * @param array $dataRow Array containing data to be written.
+     *          Example $dataRow = ['data1', 1234, null, '', 'data5'];
+     * @param \Box\Spout\Writer\Style\Style $style Style to be applied to the row. NULL means use default style.
+     * @return void
+     * @throws \Box\Spout\Common\Exception\IOException If the data cannot be written
+     * @throws \Box\Spout\Common\Exception\InvalidArgumentException If a cell value's type is not supported
+     */
+    public function addRow($dataRow, $style);
+
+    /**
+     * Closes the worksheet
+     *
+     * @return void
+     */
+    public function close();
+}

src/Spout/Writer/Common/Sheet.php

@@ -1,15 +1,15 @@
 <?php
 
-namespace Box\Spout\Writer\XLSX;
+namespace Box\Spout\Writer\Common;
 
 use Box\Spout\Common\Helper\StringHelper;
 use Box\Spout\Writer\Exception\InvalidSheetNameException;
 
 /**
  * Class Sheet
- * External representation of a worksheet within a XLSX file
+ * External representation of a worksheet within a ODS file
  *
- * @package Box\Spout\Writer\XLSX
+ * @package Box\Spout\Writer\Common
  */
 class Sheet
 {

src/Spout/Writer/ODS/Helper/FileSystemHelper.php

@@ -0,0 +1,283 @@
+<?php
+
+namespace Box\Spout\Writer\ODS\Helper;
+
+use Box\Spout\Writer\Common\Helper\ZipHelper;
+use Box\Spout\Writer\ODS\Internal\Worksheet;
+
+/**
+ * Class FileSystemHelper
+ * This class provides helper functions to help with the file system operations
+ * like files/folders creation & deletion for ODS files
+ *
+ * @package Box\Spout\Writer\ODS\Helper
+ */
+class FileSystemHelper extends \Box\Spout\Common\Helper\FileSystemHelper
+{
+    const APP_NAME = 'Spout';
+    const MIMETYPE = 'application/vnd.oasis.opendocument.spreadsheet';
+
+    const META_INF_FOLDER_NAME = 'META-INF';
+    const SHEETS_CONTENT_TEMP_FOLDER_NAME = 'worksheets-temp';
+
+    const MANIFEST_XML_FILE_NAME = 'manifest.xml';
+    const CONTENT_XML_FILE_NAME = 'content.xml';
+    const META_XML_FILE_NAME = 'meta.xml';
+    const MIMETYPE_FILE_NAME = 'mimetype';
+    const STYLES_XML_FILE_NAME = 'styles.xml';
+
+    /** @var string Path to the root folder inside the temp folder where the files to create the ODS will be stored */
+    protected $rootFolder;
+
+    /** @var string Path to the "META-INF" folder inside the root folder */
+    protected $metaInfFolder;
+
+    /** @var string Path to the temp folder, inside the root folder, where specific sheets content will be written to */
+    protected $sheetsContentTempFolder;
+
+    /**
+     * @return string
+     */
+    public function getRootFolder()
+    {
+        return $this->rootFolder;
+    }
+
+    /**
+     * @return string
+     */
+    public function getSheetsContentTempFolder()
+    {
+        return $this->sheetsContentTempFolder;
+    }
+
+    /**
+     * Creates all the folders needed to create a ODS file, as well as the files that won't change.
+     *
+     * @return void
+     * @throws \Box\Spout\Common\Exception\IOException If unable to create at least one of the base folders
+     */
+    public function createBaseFilesAndFolders()
+    {
+        $this
+            ->createRootFolder()
+            ->createMetaInfoFolderAndFile()
+            ->createSheetsContentTempFolder()
+            ->createMetaFile()
+            ->createMimetypeFile();
+    }
+
+    /**
+     * Creates the folder that will be used as root
+     *
+     * @return FileSystemHelper
+     * @throws \Box\Spout\Common\Exception\IOException If unable to create the folder
+     */
+    protected function createRootFolder()
+    {
+        $this->rootFolder = $this->createFolder($this->baseFolderPath, uniqid('ods'));
+        return $this;
+    }
+
+    /**
+     * Creates the "META-INF" folder under the root folder as well as the "manifest.xml" file in it
+     *
+     * @return FileSystemHelper
+     * @throws \Box\Spout\Common\Exception\IOException If unable to create the folder or the "manifest.xml" file
+     */
+    protected function createMetaInfoFolderAndFile()
+    {
+        $this->metaInfFolder = $this->createFolder($this->rootFolder, self::META_INF_FOLDER_NAME);
+
+        $this->createManifestFile();
+
+        return $this;
+    }
+
+    /**
+     * Creates the "manifest.xml" file under the "META-INF" folder (under root)
+     *
+     * @return FileSystemHelper
+     * @throws \Box\Spout\Common\Exception\IOException If unable to create the file
+     */
+    protected function createManifestFile()
+    {
+        $manifestXmlFileContents = <<<EOD
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<manifest:manifest xmlns:manifest="urn:oasis:names:tc:opendocument:xmlns:manifest:1.0">
+    <manifest:file-entry manifest:full-path="/" manifest:media-type="application/vnd.oasis.opendocument.spreadsheet"/>
+    <manifest:file-entry manifest:full-path="styles.xml" manifest:media-type="text/xml"/>
+    <manifest:file-entry manifest:full-path="content.xml" manifest:media-type="text/xml"/>
+    <manifest:file-entry manifest:full-path="meta.xml" manifest:media-type="text/xml"/>
+    <manifest:file-entry manifest:full-path="mimetype" manifest:media-type="text/plain"/>
+    <manifest:file-entry manifest:full-path="META-INF/manifest.xml" manifest:media-type="text/xml"/>
+</manifest:manifest>
+EOD;
+
+        $this->createFileWithContents($this->metaInfFolder, self::MANIFEST_XML_FILE_NAME, $manifestXmlFileContents);
+
+        return $this;
+    }
+
+    /**
+     * Creates the temp folder where specific sheets content will be written to.
+     * This folder is not part of the final ODS file and is only used to be able to jump between sheets.
+     *
+     * @return FileSystemHelper
+     * @throws \Box\Spout\Common\Exception\IOException If unable to create the folder
+     */
+    protected function createSheetsContentTempFolder()
+    {
+        $this->sheetsContentTempFolder = $this->createFolder($this->rootFolder, self::SHEETS_CONTENT_TEMP_FOLDER_NAME);
+        return $this;
+    }
+
+    /**
+     * Creates the "meta.xml" file under the root folder
+     *
+     * @return FileSystemHelper
+     * @throws \Box\Spout\Common\Exception\IOException If unable to create the file
+     */
+    protected function createMetaFile()
+    {
+        $appName = self::APP_NAME;
+        $createdDate = (new \DateTime())->format(\DateTime::W3C);
+
+        $metaXmlFileContents = <<<EOD
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<office:document-meta office:version="1.1" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:meta="urn:oasis:names:tc:opendocument:xmlns:meta:1.0" xmlns:office="urn:oasis:names:tc:opendocument:xmlns:office:1.0" xmlns:xlink="http://www.w3.org/1999/xlink">
+    <office:meta>
+        <dc:creator>$appName</dc:creator>
+        <meta:creation-date>$createdDate</meta:creation-date>
+        <dc:date>$createdDate</dc:date>
+    </office:meta>
+</office:document-meta>
+EOD;
+
+        $this->createFileWithContents($this->rootFolder, self::META_XML_FILE_NAME, $metaXmlFileContents);
+
+        return $this;
+    }
+
+    /**
+     * Creates the "mimetype" file under the root folder
+     *
+     * @return FileSystemHelper
+     * @throws \Box\Spout\Common\Exception\IOException If unable to create the file
+     */
+    protected function createMimetypeFile()
+    {
+        $this->createFileWithContents($this->rootFolder, self::MIMETYPE_FILE_NAME, self::MIMETYPE);
+        return $this;
+    }
+
+    /**
+     * Creates the "content.xml" file under the root folder
+     *
+     * @param Worksheet[] $worksheets
+     * @param StyleHelper $styleHelper
+     * @return FileSystemHelper
+     */
+    public function createContentFile($worksheets, $styleHelper)
+    {
+        $contentXmlFileContents = <<<EOD
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<office:document-content xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:draw="urn:oasis:names:tc:opendocument:xmlns:drawing:1.0" xmlns:fo="urn:oasis:names:tc:opendocument:xmlns:xsl-fo-compatible:1.0" xmlns:msoxl="http://schemas.microsoft.com/office/excel/formula" xmlns:number="urn:oasis:names:tc:opendocument:xmlns:datastyle:1.0" xmlns:office="urn:oasis:names:tc:opendocument:xmlns:office:1.0" xmlns:style="urn:oasis:names:tc:opendocument:xmlns:style:1.0" xmlns:svg="urn:oasis:names:tc:opendocument:xmlns:svg-compatible:1.0" xmlns:table="urn:oasis:names:tc:opendocument:xmlns:table:1.0" xmlns:text="urn:oasis:names:tc:opendocument:xmlns:text:1.0" xmlns:xlink="http://www.w3.org/1999/xlink">
+
+EOD;
+
+        $contentXmlFileContents .= $styleHelper->getContentXmlFontFaceSectionContent();
+        $contentXmlFileContents .= $styleHelper->getContentXmlAutomaticStylesSectionContent(count($worksheets));
+
+        $contentXmlFileContents .= <<<EOD
+    <office:body>
+        <office:spreadsheet>
+
+EOD;
+
+        $this->createFileWithContents($this->rootFolder, self::CONTENT_XML_FILE_NAME, $contentXmlFileContents);
+
+        // Append sheets content to "content.xml"
+        $contentXmlFilePath = $this->rootFolder . '/' . self::CONTENT_XML_FILE_NAME;
+        $contentXmlHandle = fopen($contentXmlFilePath, 'a');
+
+        foreach ($worksheets as $worksheet) {
+            // write the "<table:table>" node, with the final sheet's name
+            fwrite($contentXmlHandle, $worksheet->getTableRootNodeAsString() . PHP_EOL);
+
+            $worksheetFilePath = $worksheet->getWorksheetFilePath();
+            $this->copyFileContentsToTarget($worksheetFilePath, $contentXmlHandle);
+
+            fwrite($contentXmlHandle, '</table:table>' . PHP_EOL);
+        }
+
+        $contentXmlFileContents = <<<EOD
+        </office:spreadsheet>
+    </office:body>
+</office:document-content>
+EOD;
+
+        fwrite($contentXmlHandle, $contentXmlFileContents);
+        fclose($contentXmlHandle);
+
+        return $this;
+    }
+
+    /**
+     * Streams the content of the file at the given path into the target resource.
+     * Depending on which mode the target resource was created with, it will truncate then copy
+     * or append the content to the target file.
+     *
+     * @param string $sourceFilePath Path of the file whose content will be copied
+     * @param resource $targetResource Target resource that will receive the content
+     * @return void
+     */
+    protected function copyFileContentsToTarget($sourceFilePath, $targetResource)
+    {
+        $sourceHandle = fopen($sourceFilePath, 'r');
+        stream_copy_to_stream($sourceHandle, $targetResource);
+        fclose($sourceHandle);
+    }
+
+    /**
+     * Deletes the temporary folder where sheets content was stored.
+     *
+     * @return FileSystemHelper
+     */
+    public function deleteWorksheetTempFolder()
+    {
+        $this->deleteFolderRecursively($this->sheetsContentTempFolder);
+        return $this;
+    }
+
+
+    /**
+     * Creates the "styles.xml" file under the root folder
+     *
+     * @param StyleHelper $styleHelper
+     * @param int $numWorksheets Number of created worksheets
+     * @return FileSystemHelper
+     */
+    public function createStylesFile($styleHelper, $numWorksheets)
+    {
+        $stylesXmlFileContents = $styleHelper->getStylesXMLFileContent($numWorksheets);
+        $this->createFileWithContents($this->rootFolder, self::STYLES_XML_FILE_NAME, $stylesXmlFileContents);
+
+        return $this;
+    }
+
+    /**
+     * Zips the root folder and streams the contents of the zip into the given stream
+     *
+     * @param resource $streamPointer Pointer to the stream to copy the zip
+     * @return void
+     */
+    public function zipRootFolderAndCopyToStream($streamPointer)
+    {
+        $zipHelper = new ZipHelper();
+        $zipHelper->zipFolderAndCopyToStream($this->rootFolder, $streamPointer);
+
+        // once the zip is copied, remove it
+        $this->deleteFile($zipHelper->getZipFilePath($this->rootFolder));
+    }
+}

src/Spout/Writer/ODS/Helper/StyleHelper.php

@@ -0,0 +1,270 @@
+<?php
+
+namespace Box\Spout\Writer\ODS\Helper;
+
+use Box\Spout\Writer\Common\Helper\AbstractStyleHelper;
+
+/**
+ * Class StyleHelper
+ * This class provides helper functions to manage styles
+ *
+ * @package Box\Spout\Writer\ODS\Helper
+ */
+class StyleHelper extends AbstractStyleHelper
+{
+    /** @var string[] [FONT_NAME] => [] Map whose keys contain all the fonts used */
+    protected $usedFontsSet = [];
+
+    /**
+     * Registers the given style as a used style.
+     * Duplicate styles won't be registered more than once.
+     *
+     * @param \Box\Spout\Writer\Style\Style $style The style to be registered
+     * @return \Box\Spout\Writer\Style\Style The registered style, updated with an internal ID.
+     */
+    public function registerStyle($style)
+    {
+        $this->usedFontsSet[$style->getFontName()] = true;
+        return parent::registerStyle($style);
+    }
+
+    /**
+     * @return string[] List of used fonts name
+     */
+    protected function getUsedFonts()
+    {
+        return array_keys($this->usedFontsSet);
+    }
+
+    /**
+     * Returns the content of the "styles.xml" file, given a list of styles.
+     *
+     * @param int $numWorksheets Number of worksheets created
+     * @return string
+     */
+    public function getStylesXMLFileContent($numWorksheets)
+    {
+        $content = <<<EOD
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<office:document-styles xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:draw="urn:oasis:names:tc:opendocument:xmlns:drawing:1.0" xmlns:fo="urn:oasis:names:tc:opendocument:xmlns:xsl-fo-compatible:1.0" xmlns:msoxl="http://schemas.microsoft.com/office/excel/formula" xmlns:number="urn:oasis:names:tc:opendocument:xmlns:datastyle:1.0" xmlns:office="urn:oasis:names:tc:opendocument:xmlns:office:1.0" xmlns:style="urn:oasis:names:tc:opendocument:xmlns:style:1.0" xmlns:svg="urn:oasis:names:tc:opendocument:xmlns:svg-compatible:1.0" xmlns:table="urn:oasis:names:tc:opendocument:xmlns:table:1.0" xmlns:text="urn:oasis:names:tc:opendocument:xmlns:text:1.0" xmlns:xlink="http://www.w3.org/1999/xlink">
+
+EOD;
+
+        $content .= $this->getFontFaceSectionContent();
+        $content .= $this->getStylesSectionContent();
+        $content .= $this->getAutomaticStylesSectionContent($numWorksheets);
+        $content .= $this->getMasterStylesSectionContent($numWorksheets);
+
+        $content .= <<<EOD
+</office:document-styles>
+EOD;
+
+        return $content;
+    }
+
+    /**
+     * Returns the content of the "<office:font-face-decls>" section, inside "styles.xml" file.
+     *
+     * @return string
+     */
+    protected function getFontFaceSectionContent()
+    {
+        $content = '<office:font-face-decls>' . PHP_EOL;
+        foreach ($this->getUsedFonts() as $fontName) {
+            $content .= '    <style:font-face style:name="' . $fontName . '" svg:font-family="' . $fontName . '"/>' . PHP_EOL;
+        }
+        $content .= '</office:font-face-decls>' . PHP_EOL;
+
+        return $content;
+    }
+
+    /**
+     * Returns the content of the "<office:styles>" section, inside "styles.xml" file.
+     *
+     * @return string
+     */
+    protected function getStylesSectionContent()
+    {
+        $defaultStyle = $this->getDefaultStyle();
+
+        return <<<EOD
+<office:styles>
+    <number:number-style style:name="N0">
+        <number:number number:min-integer-digits="1"/>
+    </number:number-style>
+    <style:style style:data-style-name="N0" style:family="table-cell" style:name="Default">
+        <style:table-cell-properties fo:background-color="transparent" style:vertical-align="automatic"/>
+        <style:text-properties fo:color="#{$defaultStyle->getFontColor()}"
+                               fo:font-size="{$defaultStyle->getFontSize()}pt" style:font-size-asian="{$defaultStyle->getFontSize()}pt" style:font-size-complex="{$defaultStyle->getFontSize()}pt"
+                               style:font-name="{$defaultStyle->getFontName()}" style:font-name-asian="{$defaultStyle->getFontName()}" style:font-name-complex="{$defaultStyle->getFontName()}"/>
+    </style:style>
+</office:styles>
+
+EOD;
+    }
+
+    /**
+     * Returns the content of the "<office:automatic-styles>" section, inside "styles.xml" file.
+     *
+     * @param int $numWorksheets Number of worksheets created
+     * @return string
+     */
+    protected function getAutomaticStylesSectionContent($numWorksheets)
+    {
+        $content = '<office:automatic-styles>' . PHP_EOL;
+
+        for ($i = 1; $i <= $numWorksheets; $i++) {
+            $content .= <<<EOD
+    <style:page-layout style:name="pm$i">
+        <style:page-layout-properties style:first-page-number="continue" style:print="objects charts drawings" style:table-centering="none"/>
+        <style:header-style/>
+        <style:footer-style/>
+    </style:page-layout>
+
+EOD;
+        }
+
+        $content .= '</office:automatic-styles>' . PHP_EOL;
+
+        return $content;
+    }
+
+    /**
+     * Returns the content of the "<office:master-styles>" section, inside "styles.xml" file.
+     *
+     * @param int $numWorksheets Number of worksheets created
+     * @return string
+     */
+    protected function getMasterStylesSectionContent($numWorksheets)
+    {
+        $content = '<office:master-styles>' . PHP_EOL;
+
+        for ($i = 1; $i <= $numWorksheets; $i++) {
+            $content .= <<<EOD
+    <style:master-page style:name="mp$i" style:page-layout-name="pm$i">
+        <style:header/>
+        <style:header-left style:display="false"/>
+        <style:footer/>
+        <style:footer-left style:display="false"/>
+    </style:master-page>
+
+EOD;
+        }
+
+        $content .= '</office:master-styles>' . PHP_EOL;
+
+        return $content;
+    }
+
+
+    /**
+     * Returns the contents of the "<office:font-face-decls>" section, inside "content.xml" file.
+     *
+     * @return string
+     */
+    public function getContentXmlFontFaceSectionContent()
+    {
+        $content = '<office:font-face-decls>' . PHP_EOL;
+        foreach ($this->getUsedFonts() as $fontName) {
+            $content .= '    <style:font-face style:name="' . $fontName . '" svg:font-family="' . $fontName . '"/>' . PHP_EOL;
+        }
+        $content .= '</office:font-face-decls>' . PHP_EOL;
+
+        return $content;
+    }
+
+    /**
+     * Returns the contents of the "<office:automatic-styles>" section, inside "content.xml" file.
+     *
+     * @param int $numWorksheets Number of worksheets created
+     * @return string
+     */
+    public function getContentXmlAutomaticStylesSectionContent($numWorksheets)
+    {
+        $content = '<office:automatic-styles>' . PHP_EOL;
+
+        foreach ($this->getRegisteredStyles() as $style) {
+            $content .= $this->getStyleSectionContent($style);
+        }
+
+        $content .= <<<EOD
+    <style:style style:family="table-column" style:name="co1">
+        <style:table-column-properties fo:break-before="auto"/>
+    </style:style>
+    <style:style style:family="table-row" style:name="ro1">
+        <style:table-row-properties fo:break-before="auto" style:row-height="15pt" style:use-optimal-row-height="true"/>
+    </style:style>
+
+EOD;
+
+        for ($i = 1; $i <= $numWorksheets; $i++) {
+            $content .= <<<EOD
+    <style:style style:family="table" style:master-page-name="mp$i" style:name="ta$i">
+        <style:table-properties style:writing-mode="lr-tb" table:display="true"/>
+    </style:style>
+
+EOD;
+        }
+
+        $content .= '</office:automatic-styles>' . PHP_EOL;
+
+        return $content;
+    }
+
+    /**
+     * Returns the contents of the "<style:style>" section, inside "<office:automatic-styles>" section
+     *
+     * @param \Box\Spout\Writer\Style\Style $style
+     * @return string
+     */
+    protected function getStyleSectionContent($style)
+    {
+        $defaultStyle = $this->getDefaultStyle();
+        $styleIndex = $style->getId() + 1; // 1-based
+
+        $content = '    <style:style style:data-style-name="N0" style:family="table-cell" style:name="ce' . $styleIndex . '" style:parent-style-name="Default">' . PHP_EOL;
+
+        if ($style->shouldApplyFont()) {
+            $content .= '        <style:text-properties';
+
+            $fontColor = $style->getFontColor();
+            if ($fontColor !== $defaultStyle->getFontColor()) {
+                $content .= ' fo:color="#' . $fontColor . '"';
+            }
+
+            $fontName = $style->getFontName();
+            if ($fontName !== $defaultStyle->getFontName()) {
+                $content .= ' style:font-name="' . $fontName . '" style:font-name-asian="' . $fontName . '" style:font-name-complex="' . $fontName . '"';
+            }
+
+            $fontSize = $style->getFontSize();
+            if ($fontSize !== $defaultStyle->getFontSize()) {
+                $content .= ' fo:font-size="' . $fontSize . 'pt" style:font-size-asian="' . $fontSize . 'pt" style:font-size-complex="' . $fontSize . 'pt"';
+            }
+
+            if ($style->isFontBold()) {
+                $content .= ' fo:font-weight="bold" style:font-weight-asian="bold" style:font-weight-complex="bold"';
+            }
+            if ($style->isFontItalic()) {
+                $content .= ' fo:font-style="italic" style:font-style-asian="italic" style:font-style-complex="italic"';
+            }
+            if ($style->isFontUnderline()) {
+                $content .= ' style:text-underline-style="solid" style:text-underline-type="single"';
+            }
+            if ($style->isFontStrikethrough()) {
+                $content .= ' style:text-line-through-style="solid"';
+            }
+
+            $content .= '/>' . PHP_EOL;
+        }
+
+        if ($style->shouldWrapText()) {
+            $content .= '        <style:table-cell-properties fo:wrap-option="wrap" style:vertical-align="automatic"/>' . PHP_EOL;
+        }
+
+        $content .= '    </style:style>' . PHP_EOL;
+
+        return $content;
+    }
+
+}

src/Spout/Writer/ODS/Internal/Workbook.php

@@ -0,0 +1,119 @@
+<?php
+
+namespace Box\Spout\Writer\ODS\Internal;
+
+use Box\Spout\Writer\Common\Internal\AbstractWorkbook;
+use Box\Spout\Writer\ODS\Helper\FileSystemHelper;
+use Box\Spout\Writer\ODS\Helper\StyleHelper;
+use Box\Spout\Writer\Common\Sheet;
+
+/**
+ * Class Workbook
+ * Represents a workbook within a ODS file.
+ * It provides the functions to work with worksheets.
+ *
+ * @package Box\Spout\Writer\ODS\Internal
+ */
+class Workbook extends AbstractWorkbook
+{
+    /**
+     * Maximum number of rows a ODS sheet can contain
+     * @see http://office.microsoft.com/en-us/excel-help/excel-specifications-and-limits-HP010073849.aspx
+     */
+    protected static $maxRowsPerWorksheet = 1048576;
+
+    /** @var \Box\Spout\Writer\ODS\Helper\FileSystemHelper Helper to perform file system operations */
+    protected $fileSystemHelper;
+
+    /** @var \Box\Spout\Writer\ODS\Helper\StyleHelper Helper to apply styles */
+    protected $styleHelper;
+
+    /**
+     * @param string $tempFolder
+     * @param bool $shouldCreateNewSheetsAutomatically
+     * @param \Box\Spout\Writer\Style\Style $defaultRowStyle
+     * @throws \Box\Spout\Common\Exception\IOException If unable to create at least one of the base folders
+     */
+    public function __construct($tempFolder, $shouldCreateNewSheetsAutomatically, $defaultRowStyle)
+    {
+        parent::__construct($shouldCreateNewSheetsAutomatically, $defaultRowStyle);
+
+        $this->fileSystemHelper = new FileSystemHelper($tempFolder);
+        $this->fileSystemHelper->createBaseFilesAndFolders();
+
+        $this->styleHelper = new StyleHelper($defaultRowStyle);
+    }
+
+    /**
+     * @return \Box\Spout\Writer\ODS\Helper\StyleHelper Helper to apply styles to ODS files
+     */
+    protected function getStyleHelper()
+    {
+        return $this->styleHelper;
+    }
+
+    /**
+     * @return int Maximum number of rows/columns a sheet can contain
+     */
+    protected function getMaxRowsPerWorksheet()
+    {
+        return self::$maxRowsPerWorksheet;
+    }
+
+    /**
+     * Creates a new sheet in the workbook. The current sheet remains unchanged.
+     *
+     * @return Worksheet The created sheet
+     * @throws \Box\Spout\Common\Exception\IOException If unable to open the sheet for writing
+     */
+    public function addNewSheet()
+    {
+        $newSheetIndex = count($this->worksheets);
+        $sheet = new Sheet($newSheetIndex);
+
+        $sheetsContentTempFolder = $this->fileSystemHelper->getSheetsContentTempFolder();
+        $worksheet = new Worksheet($sheet, $sheetsContentTempFolder);
+        $this->worksheets[] = $worksheet;
+
+        return $worksheet;
+    }
+
+    /**
+     * Closes the workbook and all its associated sheets.
+     * All the necessary files are written to disk and zipped together to create the ODS file.
+     * All the temporary files are then deleted.
+     *
+     * @param resource $finalFilePointer Pointer to the ODS that will be created
+     * @return void
+     */
+    public function close($finalFilePointer)
+    {
+        /** @var Worksheet[] $worksheets */
+        $worksheets = $this->worksheets;
+        $numWorksheets = count($worksheets);
+
+        foreach ($worksheets as $worksheet) {
+            $worksheet->close();
+        }
+
+        // Finish creating all the necessary files before zipping everything together
+        $this->fileSystemHelper
+            ->createContentFile($worksheets, $this->styleHelper)
+            ->deleteWorksheetTempFolder()
+            ->createStylesFile($this->styleHelper, $numWorksheets)
+            ->zipRootFolderAndCopyToStream($finalFilePointer);
+
+        $this->cleanupTempFolder();
+    }
+
+    /**
+     * Deletes the root folder created in the temp folder and all its contents.
+     *
+     * @return void
+     */
+    protected function cleanupTempFolder()
+    {
+        $xlsxRootFolder = $this->fileSystemHelper->getRootFolder();
+        $this->fileSystemHelper->deleteFolderRecursively($xlsxRootFolder);
+    }
+}

src/Spout/Writer/ODS/Internal/Worksheet.php

@@ -0,0 +1,210 @@
+<?php
+
+namespace Box\Spout\Writer\ODS\Internal;
+
+use Box\Spout\Common\Exception\InvalidArgumentException;
+use Box\Spout\Common\Exception\IOException;
+use Box\Spout\Common\Helper\StringHelper;
+use Box\Spout\Writer\Common\Helper\CellHelper;
+use Box\Spout\Writer\Common\Internal\WorksheetInterface;
+use Box\Spout\Writer\Common\Sheet;
+
+/**
+ * Class Worksheet
+ * Represents a worksheet within a ODS file. The difference with the Sheet object is
+ * that this class provides an interface to write data
+ *
+ * @package Box\Spout\Writer\ODS\Internal
+ */
+class Worksheet implements WorksheetInterface
+{
+    /**
+     * @see https://wiki.openoffice.org/wiki/Documentation/FAQ/Calc/Miscellaneous/What's_the_maximum_number_of_rows_and_cells_for_a_spreadsheet_file%3f
+     * @see https://bz.apache.org/ooo/show_bug.cgi?id=30215
+     */
+    const MAX_NUM_ROWS_REPEATED = 1048576;
+    const MAX_NUM_COLUMNS_REPEATED = 1024;
+
+    /** @var \Box\Spout\Writer\Common\Sheet The "external" sheet */
+    protected $externalSheet;
+
+    /** @var string Path to the XML file that will contain the sheet data */
+    protected $worksheetFilePath;
+
+    /** @var \Box\Spout\Common\Escaper\ODS Strings escaper */
+    protected $stringsEscaper;
+
+    /** @var \Box\Spout\Common\Helper\StringHelper To help with string manipulation */
+    protected $stringHelper;
+
+    /** @var Resource Pointer to the sheet data file (e.g. xl/worksheets/sheet1.xml) */
+    protected $sheetFilePointer;
+
+    /** @var int Index of the last written row */
+    protected $lastWrittenRowIndex = 0;
+
+    /**
+     * @param \Box\Spout\Writer\Common\Sheet $externalSheet The associated "external" sheet
+     * @param string $worksheetFilesFolder Temporary folder where the files to create the XLSX will be stored
+     * @throws \Box\Spout\Common\Exception\IOException If the sheet data file cannot be opened for writing
+     */
+    public function __construct($externalSheet, $worksheetFilesFolder)
+    {
+        $this->externalSheet = $externalSheet;
+        /** @noinspection PhpUnnecessaryFullyQualifiedNameInspection */
+        $this->stringsEscaper = new \Box\Spout\Common\Escaper\ODS();
+        $this->worksheetFilePath = $worksheetFilesFolder . '/sheet' . $externalSheet->getIndex() . '.xml';
+
+        $this->stringHelper = new StringHelper();
+
+        $this->startSheet();
+    }
+
+    /**
+     * Prepares the worksheet to accept data
+     *
+     * @return void
+     * @throws \Box\Spout\Common\Exception\IOException If the sheet data file cannot be opened for writing
+     */
+    protected function startSheet()
+    {
+        $this->sheetFilePointer = fopen($this->worksheetFilePath, 'w');
+        $this->throwIfSheetFilePointerIsNotAvailable();
+
+        // The XML file does not contain the "<table:table>" node as it contains the sheet's name
+        // which may change during the execution of the program. It will be added at the end.
+        $content = '    <table:table-column table:default-cell-style-name="ce1" table:number-columns-repeated="' . self::MAX_NUM_COLUMNS_REPEATED . '" table:style-name="co1"/>' . PHP_EOL;
+        fwrite($this->sheetFilePointer, $content);
+    }
+
+    /**
+     * Checks if the book has been created. Throws an exception if not created yet.
+     *
+     * @return void
+     * @throws \Box\Spout\Common\Exception\IOException If the sheet data file cannot be opened for writing
+     */
+    protected function throwIfSheetFilePointerIsNotAvailable()
+    {
+        if (!$this->sheetFilePointer) {
+            throw new IOException('Unable to open sheet for writing.');
+        }
+    }
+
+    /**
+     * @return string Path to the temporary sheet content XML file
+     */
+    public function getWorksheetFilePath()
+    {
+        return $this->worksheetFilePath;
+    }
+
+    /**
+     * Returns the table XML root node as string.
+     *
+     * @return string <table> node as string
+     */
+    public function getTableRootNodeAsString()
+    {
+        $escapedSheetName = $this->stringsEscaper->escape($this->externalSheet->getName());
+        $tableStyleName = 'ta' . ($this->externalSheet->getIndex() + 1);
+
+        return '<table:table table:style-name="' . $tableStyleName . '" table:name="' . $escapedSheetName . '">';
+    }
+
+    /**
+     * @return \Box\Spout\Writer\Common\Sheet The "external" sheet
+     */
+    public function getExternalSheet()
+    {
+        return $this->externalSheet;
+    }
+
+    /**
+     * @return int The index of the last written row
+     */
+    public function getLastWrittenRowIndex()
+    {
+        return $this->lastWrittenRowIndex;
+    }
+
+    /**
+     * Adds data to the worksheet.
+     *
+     * @param array $dataRow Array containing data to be written.
+     *          Example $dataRow = ['data1', 1234, null, '', 'data5'];
+     * @param \Box\Spout\Writer\Style\Style $style Style to be applied to the row. NULL means use default style.
+     * @return void
+     * @throws \Box\Spout\Common\Exception\IOException If the data cannot be written
+     * @throws \Box\Spout\Common\Exception\InvalidArgumentException If a cell value's type is not supported
+     */
+    public function addRow($dataRow, $style)
+    {
+        $numColumnsRepeated = self::MAX_NUM_COLUMNS_REPEATED;
+        $styleIndex = ($style->getId() + 1); // 1-based
+
+        $data = '    <table:table-row table:style-name="ro1">' . PHP_EOL;
+
+        foreach($dataRow as $cellValue) {
+            $data .= '        <table:table-cell table:style-name="ce' . $styleIndex . '"';
+
+            if (CellHelper::isNonEmptyString($cellValue)) {
+                $data .= ' office:value-type="string">' . PHP_EOL;
+
+                $cellValueLines = explode("\n", $cellValue);
+                foreach ($cellValueLines as $cellValueLine) {
+                    $data .= '            <text:p>' . $this->stringsEscaper->escape($cellValueLine) . '</text:p>' . PHP_EOL;
+                }
+
+                $data .= '        </table:table-cell>' . PHP_EOL;
+            } else if (CellHelper::isBoolean($cellValue)) {
+                $data .= ' office:value-type="boolean" office:value="' . $cellValue . '">' . PHP_EOL;
+                $data .= '            <text:p>' . $cellValue . '</text:p>' . PHP_EOL;
+                $data .= '        </table:table-cell>' . PHP_EOL;
+            } else if (CellHelper::isNumeric($cellValue)) {
+                $data .= ' office:value-type="float" office:value="' . $cellValue . '">' . PHP_EOL;
+                $data .= '            <text:p>' . $cellValue . '</text:p>' . PHP_EOL;
+                $data .= '        </table:table-cell>' . PHP_EOL;
+            } else if (empty($cellValue)) {
+                $data .= '/>' . PHP_EOL;
+            } else {
+                throw new InvalidArgumentException('Trying to add a value with an unsupported type: ' . gettype($cellValue));
+            }
+
+            $numColumnsRepeated--;
+        }
+
+        if ($numColumnsRepeated > 0) {
+            $data .= '        <table:table-cell table:number-columns-repeated="' . $numColumnsRepeated . '"/>' . PHP_EOL;
+        }
+
+        $data .= '    </table:table-row>' . PHP_EOL;
+
+        $wasWriteSuccessful = fwrite($this->sheetFilePointer, $data);
+        if ($wasWriteSuccessful === false) {
+            throw new IOException("Unable to write data in {$this->worksheetFilePath}");
+        }
+
+        // only update the count if the write worked
+        $this->lastWrittenRowIndex++;
+    }
+
+    /**
+     * Closes the worksheet
+     *
+     * @return void
+     */
+    public function close()
+    {
+        $remainingRepeatedRows = self::MAX_NUM_ROWS_REPEATED - $this->lastWrittenRowIndex;
+
+        if ($remainingRepeatedRows > 0) {
+            $data = '    <table:table-row table:style-name="ro1" table:number-rows-repeated="' . $remainingRepeatedRows . '">' . PHP_EOL;
+            $data .= '        <table:table-cell table:number-columns-repeated="' . self::MAX_NUM_COLUMNS_REPEATED . '"/>' . PHP_EOL;
+            $data .= '    </table:table-row>' . PHP_EOL;
+
+            fwrite($this->sheetFilePointer, $data);
+        }
+
+        fclose($this->sheetFilePointer);
+    }
+}

src/Spout/Writer/ODS/Writer.php

@@ -0,0 +1,92 @@
+<?php
+
+namespace Box\Spout\Writer\ODS;
+
+use Box\Spout\Writer\AbstractMultiSheetsWriter;
+use Box\Spout\Writer\Common;
+use Box\Spout\Writer\ODS\Internal\Workbook;
+
+/**
+ * Class Writer
+ * This class provides base support to write data to ODS files
+ *
+ * @package Box\Spout\Writer\ODS
+ */
+class Writer extends AbstractMultiSheetsWriter
+{
+    /** @var string Content-Type value for the header */
+    protected static $headerContentType = 'application/vnd.oasis.opendocument.spreadsheet';
+
+    /** @var string Temporary folder where the files to create the ODS will be stored */
+    protected $tempFolder;
+
+    /** @var Internal\Workbook The workbook for the XLSX file */
+    protected $book;
+
+    /**
+     * Sets a custom temporary folder for creating intermediate files/folders.
+     * This must be set before opening the writer.
+     *
+     * @param string $tempFolder Temporary folder where the files to create the ODS will be stored
+     * @return Writer
+     * @throws \Box\Spout\Writer\Exception\WriterAlreadyOpenedException If the writer was already opened
+     */
+    public function setTempFolder($tempFolder)
+    {
+        $this->throwIfWriterAlreadyOpened('Writer must be configured before opening it.');
+
+        $this->tempFolder = $tempFolder;
+        return $this;
+    }
+
+    /**
+     * Configures the write and sets the current sheet pointer to a new sheet.
+     *
+     * @return void
+     * @throws \Box\Spout\Common\Exception\IOException If unable to open the file for writing
+     */
+    protected function openWriter()
+    {
+        $tempFolder = ($this->tempFolder) ? : sys_get_temp_dir();
+        $this->book = new Workbook($tempFolder, $this->shouldCreateNewSheetsAutomatically, $this->defaultRowStyle);
+        $this->book->addNewSheetAndMakeItCurrent();
+    }
+
+    /**
+     * @return Internal\Workbook The workbook representing the file to be written
+     */
+    protected function getWorkbook()
+    {
+        return $this->book;
+    }
+
+    /**
+     * Adds data to the currently opened writer.
+     * If shouldCreateNewSheetsAutomatically option is set to true, it will handle pagination
+     * with the creation of new worksheets if one worksheet has reached its maximum capicity.
+     *
+     * @param array $dataRow Array containing data to be written.
+     *          Example $dataRow = ['data1', 1234, null, '', 'data5'];
+     * @param \Box\Spout\Writer\Style\Style $style Style to be applied to the row.
+     * @return void
+     * @throws \Box\Spout\Writer\Exception\WriterNotOpenedException If the book is not created yet
+     * @throws \Box\Spout\Common\Exception\IOException If unable to write data
+     */
+    protected function addRowToWriter(array $dataRow, $style)
+    {
+        $this->throwIfBookIsNotAvailable();
+        $this->book->addRowToCurrentWorksheet($dataRow, $style);
+    }
+
+    /**
+     * Closes the writer, preventing any additional writing.
+     *
+     * @return void
+     */
+    protected function closeWriter()
+    {
+        if ($this->book) {
+            $this->book->close($this->filePointer);
+        }
+    }
+}

src/Spout/Writer/Style/Color.php

@@ -13,27 +13,26 @@ use Box\Spout\Writer\Exception\InvalidColorException;
 class Color
 {
     /** Standard colors - based on Office Online */
-    const BLACK = 'FF000000';
-    const WHITE = 'FFFFFFFF';
-    const RED = 'FFFF0000';
-    const DARK_RED = 'FFC00000';
-    const ORANGE = 'FFFFC000';
-    const YELLOW = 'FFFFFF00';
-    const LIGHT_GREEN = 'FF92D040';
-    const GREEN = 'FF00B050';
-    const LIGHT_BLUE = 'FF00B0E0';
-    const BLUE = 'FF0070C0';
-    const DARK_BLUE = 'FF002060';
-    const PURPLE = 'FF7030A0';
+    const BLACK = '000000';
+    const WHITE = 'FFFFFF';
+    const RED = 'FF0000';
+    const DARK_RED = 'C00000';
+    const ORANGE = 'FFC000';
+    const YELLOW = 'FFFF00';
+    const LIGHT_GREEN = '92D040';
+    const GREEN = '00B050';
+    const LIGHT_BLUE = '00B0E0';
+    const BLUE = '0070C0';
+    const DARK_BLUE = '002060';
+    const PURPLE = '7030A0';
 
     /**
-     * Returns an ARGB color from R, G and B values
-     * Alpha is assumed to always be 1
+     * Returns an RGB color from R, G and B values
      *
      * @param int $red Red component, 0 - 255
      * @param int $green Green component, 0 - 255
      * @param int $blue Blue component, 0 - 255
-     * @return string ARGB color
+     * @return string RGB color
      */
     public static function rgb($red, $green, $blue)
     {
@@ -42,7 +41,6 @@ class Color
         self::throwIfInvalidColorComponentValue($blue);
 
         return strtoupper(
-            'FF' .
             self::convertColorComponentToHex($red) .
             self::convertColorComponentToHex($green) .
             self::convertColorComponentToHex($blue)
@@ -71,6 +69,18 @@ class Color
      */
     protected static function convertColorComponentToHex($colorComponent)
     {
-        return str_pad(dechex($colorComponent), 2, '0', 0);
+        return str_pad(dechex($colorComponent), 2, '0', STR_PAD_LEFT);
+    }
+
+    /**
+     * Returns the ARGB color of the given RGB color,
+     * assuming that alpha value is always 1.
+     *
+     * @param string $rgbColor RGB color like "FF08B2"
+     * @return string ARGB color
+     */
+    public static function toARGB($rgbColor)
+    {
+        return 'FF' . $rgbColor;
     }
 }

src/Spout/Writer/WriterFactory.php

@@ -9,7 +9,7 @@ use Box\Spout\Common\Type;
 /**
  * Class WriterFactory
  * This factory is used to create writers, based on the type of the file to be read.
- * It supports CSV and XLSX formats.
+ * It supports CSV, XLSX and ODS formats.
  *
  * @package Box\Spout\Writer
  */
@@ -33,6 +33,9 @@ class WriterFactory
             case Type::XLSX:
                 $writer = new XLSX\Writer();
                 break;
+            case Type::ODS:
+                $writer = new ODS\Writer();
+                break;
             default:
                 throw new UnsupportedTypeException('No writers supporting the given type: ' . $writerType);
         }

src/Spout/Writer/XLSX/Helper/FileSystemHelper.php

@@ -2,6 +2,7 @@
 
 namespace Box\Spout\Writer\XLSX\Helper;
 
+use Box\Spout\Writer\Common\Helper\ZipHelper;
 use Box\Spout\Writer\XLSX\Internal\Worksheet;
 
 /**
@@ -284,6 +285,7 @@ EOD;
 
 EOD;
 
+        /** @noinspection PhpUnnecessaryFullyQualifiedNameInspection */
         $escaper = new \Box\Spout\Common\Escaper\XLSX();
 
         /** @var Worksheet $worksheet */
@@ -354,42 +356,10 @@ EOD;
      */
     public function zipRootFolderAndCopyToStream($streamPointer)
     {
-        $this->zipRootFolder();
-        $this->copyZipToStream($streamPointer);
+        $zipHelper = new ZipHelper();
+        $zipHelper->zipFolderAndCopyToStream($this->rootFolder, $streamPointer);
 
         // once the zip is copied, remove it
-        $this->deleteFile($this->getZipFilePath());
-    }
-
-    /**
-     * Zips the root folder
-     *
-     * @return void
-     */
-    protected function zipRootFolder()
-    {
-        $zipHelper = new ZipHelper();
-        $zipHelper->zipFolder($this->rootFolder, $this->getZipFilePath());
-    }
-
-    /**
-     * @return string Path of the zip file created from the root folder
-     */
-    protected function getZipFilePath()
-    {
-        return $this->rootFolder . '.zip';
-    }
-
-    /**
-     * Streams the contents of the zip into the given stream
-     *
-     * @param resource $pointer Pointer to the stream to copy the zip
-     * @return void
-     */
-    protected function copyZipToStream($pointer)
-    {
-        $zipFilePointer = fopen($this->getZipFilePath(), 'r');
-        stream_copy_to_stream($zipFilePointer, $pointer);
-        fclose($zipFilePointer);
+        $this->deleteFile($zipHelper->getZipFilePath($this->rootFolder));
     }
 }

src/Spout/Writer/XLSX/Helper/SharedStringsHelper.php

@@ -48,6 +48,7 @@ EOD;
         $header = self::SHARED_STRINGS_XML_FILE_FIRST_PART_HEADER . ' ' . self::DEFAULT_STRINGS_COUNT_PART . '>' . PHP_EOL;
         fwrite($this->sharedStringsFilePointer, $header);
 
+        /** @noinspection PhpUnnecessaryFullyQualifiedNameInspection */
         $this->stringsEscaper = new \Box\Spout\Common\Escaper\XLSX();
     }
 

src/Spout/Writer/XLSX/Helper/StyleHelper.php

@@ -2,122 +2,20 @@
 
 namespace Box\Spout\Writer\XLSX\Helper;
 
+use Box\Spout\Writer\Common\Helper\AbstractStyleHelper;
+use Box\Spout\Writer\Style\Color;
+
 /**
  * Class StyleHelper
  * This class provides helper functions to manage styles
  *
  * @package Box\Spout\Writer\XLSX\Helper
  */
-class StyleHelper
+class StyleHelper extends AbstractStyleHelper
 {
-    /** @var array [SERIALIZED_STYLE] => [STYLE_ID] mapping table, keeping track of the registered styles */
-    protected $serializedStyleToStyleIdMappingTable = [];
-
-    /** @var array [STYLE_ID] => [STYLE] mapping table, keeping track of the registered styles */
-    protected $styleIdToStyleMappingTable = [];
-
-    /**
-     * @param \Box\Spout\Writer\Style\Style $defaultStyle
-     */
-    public function __construct($defaultStyle)
-    {
-        // This ensures that the default style is the first one to be registered
-        $this->registerStyle($defaultStyle);
-    }
-
-    /**
-     * Registers the given style as a used style.
-     * Duplicate styles won't be registered more than once.
-     *
-     * @param \Box\Spout\Writer\Style\Style $style The style to be registered
-     * @return \Box\Spout\Writer\Style\Style The registered style, updated with an internal ID.
-     */
-    public function registerStyle($style)
-    {
-        $serializedStyle = $style->serialize();
-
-        if (!$this->hasStyleAlreadyBeenRegistered($style)) {
-            $nextStyleId = count($this->serializedStyleToStyleIdMappingTable);
-            $style->setId($nextStyleId);
-
-            $this->serializedStyleToStyleIdMappingTable[$serializedStyle] = $nextStyleId;
-            $this->styleIdToStyleMappingTable[$nextStyleId] = $style;
-        }
-
-        return $this->getStyleFromSerializedStyle($serializedStyle);
-    }
-
-    /**
-     * Returns whether the given style has already been registered.
-     *
-     * @param \Box\Spout\Writer\Style\Style $style
-     * @return bool
-     */
-    protected function hasStyleAlreadyBeenRegistered($style)
-    {
-        $serializedStyle = $style->serialize();
-        return array_key_exists($serializedStyle, $this->serializedStyleToStyleIdMappingTable);
-    }
-
-    /**
-     * Returns the registered style associated to the given serialization.
-     *
-     * @param string $serializedStyle The serialized style from which the actual style should be fetched from
-     * @return \Box\Spout\Writer\Style\Style
-     */
-    protected function getStyleFromSerializedStyle($serializedStyle)
-    {
-        $styleId = $this->serializedStyleToStyleIdMappingTable[$serializedStyle];
-        return $this->styleIdToStyleMappingTable[$styleId];
-    }
-
-    /**
-     * Apply additional styles if the given row needs it.
-     * Typically, set "wrap text" if a cell contains a new line.
-     *
-     * @param \Box\Spout\Writer\Style\Style $style The original style
-     * @param array $dataRow The row the style will be applied to
-     * @return \Box\Spout\Writer\Style\Style The updated style
-     */
-    public function applyExtraStylesIfNeeded($style, $dataRow)
-    {
-        $updatedStyle = $this->applyWrapTextIfCellContainsNewLine($style, $dataRow);
-
-        return $updatedStyle;
-    }
-
-    /**
-     * Set the "wrap text" option if a cell of the given row contains a new line.
-     *
-     * @NOTE: There is a bug on the Mac version of Excel (2011 and below) where new lines
-     *        are ignored even when the "wrap text" option is set. This only occurs with
-     *        inline strings (shared strings do work fine).
-     *        A workaround would be to encode "\n" as "_x000D_" but it does not work
-     *        on the Windows version of Excel...
-     *
-     * @param \Box\Spout\Writer\Style\Style $style The original style
-     * @param array $dataRow The row the style will be applied to
-     * @return \Box\Spout\Writer\Style\Style The eventually updated style
-     */
-    protected function applyWrapTextIfCellContainsNewLine($style, $dataRow)
-    {
-        // if the "wrap text" option is already set, no-op
-        if ($style->shouldWrapText()) {
-            return $style;
-        }
-
-        foreach ($dataRow as $cell) {
-            if (is_string($cell) && strpos($cell, "\n") !== false) {
-                $style->setShouldWrapText();
-                break;
-            }
-        }
-
-        return $style;
-    }
-
     /**
      * Returns the content of the "styles.xml" file, given a list of styles.
+     *
      * @return string
      */
     public function getStylesXMLFileContent()
@@ -144,6 +42,7 @@ EOD;
 
     /**
      * Returns the content of the "<fonts>" section.
+     *
      * @return string
      */
     protected function getFontsSectionContent()
@@ -151,11 +50,11 @@ EOD;
         $content = '    <fonts count="' . count($this->styleIdToStyleMappingTable) . '">' . PHP_EOL;
 
         /** @var \Box\Spout\Writer\Style\Style $style */
-        foreach ($this->styleIdToStyleMappingTable as $style) {
+        foreach ($this->getRegisteredStyles() as $style) {
             $content .= '        <font>' . PHP_EOL;
 
             $content .= '            <sz val="' . $style->getFontSize() . '"/>' . PHP_EOL;
-            $content .= '            <color rgb="' . $style->getFontColor() . '"/>' . PHP_EOL;
+            $content .= '            <color rgb="' . Color::toARGB($style->getFontColor()) . '"/>' . PHP_EOL;
             $content .= '            <name val="' . $style->getFontName() . '"/>' . PHP_EOL;
 
             if ($style->isFontBold()) {
@@ -234,14 +133,17 @@ EOD;
 
     /**
      * Returns the content of the "<cellXfs>" section.
+     *
      * @return string
      */
     protected function getCellXfsSectionContent()
     {
-        $content = '    <cellXfs count="' . count($this->styleIdToStyleMappingTable) . '">' . PHP_EOL;
+        $registeredStyles = $this->getRegisteredStyles();
 
-        foreach ($this->styleIdToStyleMappingTable as $styleId => $style) {
-            $content .= '        <xf numFmtId="0" fontId="' . $styleId . '" fillId="0" borderId="0" xfId="0"';
+        $content = '    <cellXfs count="' . count($registeredStyles) . '">' . PHP_EOL;
+
+        foreach ($registeredStyles as $style) {
+            $content .= '        <xf numFmtId="0" fontId="' . $style->getId() . '" fillId="0" borderId="0" xfId="0"';
 
             if ($style->shouldApplyFont()) {
                 $content .= ' applyFont="1"';

src/Spout/Writer/XLSX/Internal/Workbook.php

@@ -2,20 +2,20 @@
 
 namespace Box\Spout\Writer\XLSX\Internal;
 
-use Box\Spout\Writer\Exception\SheetNotFoundException;
+use Box\Spout\Writer\Common\Internal\AbstractWorkbook;
 use Box\Spout\Writer\XLSX\Helper\FileSystemHelper;
 use Box\Spout\Writer\XLSX\Helper\SharedStringsHelper;
 use Box\Spout\Writer\XLSX\Helper\StyleHelper;
-use Box\Spout\Writer\XLSX\Sheet;
+use Box\Spout\Writer\Common\Sheet;
 
 /**
- * Class Book
+ * Class Workbook
  * Represents a workbook within a XLSX file.
  * It provides the functions to work with worksheets.
  *
  * @package Box\Spout\Writer\XLSX\Internal
  */
-class Workbook
+class Workbook extends AbstractWorkbook
 {
     /**
      * Maximum number of rows a XLSX sheet can contain
@@ -26,9 +26,6 @@ class Workbook
     /** @var bool Whether inline or shared strings should be used */
     protected $shouldUseInlineStrings;
 
-    /** @var bool Whether new sheets should be automatically created when the max rows limit per sheet is reached */
-    protected $shouldCreateNewSheetsAutomatically;
-
     /** @var \Box\Spout\Writer\XLSX\Helper\FileSystemHelper Helper to perform file system operations */
     protected $fileSystemHelper;
 
@@ -38,12 +35,6 @@ class Workbook
     /** @var \Box\Spout\Writer\XLSX\Helper\StyleHelper Helper to apply styles */
     protected $styleHelper;
 
-    /** @var Worksheet[] Array containing the workbook's sheets */
-    protected $worksheets = [];
-
-    /** @var Worksheet The worksheet where data will be written to */
-    protected $currentWorksheet;
-
     /**
      * @param string $tempFolder
      * @param bool $shouldUseInlineStrings
@@ -53,8 +44,9 @@ class Workbook
      */
     public function __construct($tempFolder, $shouldUseInlineStrings, $shouldCreateNewSheetsAutomatically, $defaultRowStyle)
     {
+        parent::__construct($shouldCreateNewSheetsAutomatically, $defaultRowStyle);
+
         $this->shouldUseInlineStrings = $shouldUseInlineStrings;
-        $this->shouldCreateNewSheetsAutomatically = $shouldCreateNewSheetsAutomatically;
 
         $this->fileSystemHelper = new FileSystemHelper($tempFolder);
         $this->fileSystemHelper->createBaseFilesAndFolders();
@@ -66,6 +58,22 @@ class Workbook
         $this->sharedStringsHelper = new SharedStringsHelper($xlFolder);
     }
 
+    /**
+     * @return \Box\Spout\Writer\XLSX\Helper\StyleHelper Helper to apply styles to XLSX files
+     */
+    protected function getStyleHelper()
+    {
+        return $this->styleHelper;
+    }
+
+    /**
+     * @return int Maximum number of rows/columns a sheet can contain
+     */
+    protected function getMaxRowsPerWorksheet()
+    {
+        return self::$maxRowsPerWorksheet;
+    }
+
     /**
      * Creates a new sheet in the workbook. The current sheet remains unchanged.
      *
@@ -84,131 +92,6 @@ class Workbook
         return $worksheet;
     }
 
-    /**
-     * 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).
-     *
-     * @return Worksheet The created sheet
-     * @throws \Box\Spout\Common\Exception\IOException If unable to open the sheet for writing
-     */
-    public function addNewSheetAndMakeItCurrent()
-    {
-        $worksheet = $this->addNewSheet();
-        $this->setCurrentWorksheet($worksheet);
-
-        return $worksheet;
-    }
-
-    /**
-     * @return Worksheet[] All the workbook's sheets
-     */
-    public function getWorksheets()
-    {
-        return $this->worksheets;
-    }
-
-    /**
-     * Returns the current sheet
-     *
-     * @return Worksheet The current sheet
-     */
-    public function getCurrentWorksheet()
-    {
-        return $this->currentWorksheet;
-    }
-
-    /**
-     * 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).
-     *
-     * @param \Box\Spout\Writer\XLSX\Sheet $sheet The "external" sheet to set as current
-     * @return void
-     * @throws \Box\Spout\Writer\Exception\SheetNotFoundException If the given sheet does not exist in the workbook
-     */
-    public function setCurrentSheet($sheet)
-    {
-        $worksheet = $this->getWorksheetFromExternalSheet($sheet);
-        if ($worksheet !== null) {
-            $this->currentWorksheet = $worksheet;
-        } else {
-            throw new SheetNotFoundException('The given sheet does not exist in the workbook.');
-        }
-    }
-
-    /**
-     * @param Worksheet $worksheet
-     * @return void
-     */
-    protected function setCurrentWorksheet($worksheet)
-    {
-        $this->currentWorksheet = $worksheet;
-    }
-
-    /**
-     * Returns the worksheet associated to the given external sheet.
-     *
-     * @param \Box\Spout\Writer\XLSX\Sheet $sheet
-     * @return Worksheet|null The worksheet associated to the given external sheet or null if not found.
-     */
-    protected function getWorksheetFromExternalSheet($sheet)
-    {
-        $worksheetFound = null;
-
-        foreach ($this->worksheets as $worksheet) {
-            if ($worksheet->getExternalSheet() === $sheet) {
-                $worksheetFound = $worksheet;
-                break;
-            }
-        }
-
-        return $worksheetFound;
-    }
-
-    /**
-     * Adds data to the current sheet.
-     * If shouldCreateNewSheetsAutomatically option is set to true, it will handle pagination
-     * with the creation of new worksheets if one worksheet has reached its maximum capicity.
-     *
-     * @param array $dataRow Array containing data to be written.
-     *          Example $dataRow = ['data1', 1234, null, '', 'data5'];
-     * @param \Box\Spout\Writer\Style\Style $style Style to be applied to the row.
-     * @return void
-     * @throws \Box\Spout\Common\Exception\IOException If trying to create a new sheet and unable to open the sheet for writing
-     * @throws \Box\Spout\Writer\Exception\WriterException If unable to write data
-     */
-    public function addRowToCurrentWorksheet($dataRow, $style)
-    {
-        $currentWorksheet = $this->getCurrentWorksheet();
-        $hasReachedMaxRows = $this->hasCurrentWorkseetReachedMaxRows();
-
-        // if we reached the maximum number of rows for the current sheet...
-        if ($hasReachedMaxRows) {
-            // ... continue writing in a new sheet if option set
-            if ($this->shouldCreateNewSheetsAutomatically) {
-                $currentWorksheet = $this->addNewSheetAndMakeItCurrent();
-
-                $updatedStyle = $this->styleHelper->applyExtraStylesIfNeeded($style, $dataRow);
-                $registeredStyle = $this->styleHelper->registerStyle($updatedStyle);
-                $currentWorksheet->addRow($dataRow, $registeredStyle);
-            } else {
-                // otherwise, do nothing as the data won't be read anyways
-            }
-        } else {
-            $updatedStyle = $this->styleHelper->applyExtraStylesIfNeeded($style, $dataRow);
-            $registeredStyle = $this->styleHelper->registerStyle($updatedStyle);
-            $currentWorksheet->addRow($dataRow, $registeredStyle);
-        }
-    }
-
-    /**
-     * @return bool Whether the current worksheet has reached the maximum number of rows per sheet.
-     */
-    protected function hasCurrentWorkseetReachedMaxRows()
-    {
-        $currentWorksheet = $this->getCurrentWorksheet();
-        return ($currentWorksheet->getLastWrittenRowIndex() >= self::$maxRowsPerWorksheet);
-    }
-
     /**
      * Closes the workbook and all its associated sheets.
      * All the necessary files are written to disk and zipped together to create the XLSX file.
@@ -219,7 +102,10 @@ class Workbook
      */
     public function close($finalFilePointer)
     {
-        foreach ($this->worksheets as $worksheet) {
+        /** @var Worksheet[] $worksheets */
+        $worksheets = $this->worksheets;
+
+        foreach ($worksheets as $worksheet) {
             $worksheet->close();
         }
 
@@ -227,9 +113,9 @@ class Workbook
 
         // Finish creating all the necessary files before zipping everything together
         $this->fileSystemHelper
-            ->createContentTypesFile($this->worksheets)
-            ->createWorkbookFile($this->worksheets)
-            ->createWorkbookRelsFile($this->worksheets)
+            ->createContentTypesFile($worksheets)
+            ->createWorkbookFile($worksheets)
+            ->createWorkbookRelsFile($worksheets)
             ->createStylesFile($this->styleHelper)
             ->zipRootFolderAndCopyToStream($finalFilePointer);
 

src/Spout/Writer/XLSX/Internal/Worksheet.php

@@ -4,7 +4,8 @@ namespace Box\Spout\Writer\XLSX\Internal;
 
 use Box\Spout\Common\Exception\InvalidArgumentException;
 use Box\Spout\Common\Exception\IOException;
-use Box\Spout\Writer\XLSX\Helper\CellHelper;
+use Box\Spout\Writer\Common\Helper\CellHelper;
+use Box\Spout\Writer\Common\Internal\WorksheetInterface;
 
 /**
  * Class Worksheet
@@ -13,14 +14,14 @@ use Box\Spout\Writer\XLSX\Helper\CellHelper;
  *
  * @package Box\Spout\Writer\XLSX\Internal
  */
-class Worksheet
+class Worksheet implements WorksheetInterface
 {
     const SHEET_XML_FILE_HEADER = <<<EOD
 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <worksheet xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main" xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships">
 EOD;
 
-    /** @var \Box\Spout\Writer\XLSX\Sheet The "external" sheet */
+    /** @var \Box\Spout\Writer\Common\Sheet The "external" sheet */
     protected $externalSheet;
 
     /** @var string Path to the XML file that will contain the sheet data */
@@ -42,7 +43,7 @@ EOD;
     protected $lastWrittenRowIndex = 0;
 
     /**
-     * @param \Box\Spout\Writer\XLSX\Sheet $externalSheet The associated "external" sheet
+     * @param \Box\Spout\Writer\Common\Sheet $externalSheet The associated "external" sheet
      * @param string $worksheetFilesFolder Temporary folder where the files to create the XLSX will be stored
      * @param \Box\Spout\Writer\XLSX\Helper\SharedStringsHelper $sharedStringsHelper Helper for shared strings
      * @param bool $shouldUseInlineStrings Whether inline or shared strings should be used
@@ -54,6 +55,7 @@ EOD;
         $this->sharedStringsHelper = $sharedStringsHelper;
         $this->shouldUseInlineStrings = $shouldUseInlineStrings;
 
+        /** @noinspection PhpUnnecessaryFullyQualifiedNameInspection */
         $this->stringsEscaper = new \Box\Spout\Common\Escaper\XLSX();
 
         $this->worksheetFilePath = $worksheetFilesFolder . '/' . strtolower($this->externalSheet->getName()) . '.xml';
@@ -76,7 +78,20 @@ EOD;
     }
 
     /**
-     * @return \Box\Spout\Writer\XLSX\Sheet The "external" sheet
+     * Checks if the book has been created. Throws an exception if not created yet.
+     *
+     * @return void
+     * @throws \Box\Spout\Common\Exception\IOException If the sheet data file cannot be opened for writing
+     */
+    protected function throwIfSheetFilePointerIsNotAvailable()
+    {
+        if (!$this->sheetFilePointer) {
+            throw new IOException('Unable to open sheet for writing.');
+        }
+    }
+
+    /**
+     * @return \Box\Spout\Writer\Common\Sheet The "external" sheet
      */
     public function getExternalSheet()
     {
@@ -100,19 +115,6 @@ EOD;
         return $this->externalSheet->getIndex() + 1;
     }
 
-    /**
-     * Checks if the book has been created. Throws an exception if not created yet.
-     *
-     * @return void
-     * @throws \Box\Spout\Common\Exception\IOException If the sheet data file cannot be opened for writing
-     */
-    protected function throwIfSheetFilePointerIsNotAvailable()
-    {
-        if (!$this->sheetFilePointer) {
-            throw new IOException('Unable to open sheet for writing.');
-        }
-    }
-
     /**
      * Adds data to the worksheet.
      *

src/Spout/Writer/XLSX/Writer.php

@@ -2,9 +2,7 @@
 
 namespace Box\Spout\Writer\XLSX;
 
-use Box\Spout\Writer\AbstractWriter;
-use Box\Spout\Writer\Exception\WriterAlreadyOpenedException;
-use Box\Spout\Writer\Exception\WriterNotOpenedException;
+use Box\Spout\Writer\AbstractMultiSheetsWriter;
 use Box\Spout\Writer\Style\StyleBuilder;
 use Box\Spout\Writer\XLSX\Internal\Workbook;
 
@@ -14,7 +12,7 @@ use Box\Spout\Writer\XLSX\Internal\Workbook;
  *
  * @package Box\Spout\Writer\XLSX
  */
-class Writer extends AbstractWriter
+class Writer extends AbstractMultiSheetsWriter
 {
     /** Default style font values */
     const DEFAULT_FONT_SIZE = 12;
@@ -35,9 +33,6 @@ class Writer extends AbstractWriter
     /** @var Internal\Workbook The workbook for the XLSX file */
     protected $book;
 
-    /** @var int */
-    protected $highestRowIndex = 0;
-
     /**
      * Sets a custom temporary folder for creating intermediate files/folders.
      * This must be set before opening the writer.
@@ -48,7 +43,7 @@ class Writer extends AbstractWriter
      */
     public function setTempFolder($tempFolder)
     {
-        $this->throwIfWriterAlreadyOpened();
+        $this->throwIfWriterAlreadyOpened('Writer must be configured before opening it.');
 
         $this->tempFolder = $tempFolder;
         return $this;
@@ -64,7 +59,7 @@ class Writer extends AbstractWriter
      */
     public function setShouldUseInlineStrings($shouldUseInlineStrings)
     {
-        $this->throwIfWriterAlreadyOpened();
+        $this->throwIfWriterAlreadyOpened('Writer must be configured before opening it.');
 
         $this->shouldUseInlineStrings = $shouldUseInlineStrings;
         return $this;
@@ -80,26 +75,12 @@ class Writer extends AbstractWriter
      */
     public function setShouldCreateNewSheetsAutomatically($shouldCreateNewSheetsAutomatically)
     {
-        $this->throwIfWriterAlreadyOpened();
+        $this->throwIfWriterAlreadyOpened('Writer must be configured before opening it.');
 
         $this->shouldCreateNewSheetsAutomatically = $shouldCreateNewSheetsAutomatically;
         return $this;
     }
 
-    /**
-     * Checks if the writer has already been opened, since some actions must be done before it gets opened.
-     * Throws an exception if already opened.
-     *
-     * @return void
-     * @throws \Box\Spout\Writer\Exception\WriterAlreadyOpenedException If the writer was already opened and must not be.
-     */
-    protected function throwIfWriterAlreadyOpened()
-    {
-        if ($this->isWriterOpened) {
-            throw new WriterAlreadyOpenedException('Writer must be configured before opening it.');
-        }
-    }
-
     /**
      * Configures the write and sets the current sheet pointer to a new sheet.
      *
@@ -116,78 +97,11 @@ class Writer extends AbstractWriter
     }
 
     /**
-     * Returns all the workbook's sheets
-     *
-     * @return Sheet[] All the workbook's sheets
-     * @throws \Box\Spout\Writer\Exception\WriterNotOpenedException If the writer has not been opened yet
+     * @return Internal\Workbook The workbook representing the file to be written
      */
-    public function getSheets()
+    protected function getWorkbook()
     {
-        $this->throwIfBookIsNotAvailable();
-
-        $externalSheets = [];
-        $worksheets = $this->book->getWorksheets();
-
-        /** @var Internal\Worksheet $worksheet */
-        foreach ($worksheets as $worksheet) {
-            $externalSheets[] = $worksheet->getExternalSheet();
-        }
-
-        return $externalSheets;
-    }
-
-    /**
-     * Creates a new sheet and make it the current sheet. The data will now be written to this sheet.
-     *
-     * @return Sheet The created sheet
-     * @throws \Box\Spout\Writer\Exception\WriterNotOpenedException If the writer has not been opened yet
-     */
-    public function addNewSheetAndMakeItCurrent()
-    {
-        $this->throwIfBookIsNotAvailable();
-        $worksheet = $this->book->addNewSheetAndMakeItCurrent();
-
-        return $worksheet->getExternalSheet();
-    }
-
-    /**
-     * Returns the current sheet
-     *
-     * @return Sheet The current sheet
-     * @throws \Box\Spout\Writer\Exception\WriterNotOpenedException If the writer has not been opened yet
-     */
-    public function getCurrentSheet()
-    {
-        $this->throwIfBookIsNotAvailable();
-        return $this->book->getCurrentWorksheet()->getExternalSheet();
-    }
-
-    /**
-     * 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).
-     *
-     * @param Sheet $sheet The sheet to set as current
-     * @return void
-     * @throws \Box\Spout\Writer\Exception\WriterNotOpenedException If the writer has not been opened yet
-     * @throws \Box\Spout\Writer\Exception\SheetNotFoundException If the given sheet does not exist in the workbook
-     */
-    public function setCurrentSheet($sheet)
-    {
-        $this->throwIfBookIsNotAvailable();
-        $this->book->setCurrentSheet($sheet);
-    }
-
-    /**
-     * Checks if the book has been created. Throws an exception if not created yet.
-     *
-     * @return void
-     * @throws \Box\Spout\Writer\Exception\WriterNotOpenedException If the book is not created yet
-     */
-    protected function throwIfBookIsNotAvailable()
-    {
-        if (!$this->book) {
-            throw new WriterNotOpenedException('The writer must be opened before performing this action.');
-        }
+        return $this->book;
     }
 
     /**