\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

Summary

Methods
Properties
Constants
__construct()
isSecurityEnabled()
getLockRevision()
setLockRevision()
getLockStructure()
setLockStructure()
getLockWindows()
setLockWindows()
getRevisionsPassword()
setRevisionsPassword()
getWorkbookPassword()
setWorkbookPassword()
__clone()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$lockRevision
$lockStructure
$lockWindows
$revisionsPassword
$workbookPassword
N/A

Properties

$lockRevision

$lockRevision : boolean

LockRevision

Type

boolean

$lockStructure

$lockStructure : boolean

LockStructure

Type

boolean

$lockWindows

$lockWindows : boolean

LockWindows

Type

boolean

$revisionsPassword

$revisionsPassword : string

RevisionsPassword

Type

string

$workbookPassword

$workbookPassword : string

WorkbookPassword

Type

string

Methods

__construct()

__construct() 

Create a new PHPExcel_DocumentSecurity

isSecurityEnabled()

isSecurityEnabled() : boolean

Is some sort of document security enabled?

Returns

boolean

getLockRevision()

getLockRevision() : boolean

Get LockRevision

Returns

boolean

setLockRevision()

setLockRevision(boolean  $pValue = false) : \PHPExcel_DocumentSecurity

Set LockRevision

Parameters

boolean $pValue

Returns

\PHPExcel_DocumentSecurity

getLockStructure()

getLockStructure() : boolean

Get LockStructure

Returns

boolean

setLockStructure()

setLockStructure(boolean  $pValue = false) : \PHPExcel_DocumentSecurity

Set LockStructure

Parameters

boolean $pValue

Returns

\PHPExcel_DocumentSecurity

getLockWindows()

getLockWindows() : boolean

Get LockWindows

Returns

boolean

setLockWindows()

setLockWindows(boolean  $pValue = false) : \PHPExcel_DocumentSecurity

Set LockWindows

Parameters

boolean $pValue

Returns

\PHPExcel_DocumentSecurity

getRevisionsPassword()

getRevisionsPassword() : string

Get RevisionsPassword (hashed)

Returns

string

setRevisionsPassword()

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

Set RevisionsPassword

Parameters

string $pValue
boolean $pAlreadyHashed

If the password has already been hashed, set this to true

Returns

\PHPExcel_DocumentSecurity

getWorkbookPassword()

getWorkbookPassword() : string

Get WorkbookPassword (hashed)

Returns

string

setWorkbookPassword()

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

Set WorkbookPassword

Parameters

string $pValue
boolean $pAlreadyHashed

If the password has already been hashed, set this to true

Returns

\PHPExcel_DocumentSecurity

__clone()

__clone() 

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