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

$font

$font : \PhpOffice\PhpSpreadsheet\Style\Font

Font.

Type

Font

$fill

$fill : \PhpOffice\PhpSpreadsheet\Style\Fill

Fill.

Type

Fill

$borders

$borders : \PhpOffice\PhpSpreadsheet\Style\Borders

Borders.

Type

Borders

$alignment

$alignment : \PhpOffice\PhpSpreadsheet\Style\Alignment

Alignment.

Type

Alignment

$numberFormat

$numberFormat : \PhpOffice\PhpSpreadsheet\Style\NumberFormat

Number Format.

Type

NumberFormat

$conditionalStyles

$conditionalStyles : \PhpOffice\PhpSpreadsheet\Style\Conditional[]

Conditional styles.

Type

Conditional[]

$protection

$protection : \PhpOffice\PhpSpreadsheet\Style\Protection

Protection.

Type

Protection

$index

$index : int

Index of style in collection. Only used for real style.

Type

int

$quotePrefix

$quotePrefix : bool

Use Quote Prefix when displaying in cell editor. Only used for real style.

Type

bool

Methods

__construct()

__construct(bool  $isSupervisor = false, bool  $isConditional = false) : mixed

Create a new Style.

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\Style

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

Only used for style supervisor.

Returns

\PhpOffice\PhpSpreadsheet\Style\Style —

getParent()

getParent() : \PhpOffice\PhpSpreadsheet\Spreadsheet

Get parent. Only used for style supervisor.

Returns

\PhpOffice\PhpSpreadsheet\Spreadsheet —

getStyleArray()

getStyleArray(array  $array) : array

Build style array from subcomponents.

Parameters

array $array

Returns

array —

applyFromArray()

applyFromArray(array  $pStyles, bool  $pAdvanced = true) : \PhpOffice\PhpSpreadsheet\Style\Style

Apply styles from array.

$spreadsheet->getActiveSheet()->getStyle('B2')->applyFromArray( [ 'font' => [ 'name' => 'Arial', 'bold' => true, 'italic' => false, 'underline' => Font::UNDERLINE_DOUBLE, 'strikethrough' => false, 'color' => [ 'rgb' => '808080' ] ], 'borders' => [ 'bottom' => [ 'borderStyle' => Border::BORDER_DASHDOT, 'color' => [ 'rgb' => '808080' ] ], 'top' => [ 'borderStyle' => Border::BORDER_DASHDOT, 'color' => [ 'rgb' => '808080' ] ] ], 'alignment' => [ 'horizontal' => Alignment::HORIZONTAL_CENTER, 'vertical' => Alignment::VERTICAL_CENTER, 'wrapText' => true, ], 'quotePrefix' => true ] );

Parameters

array $pStyles

Array containing style information

bool $pAdvanced

advanced mode for setting borders

Returns

\PhpOffice\PhpSpreadsheet\Style\Style —

getFill()

getFill() : \PhpOffice\PhpSpreadsheet\Style\Fill

Get Fill.

Returns

\PhpOffice\PhpSpreadsheet\Style\Fill —

getFont()

getFont() : \PhpOffice\PhpSpreadsheet\Style\Font

Get Font.

Returns

\PhpOffice\PhpSpreadsheet\Style\Font —

setFont()

setFont(\PhpOffice\PhpSpreadsheet\Style\Font  $font) : \PhpOffice\PhpSpreadsheet\Style\Style

Set font.

Parameters

\PhpOffice\PhpSpreadsheet\Style\Font $font

Returns

\PhpOffice\PhpSpreadsheet\Style\Style —

getBorders()

getBorders() : \PhpOffice\PhpSpreadsheet\Style\Borders

Get Borders.

Returns

\PhpOffice\PhpSpreadsheet\Style\Borders —

getAlignment()

getAlignment() : \PhpOffice\PhpSpreadsheet\Style\Alignment

Get Alignment.

Returns

\PhpOffice\PhpSpreadsheet\Style\Alignment —

getNumberFormat()

getNumberFormat() : \PhpOffice\PhpSpreadsheet\Style\NumberFormat

Get Number Format.

Returns

\PhpOffice\PhpSpreadsheet\Style\NumberFormat —

getConditionalStyles()

getConditionalStyles() : \PhpOffice\PhpSpreadsheet\Style\Conditional[]

Get Conditional Styles. Only used on supervisor.

Returns

\PhpOffice\PhpSpreadsheet\Style\Conditional[] —

setConditionalStyles()

setConditionalStyles(\PhpOffice\PhpSpreadsheet\Style\Conditional[]  $pValue) : \PhpOffice\PhpSpreadsheet\Style\Style

Set Conditional Styles. Only used on supervisor.

Parameters

\PhpOffice\PhpSpreadsheet\Style\Conditional[] $pValue

Array of conditional styles

Returns

\PhpOffice\PhpSpreadsheet\Style\Style —

getProtection()

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

Get Protection.

Returns

\PhpOffice\PhpSpreadsheet\Style\Protection —

getQuotePrefix()

getQuotePrefix() : bool

Get quote prefix.

Returns

bool —

setQuotePrefix()

setQuotePrefix(bool  $pValue) : \PhpOffice\PhpSpreadsheet\Style\Style

Set quote prefix.

Parameters

bool $pValue

Returns

\PhpOffice\PhpSpreadsheet\Style\Style —

getHashCode()

getHashCode() : string

Get hash code.

Returns

string —

Hash code

getIndex()

getIndex() : int

Get own index in style collection.

Returns

int —

setIndex()

setIndex(int  $pValue) : mixed

Set own index in style collection.

Parameters

int $pValue

Returns

mixed —