| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198 |
- <?php
- namespace PhpOffice\PhpSpreadsheet\Style;
- class Protection extends Supervisor
- {
- /** Protection styles */
- const PROTECTION_INHERIT = 'inherit';
- const PROTECTION_PROTECTED = 'protected';
- const PROTECTION_UNPROTECTED = 'unprotected';
- /**
- * Locked.
- *
- * @var string
- */
- protected $locked;
- /**
- * Hidden.
- *
- * @var string
- */
- protected $hidden;
- /**
- * Create a new Protection.
- *
- * @param bool $isSupervisor Flag indicating if this is a supervisor or not
- * Leave this value at default unless you understand exactly what
- * its ramifications are
- * @param bool $isConditional Flag indicating if this is a conditional style or not
- * Leave this value at default unless you understand exactly what
- * its ramifications are
- */
- public function __construct($isSupervisor = false, $isConditional = false)
- {
- // Supervisor?
- parent::__construct($isSupervisor);
- // Initialise values
- if (!$isConditional) {
- $this->locked = self::PROTECTION_INHERIT;
- $this->hidden = self::PROTECTION_INHERIT;
- }
- }
- /**
- * Get the shared style component for the currently active cell in currently active sheet.
- * Only used for style supervisor.
- *
- * @return Protection
- */
- public function getSharedComponent()
- {
- /** @var Style */
- $parent = $this->parent;
- return $parent->getSharedComponent()->getProtection();
- }
- /**
- * Build style array from subcomponents.
- *
- * @param array $array
- *
- * @return array
- */
- public function getStyleArray($array)
- {
- return ['protection' => $array];
- }
- /**
- * Apply styles from array.
- *
- * <code>
- * $spreadsheet->getActiveSheet()->getStyle('B2')->getLocked()->applyFromArray(
- * [
- * 'locked' => TRUE,
- * 'hidden' => FALSE
- * ]
- * );
- * </code>
- *
- * @param array $styleArray Array containing style information
- *
- * @return $this
- */
- public function applyFromArray(array $styleArray)
- {
- if ($this->isSupervisor) {
- $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($this->getStyleArray($styleArray));
- } else {
- if (isset($styleArray['locked'])) {
- $this->setLocked($styleArray['locked']);
- }
- if (isset($styleArray['hidden'])) {
- $this->setHidden($styleArray['hidden']);
- }
- }
- return $this;
- }
- /**
- * Get locked.
- *
- * @return string
- */
- public function getLocked()
- {
- if ($this->isSupervisor) {
- return $this->getSharedComponent()->getLocked();
- }
- return $this->locked;
- }
- /**
- * Set locked.
- *
- * @param string $lockType see self::PROTECTION_*
- *
- * @return $this
- */
- public function setLocked($lockType)
- {
- if ($this->isSupervisor) {
- $styleArray = $this->getStyleArray(['locked' => $lockType]);
- $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);
- } else {
- $this->locked = $lockType;
- }
- return $this;
- }
- /**
- * Get hidden.
- *
- * @return string
- */
- public function getHidden()
- {
- if ($this->isSupervisor) {
- return $this->getSharedComponent()->getHidden();
- }
- return $this->hidden;
- }
- /**
- * Set hidden.
- *
- * @param string $hiddenType see self::PROTECTION_*
- *
- * @return $this
- */
- public function setHidden($hiddenType)
- {
- if ($this->isSupervisor) {
- $styleArray = $this->getStyleArray(['hidden' => $hiddenType]);
- $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);
- } else {
- $this->hidden = $hiddenType;
- }
- return $this;
- }
- /**
- * Get hash code.
- *
- * @return string Hash code
- */
- public function getHashCode()
- {
- if ($this->isSupervisor) {
- return $this->getSharedComponent()->getHashCode();
- }
- return md5(
- $this->locked .
- $this->hidden .
- __CLASS__
- );
- }
- protected function exportArray1(): array
- {
- $exportedArray = [];
- $this->exportArray2($exportedArray, 'locked', $this->getLocked());
- $this->exportArray2($exportedArray, 'hidden', $this->getHidden());
- return $exportedArray;
- }
- }
|