class Protection (View source)

Methods

__construct()

Create a new Protection.

bool
isProtectionEnabled()

Is some sort of protection enabled?

bool
getSheet()

Get Sheet.

setSheet(bool $pValue)

Set Sheet.

bool
getObjects()

Get Objects.

setObjects(bool $pValue)

Set Objects.

bool
getScenarios()

Get Scenarios.

setScenarios(bool $pValue)

Set Scenarios.

bool
getFormatCells()

Get FormatCells.

setFormatCells(bool $pValue)

Set FormatCells.

bool
getFormatColumns()

Get FormatColumns.

setFormatColumns(bool $pValue)

Set FormatColumns.

bool
getFormatRows()

Get FormatRows.

setFormatRows(bool $pValue)

Set FormatRows.

bool
getInsertColumns()

Get InsertColumns.

setInsertColumns(bool $pValue)

Set InsertColumns.

bool
getInsertRows()

Get InsertRows.

setInsertRows(bool $pValue)

Set InsertRows.

bool
getInsertHyperlinks()

Get InsertHyperlinks.

setInsertHyperlinks(bool $pValue)

Set InsertHyperlinks.

bool
getDeleteColumns()

Get DeleteColumns.

setDeleteColumns(bool $pValue)

Set DeleteColumns.

bool
getDeleteRows()

Get DeleteRows.

setDeleteRows(bool $pValue)

Set DeleteRows.

bool
getSelectLockedCells()

Get SelectLockedCells.

setSelectLockedCells(bool $pValue)

Set SelectLockedCells.

bool
getSort()

Get Sort.

setSort(bool $pValue)

Set Sort.

bool
getAutoFilter()

Get AutoFilter.

setAutoFilter(bool $pValue)

Set AutoFilter.

bool
getPivotTables()

Get PivotTables.

setPivotTables(bool $pValue)

Set PivotTables.

bool
getSelectUnlockedCells()

Get SelectUnlockedCells.

setSelectUnlockedCells(bool $pValue)

Set SelectUnlockedCells.

string
getPassword()

Get Password (hashed).

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

Set Password.

__clone()

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

Details

__construct()

Create a new Protection.

bool isProtectionEnabled()

Is some sort of protection enabled?

Return Value

bool

bool getSheet()

Get Sheet.

Return Value

bool

Protection setSheet(bool $pValue)

Set Sheet.

Parameters

bool $pValue

Return Value

Protection

bool getObjects()

Get Objects.

Return Value

bool

Protection setObjects(bool $pValue)

Set Objects.

Parameters

bool $pValue

Return Value

Protection

bool getScenarios()

Get Scenarios.

Return Value

bool

Protection setScenarios(bool $pValue)

Set Scenarios.

Parameters

bool $pValue

Return Value

Protection

bool getFormatCells()

Get FormatCells.

Return Value

bool

Protection setFormatCells(bool $pValue)

Set FormatCells.

Parameters

bool $pValue

Return Value

Protection

bool getFormatColumns()

Get FormatColumns.

Return Value

bool

Protection setFormatColumns(bool $pValue)

Set FormatColumns.

Parameters

bool $pValue

Return Value

Protection

bool getFormatRows()

Get FormatRows.

Return Value

bool

Protection setFormatRows(bool $pValue)

Set FormatRows.

Parameters

bool $pValue

Return Value

Protection

bool getInsertColumns()

Get InsertColumns.

Return Value

bool

Protection setInsertColumns(bool $pValue)

Set InsertColumns.

Parameters

bool $pValue

Return Value

Protection

bool getInsertRows()

Get InsertRows.

Return Value

bool

Protection setInsertRows(bool $pValue)

Set InsertRows.

Parameters

bool $pValue

Return Value

Protection

Get InsertHyperlinks.

Return Value

bool

Set InsertHyperlinks.

Parameters

bool $pValue

Return Value

Protection

bool getDeleteColumns()

Get DeleteColumns.

Return Value

bool

Protection setDeleteColumns(bool $pValue)

Set DeleteColumns.

Parameters

bool $pValue

Return Value

Protection

bool getDeleteRows()

Get DeleteRows.

Return Value

bool

Protection setDeleteRows(bool $pValue)

Set DeleteRows.

Parameters

bool $pValue

Return Value

Protection

bool getSelectLockedCells()

Get SelectLockedCells.

Return Value

bool

Protection setSelectLockedCells(bool $pValue)

Set SelectLockedCells.

Parameters

bool $pValue

Return Value

Protection

bool getSort()

Get Sort.

Return Value

bool

Protection setSort(bool $pValue)

Set Sort.

Parameters

bool $pValue

Return Value

Protection

bool getAutoFilter()

Get AutoFilter.

Return Value

bool

Protection setAutoFilter(bool $pValue)

Set AutoFilter.

Parameters

bool $pValue

Return Value

Protection

bool getPivotTables()

Get PivotTables.

Return Value

bool

Protection setPivotTables(bool $pValue)

Set PivotTables.

Parameters

bool $pValue

Return Value

Protection

bool getSelectUnlockedCells()

Get SelectUnlockedCells.

Return Value

bool

Protection setSelectUnlockedCells(bool $pValue)

Set SelectUnlockedCells.

Parameters

bool $pValue

Return Value

Protection

string getPassword()

Get Password (hashed).

Return Value

string

Protection setPassword(string $pValue, bool $pAlreadyHashed = false)

Set Password.

Parameters

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

Return Value

Protection

__clone()

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