__construct()
bindParent()
getIsSupervisor()
getActiveSheet()
getSelectedCells()
getActiveCell()
__clone()
exportArray()
getSharedComponent()
getStyleArray()
applyFromArray()
getName()
setName()
getSize()
setSize()
getBold()
setBold()
getItalic()
setItalic()
getSuperscript()
setSuperscript()
getSubscript()
setSubscript()
getUnderline()
setUnderline()
getStrikethrough()
setStrikethrough()
getColor()
setColor()
getHashCode()

$colorIndex

UNDERLINE_NONE
UNDERLINE_DOUBLE
UNDERLINE_DOUBLEACCOUNTING
UNDERLINE_SINGLE
UNDERLINE_SINGLEACCOUNTING

exportArray1()
exportArray2()

$isSupervisor
$parent
$parentPropertyName
$name
$size
$bold
$italic
$superscript
$subscript
$underline
$strikethrough
$color

N/A

No private methods found

No private properties found

N/A

File: serve/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Style/Font.php
Package: Application
Class hierarchy: Supervisor

\PhpOffice\PhpSpreadsheet\Style\Font
Uses

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 : int

Type

int —

$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 —

$name

$name : string

Font Name.

Type

string —

$size

$size : float

Font Size.

Type

float —

$bold

$bold : bool

Bold.

Type

bool —

$italic

$italic : bool

Italic.

Type

bool —

$superscript

$superscript : bool

Superscript.

Type

bool —

$subscript

$subscript : bool

Subscript.

Type

bool —

$underline

$underline : string

Underline.

Type

string —

$strikethrough

$strikethrough : bool

Strikethrough.

Type

bool —

$color

$color : \PhpOffice\PhpSpreadsheet\Style\Color

Foreground color.

Type

Color —

Methods

__construct()

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

Create a new Font.

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) : $this

Bind parent. Only used for supervisor.

Parameters

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

Returns

$this —

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 —

exportArray()

exportArray() : array

Export style as array.

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

Returns

array —

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

Get Bold.

Returns

bool —

setBold()

setBold(bool  $pValue) : $this

Set Bold.

Parameters

bool

$pValue

Returns

$this —

getItalic()

getItalic() : bool

Get Italic.

Returns

bool —

setItalic()

setItalic(bool  $pValue) : $this

Set Italic.

Parameters

bool

$pValue

Returns

$this —

getSuperscript()

getSuperscript() : bool

Get Superscript.

Returns

bool —

setSuperscript()

setSuperscript(bool  $pValue) : $this

Set Superscript.

Parameters

bool

$pValue

Returns

$this —

getSubscript()

getSubscript() : bool

Get Subscript.

Returns

bool —

setSubscript()

setSubscript(bool  $pValue) : $this

Set Subscript.

Parameters

bool

$pValue

Returns

$this —

getUnderline()

getUnderline() : string

Get Underline.

Returns

string —

setUnderline()

setUnderline(bool|string  $pValue) : $this

Set Underline.

Parameters

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

Get Strikethrough.

Returns

bool —

setStrikethrough()

setStrikethrough(bool  $pValue) : $this

Set Strikethrough.

Parameters

bool

$pValue

Returns

$this —

getColor()

getColor() : \PhpOffice\PhpSpreadsheet\Style\Color

Get Color.

Returns

\PhpOffice\PhpSpreadsheet\Style\Color —

setColor()

setColor(\PhpOffice\PhpSpreadsheet\Style\Color  $pValue) : $this

Set Color.

Parameters

\PhpOffice\PhpSpreadsheet\Style\Color

$pValue

Returns

$this —

getHashCode()

getHashCode() : string

Get hash code.

Returns

string —

Hash code

exportArray1()

exportArray1() : array

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.

Returns

array —

exportArray2()

exportArray2(array  $exportedArray, string  $index, mixed  $objOrValue) : void

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
string	$index
mixed	$objOrValue