__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

File: vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Document/Security.php
Package: Application
Class hierarchy: \PhpOffice\PhpSpreadsheet\Document\Security
Uses

Properties

$lockRevision

$lockRevision : bool

LockRevision.

Type

bool —

$lockStructure

$lockStructure : bool

LockStructure.

Type

bool —

$lockWindows

$lockWindows : bool

LockWindows.

Type

bool —

$revisionsPassword

$revisionsPassword : string

RevisionsPassword.

Type

string —

$workbookPassword

$workbookPassword : string

WorkbookPassword.

Type

string —

Methods

__construct()

__construct() : mixed

Create a new Document Security instance.

Returns

mixed —

isSecurityEnabled()

isSecurityEnabled() : bool

Is some sort of document security enabled?

Returns

bool —

getLockRevision()

getLockRevision() : bool

Get LockRevision.

Returns

bool —

setLockRevision()

setLockRevision(bool  $pValue) : \PhpOffice\PhpSpreadsheet\Document\Security

Set LockRevision.

Parameters

bool

$pValue

Returns

\PhpOffice\PhpSpreadsheet\Document\Security —

getLockStructure()

getLockStructure() : bool

Get LockStructure.

Returns

bool —

setLockStructure()

setLockStructure(bool  $pValue) : \PhpOffice\PhpSpreadsheet\Document\Security

Set LockStructure.

Parameters

bool

$pValue

Returns

\PhpOffice\PhpSpreadsheet\Document\Security —

getLockWindows()

getLockWindows() : bool

Get LockWindows.

Returns

bool —

setLockWindows()

setLockWindows(bool  $pValue) : \PhpOffice\PhpSpreadsheet\Document\Security

Set LockWindows.

Parameters

bool

$pValue

Returns

\PhpOffice\PhpSpreadsheet\Document\Security —

getRevisionsPassword()

getRevisionsPassword() : string

Get RevisionsPassword (hashed).

Returns

string —

setRevisionsPassword()

setRevisionsPassword(string  $pValue, bool  $pAlreadyHashed = false) : \PhpOffice\PhpSpreadsheet\Document\Security

Set RevisionsPassword.

Parameters

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

Returns

\PhpOffice\PhpSpreadsheet\Document\Security —

getWorkbookPassword()

getWorkbookPassword() : string

Get WorkbookPassword (hashed).

Returns

string —

setWorkbookPassword()

setWorkbookPassword(string  $pValue, bool  $pAlreadyHashed = false) : \PhpOffice\PhpSpreadsheet\Document\Security

Set WorkbookPassword.

Parameters

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

Returns

\PhpOffice\PhpSpreadsheet\Document\Security —

__clone()

__clone() : mixed

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

Returns

mixed —