PHPExcel

# Class: PHPExcel_DocumentSecurity Source Location: /PHPExcel/DocumentSecurity.php
### Class Overview
PHPExcel_DocumentSecurity #### Author(s): #### Copyright: Copyright (c) 2006 - 2010 PHPExcel (http://www.codeplex.com/PHPExcel) | ### Variables $_lockRevision $_lockStructure $_lockWindows $_revisionsPassword $_workbookPassword | ### Methods __construct getLockRevision getLockStructure getLockWindows getRevisionsPassword getWorkbookPassword isSecurityEnabled setLockRevision setLockStructure setLockWindows setRevisionsPassword setWorkbookPassword __clone
### Class Details [line 48] PHPExcel_DocumentSecurity PHPExcel_DocumentSecurity #### Tags:
copyright: | Copyright (c) 2006 - 2010 PHPExcel (http://www.codeplex.com/PHPExcel)
[ Top ] ### Class Variables #### $_lockRevision = [line 55] LockRevision LockRevision #### Tags:
access: | private
Type: | boolean
[ Top ] #### $_lockStructure = [line 62] LockStructure LockStructure #### Tags:
access: | private
Type: | boolean
[ Top ] #### $_lockWindows = [line 69] LockWindows LockWindows #### Tags:
access: | private
Type: | boolean
[ Top ] #### $_revisionsPassword = [line 76] RevisionsPassword RevisionsPassword #### Tags:
access: | private
Type: | string
[ Top ] #### $_workbookPassword = [line 83] WorkbookPassword WorkbookPassword #### Tags:
access: | private
Type: | string
[ Top ] ### Class Methods ### constructor __construct [line 88]
`PHPExcel_DocumentSecurity __construct( )`
Create a new PHPExcel_DocumentSecurity Create a new PHPExcel_DocumentSecurity #### Tags:
access: | public
[ Top ] ### method getLockRevision [line 114]
`boolean getLockRevision( )`
Get LockRevision Get LockRevision [ Top ] ### method getLockStructure [line 134]
`boolean getLockStructure( )`
Get LockStructure Get LockStructure [ Top ] ### method getLockWindows [line 154]
`boolean getLockWindows( )`
Get LockWindows Get LockWindows [ Top ] ### method getRevisionsPassword [line 174]
`string getRevisionsPassword( )`
Get RevisionsPassword (hashed) Get RevisionsPassword (hashed) [ Top ] ### method getWorkbookPassword [line 198]
`string getWorkbookPassword( )`
Get WorkbookPassword (hashed) Get WorkbookPassword (hashed) [ Top ] ### method isSecurityEnabled [line 103]
`boolean isSecurityEnabled( )`
Is some sort of dcument security enabled? Is some sort of dcument security enabled? [ Top ] ### method setLockRevision [line 124]
`PHPExcel_DocumentSecurity setLockRevision( [boolean $pValue = false])`
Set LockRevision Set LockRevision #### Parameters:
boolean | $pValue |
[ Top ] ### method setLockStructure [line 144]
`PHPExcel_DocumentSecurity setLockStructure( [boolean $pValue = false])`
Set LockStructure Set LockStructure #### Parameters:
boolean | $pValue |
[ Top ] ### method setLockWindows [line 164]
`PHPExcel_DocumentSecurity setLockWindows( [boolean $pValue = false])`
Set LockWindows Set LockWindows #### Parameters:
boolean | $pValue |
[ Top ] ### method setRevisionsPassword [line 185]
`PHPExcel_DocumentSecurity setRevisionsPassword( [string $pValue = ''], [boolean $pAlreadyHashed = false])`
Set RevisionsPassword Set RevisionsPassword #### Parameters:
string | $pValue |
boolean | $pAlreadyHashed | If the password has already been hashed, set this to true
[ Top ] ### method setWorkbookPassword [line 209]
`PHPExcel_DocumentSecurity setWorkbookPassword( [string $pValue = ''], [boolean $pAlreadyHashed = false])`
Set WorkbookPassword Set WorkbookPassword #### Parameters:
string | $pValue |
boolean | $pAlreadyHashed | If the password has already been hashed, set this to true
[ Top ] ### method __clone [line 220]
`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:07:55 +0100 by phpDocumentor 1.4.1