Move entities and managers back to Common (#431)

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

@@ -0,0 +1,80 @@
+<?php
+
+namespace Box\Spout\Writer\Common\Manager;
+
+use Box\Spout\Common\Exception\IOException;
+use Box\Spout\Writer\Common\Sheet;
+use Box\Spout\Writer\Common\Entity\Workbook;
+use Box\Spout\Writer\Common\Entity\Worksheet;
+use Box\Spout\Writer\Exception\SheetNotFoundException;
+use Box\Spout\Writer\Exception\WriterException;
+use Box\Spout\Writer\Style\Style;
+
+/**
+ * Interface WorkbookManagerInterface
+ * workbook manager interface, providing the generic interfaces to work with workbook.
+ *
+ * @package Box\Spout\Writer\Common\Manager
+ */
+interface WorkbookManagerInterface
+{
+    /**
+     * @return Workbook
+     */
+    public function getWorkbook();
+
+    /**
+     * Creates a new sheet in the workbook and make it the current sheet.
+     * The writing will resume where it stopped (i.e. data won't be truncated).
+     *
+     * @return Worksheet The created sheet
+     * @throws IOException If unable to open the sheet for writing
+     */
+    public function addNewSheetAndMakeItCurrent();
+
+    /**
+     * @return Worksheet[] All the workbook's sheets
+     */
+    public function getWorksheets();
+
+    /**
+     * Returns the current sheet
+     *
+     * @return Worksheet 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 Sheet $sheet The "external" sheet to set as current
+     * @return void
+     * @throws SheetNotFoundException If the given sheet does not exist in the workbook
+     */
+    public function setCurrentSheet(Sheet $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. Cannot be empty.
+     *          Example $dataRow = ['data1', 1234, null, '', 'data5'];
+     * @param Style $style Style to be applied to the row.
+     * @return void
+     * @throws IOException If trying to create a new sheet and unable to open the sheet for writing
+     * @throws WriterException If unable to write data
+     */
+    public function addRowToCurrentWorksheet($dataRow, Style $style);
+
+    /**
+     * Closes the workbook and all its associated sheets.
+     * All the necessary files are written to disk and zipped together to create the final file.
+     * All the temporary files are then deleted.
+     *
+     * @param resource $finalFilePointer Pointer to the spreadsheet that will be created
+     * @return void
+     */
+    public function close($finalFilePointer);
+}