class Security (View source)

Methods

__construct()

Create a new Document Security instance.

bool
isSecurityEnabled()

Is some sort of document security enabled?

bool
getLockRevision()

Get LockRevision.

setLockRevision(bool $pValue)

Set LockRevision.

bool
getLockStructure()

Get LockStructure.

setLockStructure(bool $pValue)

Set LockStructure.

bool
getLockWindows()

Get LockWindows.

setLockWindows(bool $pValue)

Set LockWindows.

string
getRevisionsPassword()

Get RevisionsPassword (hashed).

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

Set RevisionsPassword.

string
getWorkbookPassword()

Get WorkbookPassword (hashed).

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

Set WorkbookPassword.

__clone()

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

Details

__construct()

Create a new Document Security instance.

bool isSecurityEnabled()

Is some sort of document security enabled?

Return Value

bool

bool getLockRevision()

Get LockRevision.

Return Value

bool

Security setLockRevision(bool $pValue)

Set LockRevision.

Parameters

bool $pValue

Return Value

Security

bool getLockStructure()

Get LockStructure.

Return Value

bool

Security setLockStructure(bool $pValue)

Set LockStructure.

Parameters

bool $pValue

Return Value

Security

bool getLockWindows()

Get LockWindows.

Return Value

bool

Security setLockWindows(bool $pValue)

Set LockWindows.

Parameters

bool $pValue

Return Value

Security

string getRevisionsPassword()

Get RevisionsPassword (hashed).

Return Value

string

Security setRevisionsPassword(string $pValue, bool $pAlreadyHashed = false)

Set RevisionsPassword.

Parameters

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

Return Value

Security

string getWorkbookPassword()

Get WorkbookPassword (hashed).

Return Value

string

Security setWorkbookPassword(string $pValue, bool $pAlreadyHashed = false)

Set WorkbookPassword.

Parameters

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

Return Value

Security

__clone()

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