Documentation

Security
in package

Table of Contents

Properties

$lockRevision  : bool
LockRevision.
$lockStructure  : bool
LockStructure.
$lockWindows  : bool
LockWindows.
$revisionsAlgorithmName  : string
$revisionsHashValue  : string
$revisionsPassword  : string
RevisionsPassword.
$revisionsSaltValue  : string
$revisionsSpinCount  : int
$workbookAlgorithmName  : string
$workbookHashValue  : string
$workbookPassword  : string
WorkbookPassword.
$workbookSaltValue  : string
$workbookSpinCount  : int

Methods

advancedPassword()  : bool
advancedRevisionsPassword()  : bool
getLockRevision()  : bool
getLockStructure()  : bool
getLockWindows()  : bool
getRevisionsAlgorithmName()  : string
getRevisionsHashValue()  : string
getRevisionsPassword()  : string
getRevisionsSaltValue()  : string
getRevisionsSpinCount()  : int
getWorkbookAlgorithmName()  : string
getWorkbookHashValue()  : string
getWorkbookPassword()  : string
getWorkbookSaltValue()  : string
getWorkbookSpinCount()  : int
isSecurityEnabled()  : bool
Is some sort of document security enabled?
setLockRevision()  : self
setLockStructure()  : self
setLockWindows()  : self
setRevisionsAlgorithmName()  : static
setRevisionsPassword()  : $this
Set RevisionsPassword.
setRevisionsSaltValue()  : static
setRevisionsSpinCount()  : static
setWorkbookAlgorithmName()  : static
setWorkbookPassword()  : $this
Set WorkbookPassword.
setWorkbookSaltValue()  : static
setWorkbookSpinCount()  : static

Properties

$lockRevision

LockRevision.

private bool $lockRevision = false

$lockStructure

LockStructure.

private bool $lockStructure = false

$lockWindows

LockWindows.

private bool $lockWindows = false

$revisionsAlgorithmName

private string $revisionsAlgorithmName = ''

$revisionsHashValue

private string $revisionsHashValue = ''

$revisionsPassword

RevisionsPassword.

private string $revisionsPassword = ''

$revisionsSaltValue

private string $revisionsSaltValue = ''

$revisionsSpinCount

private int $revisionsSpinCount = 0

$workbookAlgorithmName

private string $workbookAlgorithmName = ''

$workbookHashValue

private string $workbookHashValue = ''

$workbookPassword

WorkbookPassword.

private string $workbookPassword = ''

$workbookSaltValue

private string $workbookSaltValue = ''

$workbookSpinCount

private int $workbookSpinCount = 0

Methods

advancedPassword()

public advancedPassword() : bool
Return values
bool

advancedRevisionsPassword()

public advancedRevisionsPassword() : bool
Return values
bool

getLockRevision()

public getLockRevision() : bool
Return values
bool

getLockStructure()

public getLockStructure() : bool
Return values
bool

getLockWindows()

public getLockWindows() : bool
Return values
bool

getRevisionsAlgorithmName()

public getRevisionsAlgorithmName() : string
Return values
string

getRevisionsHashValue()

public getRevisionsHashValue() : string
Return values
string

getRevisionsPassword()

public getRevisionsPassword() : string
Return values
string

getRevisionsSaltValue()

public getRevisionsSaltValue() : string
Return values
string

getRevisionsSpinCount()

public getRevisionsSpinCount() : int
Return values
int

getWorkbookAlgorithmName()

public getWorkbookAlgorithmName() : string
Return values
string

getWorkbookHashValue()

public getWorkbookHashValue() : string
Return values
string

getWorkbookPassword()

public getWorkbookPassword() : string
Return values
string

getWorkbookSaltValue()

public getWorkbookSaltValue() : string
Return values
string

getWorkbookSpinCount()

public getWorkbookSpinCount() : int
Return values
int

isSecurityEnabled()

Is some sort of document security enabled?

public isSecurityEnabled() : bool
Return values
bool

setLockRevision()

public setLockRevision(bool|null $locked) : self
Parameters
$locked : bool|null
Return values
self

setLockStructure()

public setLockStructure(bool|null $locked) : self
Parameters
$locked : bool|null
Return values
self

setLockWindows()

public setLockWindows(bool|null $locked) : self
Parameters
$locked : bool|null
Return values
self

setRevisionsAlgorithmName()

public setRevisionsAlgorithmName(string $revisionsAlgorithmName) : static
Parameters
$revisionsAlgorithmName : string
Return values
static

setRevisionsPassword()

Set RevisionsPassword.

public setRevisionsPassword(string|null $password[, bool $alreadyHashed = false ]) : $this
Parameters
$password : string|null
$alreadyHashed : bool = false

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

Return values
$this

setRevisionsSaltValue()

public setRevisionsSaltValue(string $revisionsSaltValue, bool $base64Required) : static
Parameters
$revisionsSaltValue : string
$base64Required : bool
Return values
static

setRevisionsSpinCount()

public setRevisionsSpinCount(int $revisionsSpinCount) : static
Parameters
$revisionsSpinCount : int
Return values
static

setWorkbookAlgorithmName()

public setWorkbookAlgorithmName(string $workbookAlgorithmName) : static
Parameters
$workbookAlgorithmName : string
Return values
static

setWorkbookPassword()

Set WorkbookPassword.

public setWorkbookPassword(string|null $password[, bool $alreadyHashed = false ]) : $this
Parameters
$password : string|null
$alreadyHashed : bool = false

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

Return values
$this

setWorkbookSaltValue()

public setWorkbookSaltValue(string $workbookSaltValue, bool $base64Required) : static
Parameters
$workbookSaltValue : string
$base64Required : bool
Return values
static

setWorkbookSpinCount()

public setWorkbookSpinCount(int $workbookSpinCount) : static
Parameters
$workbookSpinCount : int
Return values
static

        
On this page

Search results