Documentation

Protection extends Supervisor
in package

Table of Contents

Constants

PROTECTION_INHERIT  = 'inherit'
Protection styles
PROTECTION_PROTECTED  = 'protected'
PROTECTION_UNPROTECTED  = 'unprotected'

Properties

$hidden  : string|null
Hidden.
$isSupervisor  : bool
Supervisor?
$locked  : string|null
Locked.
$parent  : Spreadsheet|Supervisor
Parent. Only used for supervisor.
$parentPropertyName  : string|null
Parent property name.

Methods

__clone()  : mixed
Implement PHP __clone to create a deep clone, not just a shallow copy.
__construct()  : mixed
Create a new Protection.
applyFromArray()  : $this
Apply styles from array.
bindParent()  : $this
Bind parent. Only used for supervisor.
exportArray()  : array<string|int, mixed>
Export style as array.
getActiveCell()  : string
Get the currently active cell coordinate in currently active sheet.
getActiveSheet()  : Worksheet
Get the currently active sheet. Only used for supervisor.
getHashCode()  : string
Get hash code.
getHidden()  : string|null
Get hidden.
getIsSupervisor()  : bool
Is this a supervisor or a cell style component?
getLocked()  : string|null
Get locked.
getSelectedCells()  : string
Get the currently active cell coordinate in currently active sheet.
getSharedComponent()  : self
Get the shared style component for the currently active cell in currently active sheet.
getStyleArray()  : array<string|int, mixed>
Build style array from subcomponents.
setHidden()  : $this
Set hidden.
setLocked()  : $this
Set locked.
exportArray1()  : array<string|int, mixed>
Abstract method to be implemented in anything which extends this class.
exportArray2()  : void
Populate array from exportArray1.

Constants

PROTECTION_INHERIT

Protection styles

public mixed PROTECTION_INHERIT = 'inherit'

PROTECTION_PROTECTED

public mixed PROTECTION_PROTECTED = 'protected'

PROTECTION_UNPROTECTED

public mixed PROTECTION_UNPROTECTED = 'unprotected'

Properties

$hidden

Hidden.

protected string|null $hidden = null

$isSupervisor

Supervisor?

protected bool $isSupervisor

$locked

Locked.

protected string|null $locked = null

$parentPropertyName

Parent property name.

protected string|null $parentPropertyName = null

Methods

__clone()

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

public __clone() : mixed

__construct()

Create a new Protection.

public __construct([bool $isSupervisor = false ][, bool $isConditional = false ]) : mixed
Parameters
$isSupervisor : bool = false

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

$isConditional : bool = false

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

applyFromArray()

Apply styles from array.

public applyFromArray(array<string|int, mixed> $styleArray) : $this
$spreadsheet->getActiveSheet()->getStyle('B2')->getLocked()->applyFromArray( [ 'locked' => TRUE, 'hidden' => FALSE ] );
Parameters
$styleArray : array<string|int, mixed>

Array containing style information

Return values
$this

bindParent()

Bind parent. Only used for supervisor.

public bindParent(Spreadsheet|self $parent[, string|null $parentPropertyName = null ]) : $this
Parameters
$parent : Spreadsheet|self
$parentPropertyName : string|null = null
Return values
$this

exportArray()

Export style as array.

public final exportArray() : array<string|int, mixed>

Available to anything which extends this class: Alignment, Border, Borders, Color, Fill, Font, NumberFormat, Protection, and Style.

Return values
array<string|int, mixed>

getActiveCell()

Get the currently active cell coordinate in currently active sheet.

public getActiveCell() : string

Only used for supervisor.

Return values
string —

E.g. 'A1'

getHashCode()

Get hash code.

public getHashCode() : string
Return values
string —

Hash code

getHidden()

Get hidden.

public getHidden() : string|null
Return values
string|null

getIsSupervisor()

Is this a supervisor or a cell style component?

public getIsSupervisor() : bool
Return values
bool

getLocked()

Get locked.

public getLocked() : string|null
Return values
string|null

getSelectedCells()

Get the currently active cell coordinate in currently active sheet.

public getSelectedCells() : string

Only used for supervisor.

Return values
string —

E.g. 'A1'

getSharedComponent()

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

public getSharedComponent() : self

Only used for style supervisor.

Return values
self

getStyleArray()

Build style array from subcomponents.

public getStyleArray(array<string|int, mixed> $array) : array<string|int, mixed>
Parameters
$array : array<string|int, mixed>
Return values
array<string|int, mixed>

setHidden()

Set hidden.

public setHidden(string $hiddenType) : $this
Parameters
$hiddenType : string

see self::PROTECTION_*

Return values
$this

setLocked()

Set locked.

public setLocked(string $lockType) : $this
Parameters
$lockType : string

see self::PROTECTION_*

Return values
$this

exportArray1()

Abstract method to be implemented in anything which extends this class.

protected exportArray1() : array<string|int, mixed>

This method invokes exportArray2 with the names and values of all properties to be included in output array, returning that array to exportArray, then to caller.

Return values
array<string|int, mixed>

exportArray2()

Populate array from exportArray1.

protected final exportArray2(array<string|int, mixed> &$exportedArray, string $index, mixed $objOrValue) : void

This method is available to anything which extends this class. The parameter index is the key to be added to the array. The parameter objOrValue is either a primitive type, which is the value added to the array, or a Style object to be recursively added via exportArray.

Parameters
$exportedArray : array<string|int, mixed>
$index : string
$objOrValue : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results