Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 3.9.x will end* 10 May 2021 (12 months).
  • Bug fixes for security issues in 3.9.x will end* 8 May 2023 (36 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.
<?php

namespace PhpOffice\PhpSpreadsheet\Style;

< use PhpOffice\PhpSpreadsheet\Exception as PhpSpreadsheetException; <
class Font extends Supervisor { // Underline types const UNDERLINE_NONE = 'none'; const UNDERLINE_DOUBLE = 'double'; const UNDERLINE_DOUBLEACCOUNTING = 'doubleAccounting'; const UNDERLINE_SINGLE = 'single'; const UNDERLINE_SINGLEACCOUNTING = 'singleAccounting'; /** * Font Name. *
< * @var string
> * @var null|string
*/ protected $name = 'Calibri'; /** * Font Size. *
< * @var float
> * @var null|float
*/ protected $size = 11; /** * Bold. *
< * @var bool
> * @var null|bool
*/ protected $bold = false; /** * Italic. *
< * @var bool
> * @var null|bool
*/ protected $italic = false; /** * Superscript. *
< * @var bool
> * @var null|bool
*/ protected $superscript = false; /** * Subscript. *
< * @var bool
> * @var null|bool
*/ protected $subscript = false; /** * Underline. *
< * @var string
> * @var null|string
*/ protected $underline = self::UNDERLINE_NONE; /** * Strikethrough. *
< * @var bool
> * @var null|bool
*/ protected $strikethrough = false; /** * Foreground color. * * @var Color */ protected $color; /**
< * @var int
> * @var null|int
*/ public $colorIndex; /** * Create a new Font. * * @param bool $isSupervisor Flag indicating if this is a supervisor or not * Leave this value at default unless you understand exactly what * its ramifications are * @param 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 */ public function __construct($isSupervisor = false, $isConditional = false) { // Supervisor? parent::__construct($isSupervisor); // Initialise values if ($isConditional) { $this->name = null; $this->size = null; $this->bold = null; $this->italic = null; $this->superscript = null; $this->subscript = null; $this->underline = null; $this->strikethrough = null; $this->color = new Color(Color::COLOR_BLACK, $isSupervisor, $isConditional); } else { $this->color = new Color(Color::COLOR_BLACK, $isSupervisor); } // bind parent if we are a supervisor if ($isSupervisor) { $this->color->bindParent($this, 'color'); } } /** * Get the shared style component for the currently active cell in currently active sheet. * Only used for style supervisor. * * @return Font */ public function getSharedComponent() {
< return $this->parent->getSharedComponent()->getFont();
> /** @var Style */ > $parent = $this->parent; > > return $parent->getSharedComponent()->getFont();
} /** * Build style array from subcomponents. * * @param array $array * * @return array */ public function getStyleArray($array) { return ['font' => $array]; } /** * 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 $pStyles Array containing style information
> * @param array $styleArray Array containing style information
*
< * @throws PhpSpreadsheetException < * < * @return Font
> * @return $this
*/
< public function applyFromArray(array $pStyles)
> public function applyFromArray(array $styleArray)
{ if ($this->isSupervisor) {
< $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($this->getStyleArray($pStyles));
> $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($this->getStyleArray($styleArray));
} else {
< if (isset($pStyles['name'])) { < $this->setName($pStyles['name']);
> if (isset($styleArray['name'])) { > $this->setName($styleArray['name']);
}
< if (isset($pStyles['bold'])) { < $this->setBold($pStyles['bold']);
> if (isset($styleArray['bold'])) { > $this->setBold($styleArray['bold']);
}
< if (isset($pStyles['italic'])) { < $this->setItalic($pStyles['italic']);
> if (isset($styleArray['italic'])) { > $this->setItalic($styleArray['italic']);
}
< if (isset($pStyles['superscript'])) { < $this->setSuperscript($pStyles['superscript']);
> if (isset($styleArray['superscript'])) { > $this->setSuperscript($styleArray['superscript']);
}
< if (isset($pStyles['subscript'])) { < $this->setSubscript($pStyles['subscript']);
> if (isset($styleArray['subscript'])) { > $this->setSubscript($styleArray['subscript']);
}
< if (isset($pStyles['underline'])) { < $this->setUnderline($pStyles['underline']);
> if (isset($styleArray['underline'])) { > $this->setUnderline($styleArray['underline']);
}
< if (isset($pStyles['strikethrough'])) { < $this->setStrikethrough($pStyles['strikethrough']);
> if (isset($styleArray['strikethrough'])) { > $this->setStrikethrough($styleArray['strikethrough']);
}
< if (isset($pStyles['color'])) { < $this->getColor()->applyFromArray($pStyles['color']);
> if (isset($styleArray['color'])) { > $this->getColor()->applyFromArray($styleArray['color']);
}
< if (isset($pStyles['size'])) { < $this->setSize($pStyles['size']);
> if (isset($styleArray['size'])) { > $this->setSize($styleArray['size']);
} } return $this; } /** * Get Name. *
< * @return string
> * @return null|string
*/ public function getName() { if ($this->isSupervisor) { return $this->getSharedComponent()->getName(); } return $this->name; } /** * Set Name. *
< * @param string $pValue
> * @param string $fontname
*
< * @return Font
> * @return $this
*/
< public function setName($pValue)
> public function setName($fontname)
{
< if ($pValue == '') { < $pValue = 'Calibri';
> if ($fontname == '') { > $fontname = 'Calibri';
} if ($this->isSupervisor) {
< $styleArray = $this->getStyleArray(['name' => $pValue]);
> $styleArray = $this->getStyleArray(['name' => $fontname]);
$this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray); } else {
< $this->name = $pValue;
> $this->name = $fontname;
} return $this; } /** * Get Size. *
< * @return float
> * @return null|float
*/ public function getSize() { if ($this->isSupervisor) { return $this->getSharedComponent()->getSize(); } return $this->size; } /** * Set Size. *
< * @param float $pValue
> * @param mixed $sizeInPoints A float representing the value of a positive measurement in points (1/72 of an inch)
*
< * @return Font
> * @return $this
*/
< public function setSize($pValue)
> public function setSize($sizeInPoints)
{
< if ($pValue == '') { < $pValue = 10;
> if (is_string($sizeInPoints) || is_int($sizeInPoints)) { > $sizeInPoints = (float) $sizeInPoints; // $pValue = 0 if given string is not numeric > } > > // Size must be a positive floating point number > // ECMA-376-1:2016, part 1, chapter 18.4.11 sz (Font Size), p. 1536 > if (!is_float($sizeInPoints) || !($sizeInPoints > 0)) { > $sizeInPoints = 10.0;
}
>
if ($this->isSupervisor) {
< $styleArray = $this->getStyleArray(['size' => $pValue]);
> $styleArray = $this->getStyleArray(['size' => $sizeInPoints]);
$this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray); } else {
< $this->size = $pValue;
> $this->size = $sizeInPoints;
} return $this; } /** * Get Bold. *
< * @return bool
> * @return null|bool
*/ public function getBold() { if ($this->isSupervisor) { return $this->getSharedComponent()->getBold(); } return $this->bold; } /** * Set Bold. *
< * @param bool $pValue
> * @param bool $bold
*
< * @return Font
> * @return $this
*/
< public function setBold($pValue)
> public function setBold($bold)
{
< if ($pValue == '') { < $pValue = false;
> if ($bold == '') { > $bold = false;
} if ($this->isSupervisor) {
< $styleArray = $this->getStyleArray(['bold' => $pValue]);
> $styleArray = $this->getStyleArray(['bold' => $bold]);
$this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray); } else {
< $this->bold = $pValue;
> $this->bold = $bold;
} return $this; } /** * Get Italic. *
< * @return bool
> * @return null|bool
*/ public function getItalic() { if ($this->isSupervisor) { return $this->getSharedComponent()->getItalic(); } return $this->italic; } /** * Set Italic. *
< * @param bool $pValue
> * @param bool $italic
*
< * @return Font
> * @return $this
*/
< public function setItalic($pValue)
> public function setItalic($italic)
{
< if ($pValue == '') { < $pValue = false;
> if ($italic == '') { > $italic = false;
} if ($this->isSupervisor) {
< $styleArray = $this->getStyleArray(['italic' => $pValue]);
> $styleArray = $this->getStyleArray(['italic' => $italic]);
$this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray); } else {
< $this->italic = $pValue;
> $this->italic = $italic;
} return $this; } /** * Get Superscript. *
< * @return bool
> * @return null|bool
*/ public function getSuperscript() { if ($this->isSupervisor) { return $this->getSharedComponent()->getSuperscript(); } return $this->superscript; } /** * Set Superscript. *
< * @param bool $pValue < * < * @return Font
> * @return $this
*/
< public function setSuperscript($pValue)
> public function setSuperscript(bool $superscript)
{
< if ($pValue == '') { < $pValue = false; < }
if ($this->isSupervisor) {
< $styleArray = $this->getStyleArray(['superscript' => $pValue]);
> $styleArray = $this->getStyleArray(['superscript' => $superscript]);
$this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray); } else {
< $this->superscript = $pValue; < $this->subscript = !$pValue;
> $this->superscript = $superscript; > if ($this->superscript) { > $this->subscript = false; > }
} return $this; } /** * Get Subscript. *
< * @return bool
> * @return null|bool
*/ public function getSubscript() { if ($this->isSupervisor) { return $this->getSharedComponent()->getSubscript(); } return $this->subscript; } /** * Set Subscript. *
< * @param bool $pValue < * < * @return Font
> * @return $this
*/
< public function setSubscript($pValue)
> public function setSubscript(bool $subscript)
{
< if ($pValue == '') { < $pValue = false; < }
if ($this->isSupervisor) {
< $styleArray = $this->getStyleArray(['subscript' => $pValue]);
> $styleArray = $this->getStyleArray(['subscript' => $subscript]);
$this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray); } else {
< $this->subscript = $pValue; < $this->superscript = !$pValue;
> $this->subscript = $subscript; > if ($this->subscript) { > $this->superscript = false; > }
} return $this; } /** * Get Underline. *
< * @return string
> * @return null|string
*/ public function getUnderline() { if ($this->isSupervisor) { return $this->getSharedComponent()->getUnderline(); } return $this->underline; } /** * Set Underline. *
< * @param bool|string $pValue \PhpOffice\PhpSpreadsheet\Style\Font underline type
> * @param bool|string $underlineStyle \PhpOffice\PhpSpreadsheet\Style\Font underline type
* If a boolean is passed, then TRUE equates to UNDERLINE_SINGLE, * false equates to UNDERLINE_NONE *
< * @return Font
> * @return $this
*/
< public function setUnderline($pValue)
> public function setUnderline($underlineStyle)
{
< if (is_bool($pValue)) { < $pValue = ($pValue) ? self::UNDERLINE_SINGLE : self::UNDERLINE_NONE; < } elseif ($pValue == '') { < $pValue = self::UNDERLINE_NONE;
> if (is_bool($underlineStyle)) { > $underlineStyle = ($underlineStyle) ? self::UNDERLINE_SINGLE : self::UNDERLINE_NONE; > } elseif ($underlineStyle == '') { > $underlineStyle = self::UNDERLINE_NONE;
} if ($this->isSupervisor) {
< $styleArray = $this->getStyleArray(['underline' => $pValue]);
> $styleArray = $this->getStyleArray(['underline' => $underlineStyle]);
$this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray); } else {
< $this->underline = $pValue;
> $this->underline = $underlineStyle;
} return $this; } /** * Get Strikethrough. *
< * @return bool
> * @return null|bool
*/ public function getStrikethrough() { if ($this->isSupervisor) { return $this->getSharedComponent()->getStrikethrough(); } return $this->strikethrough; } /** * Set Strikethrough. *
< * @param bool $pValue
> * @param bool $strikethru
*
< * @return Font
> * @return $this
*/
< public function setStrikethrough($pValue)
> public function setStrikethrough($strikethru)
{
< if ($pValue == '') { < $pValue = false;
> if ($strikethru == '') { > $strikethru = false;
} if ($this->isSupervisor) {
< $styleArray = $this->getStyleArray(['strikethrough' => $pValue]);
> $styleArray = $this->getStyleArray(['strikethrough' => $strikethru]);
$this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray); } else {
< $this->strikethrough = $pValue;
> $this->strikethrough = $strikethru;
} return $this; } /** * Get Color. * * @return Color */ public function getColor() { return $this->color; } /** * Set Color. *
< * @param Color $pValue < * < * @throws PhpSpreadsheetException < * < * @return Font
> * @return $this
*/
< public function setColor(Color $pValue)
> public function setColor(Color $color)
{ // make sure parameter is a real color and not a supervisor
< $color = $pValue->getIsSupervisor() ? $pValue->getSharedComponent() : $pValue;
> $color = $color->getIsSupervisor() ? $color->getSharedComponent() : $color;
if ($this->isSupervisor) { $styleArray = $this->getColor()->getStyleArray(['argb' => $color->getARGB()]); $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray); } else { $this->color = $color; } return $this; } /** * Get hash code. * * @return string Hash code */ public function getHashCode() { if ($this->isSupervisor) { return $this->getSharedComponent()->getHashCode(); } return md5( $this->name . $this->size . ($this->bold ? 't' : 'f') . ($this->italic ? 't' : 'f') . ($this->superscript ? 't' : 'f') . ($this->subscript ? 't' : 'f') . $this->underline . ($this->strikethrough ? 't' : 'f') . $this->color->getHashCode() . __CLASS__ );
> } } > } > protected function exportArray1(): array > { > $exportedArray = []; > $this->exportArray2($exportedArray, 'bold', $this->getBold()); > $this->exportArray2($exportedArray, 'color', $this->getColor()); > $this->exportArray2($exportedArray, 'italic', $this->getItalic()); > $this->exportArray2($exportedArray, 'name', $this->getName()); > $this->exportArray2($exportedArray, 'size', $this->getSize()); > $this->exportArray2($exportedArray, 'strikethrough', $this->getStrikethrough()); > $this->exportArray2($exportedArray, 'subscript', $this->getSubscript()); > $this->exportArray2($exportedArray, 'superscript', $this->getSuperscript()); > $this->exportArray2($exportedArray, 'underline', $this->getUnderline()); > > return $exportedArray;