254 lines
9.2 KiB
PHP
254 lines
9.2 KiB
PHP
<?php
|
|
|
|
namespace Box\Spout\Writer\XLSX\Manager;
|
|
|
|
use Box\Spout\Common\Exception\InvalidArgumentException;
|
|
use Box\Spout\Common\Exception\IOException;
|
|
use Box\Spout\Common\Helper\StringHelper;
|
|
use Box\Spout\Common\Manager\OptionsManagerInterface;
|
|
use Box\Spout\Writer\Common\Creator\EntityFactory;
|
|
use Box\Spout\Writer\Common\Entity\Cell;
|
|
use Box\Spout\Writer\Common\Entity\Options;
|
|
use Box\Spout\Writer\Common\Entity\Row;
|
|
use Box\Spout\Writer\Common\Entity\Style\Style;
|
|
use Box\Spout\Writer\Common\Entity\Worksheet;
|
|
use Box\Spout\Writer\Common\Helper\CellHelper;
|
|
use Box\Spout\Writer\Common\Manager\WorksheetManagerInterface;
|
|
use Box\Spout\Writer\XLSX\Manager\Style\StyleManager;
|
|
|
|
/**
|
|
* Class WorksheetManager
|
|
* XLSX worksheet manager, providing the interfaces to work with XLSX worksheets.
|
|
*/
|
|
class WorksheetManager implements WorksheetManagerInterface
|
|
{
|
|
/**
|
|
* Maximum number of characters a cell can contain
|
|
* @see https://support.office.com/en-us/article/Excel-specifications-and-limits-16c69c74-3d6a-4aaf-ba35-e6eb276e8eaa [Excel 2007]
|
|
* @see https://support.office.com/en-us/article/Excel-specifications-and-limits-1672b34d-7043-467e-8e27-269d656771c3 [Excel 2010]
|
|
* @see https://support.office.com/en-us/article/Excel-specifications-and-limits-ca36e2dc-1f09-4620-b726-67c00b05040f [Excel 2013/2016]
|
|
*/
|
|
const MAX_CHARACTERS_PER_CELL = 32767;
|
|
|
|
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 bool Whether inline or shared strings should be used */
|
|
protected $shouldUseInlineStrings;
|
|
|
|
/** @var StyleManager Manages styles */
|
|
private $styleManager;
|
|
|
|
/** @var SharedStringsManager Helper to write shared strings */
|
|
private $sharedStringsManager;
|
|
|
|
/** @var \Box\Spout\Common\Helper\Escaper\XLSX Strings escaper */
|
|
private $stringsEscaper;
|
|
|
|
/** @var StringHelper String helper */
|
|
private $stringHelper;
|
|
|
|
/** @var EntityFactory Factory to create entities */
|
|
private $entityFactory;
|
|
|
|
/**
|
|
* WorksheetManager constructor.
|
|
*
|
|
* @param OptionsManagerInterface $optionsManager
|
|
* @param StyleManager $styleManager
|
|
* @param SharedStringsManager $sharedStringsManager
|
|
* @param \Box\Spout\Common\Helper\Escaper\XLSX $stringsEscaper
|
|
* @param StringHelper $stringHelper
|
|
* @param EntityFactory $entityFactory
|
|
*/
|
|
public function __construct(
|
|
OptionsManagerInterface $optionsManager,
|
|
StyleManager $styleManager,
|
|
SharedStringsManager $sharedStringsManager,
|
|
\Box\Spout\Common\Helper\Escaper\XLSX $stringsEscaper,
|
|
StringHelper $stringHelper,
|
|
EntityFactory $entityFactory
|
|
) {
|
|
$this->shouldUseInlineStrings = $optionsManager->getOption(Options::SHOULD_USE_INLINE_STRINGS);
|
|
$this->styleManager = $styleManager;
|
|
$this->sharedStringsManager = $sharedStringsManager;
|
|
$this->stringsEscaper = $stringsEscaper;
|
|
$this->stringHelper = $stringHelper;
|
|
$this->entityFactory = $entityFactory;
|
|
}
|
|
|
|
/**
|
|
* @return SharedStringsManager
|
|
*/
|
|
public function getSharedStringsManager()
|
|
{
|
|
return $this->sharedStringsManager;
|
|
}
|
|
|
|
/**
|
|
* Prepares the worksheet to accept data
|
|
*
|
|
* @param Worksheet $worksheet The worksheet to start
|
|
* @throws \Box\Spout\Common\Exception\IOException If the sheet data file cannot be opened for writing
|
|
* @return void
|
|
*/
|
|
public function startSheet(Worksheet $worksheet)
|
|
{
|
|
$sheetFilePointer = fopen($worksheet->getFilePath(), 'w');
|
|
$this->throwIfSheetFilePointerIsNotAvailable($sheetFilePointer);
|
|
|
|
$worksheet->setFilePointer($sheetFilePointer);
|
|
|
|
fwrite($sheetFilePointer, self::SHEET_XML_FILE_HEADER);
|
|
fwrite($sheetFilePointer, '<sheetData>');
|
|
}
|
|
|
|
/**
|
|
* Checks if the sheet has been sucessfully created. Throws an exception if not.
|
|
*
|
|
* @param bool|resource $sheetFilePointer Pointer to the sheet data file or FALSE if unable to open the file
|
|
* @throws IOException If the sheet data file cannot be opened for writing
|
|
* @return void
|
|
*/
|
|
private function throwIfSheetFilePointerIsNotAvailable($sheetFilePointer)
|
|
{
|
|
if (!$sheetFilePointer) {
|
|
throw new IOException('Unable to open sheet for writing.');
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Adds a row to the worksheet.
|
|
*
|
|
* @param Worksheet $worksheet The worksheet to add the row to
|
|
* @param Row $row The row to be added
|
|
* @throws IOException If the data cannot be written
|
|
* @throws InvalidArgumentException If a cell value's type is not supported
|
|
* @return void
|
|
*/
|
|
public function addRow(Worksheet $worksheet, Row $row)
|
|
{
|
|
if (!$row->isEmpty()) {
|
|
$this->addNonEmptyRow($worksheet, $row);
|
|
}
|
|
|
|
$worksheet->setLastWrittenRowIndex($worksheet->getLastWrittenRowIndex() + 1);
|
|
}
|
|
|
|
/**
|
|
* Adds non empty row to the worksheet.
|
|
*
|
|
* @param Row $row The row to be written
|
|
* @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
|
|
* @return void
|
|
*/
|
|
private function addNonEmptyRow(Worksheet $worksheet, Row $row)
|
|
{
|
|
$cellNumber = 0;
|
|
$rowIndex = $worksheet->getLastWrittenRowIndex() + 1;
|
|
$numCells = count($row->getCells());
|
|
|
|
$rowXML = '<row r="' . $rowIndex . '" spans="1:' . $numCells . '">';
|
|
|
|
// @TODO refactoring: move this to its own method
|
|
/** @var Cell $cell */
|
|
foreach ($row->getCells() as $cell) {
|
|
// Apply styles - the row style is merged at this point
|
|
$cell->applyStyle($row->getStyle());
|
|
$this->styleManager->applyExtraStylesIfNeeded($cell);
|
|
$registeredStyle = $this->styleManager->registerStyle($cell->getStyle());
|
|
$rowXML .= $this->getCellXML($rowIndex, $cellNumber, $cell, $registeredStyle->getId());
|
|
$cellNumber++;
|
|
}
|
|
|
|
$rowXML .= '</row>';
|
|
|
|
$wasWriteSuccessful = fwrite($worksheet->getFilePointer(), $rowXML);
|
|
if ($wasWriteSuccessful === false) {
|
|
throw new IOException("Unable to write data in {$worksheet->getFilePath()}");
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Build and return xml for a single cell.
|
|
*
|
|
* @param int $rowIndex
|
|
* @param int $cellNumber
|
|
* @param Cell $cell
|
|
* @param int $styleId
|
|
* @throws InvalidArgumentException If the given value cannot be processed
|
|
* @return string
|
|
*/
|
|
private function getCellXML($rowIndex, $cellNumber, Cell $cell, $styleId)
|
|
{
|
|
$columnIndex = CellHelper::getCellIndexFromColumnIndex($cellNumber);
|
|
$cellXML = '<c r="' . $columnIndex . $rowIndex . '"';
|
|
$cellXML .= ' s="' . $styleId . '"';
|
|
|
|
if ($cell->isString()) {
|
|
$cellXML .= $this->getCellXMLFragmentForNonEmptyString($cell->getValue());
|
|
} elseif ($cell->isBoolean()) {
|
|
$cellXML .= ' t="b"><v>' . (int) ($cell->getValue()) . '</v></c>';
|
|
} elseif ($cell->isNumeric()) {
|
|
$cellXML .= '><v>' . $cell->getValue() . '</v></c>';
|
|
} elseif ($cell->isEmpty()) {
|
|
if ($this->styleManager->shouldApplyStyleOnEmptyCell($styleId)) {
|
|
$cellXML .= '/>';
|
|
} else {
|
|
// don't write empty cells that do no need styling
|
|
// NOTE: not appending to $cellXML is the right behavior!!
|
|
$cellXML = '';
|
|
}
|
|
} else {
|
|
throw new InvalidArgumentException('Trying to add a value with an unsupported type: ' . gettype($cell->getValue()));
|
|
}
|
|
|
|
return $cellXML;
|
|
}
|
|
|
|
/**
|
|
* Returns the XML fragment for a cell containing a non empty string
|
|
*
|
|
* @param string $cellValue The cell value
|
|
* @throws InvalidArgumentException If the string exceeds the maximum number of characters allowed per cell
|
|
* @return string The XML fragment representing the cell
|
|
*/
|
|
private function getCellXMLFragmentForNonEmptyString($cellValue)
|
|
{
|
|
if ($this->stringHelper->getStringLength($cellValue) > self::MAX_CHARACTERS_PER_CELL) {
|
|
throw new InvalidArgumentException('Trying to add a value that exceeds the maximum number of characters allowed in a cell (32,767)');
|
|
}
|
|
|
|
if ($this->shouldUseInlineStrings) {
|
|
$cellXMLFragment = ' t="inlineStr"><is><t>' . $this->stringsEscaper->escape($cellValue) . '</t></is></c>';
|
|
} else {
|
|
$sharedStringId = $this->sharedStringsManager->writeString($cellValue);
|
|
$cellXMLFragment = ' t="s"><v>' . $sharedStringId . '</v></c>';
|
|
}
|
|
|
|
return $cellXMLFragment;
|
|
}
|
|
|
|
/**
|
|
* Closes the worksheet
|
|
*
|
|
* @param Worksheet $worksheet
|
|
* @return void
|
|
*/
|
|
public function close(Worksheet $worksheet)
|
|
{
|
|
$worksheetFilePointer = $worksheet->getFilePointer();
|
|
|
|
if (!is_resource($worksheetFilePointer)) {
|
|
return;
|
|
}
|
|
|
|
fwrite($worksheetFilePointer, '</sheetData>');
|
|
fwrite($worksheetFilePointer, '</worksheet>');
|
|
fclose($worksheetFilePointer);
|
|
}
|
|
}
|