class PHPExcel_DocumentSecurity

PHPExcel_DocumentSecurity

Copyright (c) 2006 - 2015 PHPExcel

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

Methods

__construct()

Create a new PHPExcel_DocumentSecurity

boolean
isSecurityEnabled()

Is some sort of document security enabled?

boolean
getLockRevision()

Get LockRevision

setLockRevision(boolean $pValue = false)

Set LockRevision

boolean
getLockStructure()

Get LockStructure

setLockStructure(boolean $pValue = false)

Set LockStructure

boolean
getLockWindows()

Get LockWindows

setLockWindows(boolean $pValue = false)

Set LockWindows

string
getRevisionsPassword()

Get RevisionsPassword (hashed)

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

Set RevisionsPassword

string
getWorkbookPassword()

Get WorkbookPassword (hashed)

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

Set WorkbookPassword

__clone()

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

Details

at line 77
__construct()

Create a new PHPExcel_DocumentSecurity

at line 92
boolean isSecurityEnabled()

Is some sort of document security enabled?

Return Value

boolean

at line 104
boolean getLockRevision()

Get LockRevision

Return Value

boolean

at line 115
PHPExcel_DocumentSecurity setLockRevision(boolean $pValue = false)

Set LockRevision

Parameters

boolean $pValue

Return Value

PHPExcel_DocumentSecurity

at line 126
boolean getLockStructure()

Get LockStructure

Return Value

boolean

at line 137
PHPExcel_DocumentSecurity setLockStructure(boolean $pValue = false)

Set LockStructure

Parameters

boolean $pValue

Return Value

PHPExcel_DocumentSecurity

at line 148
boolean getLockWindows()

Get LockWindows

Return Value

boolean

at line 159
PHPExcel_DocumentSecurity setLockWindows(boolean $pValue = false)

Set LockWindows

Parameters

boolean $pValue

Return Value

PHPExcel_DocumentSecurity

at line 170
string getRevisionsPassword()

Get RevisionsPassword (hashed)

Return Value

string

at line 182
PHPExcel_DocumentSecurity setRevisionsPassword(string $pValue = '', boolean $pAlreadyHashed = false)

Set RevisionsPassword

Parameters

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

Return Value

PHPExcel_DocumentSecurity

at line 196
string getWorkbookPassword()

Get WorkbookPassword (hashed)

Return Value

string

at line 208
PHPExcel_DocumentSecurity setWorkbookPassword(string $pValue = '', boolean $pAlreadyHashed = false)

Set WorkbookPassword

Parameters

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

Return Value

PHPExcel_DocumentSecurity

at line 220
__clone()

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