<?php
|
|
namespace PhpOffice\PhpSpreadsheet\Worksheet;
|
|
use PhpOffice\PhpSpreadsheet\Shared\PasswordHasher;
|
|
class Protection
|
{
|
/**
|
* Sheet.
|
*
|
* @var bool
|
*/
|
private $sheet = false;
|
|
/**
|
* Objects.
|
*
|
* @var bool
|
*/
|
private $objects = false;
|
|
/**
|
* Scenarios.
|
*
|
* @var bool
|
*/
|
private $scenarios = false;
|
|
/**
|
* Format cells.
|
*
|
* @var bool
|
*/
|
private $formatCells = false;
|
|
/**
|
* Format columns.
|
*
|
* @var bool
|
*/
|
private $formatColumns = false;
|
|
/**
|
* Format rows.
|
*
|
* @var bool
|
*/
|
private $formatRows = false;
|
|
/**
|
* Insert columns.
|
*
|
* @var bool
|
*/
|
private $insertColumns = false;
|
|
/**
|
* Insert rows.
|
*
|
* @var bool
|
*/
|
private $insertRows = false;
|
|
/**
|
* Insert hyperlinks.
|
*
|
* @var bool
|
*/
|
private $insertHyperlinks = false;
|
|
/**
|
* Delete columns.
|
*
|
* @var bool
|
*/
|
private $deleteColumns = false;
|
|
/**
|
* Delete rows.
|
*
|
* @var bool
|
*/
|
private $deleteRows = false;
|
|
/**
|
* Select locked cells.
|
*
|
* @var bool
|
*/
|
private $selectLockedCells = false;
|
|
/**
|
* Sort.
|
*
|
* @var bool
|
*/
|
private $sort = false;
|
|
/**
|
* AutoFilter.
|
*
|
* @var bool
|
*/
|
private $autoFilter = false;
|
|
/**
|
* Pivot tables.
|
*
|
* @var bool
|
*/
|
private $pivotTables = false;
|
|
/**
|
* Select unlocked cells.
|
*
|
* @var bool
|
*/
|
private $selectUnlockedCells = false;
|
|
/**
|
* Password.
|
*
|
* @var string
|
*/
|
private $password = '';
|
|
/**
|
* Create a new Protection.
|
*/
|
public function __construct()
|
{
|
}
|
|
/**
|
* Is some sort of protection enabled?
|
*
|
* @return bool
|
*/
|
public function isProtectionEnabled()
|
{
|
return $this->sheet ||
|
$this->objects ||
|
$this->scenarios ||
|
$this->formatCells ||
|
$this->formatColumns ||
|
$this->formatRows ||
|
$this->insertColumns ||
|
$this->insertRows ||
|
$this->insertHyperlinks ||
|
$this->deleteColumns ||
|
$this->deleteRows ||
|
$this->selectLockedCells ||
|
$this->sort ||
|
$this->autoFilter ||
|
$this->pivotTables ||
|
$this->selectUnlockedCells;
|
}
|
|
/**
|
* Get Sheet.
|
*
|
* @return bool
|
*/
|
public function getSheet()
|
{
|
return $this->sheet;
|
}
|
|
/**
|
* Set Sheet.
|
*
|
* @param bool $pValue
|
*
|
* @return $this
|
*/
|
public function setSheet($pValue)
|
{
|
$this->sheet = $pValue;
|
|
return $this;
|
}
|
|
/**
|
* Get Objects.
|
*
|
* @return bool
|
*/
|
public function getObjects()
|
{
|
return $this->objects;
|
}
|
|
/**
|
* Set Objects.
|
*
|
* @param bool $pValue
|
*
|
* @return $this
|
*/
|
public function setObjects($pValue)
|
{
|
$this->objects = $pValue;
|
|
return $this;
|
}
|
|
/**
|
* Get Scenarios.
|
*
|
* @return bool
|
*/
|
public function getScenarios()
|
{
|
return $this->scenarios;
|
}
|
|
/**
|
* Set Scenarios.
|
*
|
* @param bool $pValue
|
*
|
* @return $this
|
*/
|
public function setScenarios($pValue)
|
{
|
$this->scenarios = $pValue;
|
|
return $this;
|
}
|
|
/**
|
* Get FormatCells.
|
*
|
* @return bool
|
*/
|
public function getFormatCells()
|
{
|
return $this->formatCells;
|
}
|
|
/**
|
* Set FormatCells.
|
*
|
* @param bool $pValue
|
*
|
* @return $this
|
*/
|
public function setFormatCells($pValue)
|
{
|
$this->formatCells = $pValue;
|
|
return $this;
|
}
|
|
/**
|
* Get FormatColumns.
|
*
|
* @return bool
|
*/
|
public function getFormatColumns()
|
{
|
return $this->formatColumns;
|
}
|
|
/**
|
* Set FormatColumns.
|
*
|
* @param bool $pValue
|
*
|
* @return $this
|
*/
|
public function setFormatColumns($pValue)
|
{
|
$this->formatColumns = $pValue;
|
|
return $this;
|
}
|
|
/**
|
* Get FormatRows.
|
*
|
* @return bool
|
*/
|
public function getFormatRows()
|
{
|
return $this->formatRows;
|
}
|
|
/**
|
* Set FormatRows.
|
*
|
* @param bool $pValue
|
*
|
* @return $this
|
*/
|
public function setFormatRows($pValue)
|
{
|
$this->formatRows = $pValue;
|
|
return $this;
|
}
|
|
/**
|
* Get InsertColumns.
|
*
|
* @return bool
|
*/
|
public function getInsertColumns()
|
{
|
return $this->insertColumns;
|
}
|
|
/**
|
* Set InsertColumns.
|
*
|
* @param bool $pValue
|
*
|
* @return $this
|
*/
|
public function setInsertColumns($pValue)
|
{
|
$this->insertColumns = $pValue;
|
|
return $this;
|
}
|
|
/**
|
* Get InsertRows.
|
*
|
* @return bool
|
*/
|
public function getInsertRows()
|
{
|
return $this->insertRows;
|
}
|
|
/**
|
* Set InsertRows.
|
*
|
* @param bool $pValue
|
*
|
* @return $this
|
*/
|
public function setInsertRows($pValue)
|
{
|
$this->insertRows = $pValue;
|
|
return $this;
|
}
|
|
/**
|
* Get InsertHyperlinks.
|
*
|
* @return bool
|
*/
|
public function getInsertHyperlinks()
|
{
|
return $this->insertHyperlinks;
|
}
|
|
/**
|
* Set InsertHyperlinks.
|
*
|
* @param bool $pValue
|
*
|
* @return $this
|
*/
|
public function setInsertHyperlinks($pValue)
|
{
|
$this->insertHyperlinks = $pValue;
|
|
return $this;
|
}
|
|
/**
|
* Get DeleteColumns.
|
*
|
* @return bool
|
*/
|
public function getDeleteColumns()
|
{
|
return $this->deleteColumns;
|
}
|
|
/**
|
* Set DeleteColumns.
|
*
|
* @param bool $pValue
|
*
|
* @return $this
|
*/
|
public function setDeleteColumns($pValue)
|
{
|
$this->deleteColumns = $pValue;
|
|
return $this;
|
}
|
|
/**
|
* Get DeleteRows.
|
*
|
* @return bool
|
*/
|
public function getDeleteRows()
|
{
|
return $this->deleteRows;
|
}
|
|
/**
|
* Set DeleteRows.
|
*
|
* @param bool $pValue
|
*
|
* @return $this
|
*/
|
public function setDeleteRows($pValue)
|
{
|
$this->deleteRows = $pValue;
|
|
return $this;
|
}
|
|
/**
|
* Get SelectLockedCells.
|
*
|
* @return bool
|
*/
|
public function getSelectLockedCells()
|
{
|
return $this->selectLockedCells;
|
}
|
|
/**
|
* Set SelectLockedCells.
|
*
|
* @param bool $pValue
|
*
|
* @return $this
|
*/
|
public function setSelectLockedCells($pValue)
|
{
|
$this->selectLockedCells = $pValue;
|
|
return $this;
|
}
|
|
/**
|
* Get Sort.
|
*
|
* @return bool
|
*/
|
public function getSort()
|
{
|
return $this->sort;
|
}
|
|
/**
|
* Set Sort.
|
*
|
* @param bool $pValue
|
*
|
* @return $this
|
*/
|
public function setSort($pValue)
|
{
|
$this->sort = $pValue;
|
|
return $this;
|
}
|
|
/**
|
* Get AutoFilter.
|
*
|
* @return bool
|
*/
|
public function getAutoFilter()
|
{
|
return $this->autoFilter;
|
}
|
|
/**
|
* Set AutoFilter.
|
*
|
* @param bool $pValue
|
*
|
* @return $this
|
*/
|
public function setAutoFilter($pValue)
|
{
|
$this->autoFilter = $pValue;
|
|
return $this;
|
}
|
|
/**
|
* Get PivotTables.
|
*
|
* @return bool
|
*/
|
public function getPivotTables()
|
{
|
return $this->pivotTables;
|
}
|
|
/**
|
* Set PivotTables.
|
*
|
* @param bool $pValue
|
*
|
* @return $this
|
*/
|
public function setPivotTables($pValue)
|
{
|
$this->pivotTables = $pValue;
|
|
return $this;
|
}
|
|
/**
|
* Get SelectUnlockedCells.
|
*
|
* @return bool
|
*/
|
public function getSelectUnlockedCells()
|
{
|
return $this->selectUnlockedCells;
|
}
|
|
/**
|
* Set SelectUnlockedCells.
|
*
|
* @param bool $pValue
|
*
|
* @return $this
|
*/
|
public function setSelectUnlockedCells($pValue)
|
{
|
$this->selectUnlockedCells = $pValue;
|
|
return $this;
|
}
|
|
/**
|
* Get Password (hashed).
|
*
|
* @return string
|
*/
|
public function getPassword()
|
{
|
return $this->password;
|
}
|
|
/**
|
* Set Password.
|
*
|
* @param string $pValue
|
* @param bool $pAlreadyHashed If the password has already been hashed, set this to true
|
*
|
* @return $this
|
*/
|
public function setPassword($pValue, $pAlreadyHashed = false)
|
{
|
if (!$pAlreadyHashed) {
|
$pValue = PasswordHasher::hashPassword($pValue);
|
}
|
$this->password = $pValue;
|
|
return $this;
|
}
|
|
/**
|
* Implement PHP __clone to create a deep clone, not just a shallow copy.
|
*/
|
public function __clone()
|
{
|
$vars = get_object_vars($this);
|
foreach ($vars as $key => $value) {
|
if (is_object($value)) {
|
$this->$key = clone $value;
|
} else {
|
$this->$key = $value;
|
}
|
}
|
}
|
}
|
