123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586 |
- <?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;
- }
- }
- }
- }
|