Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.11.x will end 14 Nov 2022 (12 months plus 6 months extension).
  • Bug fixes for security issues in 3.11.x will end 13 Nov 2023 (18 months plus 12 months extension).
  • PHP version: minimum PHP 7.3.0 Note: minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is supported too.
<?php

namespace Box\Spout\Common\Entity\Style;

/**
 * Class Style
 * Represents a style to be applied to a cell
 */
class Style
{
< /** Default font values */
> /** Default values */
const DEFAULT_FONT_SIZE = 11; const DEFAULT_FONT_COLOR = Color::BLACK; const DEFAULT_FONT_NAME = 'Arial'; /** @var int|null Style ID */ private $id; /** @var bool Whether the font should be bold */ private $fontBold = false; /** @var bool Whether the bold property was set */ private $hasSetFontBold = false; /** @var bool Whether the font should be italic */ private $fontItalic = false; /** @var bool Whether the italic property was set */ private $hasSetFontItalic = false; /** @var bool Whether the font should be underlined */ private $fontUnderline = false; /** @var bool Whether the underline property was set */ private $hasSetFontUnderline = false; /** @var bool Whether the font should be struck through */ private $fontStrikethrough = false; /** @var bool Whether the strikethrough property was set */ private $hasSetFontStrikethrough = false; /** @var int Font size */ private $fontSize = self::DEFAULT_FONT_SIZE; /** @var bool Whether the font size property was set */ private $hasSetFontSize = false; /** @var string Font color */ private $fontColor = self::DEFAULT_FONT_COLOR; /** @var bool Whether the font color property was set */ private $hasSetFontColor = false; /** @var string Font name */ private $fontName = self::DEFAULT_FONT_NAME; /** @var bool Whether the font name property was set */ private $hasSetFontName = false; /** @var bool Whether specific font properties should be applied */ private $shouldApplyFont = false;
> /** @var bool Whether specific cell alignment should be applied */ /** @var bool Whether the text should wrap in the cell (useful for long or multi-lines text) */ > private $shouldApplyCellAlignment = false; private $shouldWrapText = false; > /** @var string Cell alignment */ /** @var bool Whether the wrap text property was set */ > private $cellAlignment; private $hasSetWrapText = false; > /** @var bool Whether the cell alignment property was set */ > private $hasSetCellAlignment = false; /** @var Border */ >
private $border; /** @var bool Whether border properties should be applied */ private $shouldApplyBorder = false; /** @var string Background color */ private $backgroundColor; /** @var bool */ private $hasSetBackgroundColor = false;
> /** @var string Format */ /** > private $format; * @return int|null > */ > /** @var bool */ public function getId() > private $hasSetFormat = false; { > return $this->id; > /** @var bool */ } > private $isRegistered = false; > /** > /** @var bool */ * @param int $id > private $isEmpty = true; * @return Style >
*/ public function setId($id) { $this->id = $id; return $this; } /** * @return Border */ public function getBorder() { return $this->border; } /** * @param Border $border * @return Style */ public function setBorder(Border $border) { $this->shouldApplyBorder = true; $this->border = $border;
> $this->isEmpty = false;
return $this; } /** * @return bool */ public function shouldApplyBorder() { return $this->shouldApplyBorder; } /** * @return bool */ public function isFontBold() { return $this->fontBold; } /** * @return Style */ public function setFontBold() { $this->fontBold = true; $this->hasSetFontBold = true; $this->shouldApplyFont = true;
> $this->isEmpty = false;
return $this; } /** * @return bool */ public function hasSetFontBold() { return $this->hasSetFontBold; } /** * @return bool */ public function isFontItalic() { return $this->fontItalic; } /** * @return Style */ public function setFontItalic() { $this->fontItalic = true; $this->hasSetFontItalic = true; $this->shouldApplyFont = true;
> $this->isEmpty = false;
return $this; } /** * @return bool */ public function hasSetFontItalic() { return $this->hasSetFontItalic; } /** * @return bool */ public function isFontUnderline() { return $this->fontUnderline; } /** * @return Style */ public function setFontUnderline() { $this->fontUnderline = true; $this->hasSetFontUnderline = true; $this->shouldApplyFont = true;
> $this->isEmpty = false;
return $this; } /** * @return bool */ public function hasSetFontUnderline() { return $this->hasSetFontUnderline; } /** * @return bool */ public function isFontStrikethrough() { return $this->fontStrikethrough; } /** * @return Style */ public function setFontStrikethrough() { $this->fontStrikethrough = true; $this->hasSetFontStrikethrough = true; $this->shouldApplyFont = true;
> $this->isEmpty = false;
return $this; } /** * @return bool */ public function hasSetFontStrikethrough() { return $this->hasSetFontStrikethrough; } /** * @return int */ public function getFontSize() { return $this->fontSize; } /** * @param int $fontSize Font size, in pixels * @return Style */ public function setFontSize($fontSize) { $this->fontSize = $fontSize; $this->hasSetFontSize = true; $this->shouldApplyFont = true;
> $this->isEmpty = false;
return $this; } /** * @return bool */ public function hasSetFontSize() { return $this->hasSetFontSize; } /** * @return string */ public function getFontColor() { return $this->fontColor; } /** * Sets the font color. * * @param string $fontColor ARGB color (@see Color) * @return Style */ public function setFontColor($fontColor) { $this->fontColor = $fontColor; $this->hasSetFontColor = true; $this->shouldApplyFont = true;
> $this->isEmpty = false;
return $this; } /** * @return bool */ public function hasSetFontColor() { return $this->hasSetFontColor; } /** * @return string */ public function getFontName() { return $this->fontName; } /** * @param string $fontName Name of the font to use * @return Style */ public function setFontName($fontName) { $this->fontName = $fontName; $this->hasSetFontName = true; $this->shouldApplyFont = true;
> $this->isEmpty = false;
return $this; } /** * @return bool */ public function hasSetFontName() { return $this->hasSetFontName; } /**
> * @return string * @return bool > */ */ > public function getCellAlignment() public function shouldWrapText() > { { > return $this->cellAlignment; return $this->shouldWrapText; > } } > > /** /** > * @param string $cellAlignment The cell alignment * @param bool $shouldWrap Should the text be wrapped > * * @return Style > * @return Style */ > */ public function setShouldWrapText($shouldWrap = true) > public function setCellAlignment($cellAlignment) { > { $this->shouldWrapText = $shouldWrap; > $this->cellAlignment = $cellAlignment; $this->hasSetWrapText = true; > $this->hasSetCellAlignment = true; > $this->shouldApplyCellAlignment = true; return $this; > $this->isEmpty = false; } > > return $this; /** > } * @return bool > */ > /** public function hasSetWrapText() > * @return bool { > */ return $this->hasSetWrapText; > public function hasSetCellAlignment() } > { > return $this->hasSetCellAlignment; /** > } * @return bool Whether specific font properties should be applied > */ > /** public function shouldApplyFont() > * @return bool Whether specific cell alignment should be applied { > */ return $this->shouldApplyFont; > public function shouldApplyCellAlignment() } > { > return $this->shouldApplyCellAlignment; /** > } * Sets the background color > * @param string $color ARGB color (@see Color) > /**
* @return Style
> $this->isEmpty = false;
*/ public function setBackgroundColor($color) { $this->hasSetBackgroundColor = true; $this->backgroundColor = $color;
> $this->isEmpty = false;
return $this; } /** * @return string */ public function getBackgroundColor() { return $this->backgroundColor; } /** * @return bool Whether the background color should be applied */ public function shouldApplyBackgroundColor() { return $this->hasSetBackgroundColor;
> } } > } > /** > * Sets format > * @param string $format > * @return Style > */ > public function setFormat($format) > { > $this->hasSetFormat = true; > $this->format = $format; > $this->isEmpty = false; > > return $this; > } > > /** > * @return string > */ > public function getFormat() > { > return $this->format; > } > > /** > * @return bool Whether format should be applied > */ > public function shouldApplyFormat() > { > return $this->hasSetFormat; > } > > /** > * @return bool > */ > public function isRegistered() : bool > { > return $this->isRegistered; > } > > public function markAsRegistered(?int $id) : void > { > $this->setId($id); > $this->isRegistered = true; > } > > public function unmarkAsRegistered() : void > { > $this->setId(0); > $this->isRegistered = false; > } > > public function isEmpty() : bool > { > return $this->isEmpty;