__construct()
bindParent()
getIsSupervisor()
getActiveSheet()
getSelectedCells()
getActiveCell()
__clone()
getSharedComponent()
getStyleArray()
applyFromArray()
getLocked()
setLocked()
getHidden()
setHidden()
getHashCode()

No public properties found

PROTECTION_INHERIT
PROTECTION_PROTECTED
PROTECTION_UNPROTECTED

No protected methods found

$isSupervisor
$parent
$parentPropertyName
$locked
$hidden

N/A

No private methods found

No private properties found

N/A

Constants

PROTECTION_INHERIT

PROTECTION_INHERIT = 'inherit'

Protection styles

PROTECTION_PROTECTED

PROTECTION_PROTECTED = 'protected'

PROTECTION_UNPROTECTED

PROTECTION_UNPROTECTED = 'unprotected'

Properties

$isSupervisor

$isSupervisor : boolean

Supervisor?

Type

boolean

$parent

$parent : \PhpOffice\PhpSpreadsheet\Spreadsheet|\PhpOffice\PhpSpreadsheet\Style\Style

Parent. Only used for supervisor.

Type

\PhpOffice\PhpSpreadsheet\Spreadsheet|\PhpOffice\PhpSpreadsheet\Style\Style

$parentPropertyName

$parentPropertyName : null|string

Parent property name.

Type

null|string

$locked

$locked : string

Locked.

Type

string

$hidden

$hidden : string

Hidden.

Type

string

Methods

__construct()

__construct(boolean  $isSupervisor = false, boolean  $isConditional = false)

Create a new Protection.

Parameters

boolean	$isSupervisor	Flag indicating if this is a supervisor or not Leave this value at default unless you understand exactly what its ramifications are
boolean	$isConditional	Flag indicating if this is a conditional style or not Leave this value at default unless you understand exactly what its ramifications are

bindParent()

bindParent(\PhpOffice\PhpSpreadsheet\Spreadsheet|\PhpOffice\PhpSpreadsheet\Style\Style  $parent, null|string  $parentPropertyName = null) : $this

Bind parent. Only used for supervisor.

Parameters

\PhpOffice\PhpSpreadsheet\Spreadsheet\|\PhpOffice\PhpSpreadsheet\Style\Style	$parent
null\|string	$parentPropertyName

Returns

$this

getIsSupervisor()

getIsSupervisor() : boolean

Is this a supervisor or a cell style component?

Returns

boolean

getActiveSheet()

getActiveSheet() : \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet

Get the currently active sheet. Only used for supervisor.

Returns

\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet

getSelectedCells()

getSelectedCells() : string

Get the currently active cell coordinate in currently active sheet.

Only used for supervisor.

Returns

string —

E.g. 'A1'

getActiveCell()

getActiveCell() : string

Get the currently active cell coordinate in currently active sheet.

Only used for supervisor.

Returns

string —

E.g. 'A1'

__clone()

__clone()

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

getSharedComponent()

getSharedComponent() : \PhpOffice\PhpSpreadsheet\Style\Protection

Get the shared style component for the currently active cell in currently active sheet.

Only used for style supervisor.

Returns

\PhpOffice\PhpSpreadsheet\Style\Protection

getStyleArray()

getStyleArray(array  $array) : array

Build style array from subcomponents.

Parameters

array

$array

Returns

array

applyFromArray()

applyFromArray(array  $pStyles) : $this

Apply styles from array.

$spreadsheet->getActiveSheet()->getStyle('B2')->getLocked()->applyFromArray( [ 'locked' => TRUE, 'hidden' => FALSE ] );

Parameters

array

$pStyles

Array containing style information

Returns

$this

getLocked()

getLocked() : string

Get locked.

Returns

string

setLocked()

setLocked(string  $pValue) : $this

Set locked.

Parameters

string

$pValue

see self::PROTECTION_*

Returns

$this

getHidden()

getHidden() : string

Get hidden.

Returns

string

setHidden()

setHidden(string  $pValue) : $this

Set hidden.

Parameters

string

$pValue

see self::PROTECTION_*

Returns

$this

getHashCode()

getHashCode() : string

Get hash code.

Returns

string —

Hash code