Inheritance diagram for PHPExcel_Style_Protection:

Collaboration diagram for PHPExcel_Style_Protection:

Public Member Functions
	__construct ($isSupervisor=FALSE, $isConditional=FALSE)
	Create a new PHPExcel_Style_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 ($pStyles=NULL)
	Apply styles from array. More...

	getLocked ()
	Get locked. More...

	setLocked ($pValue=self::PROTECTION_INHERIT)
	Set locked. More...

	getHidden ()
	Get hidden. More...

	setHidden ($pValue=self::PROTECTION_INHERIT)
	Set hidden. More...

	getHashCode ()
	Get hash code. More...

Public Member Functions inherited from PHPExcel_Style_Supervisor
	__construct ($isSupervisor=FALSE)
	Create a new PHPExcel_Style_Alignment. 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...

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

const	PROTECTION_PROTECTED = 'protected'

const	PROTECTION_UNPROTECTED = 'unprotected'

Protected Attributes
	$_locked

	$_hidden

Protected Attributes inherited from PHPExcel_Style_Supervisor
	$_isSupervisor

	$_parent

Detailed Description

Definition at line 36 of file Protection.php.

Constructor & Destructor Documentation

◆ __construct()

PHPExcel_Style_Protection::__construct	(	$isSupervisor = `FALSE`,
		$isConditional = `FALSE`
	)

Create a new PHPExcel_Style_Protection.

Parameters

boolean	$isSupervisor	Flag indicating if this is a supervisor or not Leave this value at default unless you understand exactly what its ramifications are
boolean	$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 67 of file Protection.php.

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

Member Function Documentation

◆ applyFromArray()

PHPExcel_Style_Protection::applyFromArray ( $pStyles = NULL )

Apply styles from array.

$objPHPExcel->getActiveSheet()->getStyle('B2')->getLocked()->applyFromArray( array( 'locked' => TRUE, 'hidden' => FALSE ) );

Parameters

array $pStyles Array containing style information

Exceptions

PHPExcel_Exception

Returns: PHPExcel_Style_Protection

Definition at line 117 of file Protection.php.

References PHPExcel_Style_Supervisor\getActiveSheet(), PHPExcel_Style_Supervisor\getSelectedCells(), getStyleArray(), setHidden(), and setLocked().

                                                         {
                 if (is_array($pStyles)) {
                         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']);
                                 }
                         }
                 } else {
                         throw new PHPExcel_Exception("Invalid style array passed.");
                 }
                 return $this;
         }

Here is the call graph for this function:

◆ getHashCode()

PHPExcel_Style_Protection::getHashCode ( )

Get hash code.

Returns: string Hash code

Implements PHPExcel_IComparable.

Definition at line 196 of file Protection.php.

References getSharedComponent().

                                       {
                 if ($this->_isSupervisor) {
                         return $this->getSharedComponent()->getHashCode();
                 }
         return md5(
                   $this->_locked
                 . $this->_hidden
                 . __CLASS__
         );
     }

Here is the call graph for this function:

◆ getHidden()

PHPExcel_Style_Protection::getHidden ( )

Get hidden.

Returns: string

Definition at line 168 of file Protection.php.

References $_hidden, and getSharedComponent().

                                 {
                 if ($this->_isSupervisor) {
                         return $this->getSharedComponent()->getHidden();
                 }
         return $this->_hidden;
     }

Here is the call graph for this function:

◆ getLocked()

PHPExcel_Style_Protection::getLocked ( )

Get locked.

Returns: string

Definition at line 140 of file Protection.php.

References $_locked, and getSharedComponent().

                                 {
                 if ($this->_isSupervisor) {
                         return $this->getSharedComponent()->getLocked();
                 }
         return $this->_locked;
     }

Here is the call graph for this function:

◆ getSharedComponent()

PHPExcel_Style_Protection::getSharedComponent ( )

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

Only used for style supervisor

Returns: PHPExcel_Style_Protection

Definition at line 85 of file Protection.php.

Referenced by getHashCode(), getHidden(), and getLocked().

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

Here is the caller graph for this function:

◆ getStyleArray()

PHPExcel_Style_Protection::getStyleArray ( $array )

Build style array from subcomponents.

Parameters

array $array

Returns: array

Definition at line 96 of file Protection.php.

References array.

Referenced by applyFromArray(), setHidden(), and setLocked().

         {
                 return array('protection' => $array);
         }

Here is the caller graph for this function:

◆ setHidden()

PHPExcel_Style_Protection::setHidden ( $pValue = self::PROTECTION_INHERIT )

Set hidden.

Parameters

string $pValue

Returns: PHPExcel_Style_Protection

Definition at line 181 of file Protection.php.

References array, PHPExcel_Style_Supervisor\getActiveSheet(), PHPExcel_Style_Supervisor\getSelectedCells(), and getStyleArray().

Referenced by applyFromArray().

                                                                 {
                 if ($this->_isSupervisor) {
                         $styleArray = $this->getStyleArray(array('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()

PHPExcel_Style_Protection::setLocked ( $pValue = self::PROTECTION_INHERIT )

Set locked.

Parameters

string $pValue

Returns: PHPExcel_Style_Protection

Definition at line 153 of file Protection.php.

References array, PHPExcel_Style_Supervisor\getActiveSheet(), PHPExcel_Style_Supervisor\getSelectedCells(), and getStyleArray().

Referenced by applyFromArray().

                                                                 {
                 if ($this->_isSupervisor) {
                         $styleArray = $this->getStyleArray(array('locked' => $pValue));
                         $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);
                 } else {
                         $this->_locked = $pValue;
                 }
                 return $this;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $_hidden

PHPExcel_Style_Protection::$_hidden

protected

Definition at line 55 of file Protection.php.

Referenced by getHidden().

◆ $_locked

PHPExcel_Style_Protection::$_locked

protected

Definition at line 48 of file Protection.php.

Referenced by getLocked().

◆ PROTECTION_INHERIT

const PHPExcel_Style_Protection::PROTECTION_INHERIT = 'inherit'

Protection styles.

Definition at line 39 of file Protection.php.

Referenced by PHPExcel_Writer_Excel5_Xf\_mapHidden(), PHPExcel_Writer_Excel5_Xf\_mapLocked(), PHPExcel_Reader_Excel5\_readXf(), PHPExcel_Writer_Excel2007_Style\_writeCellStyleDxf(), and PHPExcel_Writer_Excel2007_Style\_writeCellStyleXf().

◆ PROTECTION_PROTECTED

const PHPExcel_Style_Protection::PROTECTION_PROTECTED = 'protected'

Definition at line 40 of file Protection.php.

Referenced by PHPExcel_Writer_Excel5_Xf\_mapHidden(), PHPExcel_Writer_Excel5_Xf\_mapLocked(), PHPExcel_Reader_Excel2007\_readStyle(), PHPExcel_Reader_Excel5\_readXf(), PHPExcel_Writer_Excel2007_Style\_writeCellStyleDxf(), PHPExcel_Writer_Excel2007_Style\_writeCellStyleXf(), and PHPExcel_Writer_Excel5_Worksheet\_writeCFRule().

◆ PROTECTION_UNPROTECTED

const PHPExcel_Style_Protection::PROTECTION_UNPROTECTED = 'unprotected'

Definition at line 41 of file Protection.php.

Referenced by PHPExcel_Writer_Excel5_Xf\_mapHidden(), PHPExcel_Writer_Excel5_Xf\_mapLocked(), PHPExcel_Reader_Excel2007\_readStyle(), and PHPExcel_Reader_Excel5\_readXf().

The documentation for this class was generated from the following file:

libs/composer/vendor/phpoffice/phpexcel/Classes/PHPExcel/Style/Protection.php

Public Member Functions

Data Fields

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ applyFromArray()

◆ getHashCode()

◆ getHidden()

◆ getLocked()

◆ getSharedComponent()

◆ getStyleArray()

◆ setHidden()

◆ setLocked()

Field Documentation

◆ $_hidden

◆ $_locked

◆ PROTECTION_INHERIT

◆ PROTECTION_PROTECTED

◆ PROTECTION_UNPROTECTED