PHPExcel_Worksheet

# Class: PHPExcel_Worksheet_Protection Source Location: /PHPExcel/Worksheet/Protection.php
### Class Overview
PHPExcel_Worksheet_Protection #### Author(s): #### Copyright: Copyright (c) 2006 - 2010 PHPExcel (http://www.codeplex.com/PHPExcel) | ### Variables $_autoFilter $_deleteColumns $_deleteRows $_formatCells $_formatColumns $_formatRows $_insertColumns $_insertHyperlinks $_insertRows $_objects $_password $_pivotTables $_scenarios $_selectLockedCells $_selectUnlockedCells $_sheet $_sort | ### Methods __construct 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 __clone
### Class Details [line 48] PHPExcel_Worksheet_Protection PHPExcel_Worksheet_Protection #### Tags:
copyright: | Copyright (c) 2006 - 2010 PHPExcel (http://www.codeplex.com/PHPExcel)
[ Top ] ### Class Variables #### $_autoFilter = [line 146] AutoFilter AutoFilter #### Tags:
access: | private
Type: | boolean
[ Top ] #### $_deleteColumns = [line 118] Delete columns Delete columns #### Tags:
access: | private
Type: | boolean
[ Top ] #### $_deleteRows = [line 125] Delete rows Delete rows #### Tags:
access: | private
Type: | boolean
[ Top ] #### $_formatCells = [line 76] Format cells Format cells #### Tags:
access: | private
Type: | boolean
[ Top ] #### $_formatColumns = [line 83] Format columns Format columns #### Tags:
access: | private
Type: | boolean
[ Top ] #### $_formatRows = [line 90] Format rows Format rows #### Tags:
access: | private
Type: | boolean
[ Top ] #### $_insertColumns = [line 97] Insert columns Insert columns #### Tags:
access: | private
Type: | boolean
[ Top ] #### $_insertHyperlinks = [line 111] Insert hyperlinks Insert hyperlinks #### Tags:
access: | private
Type: | boolean
[ Top ] #### $_insertRows = [line 104] Insert rows Insert rows #### Tags:
access: | private
Type: | boolean
[ Top ] #### $_objects = [line 62] Objects Objects #### Tags:
access: | private
Type: | boolean
[ Top ] #### $_password = [line 167] Password Password #### Tags:
access: | private
Type: | string
[ Top ] #### $_pivotTables = [line 153] Pivot tables Pivot tables #### Tags:
access: | private
Type: | boolean
[ Top ] #### $_scenarios = [line 69] Scenarios Scenarios #### Tags:
access: | private
Type: | boolean
[ Top ] #### $_selectLockedCells = [line 132] Select locked cells Select locked cells #### Tags:
access: | private
Type: | boolean
[ Top ] #### $_selectUnlockedCells = [line 160] Select unlocked cells Select unlocked cells #### Tags:
access: | private
Type: | boolean
[ Top ] #### $_sheet = [line 55] Sheet Sheet #### Tags:
access: | private
Type: | boolean
[ Top ] #### $_sort = [line 139] Sort Sort #### Tags:
access: | private
Type: | boolean
[ Top ] ### Class Methods ### constructor __construct [line 172]
`PHPExcel_Worksheet_Protection __construct( )`
Create a new PHPExcel_Worksheet_Protection Create a new PHPExcel_Worksheet_Protection #### Tags:
access: | public
[ Top ] ### method getAutoFilter [line 483]
`boolean getAutoFilter( )`
Get AutoFilter Get AutoFilter [ Top ] ### method getDeleteColumns [line 403]
`boolean getDeleteColumns( )`
Get DeleteColumns Get DeleteColumns [ Top ] ### method getDeleteRows [line 423]
`boolean getDeleteRows( )`
Get DeleteRows Get DeleteRows [ Top ] ### method getFormatCells [line 283]
`boolean getFormatCells( )`
Get FormatCells Get FormatCells [ Top ] ### method getFormatColumns [line 303]
`boolean getFormatColumns( )`
Get FormatColumns Get FormatColumns [ Top ] ### method getFormatRows [line 323]
`boolean getFormatRows( )`
Get FormatRows Get FormatRows [ Top ] ### method getInsertColumns [line 343]
`boolean getInsertColumns( )`
Get InsertColumns Get InsertColumns [ Top ] ### method getInsertHyperlinks [line 383]
`boolean getInsertHyperlinks( )`
Get InsertHyperlinks Get InsertHyperlinks [ Top ] ### method getInsertRows [line 363]
`boolean getInsertRows( )`
Get InsertRows Get InsertRows [ Top ] ### method getObjects [line 243]
`boolean getObjects( )`
Get Objects Get Objects [ Top ] ### method getPassword [line 543]
`string getPassword( )`
Get Password (hashed) Get Password (hashed) [ Top ] ### method getPivotTables [line 503]
`boolean getPivotTables( )`
Get PivotTables Get PivotTables [ Top ] ### method getScenarios [line 263]
`boolean getScenarios( )`
Get Scenarios Get Scenarios [ Top ] ### method getSelectLockedCells [line 443]
`boolean getSelectLockedCells( )`
Get SelectLockedCells Get SelectLockedCells [ Top ] ### method getSelectUnlockedCells [line 523]
`boolean getSelectUnlockedCells( )`
Get SelectUnlockedCells Get SelectUnlockedCells [ Top ] ### method getSheet [line 223]
`boolean getSheet( )`
Get Sheet Get Sheet [ Top ] ### method getSort [line 463]
`boolean getSort( )`
Get Sort Get Sort [ Top ] ### method isProtectionEnabled [line 199]
`boolean isProtectionEnabled( )`
Is some sort of protection enabled? Is some sort of protection enabled? [ Top ] ### method setAutoFilter [line 493]
`PHPExcel_Worksheet_Protection setAutoFilter( [boolean $pValue = false])`
Set AutoFilter Set AutoFilter #### Parameters:
boolean | $pValue |
[ Top ] ### method setDeleteColumns [line 413]
`PHPExcel_Worksheet_Protection setDeleteColumns( [boolean $pValue = false])`
Set DeleteColumns Set DeleteColumns #### Parameters:
boolean | $pValue |
[ Top ] ### method setDeleteRows [line 433]
`PHPExcel_Worksheet_Protection setDeleteRows( [boolean $pValue = false])`
Set DeleteRows Set DeleteRows #### Parameters:
boolean | $pValue |
[ Top ] ### method setFormatCells [line 293]
`PHPExcel_Worksheet_Protection setFormatCells( [boolean $pValue = false])`
Set FormatCells Set FormatCells #### Parameters:
boolean | $pValue |
[ Top ] ### method setFormatColumns [line 313]
`PHPExcel_Worksheet_Protection setFormatColumns( [boolean $pValue = false])`
Set FormatColumns Set FormatColumns #### Parameters:
boolean | $pValue |
[ Top ] ### method setFormatRows [line 333]
`PHPExcel_Worksheet_Protection setFormatRows( [boolean $pValue = false])`
Set FormatRows Set FormatRows #### Parameters:
boolean | $pValue |
[ Top ] ### method setInsertColumns [line 353]
`PHPExcel_Worksheet_Protection setInsertColumns( [boolean $pValue = false])`
Set InsertColumns Set InsertColumns #### Parameters:
boolean | $pValue |
[ Top ] ### method setInsertHyperlinks [line 393]
`PHPExcel_Worksheet_Protection setInsertHyperlinks( [boolean $pValue = false])`
Set InsertHyperlinks Set InsertHyperlinks #### Parameters:
boolean | $pValue |
[ Top ] ### method setInsertRows [line 373]
`PHPExcel_Worksheet_Protection setInsertRows( [boolean $pValue = false])`
Set InsertRows Set InsertRows #### Parameters:
boolean | $pValue |
[ Top ] ### method setObjects [line 253]
`PHPExcel_Worksheet_Protection setObjects( [boolean $pValue = false])`
Set Objects Set Objects #### Parameters:
boolean | $pValue |
[ Top ] ### method setPassword [line 554]
`PHPExcel_Worksheet_Protection setPassword( [string $pValue = ''], [boolean $pAlreadyHashed = false])`
Set Password Set Password #### Parameters:
string | $pValue |
boolean | $pAlreadyHashed | If the password has already been hashed, set this to true
[ Top ] ### method setPivotTables [line 513]
`PHPExcel_Worksheet_Protection setPivotTables( [boolean $pValue = false])`
Set PivotTables Set PivotTables #### Parameters:
boolean | $pValue |
[ Top ] ### method setScenarios [line 273]
`PHPExcel_Worksheet_Protection setScenarios( [boolean $pValue = false])`
Set Scenarios Set Scenarios #### Parameters:
boolean | $pValue |
[ Top ] ### method setSelectLockedCells [line 453]
`PHPExcel_Worksheet_Protection setSelectLockedCells( [boolean $pValue = false])`
Set SelectLockedCells Set SelectLockedCells #### Parameters:
boolean | $pValue |
[ Top ] ### method setSelectUnlockedCells [line 533]
`PHPExcel_Worksheet_Protection setSelectUnlockedCells( [boolean $pValue = false])`
Set SelectUnlockedCells Set SelectUnlockedCells #### Parameters:
boolean | $pValue |
[ Top ] ### method setSheet [line 233]
`PHPExcel_Worksheet_Protection setSheet( [boolean $pValue = false])`
Set Sheet Set Sheet #### Parameters:
boolean | $pValue |
[ Top ] ### method setSort [line 473]
`PHPExcel_Worksheet_Protection setSort( [boolean $pValue = false])`
Set Sort Set Sort #### Parameters:
boolean | $pValue |
[ Top ] ### method __clone [line 565]
`void __clone( )`
Implement PHP __clone to create a deep clone, not just a shallow copy. Implement PHP __clone to create a deep clone, not just a shallow copy. #### Tags:
access: | public
[ Top ] Documentation generated on Mon, 11 Jan 2010 08:13:05 +0100 by phpDocumentor 1.4.1