Constants

PROTECTION_INHERIT

PROTECTION_INHERIT = 'inherit'

Protection styles

PROTECTION_PROTECTED

PROTECTION_PROTECTED = 'protected'

PROTECTION_UNPROTECTED

PROTECTION_UNPROTECTED = 'unprotected'

Properties

$isSupervisor

$isSupervisor : bool

Supervisor?

Type

bool

$parent

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

Parent. Only used for supervisor.

Type

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(bool  $isSupervisor = false, bool  $isConditional = false) : mixed

Create a new Protection.

Parameters

bool $isSupervisor

Flag indicating if this is a supervisor or not Leave this value at default unless you understand exactly what its ramifications are

bool $isConditional

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

Returns

mixed —

bindParent()

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

Bind parent. Only used for supervisor.

Parameters

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

Returns

\PhpOffice\PhpSpreadsheet\Style\Supervisor —

getIsSupervisor()

getIsSupervisor() : bool

Is this a supervisor or a cell style component?

Returns

bool —

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() : mixed

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

Returns

mixed —

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) : \PhpOffice\PhpSpreadsheet\Style\Protection

Apply styles from array.

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

Parameters

array $pStyles

Array containing style information

Throws

\PhpOffice\PhpSpreadsheet\Exception

Returns

\PhpOffice\PhpSpreadsheet\Style\Protection —

getLocked()

getLocked() : string

Get locked.

Returns

string —

setLocked()

setLocked(string  $pValue) : \PhpOffice\PhpSpreadsheet\Style\Protection

Set locked.

Parameters

string $pValue

see self::PROTECTION_*

Returns

\PhpOffice\PhpSpreadsheet\Style\Protection —

getHidden()

getHidden() : string

Get hidden.

Returns

string —

setHidden()

setHidden(string  $pValue) : \PhpOffice\PhpSpreadsheet\Style\Protection

Set hidden.

Parameters

string $pValue

see self::PROTECTION_*

Returns

\PhpOffice\PhpSpreadsheet\Style\Protection —

getHashCode()

getHashCode() : string

Get hash code.

Returns

string —

Hash code