bc17311f5f
This commit is a big refactor that improves the code organization. It focuses on how dependencies are injected into the different classes. This is now done via some factories. Also, the code is now built around entities (data model that only exposes getters and setters), managers (used to manage an entity) and helpers (used by the managers to perform some specific tasks). The refactoring is not fully complete, as some dependencies are still hidden...
117 lines
2.4 KiB
PHP
117 lines
2.4 KiB
PHP
<?php
|
|
|
|
namespace Box\Spout\Writer\Entity;
|
|
|
|
use Box\Spout\Writer\Common\Sheet;
|
|
|
|
/**
|
|
* Class Worksheet
|
|
* Entity describing a Worksheet
|
|
*
|
|
* @package Box\Spout\Writer\Entity
|
|
*/
|
|
class Worksheet
|
|
{
|
|
/** @var string Path to the XML file that will contain the sheet data */
|
|
private $filePath;
|
|
|
|
/** @var Resource Pointer to the sheet data file (e.g. xl/worksheets/sheet1.xml) */
|
|
private $filePointer;
|
|
|
|
/** @var Sheet The "external" sheet */
|
|
private $externalSheet;
|
|
|
|
/** @var int Maximum number of columns among all the written rows */
|
|
private $maxNumColumns;
|
|
|
|
/** @var int Index of the last written row */
|
|
private $lastWrittenRowIndex;
|
|
|
|
/**
|
|
* Worksheet constructor.
|
|
*
|
|
* @param string $worksheetFilePath
|
|
* @param Sheet $externalSheet
|
|
*/
|
|
public function __construct($worksheetFilePath, Sheet $externalSheet)
|
|
{
|
|
$this->filePath = $worksheetFilePath;
|
|
$this->filePointer = null;
|
|
$this->externalSheet = $externalSheet;
|
|
$this->maxNumColumns = 0;
|
|
$this->lastWrittenRowIndex = 0;
|
|
}
|
|
|
|
/**
|
|
* @return string
|
|
*/
|
|
public function getFilePath()
|
|
{
|
|
return $this->filePath;
|
|
}
|
|
|
|
/**
|
|
* @return Resource
|
|
*/
|
|
public function getFilePointer()
|
|
{
|
|
return $this->filePointer;
|
|
}
|
|
|
|
/**
|
|
* @param Resource $filePointer
|
|
*/
|
|
public function setFilePointer($filePointer)
|
|
{
|
|
$this->filePointer = $filePointer;
|
|
}
|
|
|
|
/**
|
|
* @return Sheet
|
|
*/
|
|
public function getExternalSheet()
|
|
{
|
|
return $this->externalSheet;
|
|
}
|
|
|
|
/**
|
|
* @return int
|
|
*/
|
|
public function getMaxNumColumns()
|
|
{
|
|
return $this->maxNumColumns;
|
|
}
|
|
|
|
/**
|
|
* @param int $maxNumColumns
|
|
*/
|
|
public function setMaxNumColumns($maxNumColumns)
|
|
{
|
|
$this->maxNumColumns = $maxNumColumns;
|
|
}
|
|
|
|
/**
|
|
* @return int
|
|
*/
|
|
public function getLastWrittenRowIndex()
|
|
{
|
|
return $this->lastWrittenRowIndex;
|
|
}
|
|
|
|
/**
|
|
* @param int $lastWrittenRowIndex
|
|
*/
|
|
public function setLastWrittenRowIndex($lastWrittenRowIndex)
|
|
{
|
|
$this->lastWrittenRowIndex = $lastWrittenRowIndex;
|
|
}
|
|
|
|
/**
|
|
* @return int The ID of the worksheet
|
|
*/
|
|
public function getId()
|
|
{
|
|
// sheet index is zero-based, while ID is 1-based
|
|
return $this->externalSheet->getIndex() + 1;
|
|
}
|
|
} |