Inheritance diagram for PhpOffice\PhpSpreadsheet\Style\Protection:

Collaboration diagram for PhpOffice\PhpSpreadsheet\Style\Protection:

Public Member Functions
	__construct ($isSupervisor=false, $isConditional=false)
	Create a new Protection. More...

	getSharedComponent ()
	Get the shared style component for the currently active cell in currently active sheet. More...

	getStyleArray ($array)
	Build style array from subcomponents. More...

	applyFromArray (array $pStyles)
	Apply styles from array. More...

	getLocked ()
	Get locked. More...

	setLocked ($pValue)
	Set locked. More...

	getHidden ()
	Get hidden. More...

	setHidden ($pValue)
	Set hidden. More...

	getHashCode ()
	Get hash code. More...

Public Member Functions inherited from PhpOffice\PhpSpreadsheet\Style\Supervisor
	__construct ($isSupervisor=false)
	Create a new Supervisor. More...

	bindParent ($parent, $parentPropertyName=null)
	Bind parent. More...

	getIsSupervisor ()
	Is this a supervisor or a cell style component? More...

	getActiveSheet ()
	Get the currently active sheet. More...

	getSelectedCells ()
	Get the currently active cell coordinate in currently active sheet. More...

	getActiveCell ()
	Get the currently active cell coordinate in currently active sheet. More...

	__clone ()
	Implement PHP __clone to create a deep clone, not just a shallow copy. More...

	exportArray ()
	Export style as array. More...

Data Fields
const	PROTECTION_INHERIT = 'inherit'
	Protection styles. More...

const	PROTECTION_PROTECTED = 'protected'

const	PROTECTION_UNPROTECTED = 'unprotected'

Protected Member Functions
	exportArray1 ()

Protected Member Functions inherited from PhpOffice\PhpSpreadsheet\Style\Supervisor
	exportArray1 ()
	Abstract method to be implemented in anything which extends this class. More...

	exportArray2 (array &$exportedArray, string $index, $objOrValue)
	Populate array from exportArray1. More...

Protected Attributes
	$locked

	$hidden

Protected Attributes inherited from PhpOffice\PhpSpreadsheet\Style\Supervisor
	$isSupervisor

	$parent

	$parentPropertyName

Detailed Description

Definition at line 5 of file Protection.php.

Constructor & Destructor Documentation

◆ __construct()

PhpOffice\PhpSpreadsheet\Style\Protection::__construct	(	$isSupervisor = `false`,
		$isConditional = `false`
	)

Create a new Protection.

Parameters

bool	$isSupervisor	Flag indicating if this is a supervisor or not Leave this value at default unless you understand exactly what its ramifications are
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

Definition at line 36 of file Protection.php.

References PhpOffice\PhpSpreadsheet\Style\Supervisor\$isSupervisor.

     {
         // Supervisor?
         parent::__construct($isSupervisor);
 
         // Initialise values
         if (!$isConditional) {
             $this->locked = self::PROTECTION_INHERIT;
             $this->hidden = self::PROTECTION_INHERIT;
         }
     }

Member Function Documentation

◆ applyFromArray()

PhpOffice\PhpSpreadsheet\Style\Protection::applyFromArray ( array $pStyles )

Apply styles from array.

$spreadsheet->getActiveSheet()->getStyle('B2')->getLocked()->applyFromArray( [ 'locked' => TRUE, 'hidden' => FALSE ] );

Parameters

array $pStyles Array containing style information

Returns: $this

Definition at line 87 of file Protection.php.

References PhpOffice\PhpSpreadsheet\Style\Supervisor\getActiveSheet(), PhpOffice\PhpSpreadsheet\Style\Supervisor\getSelectedCells(), PhpOffice\PhpSpreadsheet\Style\Protection\getStyleArray(), PhpOffice\PhpSpreadsheet\Style\Protection\setHidden(), and PhpOffice\PhpSpreadsheet\Style\Protection\setLocked().

     {
         if ($this->isSupervisor) {
             $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($this->getStyleArray($pStyles));
         } else {
             if (isset($pStyles['locked'])) {
                 $this->setLocked($pStyles['locked']);
             }
             if (isset($pStyles['hidden'])) {
                 $this->setHidden($pStyles['hidden']);
             }
         }
 
         return $this;
     }

Here is the call graph for this function:

◆ exportArray1()

PhpOffice\PhpSpreadsheet\Style\Protection::exportArray1 ( )

protected

Definition at line 187 of file Protection.php.

References PhpOffice\PhpSpreadsheet\Style\Supervisor\exportArray2(), PhpOffice\PhpSpreadsheet\Style\Protection\getHidden(), and PhpOffice\PhpSpreadsheet\Style\Protection\getLocked().

                                      : array
     {
         $exportedArray = [];
         $this->exportArray2($exportedArray, 'locked', $this->getLocked());
         $this->exportArray2($exportedArray, 'hidden', $this->getHidden());
 
         return $exportedArray;
     }

Here is the call graph for this function:

◆ getHashCode()

PhpOffice\PhpSpreadsheet\Style\Protection::getHashCode ( )

Get hash code.

Returns: string Hash code

Implements PhpOffice\PhpSpreadsheet\IComparable.

Definition at line 174 of file Protection.php.

References PhpOffice\PhpSpreadsheet\Style\Protection\getSharedComponent().

     {
         if ($this->isSupervisor) {
             return $this->getSharedComponent()->getHashCode();
         }
 
         return md5(
             $this->locked .
             $this->hidden .
             __CLASS__
         );
     }

Here is the call graph for this function:

◆ getHidden()

PhpOffice\PhpSpreadsheet\Style\Protection::getHidden ( )

Get hidden.

Returns: string

Definition at line 141 of file Protection.php.

References PhpOffice\PhpSpreadsheet\Style\Protection\$hidden, and PhpOffice\PhpSpreadsheet\Style\Protection\getSharedComponent().

Referenced by PhpOffice\PhpSpreadsheet\Style\Protection\exportArray1().

     {
         if ($this->isSupervisor) {
             return $this->getSharedComponent()->getHidden();
         }
 
         return $this->hidden;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLocked()

PhpOffice\PhpSpreadsheet\Style\Protection::getLocked ( )

Get locked.

Returns: string

Definition at line 108 of file Protection.php.

References PhpOffice\PhpSpreadsheet\Style\Protection\$locked, and PhpOffice\PhpSpreadsheet\Style\Protection\getSharedComponent().

Referenced by PhpOffice\PhpSpreadsheet\Style\Protection\exportArray1().

     {
         if ($this->isSupervisor) {
             return $this->getSharedComponent()->getLocked();
         }
 
         return $this->locked;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSharedComponent()

PhpOffice\PhpSpreadsheet\Style\Protection::getSharedComponent ( )

Get the shared style component for the currently active cell in currently active sheet.

Only used for style supervisor.

Returns: Protection

Definition at line 54 of file Protection.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\Protection\getHashCode(), PhpOffice\PhpSpreadsheet\Style\Protection\getHidden(), and PhpOffice\PhpSpreadsheet\Style\Protection\getLocked().

     {
         return $this->parent->getSharedComponent()->getProtection();
     }

Here is the caller graph for this function:

◆ getStyleArray()

PhpOffice\PhpSpreadsheet\Style\Protection::getStyleArray ( $array )

Build style array from subcomponents.

Parameters

array $array

Returns: array

Definition at line 66 of file Protection.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\Protection\applyFromArray(), PhpOffice\PhpSpreadsheet\Style\Protection\setHidden(), and PhpOffice\PhpSpreadsheet\Style\Protection\setLocked().

     {
         return ['protection' => $array];
     }

Here is the caller graph for this function:

◆ setHidden()

PhpOffice\PhpSpreadsheet\Style\Protection::setHidden ( $pValue )

Set hidden.

Parameters

string $pValue see self::PROTECTION_*

Returns: $this

Definition at line 157 of file Protection.php.

References PhpOffice\PhpSpreadsheet\Style\Supervisor\getActiveSheet(), PhpOffice\PhpSpreadsheet\Style\Supervisor\getSelectedCells(), and PhpOffice\PhpSpreadsheet\Style\Protection\getStyleArray().

Referenced by PhpOffice\PhpSpreadsheet\Style\Protection\applyFromArray().

     {
         if ($this->isSupervisor) {
             $styleArray = $this->getStyleArray(['hidden' => $pValue]);
             $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);
         } else {
             $this->hidden = $pValue;
         }
 
         return $this;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setLocked()

PhpOffice\PhpSpreadsheet\Style\Protection::setLocked ( $pValue )

Set locked.

Parameters

string $pValue see self::PROTECTION_*

Returns: $this

Definition at line 124 of file Protection.php.

References PhpOffice\PhpSpreadsheet\Style\Supervisor\getActiveSheet(), PhpOffice\PhpSpreadsheet\Style\Supervisor\getSelectedCells(), and PhpOffice\PhpSpreadsheet\Style\Protection\getStyleArray().

Referenced by PhpOffice\PhpSpreadsheet\Style\Protection\applyFromArray().

     {
         if ($this->isSupervisor) {
             $styleArray = $this->getStyleArray(['locked' => $pValue]);
             $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);
         } else {
             $this->locked = $pValue;
         }
 
         return $this;
     }