AutorÃa | Ultima modificación | Ver Log |
<?php
declare(strict_types=1);
namespace OpenSpout\Writer\Common\Manager;
use OpenSpout\Common\Entity\Row;
use OpenSpout\Common\Exception\InvalidArgumentException;
use OpenSpout\Common\Exception\IOException;
use OpenSpout\Common\Helper\StringHelper;
use OpenSpout\Writer\Common\AbstractOptions;
use OpenSpout\Writer\Common\Entity\Sheet;
use OpenSpout\Writer\Common\Entity\Workbook;
use OpenSpout\Writer\Common\Entity\Worksheet;
use OpenSpout\Writer\Common\Helper\FileSystemWithRootFolderHelperInterface;
use OpenSpout\Writer\Common\Manager\Style\StyleManagerInterface;
use OpenSpout\Writer\Common\Manager\Style\StyleMerger;
use OpenSpout\Writer\Exception\SheetNotFoundException;
/**
* @internal
*/
abstract class AbstractWorkbookManager implements WorkbookManagerInterface
{
protected WorksheetManagerInterface $worksheetManager;
/** @var StyleManagerInterface Manages styles */
protected StyleManagerInterface $styleManager;
/** @var FileSystemWithRootFolderHelperInterface Helper to perform file system operations */
protected FileSystemWithRootFolderHelperInterface $fileSystemHelper;
protected AbstractOptions $options;
/** @var Workbook The workbook to manage */
private readonly Workbook $workbook;
/** @var StyleMerger Helper to merge styles */
private readonly StyleMerger $styleMerger;
/** @var Worksheet The worksheet where data will be written to */
private Worksheet $currentWorksheet;
public function __construct(
Workbook $workbook,
AbstractOptions $options,
WorksheetManagerInterface $worksheetManager,
StyleManagerInterface $styleManager,
StyleMerger $styleMerger,
FileSystemWithRootFolderHelperInterface $fileSystemHelper
) {
$this->workbook = $workbook;
$this->options = $options;
$this->worksheetManager = $worksheetManager;
$this->styleManager = $styleManager;
$this->styleMerger = $styleMerger;
$this->fileSystemHelper = $fileSystemHelper;
}
/**
* 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
*/
final public function addNewSheetAndMakeItCurrent(): Worksheet
{
$worksheet = $this->addNewSheet();
$this->setCurrentWorksheet($worksheet);
return $worksheet;
}
/**
* @return Worksheet[] All the workbook's sheets
*/
final public function getWorksheets(): array
{
return $this->workbook->getWorksheets();
}
/**
* Returns the current sheet.
*
* @return Worksheet The current sheet
*/
final public function getCurrentWorksheet(): Worksheet
{
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 Sheet $sheet The "external" sheet to set as current
*
* @throws SheetNotFoundException If the given sheet does not exist in the workbook
*/
final public function setCurrentSheet(Sheet $sheet): void
{
$worksheet = $this->getWorksheetFromExternalSheet($sheet);
if (null !== $worksheet) {
$this->currentWorksheet = $worksheet;
} else {
throw new SheetNotFoundException('The given sheet does not exist in the workbook.');
}
}
/**
* Adds a row 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 Row $row The row to be added
*
* @throws IOException If trying to create a new sheet and unable to open the sheet for writing
* @throws InvalidArgumentException
*/
final public function addRowToCurrentWorksheet(Row $row): void
{
$currentWorksheet = $this->getCurrentWorksheet();
if ($this->hasCurrentWorksheetReachedMaxRows()) {
if (!$this->options->SHOULD_CREATE_NEW_SHEETS_AUTOMATICALLY) {
return;
}
$currentWorksheet = $this->addNewSheetAndMakeItCurrent();
}
$this->addRowToWorksheet($currentWorksheet, $row);
$currentWorksheet->getExternalSheet()->incrementWrittenRowCount();
}
/**
* 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
*/
final public function close($finalFilePointer): void
{
$this->closeAllWorksheets();
$this->closeRemainingObjects();
$this->writeAllFilesToDiskAndZipThem($finalFilePointer);
$this->cleanupTempFolder();
}
/**
* @return int Maximum number of rows/columns a sheet can contain
*/
abstract protected function getMaxRowsPerWorksheet(): int;
/**
* Closes custom objects that are still opened.
*/
protected function closeRemainingObjects(): void
{
// do nothing by default
}
/**
* Writes all the necessary files to disk and zip them together to create the final file.
*
* @param resource $finalFilePointer Pointer to the spreadsheet that will be created
*/
abstract protected function writeAllFilesToDiskAndZipThem($finalFilePointer): void;
/**
* @return string The file path where the data for the given sheet will be stored
*/
private function getWorksheetFilePath(Sheet $sheet): string
{
$sheetsContentTempFolder = $this->fileSystemHelper->getSheetsContentTempFolder();
return $sheetsContentTempFolder.\DIRECTORY_SEPARATOR.'sheet'.(1 + $sheet->getIndex()).'.xml';
}
/**
* Deletes the root folder created in the temp folder and all its contents.
*/
private function cleanupTempFolder(): void
{
$rootFolder = $this->fileSystemHelper->getRootFolder();
$this->fileSystemHelper->deleteFolderRecursively($rootFolder);
}
/**
* Creates a new sheet in the workbook. The current sheet remains unchanged.
*
* @return Worksheet The created sheet
*
* @throws IOException If unable to open the sheet for writing
*/
private function addNewSheet(): Worksheet
{
$worksheets = $this->getWorksheets();
$newSheetIndex = \count($worksheets);
$sheetManager = new SheetManager(StringHelper::factory());
$sheet = new Sheet($newSheetIndex, $this->workbook->getInternalId(), $sheetManager);
$worksheetFilePath = $this->getWorksheetFilePath($sheet);
$worksheet = new Worksheet($worksheetFilePath, $sheet);
$this->worksheetManager->startSheet($worksheet);
$worksheets[] = $worksheet;
$this->workbook->setWorksheets($worksheets);
return $worksheet;
}
private function setCurrentWorksheet(Worksheet $worksheet): void
{
$this->currentWorksheet = $worksheet;
}
/**
* Returns the worksheet associated to the given external sheet.
*
* @return null|Worksheet the worksheet associated to the given external sheet or null if not found
*/
private function getWorksheetFromExternalSheet(Sheet $sheet): ?Worksheet
{
$worksheetFound = null;
foreach ($this->getWorksheets() as $worksheet) {
if ($worksheet->getExternalSheet() === $sheet) {
$worksheetFound = $worksheet;
break;
}
}
return $worksheetFound;
}
/**
* @return bool whether the current worksheet has reached the maximum number of rows per sheet
*/
private function hasCurrentWorksheetReachedMaxRows(): bool
{
$currentWorksheet = $this->getCurrentWorksheet();
return $currentWorksheet->getLastWrittenRowIndex() >= $this->getMaxRowsPerWorksheet();
}
/**
* Adds a row to the given sheet.
*
* @param Worksheet $worksheet Worksheet to write the row to
* @param Row $row The row to be added
*
* @throws IOException
* @throws InvalidArgumentException
*/
private function addRowToWorksheet(Worksheet $worksheet, Row $row): void
{
$this->applyDefaultRowStyle($row);
$this->worksheetManager->addRow($worksheet, $row);
// update max num columns for the worksheet
$currentMaxNumColumns = $worksheet->getMaxNumColumns();
$cellsCount = $row->getNumCells();
$worksheet->setMaxNumColumns(max($currentMaxNumColumns, $cellsCount));
}
private function applyDefaultRowStyle(Row $row): void
{
$mergedStyle = $this->styleMerger->merge(
$row->getStyle(),
$this->options->DEFAULT_ROW_STYLE
);
$row->setStyle($mergedStyle);
}
/**
* Closes all workbook's associated sheets.
*/
private function closeAllWorksheets(): void
{
$worksheets = $this->getWorksheets();
foreach ($worksheets as $worksheet) {
$this->worksheetManager->close($worksheet);
}
}
}