Constants

UNDERLINE_NONE

UNDERLINE_NONE = 'none'

UNDERLINE_DOUBLE

UNDERLINE_DOUBLE = 'double'

UNDERLINE_DOUBLEACCOUNTING

UNDERLINE_DOUBLEACCOUNTING = 'doubleAccounting'

UNDERLINE_SINGLE

UNDERLINE_SINGLE = 'single'

UNDERLINE_SINGLEACCOUNTING

UNDERLINE_SINGLEACCOUNTING = 'singleAccounting'

Properties

$colorIndex

$colorIndex : integer

Type

integer

$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

$name

$name : string

Font Name.

Type

string

$size

$size : float

Font Size.

Type

float

$bold

$bold : boolean

Bold.

Type

boolean

$italic

$italic : boolean

Italic.

Type

boolean

$superscript

$superscript : boolean

Superscript.

Type

boolean

$subscript

$subscript : boolean

Subscript.

Type

boolean

$underline

$underline : string

Underline.

Type

string

$strikethrough

$strikethrough : boolean

Strikethrough.

Type

boolean

Methods

__construct()

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

Create a new Font.

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.

exportArray()

exportArray() 

Export style as array.

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

getSharedComponent()

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

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

Only used for style supervisor.

Returns

\PhpOffice\PhpSpreadsheet\Style\Font

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')->getFont()->applyFromArray( [ 'name' => 'Arial', 'bold' => TRUE, 'italic' => FALSE, 'underline' => \PhpOffice\PhpSpreadsheet\Style\Font::UNDERLINE_DOUBLE, 'strikethrough' => FALSE, 'color' => [ 'rgb' => '808080' ] ] );

Parameters

array $pStyles

Array containing style information

Returns

$this

getName()

getName() : string

Get Name.

Returns

string

setName()

setName(string  $pValue) : $this

Set Name.

Parameters

string $pValue

Returns

$this

getSize()

getSize() : float

Get Size.

Returns

float

setSize()

setSize(float  $pValue) : $this

Set Size.

Parameters

float $pValue

Returns

$this

getBold()

getBold() : boolean

Get Bold.

Returns

boolean

setBold()

setBold(boolean  $pValue) : $this

Set Bold.

Parameters

boolean $pValue

Returns

$this

getItalic()

getItalic() : boolean

Get Italic.

Returns

boolean

setItalic()

setItalic(boolean  $pValue) : $this

Set Italic.

Parameters

boolean $pValue

Returns

$this

getSuperscript()

getSuperscript() : boolean

Get Superscript.

Returns

boolean

setSuperscript()

setSuperscript(\PhpOffice\PhpSpreadsheet\Style\bool  $pValue) : $this

Set Superscript.

Parameters

\PhpOffice\PhpSpreadsheet\Style\bool $pValue

Returns

$this

getSubscript()

getSubscript() : boolean

Get Subscript.

Returns

boolean

setSubscript()

setSubscript(\PhpOffice\PhpSpreadsheet\Style\bool  $pValue) : $this

Set Subscript.

Parameters

\PhpOffice\PhpSpreadsheet\Style\bool $pValue

Returns

$this

getUnderline()

getUnderline() : string

Get Underline.

Returns

string

setUnderline()

setUnderline(boolean|string  $pValue) : $this

Set Underline.

Parameters

boolean|string $pValue

\PhpOffice\PhpSpreadsheet\Style\Font underline type If a boolean is passed, then TRUE equates to UNDERLINE_SINGLE, false equates to UNDERLINE_NONE

Returns

$this

getStrikethrough()

getStrikethrough() : boolean

Get Strikethrough.

Returns

boolean

setStrikethrough()

setStrikethrough(boolean  $pValue) : $this

Set Strikethrough.

Parameters

boolean $pValue

Returns

$this

getHashCode()

getHashCode() : string

Get hash code.

Returns

string —

Hash code

exportArray1()

exportArray1() 

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

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.

exportArray2()

exportArray2(array  $exportedArray, \PhpOffice\PhpSpreadsheet\Style\string  $index, mixed  $objOrValue) 

Populate array from exportArray1.

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

array $exportedArray
\PhpOffice\PhpSpreadsheet\Style\string $index
mixed $objOrValue