Adrien Loison
6b7366bb6f
/!\ Removed PHP 7.2 support /!\ - PHPUnit 8 => 9 (+ fix the tests) - PHP-CS-Fixer 2 => 3 (+ fix the code) - Introduced PHP stan
112 lines
2.8 KiB
PHP
112 lines
2.8 KiB
PHP
<?php
|
|
|
|
namespace Box\Spout\Writer\Common\Entity;
|
|
|
|
use Box\Spout\Writer\Common\Manager\SheetManager;
|
|
|
|
/**
|
|
* Class Sheet
|
|
* External representation of a worksheet
|
|
*/
|
|
class Sheet
|
|
{
|
|
public const DEFAULT_SHEET_NAME_PREFIX = 'Sheet';
|
|
|
|
/** @var int Index of the sheet, based on order in the workbook (zero-based) */
|
|
private $index;
|
|
|
|
/** @var string ID of the sheet's associated workbook. Used to restrict sheet name uniqueness enforcement to a single workbook */
|
|
private $associatedWorkbookId;
|
|
|
|
/** @var string Name of the sheet */
|
|
private $name;
|
|
|
|
/** @var bool Visibility of the sheet */
|
|
private $isVisible;
|
|
|
|
/** @var SheetManager Sheet manager */
|
|
private $sheetManager;
|
|
|
|
/**
|
|
* @param int $sheetIndex Index of the sheet, based on order in the workbook (zero-based)
|
|
* @param string $associatedWorkbookId ID of the sheet's associated workbook
|
|
* @param SheetManager $sheetManager To manage sheets
|
|
*/
|
|
public function __construct($sheetIndex, $associatedWorkbookId, SheetManager $sheetManager)
|
|
{
|
|
$this->index = $sheetIndex;
|
|
$this->associatedWorkbookId = $associatedWorkbookId;
|
|
|
|
$this->sheetManager = $sheetManager;
|
|
$this->sheetManager->markWorkbookIdAsUsed($associatedWorkbookId);
|
|
|
|
$this->setName(self::DEFAULT_SHEET_NAME_PREFIX . ($sheetIndex + 1));
|
|
$this->setIsVisible(true);
|
|
}
|
|
|
|
/**
|
|
* @return int Index of the sheet, based on order in the workbook (zero-based)
|
|
*/
|
|
public function getIndex()
|
|
{
|
|
return $this->index;
|
|
}
|
|
|
|
/**
|
|
* @return string
|
|
*/
|
|
public function getAssociatedWorkbookId()
|
|
{
|
|
return $this->associatedWorkbookId;
|
|
}
|
|
|
|
/**
|
|
* @return string Name of the sheet
|
|
*/
|
|
public function getName()
|
|
{
|
|
return $this->name;
|
|
}
|
|
|
|
/**
|
|
* Sets the name of the sheet. Note that Excel has some restrictions on the name:
|
|
* - it should not be blank
|
|
* - it should not exceed 31 characters
|
|
* - it should not contain these characters: \ / ? * : [ or ]
|
|
* - it should be unique
|
|
*
|
|
* @param string $name Name of the sheet
|
|
* @throws \Box\Spout\Writer\Exception\InvalidSheetNameException If the sheet's name is invalid.
|
|
* @return Sheet
|
|
*/
|
|
public function setName($name)
|
|
{
|
|
$this->sheetManager->throwIfNameIsInvalid($name, $this);
|
|
|
|
$this->name = $name;
|
|
|
|
$this->sheetManager->markSheetNameAsUsed($this);
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @return bool isVisible Visibility of the sheet
|
|
*/
|
|
public function isVisible()
|
|
{
|
|
return $this->isVisible;
|
|
}
|
|
|
|
/**
|
|
* @param bool $isVisible Visibility of the sheet
|
|
* @return Sheet
|
|
*/
|
|
public function setIsVisible($isVisible)
|
|
{
|
|
$this->isVisible = $isVisible;
|
|
|
|
return $this;
|
|
}
|
|
}
|