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) : $this

Set LockRevision.

Parameters

bool $pValue

Returns

$this —

getLockStructure()

getLockStructure() : bool

Get LockStructure.

Returns

bool —

setLockStructure()

setLockStructure(bool  $pValue) : $this

Set LockStructure.

Parameters

bool $pValue

Returns

$this —

getLockWindows()

getLockWindows() : bool

Get LockWindows.

Returns

bool —

setLockWindows()

setLockWindows(bool  $pValue) : $this

Set LockWindows.

Parameters

bool $pValue

Returns

$this —

getRevisionsPassword()

getRevisionsPassword() : string

Get RevisionsPassword (hashed).

Returns

string —

setRevisionsPassword()

setRevisionsPassword(string  $pValue, bool  $pAlreadyHashed = false) : $this

Set RevisionsPassword.

Parameters

string $pValue
bool $pAlreadyHashed

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

Returns

$this —

getWorkbookPassword()

getWorkbookPassword() : string

Get WorkbookPassword (hashed).

Returns

string —

setWorkbookPassword()

setWorkbookPassword(string  $pValue, bool  $pAlreadyHashed = false) : $this

Set WorkbookPassword.

Parameters

string $pValue
bool $pAlreadyHashed

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

Returns

$this —

__clone()

__clone() : mixed

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

Returns

mixed —