Properties

$sheet

$sheet : bool

Sheet.

Type

bool

$objects

$objects : bool

Objects.

Type

bool

$scenarios

$scenarios : bool

Scenarios.

Type

bool

$formatCells

$formatCells : bool

Format cells.

Type

bool

$formatColumns

$formatColumns : bool

Format columns.

Type

bool

$formatRows

$formatRows : bool

Format rows.

Type

bool

$insertColumns

$insertColumns : bool

Insert columns.

Type

bool

$insertRows

$insertRows : bool

Insert rows.

Type

bool

$insertHyperlinks

$insertHyperlinks : bool

Insert hyperlinks.

Type

bool

$deleteColumns

$deleteColumns : bool

Delete columns.

Type

bool

$deleteRows

$deleteRows : bool

Delete rows.

Type

bool

$selectLockedCells

$selectLockedCells : bool

Select locked cells.

Type

bool

$sort

$sort : bool

Sort.

Type

bool

$autoFilter

$autoFilter : bool

AutoFilter.

Type

bool

$pivotTables

$pivotTables : bool

Pivot tables.

Type

bool

$selectUnlockedCells

$selectUnlockedCells : bool

Select unlocked cells.

Type

bool

$password

$password : string

Password.

Type

string

Methods

__construct()

__construct() : mixed

Create a new Protection.

Returns

mixed —

isProtectionEnabled()

isProtectionEnabled() : bool

Is some sort of protection enabled?

Returns

bool —

getSheet()

getSheet() : bool

Get Sheet.

Returns

bool —

setSheet()

setSheet(bool  $pValue) : \PhpOffice\PhpSpreadsheet\Worksheet\Protection

Set Sheet.

Parameters

bool $pValue

Returns

\PhpOffice\PhpSpreadsheet\Worksheet\Protection —

getObjects()

getObjects() : bool

Get Objects.

Returns

bool —

setObjects()

setObjects(bool  $pValue) : \PhpOffice\PhpSpreadsheet\Worksheet\Protection

Set Objects.

Parameters

bool $pValue

Returns

\PhpOffice\PhpSpreadsheet\Worksheet\Protection —

getScenarios()

getScenarios() : bool

Get Scenarios.

Returns

bool —

setScenarios()

setScenarios(bool  $pValue) : \PhpOffice\PhpSpreadsheet\Worksheet\Protection

Set Scenarios.

Parameters

bool $pValue

Returns

\PhpOffice\PhpSpreadsheet\Worksheet\Protection —

getFormatCells()

getFormatCells() : bool

Get FormatCells.

Returns

bool —

setFormatCells()

setFormatCells(bool  $pValue) : \PhpOffice\PhpSpreadsheet\Worksheet\Protection

Set FormatCells.

Parameters

bool $pValue

Returns

\PhpOffice\PhpSpreadsheet\Worksheet\Protection —

getFormatColumns()

getFormatColumns() : bool

Get FormatColumns.

Returns

bool —

setFormatColumns()

setFormatColumns(bool  $pValue) : \PhpOffice\PhpSpreadsheet\Worksheet\Protection

Set FormatColumns.

Parameters

bool $pValue

Returns

\PhpOffice\PhpSpreadsheet\Worksheet\Protection —

getFormatRows()

getFormatRows() : bool

Get FormatRows.

Returns

bool —

setFormatRows()

setFormatRows(bool  $pValue) : \PhpOffice\PhpSpreadsheet\Worksheet\Protection

Set FormatRows.

Parameters

bool $pValue

Returns

\PhpOffice\PhpSpreadsheet\Worksheet\Protection —

getInsertColumns()

getInsertColumns() : bool

Get InsertColumns.

Returns

bool —

setInsertColumns()

setInsertColumns(bool  $pValue) : \PhpOffice\PhpSpreadsheet\Worksheet\Protection

Set InsertColumns.

Parameters

bool $pValue

Returns

\PhpOffice\PhpSpreadsheet\Worksheet\Protection —

getInsertRows()

getInsertRows() : bool

Get InsertRows.

Returns

bool —

setInsertRows()

setInsertRows(bool  $pValue) : \PhpOffice\PhpSpreadsheet\Worksheet\Protection

Set InsertRows.

Parameters

bool $pValue

Returns

\PhpOffice\PhpSpreadsheet\Worksheet\Protection —

getInsertHyperlinks()

getInsertHyperlinks() : bool

Get InsertHyperlinks.

Returns

bool —

setInsertHyperlinks()

setInsertHyperlinks(bool  $pValue) : \PhpOffice\PhpSpreadsheet\Worksheet\Protection

Set InsertHyperlinks.

Parameters

bool $pValue

Returns

\PhpOffice\PhpSpreadsheet\Worksheet\Protection —

getDeleteColumns()

getDeleteColumns() : bool

Get DeleteColumns.

Returns

bool —

setDeleteColumns()

setDeleteColumns(bool  $pValue) : \PhpOffice\PhpSpreadsheet\Worksheet\Protection

Set DeleteColumns.

Parameters

bool $pValue

Returns

\PhpOffice\PhpSpreadsheet\Worksheet\Protection —

getDeleteRows()

getDeleteRows() : bool

Get DeleteRows.

Returns

bool —

setDeleteRows()

setDeleteRows(bool  $pValue) : \PhpOffice\PhpSpreadsheet\Worksheet\Protection

Set DeleteRows.

Parameters

bool $pValue

Returns

\PhpOffice\PhpSpreadsheet\Worksheet\Protection —

getSelectLockedCells()

getSelectLockedCells() : bool

Get SelectLockedCells.

Returns

bool —

setSelectLockedCells()

setSelectLockedCells(bool  $pValue) : \PhpOffice\PhpSpreadsheet\Worksheet\Protection

Set SelectLockedCells.

Parameters

bool $pValue

Returns

\PhpOffice\PhpSpreadsheet\Worksheet\Protection —

getSort()

getSort() : bool

Get Sort.

Returns

bool —

setSort()

setSort(bool  $pValue) : \PhpOffice\PhpSpreadsheet\Worksheet\Protection

Set Sort.

Parameters

bool $pValue

Returns

\PhpOffice\PhpSpreadsheet\Worksheet\Protection —

getAutoFilter()

getAutoFilter() : bool

Get AutoFilter.

Returns

bool —

setAutoFilter()

setAutoFilter(bool  $pValue) : \PhpOffice\PhpSpreadsheet\Worksheet\Protection

Set AutoFilter.

Parameters

bool $pValue

Returns

\PhpOffice\PhpSpreadsheet\Worksheet\Protection —

getPivotTables()

getPivotTables() : bool

Get PivotTables.

Returns

bool —

setPivotTables()

setPivotTables(bool  $pValue) : \PhpOffice\PhpSpreadsheet\Worksheet\Protection

Set PivotTables.

Parameters

bool $pValue

Returns

\PhpOffice\PhpSpreadsheet\Worksheet\Protection —

getSelectUnlockedCells()

getSelectUnlockedCells() : bool

Get SelectUnlockedCells.

Returns

bool —

setSelectUnlockedCells()

setSelectUnlockedCells(bool  $pValue) : \PhpOffice\PhpSpreadsheet\Worksheet\Protection

Set SelectUnlockedCells.

Parameters

bool $pValue

Returns

\PhpOffice\PhpSpreadsheet\Worksheet\Protection —

getPassword()

getPassword() : string

Get Password (hashed).

Returns

string —

setPassword()

setPassword(string  $pValue, bool  $pAlreadyHashed = false) : \PhpOffice\PhpSpreadsheet\Worksheet\Protection

Set Password.

Parameters

string $pValue
bool $pAlreadyHashed

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

Returns

\PhpOffice\PhpSpreadsheet\Worksheet\Protection —

__clone()

__clone() : mixed

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

Returns

mixed —