class PHPExcel_Worksheet_Protection

PHPExcelWorksheetProtection

Methods

__construct()

Create a new PHPExcelWorksheetProtection

boolean
isProtectionEnabled()

Is some sort of protection enabled?

boolean
getSheet()

Get Sheet

setSheet(boolean $pValue = false)

Set Sheet

boolean
getObjects()

Get Objects

setObjects(boolean $pValue = false)

Set Objects

boolean
getScenarios()

Get Scenarios

setScenarios(boolean $pValue = false)

Set Scenarios

boolean
getFormatCells()

Get FormatCells

setFormatCells(boolean $pValue = false)

Set FormatCells

boolean
getFormatColumns()

Get FormatColumns

setFormatColumns(boolean $pValue = false)

Set FormatColumns

boolean
getFormatRows()

Get FormatRows

setFormatRows(boolean $pValue = false)

Set FormatRows

boolean
getInsertColumns()

Get InsertColumns

setInsertColumns(boolean $pValue = false)

Set InsertColumns

boolean
getInsertRows()

Get InsertRows

setInsertRows(boolean $pValue = false)

Set InsertRows

boolean
getInsertHyperlinks()

Get InsertHyperlinks

setInsertHyperlinks(boolean $pValue = false)

Set InsertHyperlinks

boolean
getDeleteColumns()

Get DeleteColumns

setDeleteColumns(boolean $pValue = false)

Set DeleteColumns

boolean
getDeleteRows()

Get DeleteRows

setDeleteRows(boolean $pValue = false)

Set DeleteRows

boolean
getSelectLockedCells()

Get SelectLockedCells

setSelectLockedCells(boolean $pValue = false)

Set SelectLockedCells

boolean
getSort()

Get Sort

setSort(boolean $pValue = false)

Set Sort

boolean
getAutoFilter()

Get AutoFilter

setAutoFilter(boolean $pValue = false)

Set AutoFilter

boolean
getPivotTables()

Get PivotTables

setPivotTables(boolean $pValue = false)

Set PivotTables

boolean
getSelectUnlockedCells()

Get SelectUnlockedCells

setSelectUnlockedCells(boolean $pValue = false)

Set SelectUnlockedCells

string
getPassword()

Get Password (hashed)

setPassword(string $pValue = '', boolean $pAlreadyHashed = false)

Set Password

__clone()

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

Details

at line 169
__construct()

Create a new PHPExcelWorksheetProtection

at line 178
boolean isProtectionEnabled()

Is some sort of protection enabled?

Return Value

boolean

at line 203
boolean getSheet()

Get Sheet

Return Value

boolean

at line 214
PHPExcel_Worksheet_Protection setSheet(boolean $pValue = false)

Set Sheet

Parameters

boolean $pValue

Return Value

PHPExcel_Worksheet_Protection

at line 225
boolean getObjects()

Get Objects

Return Value

boolean

at line 236
PHPExcel_Worksheet_Protection setObjects(boolean $pValue = false)

Set Objects

Parameters

boolean $pValue

Return Value

PHPExcel_Worksheet_Protection

at line 247
boolean getScenarios()

Get Scenarios

Return Value

boolean

at line 258
PHPExcel_Worksheet_Protection setScenarios(boolean $pValue = false)

Set Scenarios

Parameters

boolean $pValue

Return Value

PHPExcel_Worksheet_Protection

at line 269
boolean getFormatCells()

Get FormatCells

Return Value

boolean

at line 280
PHPExcel_Worksheet_Protection setFormatCells(boolean $pValue = false)

Set FormatCells

Parameters

boolean $pValue

Return Value

PHPExcel_Worksheet_Protection

at line 291
boolean getFormatColumns()

Get FormatColumns

Return Value

boolean

at line 302
PHPExcel_Worksheet_Protection setFormatColumns(boolean $pValue = false)

Set FormatColumns

Parameters

boolean $pValue

Return Value

PHPExcel_Worksheet_Protection

at line 313
boolean getFormatRows()

Get FormatRows

Return Value

boolean

at line 324
PHPExcel_Worksheet_Protection setFormatRows(boolean $pValue = false)

Set FormatRows

Parameters

boolean $pValue

Return Value

PHPExcel_Worksheet_Protection

at line 335
boolean getInsertColumns()

Get InsertColumns

Return Value

boolean

at line 346
PHPExcel_Worksheet_Protection setInsertColumns(boolean $pValue = false)

Set InsertColumns

Parameters

boolean $pValue

Return Value

PHPExcel_Worksheet_Protection

at line 357
boolean getInsertRows()

Get InsertRows

Return Value

boolean

at line 368
PHPExcel_Worksheet_Protection setInsertRows(boolean $pValue = false)

Set InsertRows

Parameters

boolean $pValue

Return Value

PHPExcel_Worksheet_Protection

Get InsertHyperlinks

Return Value

boolean

Set InsertHyperlinks

Parameters

boolean $pValue

Return Value

PHPExcel_Worksheet_Protection

at line 401
boolean getDeleteColumns()

Get DeleteColumns

Return Value

boolean

at line 412
PHPExcel_Worksheet_Protection setDeleteColumns(boolean $pValue = false)

Set DeleteColumns

Parameters

boolean $pValue

Return Value

PHPExcel_Worksheet_Protection

at line 423
boolean getDeleteRows()

Get DeleteRows

Return Value

boolean

at line 434
PHPExcel_Worksheet_Protection setDeleteRows(boolean $pValue = false)

Set DeleteRows

Parameters

boolean $pValue

Return Value

PHPExcel_Worksheet_Protection

at line 445
boolean getSelectLockedCells()

Get SelectLockedCells

Return Value

boolean

at line 456
PHPExcel_Worksheet_Protection setSelectLockedCells(boolean $pValue = false)

Set SelectLockedCells

Parameters

boolean $pValue

Return Value

PHPExcel_Worksheet_Protection

at line 467
boolean getSort()

Get Sort

Return Value

boolean

at line 478
PHPExcel_Worksheet_Protection setSort(boolean $pValue = false)

Set Sort

Parameters

boolean $pValue

Return Value

PHPExcel_Worksheet_Protection

at line 489
boolean getAutoFilter()

Get AutoFilter

Return Value

boolean

at line 500
PHPExcel_Worksheet_Protection setAutoFilter(boolean $pValue = false)

Set AutoFilter

Parameters

boolean $pValue

Return Value

PHPExcel_Worksheet_Protection

at line 511
boolean getPivotTables()

Get PivotTables

Return Value

boolean

at line 522
PHPExcel_Worksheet_Protection setPivotTables(boolean $pValue = false)

Set PivotTables

Parameters

boolean $pValue

Return Value

PHPExcel_Worksheet_Protection

at line 533
boolean getSelectUnlockedCells()

Get SelectUnlockedCells

Return Value

boolean

at line 544
PHPExcel_Worksheet_Protection setSelectUnlockedCells(boolean $pValue = false)

Set SelectUnlockedCells

Parameters

boolean $pValue

Return Value

PHPExcel_Worksheet_Protection

at line 555
string getPassword()

Get Password (hashed)

Return Value

string

at line 567
PHPExcel_Worksheet_Protection setPassword(string $pValue = '', boolean $pAlreadyHashed = false)

Set Password

Parameters

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

Return Value

PHPExcel_Worksheet_Protection

at line 579
__clone()

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