Documentation

Protection

in package

• Application

Table of Contents

Constants

ALGORITHM_MD2  = 'MD2'

ALGORITHM_MD4  = 'MD4'

ALGORITHM_MD5  = 'MD5'

ALGORITHM_RIPEMD_128  = 'RIPEMD-128'

ALGORITHM_RIPEMD_160  = 'RIPEMD-160'

ALGORITHM_SHA_1  = 'SHA-1'

ALGORITHM_SHA_256  = 'SHA-256'

ALGORITHM_SHA_384  = 'SHA-384'

ALGORITHM_SHA_512  = 'SHA-512'

ALGORITHM_WHIRLPOOL  = 'WHIRLPOOL'

Properties

$algorithm  : string

Algorithm name.

$autoFilter  : bool|null

Autofilters are locked when sheet is protected, default true.

$deleteColumns  : bool|null

Deleting columns is locked when sheet is protected, default true.

$deleteRows  : bool|null

Deleting rows is locked when sheet is protected, default true.

$formatCells  : bool|null

Formatting cells is locked when sheet is protected, default true.

$formatColumns  : bool|null

Formatting columns is locked when sheet is protected, default true.

$formatRows  : bool|null

Formatting rows is locked when sheet is protected, default true.

$insertColumns  : bool|null

Inserting columns is locked when sheet is protected, default true.

$insertHyperlinks  : bool|null

Inserting hyperlinks is locked when sheet is protected, default true.

$insertRows  : bool|null

Inserting rows is locked when sheet is protected, default true.

$objects  : bool|null

Objects are locked when sheet is protected, default false.

$password  : string

Hashed password.

$pivotTables  : bool|null

Pivot tables are locked when the sheet is protected, default true.

$salt  : string

Salt value.

$scenarios  : bool|null

Scenarios are locked when sheet is protected, default false.

$selectLockedCells  : bool|null

Selection of locked cells is locked when sheet is protected, default false.

$selectUnlockedCells  : bool|null

Selection of unlocked cells is locked when sheet is protected, default false.

$sheet  : bool|null

Sheet is locked when sheet is protected, default false.

$sort  : bool|null

Sorting is locked when sheet is protected, default true.

$spinCount  : int

Spin count.

Methods

__clone()  : mixed

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

__construct()  : mixed

Create a new Protection.

getAlgorithm()  : string

Get algorithm name.

getAutoFilter()  : bool|null

getDeleteColumns()  : bool|null

getDeleteRows()  : bool|null

getFormatCells()  : bool|null

getFormatColumns()  : bool|null

getFormatRows()  : bool|null

getInsertColumns()  : bool|null

getInsertHyperlinks()  : bool|null

getInsertRows()  : bool|null

getObjects()  : bool|null

getPassword()  : string

Get hashed password.

getPivotTables()  : bool|null

getSalt()  : string

getScenarios()  : bool|null

getSelectLockedCells()  : bool|null

getSelectUnlockedCells()  : bool|null

getSheet()  : bool|null

getSort()  : bool|null

getSpinCount()  : int

Get spin count.

isProtectionEnabled()  : bool

Is some sort of protection enabled?

setAlgorithm()  : self

Set algorithm name.

setAlgorithmName()  : self

Set algorithm name.

setAutoFilter()  : self

setDeleteColumns()  : self

setDeleteRows()  : self

setFormatCells()  : self

setFormatColumns()  : self

setFormatRows()  : self

setHashValue()  : self

setInsertColumns()  : self

setInsertHyperlinks()  : self

setInsertRows()  : self

setObjects()  : self

setPassword()  : $this

Set Password.

setPivotTables()  : self

setSalt()  : self

setSaltValue()  : self

setScenarios()  : self

setSelectLockedCells()  : self

setSelectUnlockedCells()  : self

setSheet()  : self

setSort()  : self

setSpinCount()  : self

Set spin count.

verify()  : bool

Verify that the given non-hashed password can "unlock" the protection.

generateSalt()  : string

Create a pseudorandom string.