Documentation

Security
in package

Table of Contents

Properties

$lockRevision  : bool
LockRevision.
$lockStructure  : bool
LockStructure.
$lockWindows  : bool
LockWindows.
$revisionsPassword  : string
RevisionsPassword.
$workbookPassword  : string
WorkbookPassword.

Methods

__construct()  : mixed
Create a new Document Security instance.
getLockRevision()  : bool
getLockStructure()  : bool
getLockWindows()  : bool
getRevisionsPassword()  : string
getWorkbookPassword()  : string
isSecurityEnabled()  : bool
Is some sort of document security enabled?
setLockRevision()  : self
setLockStructure()  : self
setLockWindows()  : self
setRevisionsPassword()  : $this
Set RevisionsPassword.
setWorkbookPassword()  : $this
Set WorkbookPassword.

Properties

$lockRevision

LockRevision.

private bool $lockRevision = false

$lockStructure

LockStructure.

private bool $lockStructure = false

$lockWindows

LockWindows.

private bool $lockWindows = false

$revisionsPassword

RevisionsPassword.

private string $revisionsPassword = ''

$workbookPassword

WorkbookPassword.

private string $workbookPassword = ''

Methods

__construct()

Create a new Document Security instance.

public __construct() : mixed

getLockRevision()

public getLockRevision() : bool
Return values
bool

getLockStructure()

public getLockStructure() : bool
Return values
bool

getLockWindows()

public getLockWindows() : bool
Return values
bool

getRevisionsPassword()

public getRevisionsPassword() : string
Return values
string

getWorkbookPassword()

public getWorkbookPassword() : string
Return values
string

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

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

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 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results