Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.

Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401] [Versions 400 and 401] [Versions 401 and 403]

(no description)

File Size: 815 lines (22 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class


Class: Font  - X-Ref

__construct($isSupervisor = false, $isConditional = false)   X-Ref
Create a new Font.

param: bool $isSupervisor Flag indicating if this is a supervisor or not
param: bool $isConditional Flag indicating if this is a conditional style or not

getSharedComponent()   X-Ref
Get the shared style component for the currently active cell in currently active sheet.
Only used for style supervisor.

return: Font

getStyleArray($array)   X-Ref
Build style array from subcomponents.

param: array $array
return: array

applyFromArray(array $styleArray)   X-Ref
Apply styles from array.

<code>
$spreadsheet->getActiveSheet()->getStyle('B2')->getFont()->applyFromArray(
[
'name' => 'Arial',
'bold' => TRUE,
'italic' => FALSE,
'underline' => \PhpOffice\PhpSpreadsheet\Style\Font::UNDERLINE_DOUBLE,
'strikethrough' => FALSE,
'color' => [
'rgb' => '808080'
]
]
);
</code>

param: array $styleArray Array containing style information
return: $this

getName()   X-Ref
Get Name.

return: null|string

getLatin()   X-Ref
No description

getEastAsian()   X-Ref
No description

getComplexScript()   X-Ref
No description

setName($fontname)   X-Ref
Set Name.

param: string $fontname
return: $this

setLatin(string $fontname)   X-Ref
No description

setEastAsian(string $fontname)   X-Ref
No description

setComplexScript(string $fontname)   X-Ref
No description

getSize()   X-Ref
Get Size.

return: null|float

setSize($sizeInPoints, bool $nullOk = false)   X-Ref
Set Size.

param: mixed $sizeInPoints A float representing the value of a positive measurement in points (1/72 of an inch)
return: $this

getBold()   X-Ref
Get Bold.

return: null|bool

setBold($bold)   X-Ref
Set Bold.

param: bool $bold
return: $this

getItalic()   X-Ref
Get Italic.

return: null|bool

setItalic($italic)   X-Ref
Set Italic.

param: bool $italic
return: $this

getSuperscript()   X-Ref
Get Superscript.

return: null|bool

setSuperscript(bool $superscript)   X-Ref
Set Superscript.

return: $this

getSubscript()   X-Ref
Get Subscript.

return: null|bool

setSubscript(bool $subscript)   X-Ref
Set Subscript.

return: $this

getBaseLine()   X-Ref
No description

setBaseLine(int $baseLine)   X-Ref
No description

getStrikeType()   X-Ref
No description

setStrikeType(string $strikeType)   X-Ref
No description

getUnderlineColor()   X-Ref
No description

setUnderlineColor(array $colorArray)   X-Ref
No description

getChartColor()   X-Ref
No description

setChartColor(array $colorArray)   X-Ref
No description

getUnderline()   X-Ref
Get Underline.

return: null|string

setUnderline($underlineStyle)   X-Ref
Set Underline.

param: bool|string $underlineStyle \PhpOffice\PhpSpreadsheet\Style\Font underline type
return: $this

getStrikethrough()   X-Ref
Get Strikethrough.

return: null|bool

setStrikethrough($strikethru)   X-Ref
Set Strikethrough.

param: bool $strikethru
return: $this

getColor()   X-Ref
Get Color.

return: Color

setColor(Color $color)   X-Ref
Set Color.

return: $this

hashChartColor(?ChartColor $underlineColor)   X-Ref
No description

getHashCode()   X-Ref
Get hash code.

return: string Hash code

exportArray1()   X-Ref
No description