Collaboration diagram for PHPExcel_Worksheet_Protection:

Public Member Functions
	__construct ()
	Create a new PHPExcel_Worksheet_Protection. More...

	isProtectionEnabled ()
	Is some sort of protection enabled? More...

	getSheet ()
	Get Sheet. More...

	setSheet ($pValue=false)
	Set Sheet. More...

	getObjects ()
	Get Objects. More...

	setObjects ($pValue=false)
	Set Objects. More...

	getScenarios ()
	Get Scenarios. More...

	setScenarios ($pValue=false)
	Set Scenarios. More...

	getFormatCells ()
	Get FormatCells. More...

	setFormatCells ($pValue=false)
	Set FormatCells. More...

	getFormatColumns ()
	Get FormatColumns. More...

	setFormatColumns ($pValue=false)
	Set FormatColumns. More...

	getFormatRows ()
	Get FormatRows. More...

	setFormatRows ($pValue=false)
	Set FormatRows. More...

	getInsertColumns ()
	Get InsertColumns. More...

	setInsertColumns ($pValue=false)
	Set InsertColumns. More...

	getInsertRows ()
	Get InsertRows. More...

	setInsertRows ($pValue=false)
	Set InsertRows. More...

	getInsertHyperlinks ()
	Get InsertHyperlinks. More...

	setInsertHyperlinks ($pValue=false)
	Set InsertHyperlinks. More...

	getDeleteColumns ()
	Get DeleteColumns. More...

	setDeleteColumns ($pValue=false)
	Set DeleteColumns. More...

	getDeleteRows ()
	Get DeleteRows. More...

	setDeleteRows ($pValue=false)
	Set DeleteRows. More...

	getSelectLockedCells ()
	Get SelectLockedCells. More...

	setSelectLockedCells ($pValue=false)
	Set SelectLockedCells. More...

	getSort ()
	Get Sort. More...

	setSort ($pValue=false)
	Set Sort. More...

	getAutoFilter ()
	Get AutoFilter. More...

	setAutoFilter ($pValue=false)
	Set AutoFilter. More...

	getPivotTables ()
	Get PivotTables. More...

	setPivotTables ($pValue=false)
	Set PivotTables. More...

	getSelectUnlockedCells ()
	Get SelectUnlockedCells. More...

	setSelectUnlockedCells ($pValue=false)
	Set SelectUnlockedCells. More...

	getPassword ()
	Get Password (hashed) More...

	setPassword ($pValue='', $pAlreadyHashed=false)
	Set Password. More...

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

Private Attributes
	$_sheet = false

	$_objects = false

	$_scenarios = false

	$_formatCells = false

	$_formatColumns = false

	$_formatRows = false

	$_insertColumns = false

	$_insertRows = false

	$_insertHyperlinks = false

	$_deleteColumns = false

	$_deleteRows = false

	$_selectLockedCells = false

	$_sort = false

	$_autoFilter = false

	$_pivotTables = false

	$_selectUnlockedCells = false

	$_password = ''

Detailed Description

Definition at line 36 of file Protection.php.

Constructor & Destructor Documentation

◆ __construct()

PHPExcel_Worksheet_Protection::__construct ( )

Create a new PHPExcel_Worksheet_Protection.

Definition at line 160 of file Protection.php.

161 {

162 }

Member Function Documentation

◆ __clone()

PHPExcel_Worksheet_Protection::__clone ( )

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

Definition at line 535 of file Protection.php.

                                   {
                 $vars = get_object_vars($this);
                 foreach ($vars as $key => $value) {
                         if (is_object($value)) {
                                 $this->$key = clone $value;
                         } else {
                                 $this->$key = $value;
                         }
                 }
         }

◆ getAutoFilter()

PHPExcel_Worksheet_Protection::getAutoFilter ( )

Get AutoFilter.

Returns: boolean

Definition at line 453 of file Protection.php.

References $_autoFilter.

                              {
         return $this->_autoFilter;
     }

◆ getDeleteColumns()

PHPExcel_Worksheet_Protection::getDeleteColumns ( )

Get DeleteColumns.

Returns: boolean

Definition at line 373 of file Protection.php.

References $_deleteColumns.

                                 {
         return $this->_deleteColumns;
     }

◆ getDeleteRows()

PHPExcel_Worksheet_Protection::getDeleteRows ( )

Get DeleteRows.

Returns: boolean

Definition at line 393 of file Protection.php.

References $_deleteRows.

                              {
         return $this->_deleteRows;
     }

◆ getFormatCells()

PHPExcel_Worksheet_Protection::getFormatCells ( )

Get FormatCells.

Returns: boolean

Definition at line 253 of file Protection.php.

References $_formatCells.

                               {
         return $this->_formatCells;
     }

◆ getFormatColumns()

PHPExcel_Worksheet_Protection::getFormatColumns ( )

Get FormatColumns.

Returns: boolean

Definition at line 273 of file Protection.php.

References $_formatColumns.

                                 {
         return $this->_formatColumns;
     }

◆ getFormatRows()

PHPExcel_Worksheet_Protection::getFormatRows ( )

Get FormatRows.

Returns: boolean

Definition at line 293 of file Protection.php.

References $_formatRows.

                              {
         return $this->_formatRows;
     }

◆ getInsertColumns()

PHPExcel_Worksheet_Protection::getInsertColumns ( )

Get InsertColumns.

Returns: boolean

Definition at line 313 of file Protection.php.

References $_insertColumns.

                                 {
         return $this->_insertColumns;
     }

◆ getInsertHyperlinks()

PHPExcel_Worksheet_Protection::getInsertHyperlinks ( )

Get InsertHyperlinks.

Returns: boolean

Definition at line 353 of file Protection.php.

References $_insertHyperlinks.

                                    {
         return $this->_insertHyperlinks;
     }

◆ getInsertRows()

PHPExcel_Worksheet_Protection::getInsertRows ( )

Get InsertRows.

Returns: boolean

Definition at line 333 of file Protection.php.

References $_insertRows.

                              {
         return $this->_insertRows;
     }

◆ getObjects()

PHPExcel_Worksheet_Protection::getObjects ( )

Get Objects.

Returns: boolean

Definition at line 213 of file Protection.php.

References $_objects.

                           {
         return $this->_objects;
     }

◆ getPassword()

PHPExcel_Worksheet_Protection::getPassword ( )

Get Password (hashed)

Returns: string

Definition at line 513 of file Protection.php.

References $_password.

                            {
         return $this->_password;
     }

◆ getPivotTables()

PHPExcel_Worksheet_Protection::getPivotTables ( )

Get PivotTables.

Returns: boolean

Definition at line 473 of file Protection.php.

References $_pivotTables.

                               {
         return $this->_pivotTables;
     }

◆ getScenarios()

PHPExcel_Worksheet_Protection::getScenarios ( )

Get Scenarios.

Returns: boolean

Definition at line 233 of file Protection.php.

References $_scenarios.

                             {
         return $this->_scenarios;
     }

◆ getSelectLockedCells()

PHPExcel_Worksheet_Protection::getSelectLockedCells ( )

Get SelectLockedCells.

Returns: boolean

Definition at line 413 of file Protection.php.

References $_selectLockedCells.

                                     {
         return $this->_selectLockedCells;
     }

◆ getSelectUnlockedCells()

PHPExcel_Worksheet_Protection::getSelectUnlockedCells ( )

Get SelectUnlockedCells.

Returns: boolean

Definition at line 493 of file Protection.php.

References $_selectUnlockedCells.

                                       {
         return $this->_selectUnlockedCells;
     }

◆ getSheet()

PHPExcel_Worksheet_Protection::getSheet ( )

Get Sheet.

Returns: boolean

Definition at line 193 of file Protection.php.

References $_sheet.

                         {
         return $this->_sheet;
     }

◆ getSort()

PHPExcel_Worksheet_Protection::getSort ( )

Get Sort.

Returns: boolean

Definition at line 433 of file Protection.php.

References $_sort.

                        {
         return $this->_sort;
     }

◆ isProtectionEnabled()

PHPExcel_Worksheet_Protection::isProtectionEnabled ( )

Is some sort of protection enabled?

Returns: boolean

Definition at line 169 of file Protection.php.

References $_selectUnlockedCells.

                                    {
         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;
     }

◆ setAutoFilter()

PHPExcel_Worksheet_Protection::setAutoFilter ( $pValue = false )

Set AutoFilter.

Parameters

boolean $pValue

Returns: PHPExcel_Worksheet_Protection

Definition at line 463 of file Protection.php.

                                             {
         $this->_autoFilter = $pValue;
         return $this;
     }

◆ setDeleteColumns()

PHPExcel_Worksheet_Protection::setDeleteColumns ( $pValue = false )

Set DeleteColumns.

Parameters

boolean $pValue

Returns: PHPExcel_Worksheet_Protection

Definition at line 383 of file Protection.php.

                                                {
         $this->_deleteColumns = $pValue;
         return $this;
     }

◆ setDeleteRows()

PHPExcel_Worksheet_Protection::setDeleteRows ( $pValue = false )

Set DeleteRows.

Parameters

boolean $pValue

Returns: PHPExcel_Worksheet_Protection

Definition at line 403 of file Protection.php.

                                             {
         $this->_deleteRows = $pValue;
         return $this;
     }

◆ setFormatCells()

PHPExcel_Worksheet_Protection::setFormatCells ( $pValue = false )

Set FormatCells.

Parameters

boolean $pValue

Returns: PHPExcel_Worksheet_Protection

Definition at line 263 of file Protection.php.

                                              {
         $this->_formatCells = $pValue;
         return $this;
     }

◆ setFormatColumns()

PHPExcel_Worksheet_Protection::setFormatColumns ( $pValue = false )

Set FormatColumns.

Parameters

boolean $pValue

Returns: PHPExcel_Worksheet_Protection

Definition at line 283 of file Protection.php.

                                                {
         $this->_formatColumns = $pValue;
         return $this;
     }

◆ setFormatRows()

PHPExcel_Worksheet_Protection::setFormatRows ( $pValue = false )

Set FormatRows.

Parameters

boolean $pValue

Returns: PHPExcel_Worksheet_Protection

Definition at line 303 of file Protection.php.

                                             {
         $this->_formatRows = $pValue;
         return $this;
     }

◆ setInsertColumns()

PHPExcel_Worksheet_Protection::setInsertColumns ( $pValue = false )

Set InsertColumns.

Parameters

boolean $pValue

Returns: PHPExcel_Worksheet_Protection

Definition at line 323 of file Protection.php.

                                                {
         $this->_insertColumns = $pValue;
         return $this;
     }

◆ setInsertHyperlinks()

PHPExcel_Worksheet_Protection::setInsertHyperlinks ( $pValue = false )

Set InsertHyperlinks.

Parameters

boolean $pValue

Returns: PHPExcel_Worksheet_Protection

Definition at line 363 of file Protection.php.

                                                   {
         $this->_insertHyperlinks = $pValue;
         return $this;
     }

◆ setInsertRows()

PHPExcel_Worksheet_Protection::setInsertRows ( $pValue = false )

Set InsertRows.

Parameters

boolean $pValue

Returns: PHPExcel_Worksheet_Protection

Definition at line 343 of file Protection.php.

                                             {
         $this->_insertRows = $pValue;
         return $this;
     }

◆ setObjects()

PHPExcel_Worksheet_Protection::setObjects ( $pValue = false )

Set Objects.

Parameters

boolean $pValue

Returns: PHPExcel_Worksheet_Protection

Definition at line 223 of file Protection.php.

                                          {
         $this->_objects = $pValue;
         return $this;
     }

◆ setPassword()

PHPExcel_Worksheet_Protection::setPassword	(	$pValue = `''`,
		$pAlreadyHashed = `false`
	)

Set Password.

Parameters

string	$pValue
boolean	$pAlreadyHashed	If the password has already been hashed, set this to true

Returns: PHPExcel_Worksheet_Protection

Definition at line 524 of file Protection.php.

References PHPExcel_Shared_PasswordHasher\hashPassword().

                                                                 {
         if (!$pAlreadyHashed) {
                 $pValue = PHPExcel_Shared_PasswordHasher::hashPassword($pValue);
         }
                 $this->_password = $pValue;
                 return $this;
     }

Here is the call graph for this function:

◆ setPivotTables()

PHPExcel_Worksheet_Protection::setPivotTables ( $pValue = false )

Set PivotTables.

Parameters

boolean $pValue

Returns: PHPExcel_Worksheet_Protection

Definition at line 483 of file Protection.php.

                                              {
         $this->_pivotTables = $pValue;
         return $this;
     }

◆ setScenarios()

PHPExcel_Worksheet_Protection::setScenarios ( $pValue = false )

Set Scenarios.

Parameters

boolean $pValue

Returns: PHPExcel_Worksheet_Protection

Definition at line 243 of file Protection.php.

                                            {
         $this->_scenarios = $pValue;
         return $this;
     }

◆ setSelectLockedCells()

PHPExcel_Worksheet_Protection::setSelectLockedCells ( $pValue = false )

Set SelectLockedCells.

Parameters

boolean $pValue

Returns: PHPExcel_Worksheet_Protection

Definition at line 423 of file Protection.php.

                                                    {
         $this->_selectLockedCells = $pValue;
         return $this;
     }

◆ setSelectUnlockedCells()

PHPExcel_Worksheet_Protection::setSelectUnlockedCells ( $pValue = false )

Set SelectUnlockedCells.

Parameters

boolean $pValue

Returns: PHPExcel_Worksheet_Protection

Definition at line 503 of file Protection.php.

                                                      {
         $this->_selectUnlockedCells = $pValue;
         return $this;
     }

◆ setSheet()

PHPExcel_Worksheet_Protection::setSheet ( $pValue = false )

Set Sheet.

Parameters

boolean $pValue

Returns: PHPExcel_Worksheet_Protection

Definition at line 203 of file Protection.php.

                                        {
         $this->_sheet = $pValue;
         return $this;
     }

◆ setSort()

PHPExcel_Worksheet_Protection::setSort ( $pValue = false )

Set Sort.

Parameters

boolean $pValue

Returns: PHPExcel_Worksheet_Protection

Definition at line 443 of file Protection.php.

                                       {
         $this->_sort = $pValue;
         return $this;
     }

Field Documentation

◆ $_autoFilter

PHPExcel_Worksheet_Protection::$_autoFilter = false

private

Definition at line 134 of file Protection.php.

Referenced by getAutoFilter().

◆ $_deleteColumns

PHPExcel_Worksheet_Protection::$_deleteColumns = false

private

Definition at line 106 of file Protection.php.

Referenced by getDeleteColumns().

◆ $_deleteRows

PHPExcel_Worksheet_Protection::$_deleteRows = false

private

Definition at line 113 of file Protection.php.

Referenced by getDeleteRows().

◆ $_formatCells

PHPExcel_Worksheet_Protection::$_formatCells = false

private

Definition at line 64 of file Protection.php.

Referenced by getFormatCells().

◆ $_formatColumns

PHPExcel_Worksheet_Protection::$_formatColumns = false

private

Definition at line 71 of file Protection.php.

Referenced by getFormatColumns().

◆ $_formatRows

PHPExcel_Worksheet_Protection::$_formatRows = false

private

Definition at line 78 of file Protection.php.

Referenced by getFormatRows().

◆ $_insertColumns

PHPExcel_Worksheet_Protection::$_insertColumns = false

private

Definition at line 85 of file Protection.php.

Referenced by getInsertColumns().

◆ $_insertHyperlinks

PHPExcel_Worksheet_Protection::$_insertHyperlinks = false

private

Definition at line 99 of file Protection.php.

Referenced by getInsertHyperlinks().

◆ $_insertRows

PHPExcel_Worksheet_Protection::$_insertRows = false

private

Definition at line 92 of file Protection.php.

Referenced by getInsertRows().

◆ $_objects

PHPExcel_Worksheet_Protection::$_objects = false

private

Definition at line 50 of file Protection.php.

Referenced by getObjects().

◆ $_password

PHPExcel_Worksheet_Protection::$_password = ''

private

Definition at line 155 of file Protection.php.

Referenced by getPassword().

◆ $_pivotTables

PHPExcel_Worksheet_Protection::$_pivotTables = false

private

Definition at line 141 of file Protection.php.

Referenced by getPivotTables().

◆ $_scenarios

PHPExcel_Worksheet_Protection::$_scenarios = false

private

Definition at line 57 of file Protection.php.

Referenced by getScenarios().

◆ $_selectLockedCells

PHPExcel_Worksheet_Protection::$_selectLockedCells = false

private

Definition at line 120 of file Protection.php.

Referenced by getSelectLockedCells().

◆ $_selectUnlockedCells

PHPExcel_Worksheet_Protection::$_selectUnlockedCells = false

private

Definition at line 148 of file Protection.php.

Referenced by getSelectUnlockedCells(), and isProtectionEnabled().

◆ $_sheet

PHPExcel_Worksheet_Protection::$_sheet = false

private

Definition at line 43 of file Protection.php.

Referenced by getSheet().

◆ $_sort

PHPExcel_Worksheet_Protection::$_sort = false

private

Definition at line 127 of file Protection.php.

Referenced by getSort().

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

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __clone()

◆ getAutoFilter()

◆ getDeleteColumns()

◆ getDeleteRows()

◆ getFormatCells()

◆ getFormatColumns()

◆ getFormatRows()

◆ getInsertColumns()

◆ getInsertHyperlinks()

◆ getInsertRows()

◆ getObjects()

◆ getPassword()

◆ getPivotTables()

◆ getScenarios()

◆ getSelectLockedCells()

◆ getSelectUnlockedCells()

◆ getSheet()

◆ getSort()

◆ isProtectionEnabled()

◆ setAutoFilter()

◆ setDeleteColumns()

◆ setDeleteRows()

◆ setFormatCells()

◆ setFormatColumns()

◆ setFormatRows()

◆ setInsertColumns()

◆ setInsertHyperlinks()

◆ setInsertRows()

◆ setObjects()

◆ setPassword()

◆ setPivotTables()

◆ setScenarios()

◆ setSelectLockedCells()

◆ setSelectUnlockedCells()

◆ setSheet()

◆ setSort()

Field Documentation

◆ $_autoFilter

◆ $_deleteColumns

◆ $_deleteRows

◆ $_formatCells

◆ $_formatColumns

◆ $_formatRows

◆ $_insertColumns

◆ $_insertHyperlinks

◆ $_insertRows

◆ $_objects

◆ $_password

◆ $_pivotTables

◆ $_scenarios

◆ $_selectLockedCells

◆ $_selectUnlockedCells

◆ $_sheet

◆ $_sort