Inheritance diagram for PhpOffice\PhpSpreadsheet\Style\Font:

Collaboration diagram for PhpOffice\PhpSpreadsheet\Style\Font:

Public Member Functions
	__construct ($isSupervisor=false, $isConditional=false)
	Create a new Font. More...

	getSharedComponent ()
	Get the shared style component for the currently active cell in currently active sheet. More...

	getStyleArray ($array)
	Build style array from subcomponents. More...

	applyFromArray (array $pStyles)
	Apply styles from array. More...

	getName ()
	Get Name. More...

	setName ($fontname)
	Set Name. More...

	getSize ()
	Get Size. More...

	setSize ($sizeInPoints)
	Set Size. More...

	getBold ()
	Get Bold. More...

	setBold ($pValue)
	Set Bold. More...

	getItalic ()
	Get Italic. More...

	setItalic ($pValue)
	Set Italic. More...

	getSuperscript ()
	Get Superscript. More...

	setSuperscript (bool $pValue)
	Set Superscript. More...

	getSubscript ()
	Get Subscript. More...

	setSubscript (bool $pValue)
	Set Subscript. More...

	getUnderline ()
	Get Underline. More...

	setUnderline ($pValue)
	Set Underline. More...

	getStrikethrough ()
	Get Strikethrough. More...

	setStrikethrough ($pValue)
	Set Strikethrough. More...

	getColor ()
	Get Color. More...

	setColor (Color $pValue)
	Set Color. More...

	getHashCode ()
	Get hash code. More...

Public Member Functions inherited from PhpOffice\PhpSpreadsheet\Style\Supervisor
	__construct ($isSupervisor=false)
	Create a new Supervisor. More...

	bindParent ($parent, $parentPropertyName=null)
	Bind parent. More...

	getIsSupervisor ()
	Is this a supervisor or a cell style component? More...

	getActiveSheet ()
	Get the currently active sheet. More...

	getSelectedCells ()
	Get the currently active cell coordinate in currently active sheet. More...

	getActiveCell ()
	Get the currently active cell coordinate in currently active sheet. More...

	__clone ()
	Implement PHP __clone to create a deep clone, not just a shallow copy. More...

	exportArray ()
	Export style as array. More...

	getHashCode ()
	Get hash code. More...

Data Fields
const	UNDERLINE_NONE = 'none'

const	UNDERLINE_DOUBLE = 'double'

const	UNDERLINE_DOUBLEACCOUNTING = 'doubleAccounting'

const	UNDERLINE_SINGLE = 'single'

const	UNDERLINE_SINGLEACCOUNTING = 'singleAccounting'

	$colorIndex

Protected Member Functions
	exportArray1 ()
	Abstract method to be implemented in anything which extends this class. More...

Protected Member Functions inherited from PhpOffice\PhpSpreadsheet\Style\Supervisor
	exportArray1 ()
	Abstract method to be implemented in anything which extends this class. More...

	exportArray2 (array &$exportedArray, string $index, $objOrValue)
	Populate array from exportArray1. More...

Protected Attributes
	$name = 'Calibri'

	$size = 11

	$bold = false

	$italic = false

	$superscript = false

	$subscript = false

	$underline = self::UNDERLINE_NONE

	$strikethrough = false

	$color

Protected Attributes inherited from PhpOffice\PhpSpreadsheet\Style\Supervisor
	$isSupervisor

	$parent

	$parentPropertyName

Detailed Description

Definition at line 5 of file Font.php.

Constructor & Destructor Documentation

◆ __construct()

PhpOffice\PhpSpreadsheet\Style\Font::__construct	(	$isSupervisor = `false`,
		$isConditional = `false`
	)

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

Definition at line 92 of file Font.php.

    {
        // 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');
        }
    }

References PhpOffice\PhpSpreadsheet\Style\Supervisor\$isSupervisor, color, PhpOffice\PhpSpreadsheet\Style\Color\COLOR_BLACK, and size.

Member Function Documentation

◆ applyFromArray()

PhpOffice\PhpSpreadsheet\Style\Font::applyFromArray ( array $pStyles )

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

Definition at line 162 of file Font.php.

    {
        if ($this->isSupervisor) {
            $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($this->getStyleArray($pStyles));
        } else {
            if (isset($pStyles['name'])) {
                $this->setName($pStyles['name']);
            }
            if (isset($pStyles['bold'])) {
                $this->setBold($pStyles['bold']);
            }
            if (isset($pStyles['italic'])) {
                $this->setItalic($pStyles['italic']);
            }
            if (isset($pStyles['superscript'])) {
                $this->setSuperscript($pStyles['superscript']);
            }
            if (isset($pStyles['subscript'])) {
                $this->setSubscript($pStyles['subscript']);
            }
            if (isset($pStyles['underline'])) {
                $this->setUnderline($pStyles['underline']);
            }
            if (isset($pStyles['strikethrough'])) {
                $this->setStrikethrough($pStyles['strikethrough']);
            }
            if (isset($pStyles['color'])) {
                $this->getColor()->applyFromArray($pStyles['color']);
            }
            if (isset($pStyles['size'])) {
                $this->setSize($pStyles['size']);
            }
        }
 
        return $this;
    }

Here is the call graph for this function:

◆ exportArray1()

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

protected

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.

Reimplemented from PhpOffice\PhpSpreadsheet\Style\Supervisor.

Definition at line 550 of file Font.php.

                                     : 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;
    }

Here is the call graph for this function:

◆ getBold()

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

Get Bold.

Returns: null|bool

Definition at line 283 of file Font.php.

    {
        if ($this->isSupervisor) {
            return $this->getSharedComponent()->getBold();
        }
 
        return $this->bold;
    }

References PhpOffice\PhpSpreadsheet\Style\Font\$bold, and PhpOffice\PhpSpreadsheet\Style\Font\getSharedComponent().

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\createCSSStyleFont(), PhpOffice\PhpSpreadsheet\Style\Font\exportArray1(), and PhpOffice\PhpSpreadsheet\Writer\Xlsx\Style\writeFont().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getColor()

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

Get Color.

Returns: Color

Definition at line 500 of file Font.php.

    {
        return $this->color;
    }

References PhpOffice\PhpSpreadsheet\Style\Font\$color.

Referenced by PhpOffice\PhpSpreadsheet\Style\Font\applyFromArray(), PhpOffice\PhpSpreadsheet\Writer\Html\createCSSStyleFont(), PhpOffice\PhpSpreadsheet\Style\Font\exportArray1(), PhpOffice\PhpSpreadsheet\Reader\Xlsx\Styles\readFontStyle(), PhpOffice\PhpSpreadsheet\Style\Font\setColor(), and PhpOffice\PhpSpreadsheet\Writer\Xlsx\Style\writeFont().

Here is the caller graph for this function:

◆ getHashCode()

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

Get hash code.

Returns: string Hash code

Implements PhpOffice\PhpSpreadsheet\IComparable.

Definition at line 530 of file Font.php.

    {
        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__
        );
    }

References color, PhpOffice\PhpSpreadsheet\Style\Font\getSharedComponent(), and size.

Here is the call graph for this function:

◆ getItalic()

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

Get Italic.

Returns: null|bool

Definition at line 319 of file Font.php.

    {
        if ($this->isSupervisor) {
            return $this->getSharedComponent()->getItalic();
        }
 
        return $this->italic;
    }

References PhpOffice\PhpSpreadsheet\Style\Font\$italic, and PhpOffice\PhpSpreadsheet\Style\Font\getSharedComponent().

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\createCSSStyleFont(), PhpOffice\PhpSpreadsheet\Style\Font\exportArray1(), and PhpOffice\PhpSpreadsheet\Writer\Xlsx\Style\writeFont().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getName()

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

Get Name.

Returns: null|string

Definition at line 204 of file Font.php.

    {
        if ($this->isSupervisor) {
            return $this->getSharedComponent()->getName();
        }
 
        return $this->name;
    }

References PhpOffice\PhpSpreadsheet\Style\Font\$name, and PhpOffice\PhpSpreadsheet\Style\Font\getSharedComponent().

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\createCSSStyleFont(), PhpOffice\PhpSpreadsheet\Style\Font\exportArray1(), and PhpOffice\PhpSpreadsheet\Writer\Xlsx\Style\writeFont().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSharedComponent()

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

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

Only used for style supervisor.

Returns: Font

Definition at line 123 of file Font.php.

    {
        return $this->parent->getSharedComponent()->getFont();
    }

Referenced by PhpOffice\PhpSpreadsheet\Style\Font\getBold(), PhpOffice\PhpSpreadsheet\Style\Font\getHashCode(), PhpOffice\PhpSpreadsheet\Style\Font\getItalic(), PhpOffice\PhpSpreadsheet\Style\Font\getName(), PhpOffice\PhpSpreadsheet\Style\Font\getSize(), PhpOffice\PhpSpreadsheet\Style\Font\getStrikethrough(), PhpOffice\PhpSpreadsheet\Style\Font\getSubscript(), PhpOffice\PhpSpreadsheet\Style\Font\getSuperscript(), and PhpOffice\PhpSpreadsheet\Style\Font\getUnderline().

Here is the caller graph for this function:

◆ getSize()

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

Get Size.

Returns: null|float

Definition at line 240 of file Font.php.

    {
        if ($this->isSupervisor) {
            return $this->getSharedComponent()->getSize();
        }
 
        return $this->size;
    }

References PhpOffice\PhpSpreadsheet\Style\Font\$size, and PhpOffice\PhpSpreadsheet\Style\Font\getSharedComponent().

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\createCSSStyleFont(), PhpOffice\PhpSpreadsheet\Style\Font\exportArray1(), and PhpOffice\PhpSpreadsheet\Writer\Xlsx\Style\writeFont().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStrikethrough()

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

Get Strikethrough.

Returns: null|bool

Definition at line 463 of file Font.php.

    {
        if ($this->isSupervisor) {
            return $this->getSharedComponent()->getStrikethrough();
        }
 
        return $this->strikethrough;
    }

References PhpOffice\PhpSpreadsheet\Style\Font\$strikethrough, and PhpOffice\PhpSpreadsheet\Style\Font\getSharedComponent().

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\createCSSStyleFont(), PhpOffice\PhpSpreadsheet\Style\Font\exportArray1(), and PhpOffice\PhpSpreadsheet\Writer\Xlsx\Style\writeFont().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStyleArray()

PhpOffice\PhpSpreadsheet\Style\Font::getStyleArray ( $array )

Build style array from subcomponents.

Parameters

array $array

Returns: array

Definition at line 135 of file Font.php.

    {
        return ['font' => $array];
    }

Referenced by PhpOffice\PhpSpreadsheet\Style\Font\applyFromArray(), PhpOffice\PhpSpreadsheet\Style\Font\setBold(), PhpOffice\PhpSpreadsheet\Style\Font\setItalic(), PhpOffice\PhpSpreadsheet\Style\Font\setName(), PhpOffice\PhpSpreadsheet\Style\Font\setSize(), PhpOffice\PhpSpreadsheet\Style\Font\setStrikethrough(), PhpOffice\PhpSpreadsheet\Style\Font\setSubscript(), PhpOffice\PhpSpreadsheet\Style\Font\setSuperscript(), and PhpOffice\PhpSpreadsheet\Style\Font\setUnderline().

Here is the caller graph for this function:

◆ getSubscript()

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

Get Subscript.

Returns: null|bool

Definition at line 389 of file Font.php.

    {
        if ($this->isSupervisor) {
            return $this->getSharedComponent()->getSubscript();
        }
 
        return $this->subscript;
    }

References PhpOffice\PhpSpreadsheet\Style\Font\$subscript, and PhpOffice\PhpSpreadsheet\Style\Font\getSharedComponent().

Referenced by PhpOffice\PhpSpreadsheet\Style\Font\exportArray1(), and PhpOffice\PhpSpreadsheet\Writer\Xlsx\Style\writeFont().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSuperscript()

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

Get Superscript.

Returns: null|bool

Definition at line 355 of file Font.php.

    {
        if ($this->isSupervisor) {
            return $this->getSharedComponent()->getSuperscript();
        }
 
        return $this->superscript;
    }

References PhpOffice\PhpSpreadsheet\Style\Font\$superscript, and PhpOffice\PhpSpreadsheet\Style\Font\getSharedComponent().

Referenced by PhpOffice\PhpSpreadsheet\Style\Font\exportArray1(), and PhpOffice\PhpSpreadsheet\Writer\Xlsx\Style\writeFont().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getUnderline()

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

Get Underline.

Returns: null|string

Definition at line 423 of file Font.php.

    {
        if ($this->isSupervisor) {
            return $this->getSharedComponent()->getUnderline();
        }
 
        return $this->underline;
    }

References PhpOffice\PhpSpreadsheet\Style\Font\$underline, and PhpOffice\PhpSpreadsheet\Style\Font\getSharedComponent().

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\createCSSStyleFont(), PhpOffice\PhpSpreadsheet\Style\Font\exportArray1(), PhpOffice\PhpSpreadsheet\Writer\Ods\Cell\Style\mapUnderlineStyle(), and PhpOffice\PhpSpreadsheet\Writer\Xlsx\Style\writeFont().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setBold()

PhpOffice\PhpSpreadsheet\Style\Font::setBold ( $pValue )

Set Bold.

Parameters

bool $pValue

Returns: $this

Definition at line 299 of file Font.php.

    {
        if ($pValue == '') {
            $pValue = false;
        }
        if ($this->isSupervisor) {
            $styleArray = $this->getStyleArray(['bold' => $pValue]);
            $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);
        } else {
            $this->bold = $pValue;
        }
 
        return $this;
    }

References PhpOffice\PhpSpreadsheet\Style\Supervisor\getActiveSheet(), PhpOffice\PhpSpreadsheet\Style\Supervisor\getSelectedCells(), and PhpOffice\PhpSpreadsheet\Style\Font\getStyleArray().

Referenced by PhpOffice\PhpSpreadsheet\Style\Font\applyFromArray(), and PhpOffice\PhpSpreadsheet\Reader\Xlsx\Styles\readFontStyle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setColor()

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

Set Color.

Returns: $this

Definition at line 510 of file Font.php.

    {
        // make sure parameter is a real color and not a supervisor
        $color = $pValue->getIsSupervisor() ? $pValue->getSharedComponent() : $pValue;
 
        if ($this->isSupervisor) {
            $styleArray = $this->getColor()->getStyleArray(['argb' => $color->getARGB()]);
            $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);
        } else {
            $this->color = $color;
        }
 
        return $this;
    }

References PhpOffice\PhpSpreadsheet\Style\Font\$color, color, PhpOffice\PhpSpreadsheet\Style\Supervisor\getActiveSheet(), PhpOffice\PhpSpreadsheet\Style\Font\getColor(), PhpOffice\PhpSpreadsheet\Style\Supervisor\getIsSupervisor(), and PhpOffice\PhpSpreadsheet\Style\Supervisor\getSelectedCells().

Here is the call graph for this function:

◆ setItalic()

PhpOffice\PhpSpreadsheet\Style\Font::setItalic ( $pValue )

Set Italic.

Parameters

bool $pValue

Returns: $this

Definition at line 335 of file Font.php.

    {
        if ($pValue == '') {
            $pValue = false;
        }
        if ($this->isSupervisor) {
            $styleArray = $this->getStyleArray(['italic' => $pValue]);
            $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);
        } else {
            $this->italic = $pValue;
        }
 
        return $this;
    }

References PhpOffice\PhpSpreadsheet\Style\Supervisor\getActiveSheet(), PhpOffice\PhpSpreadsheet\Style\Supervisor\getSelectedCells(), and PhpOffice\PhpSpreadsheet\Style\Font\getStyleArray().

Referenced by PhpOffice\PhpSpreadsheet\Style\Font\applyFromArray(), and PhpOffice\PhpSpreadsheet\Reader\Xlsx\Styles\readFontStyle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setName()

PhpOffice\PhpSpreadsheet\Style\Font::setName ( $fontname )

Set Name.

Parameters

string $fontname

Returns: $this

Definition at line 220 of file Font.php.

    {
        if ($fontname == '') {
            $fontname = 'Calibri';
        }
        if ($this->isSupervisor) {
            $styleArray = $this->getStyleArray(['name' => $fontname]);
            $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);
        } else {
            $this->name = $fontname;
        }
 
        return $this;
    }

References PhpOffice\PhpSpreadsheet\Style\Supervisor\getActiveSheet(), PhpOffice\PhpSpreadsheet\Style\Supervisor\getSelectedCells(), and PhpOffice\PhpSpreadsheet\Style\Font\getStyleArray().

Referenced by PhpOffice\PhpSpreadsheet\Style\Font\applyFromArray(), and PhpOffice\PhpSpreadsheet\Reader\Xlsx\Styles\readFontStyle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setSize()

PhpOffice\PhpSpreadsheet\Style\Font::setSize ( $sizeInPoints )

Set Size.

Parameters

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

Returns: $this

Definition at line 256 of file Font.php.

    {
        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' => $sizeInPoints]);
            $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);
        } else {
            $this->size = $sizeInPoints;
        }
 
        return $this;
    }

References PhpOffice\PhpSpreadsheet\Style\Supervisor\getActiveSheet(), PhpOffice\PhpSpreadsheet\Style\Supervisor\getSelectedCells(), PhpOffice\PhpSpreadsheet\Style\Font\getStyleArray(), and size.

Referenced by PhpOffice\PhpSpreadsheet\Style\Font\applyFromArray(), and PhpOffice\PhpSpreadsheet\Reader\Xlsx\Styles\readFontStyle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setStrikethrough()

PhpOffice\PhpSpreadsheet\Style\Font::setStrikethrough ( $pValue )

Set Strikethrough.

Parameters

bool $pValue

Returns: $this

Definition at line 479 of file Font.php.

    {
        if ($pValue == '') {
            $pValue = false;
        }
 
        if ($this->isSupervisor) {
            $styleArray = $this->getStyleArray(['strikethrough' => $pValue]);
            $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);
        } else {
            $this->strikethrough = $pValue;
        }
 
        return $this;
    }

References PhpOffice\PhpSpreadsheet\Style\Supervisor\getActiveSheet(), PhpOffice\PhpSpreadsheet\Style\Supervisor\getSelectedCells(), and PhpOffice\PhpSpreadsheet\Style\Font\getStyleArray().

Referenced by PhpOffice\PhpSpreadsheet\Style\Font\applyFromArray(), and PhpOffice\PhpSpreadsheet\Reader\Xlsx\Styles\readFontStyle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setSubscript()

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

Set Subscript.

Returns: $this

Definition at line 403 of file Font.php.

    {
        if ($this->isSupervisor) {
            $styleArray = $this->getStyleArray(['subscript' => $pValue]);
            $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);
        } else {
            $this->subscript = $pValue;
            if ($this->subscript) {
                $this->superscript = false;
            }
        }
 
        return $this;
    }

References PhpOffice\PhpSpreadsheet\Style\Supervisor\getActiveSheet(), PhpOffice\PhpSpreadsheet\Style\Supervisor\getSelectedCells(), and PhpOffice\PhpSpreadsheet\Style\Font\getStyleArray().

Referenced by PhpOffice\PhpSpreadsheet\Style\Font\applyFromArray(), PhpOffice\PhpSpreadsheet\Reader\Xls\Style\CellFont\escapement(), and PhpOffice\PhpSpreadsheet\Reader\Xlsx\Styles\readFontStyle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setSuperscript()

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

Set Superscript.

Returns: $this

Definition at line 369 of file Font.php.

    {
        if ($this->isSupervisor) {
            $styleArray = $this->getStyleArray(['superscript' => $pValue]);
            $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);
        } else {
            $this->superscript = $pValue;
            if ($this->superscript) {
                $this->subscript = false;
            }
        }
 
        return $this;
    }

References PhpOffice\PhpSpreadsheet\Style\Supervisor\getActiveSheet(), PhpOffice\PhpSpreadsheet\Style\Supervisor\getSelectedCells(), and PhpOffice\PhpSpreadsheet\Style\Font\getStyleArray().

Referenced by PhpOffice\PhpSpreadsheet\Style\Font\applyFromArray(), PhpOffice\PhpSpreadsheet\Reader\Xls\Style\CellFont\escapement(), and PhpOffice\PhpSpreadsheet\Reader\Xlsx\Styles\readFontStyle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setUnderline()

PhpOffice\PhpSpreadsheet\Style\Font::setUnderline ( $pValue )

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

Definition at line 441 of file Font.php.

    {
        if (is_bool($pValue)) {
            $pValue = ($pValue) ? self::UNDERLINE_SINGLE : self::UNDERLINE_NONE;
        } elseif ($pValue == '') {
            $pValue = self::UNDERLINE_NONE;
        }
        if ($this->isSupervisor) {
            $styleArray = $this->getStyleArray(['underline' => $pValue]);
            $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);
        } else {
            $this->underline = $pValue;
        }
 
        return $this;
    }

References PhpOffice\PhpSpreadsheet\Style\Supervisor\getActiveSheet(), PhpOffice\PhpSpreadsheet\Style\Supervisor\getSelectedCells(), PhpOffice\PhpSpreadsheet\Style\Font\getStyleArray(), and PhpOffice\PhpSpreadsheet\Style\Font\UNDERLINE_NONE.

Referenced by PhpOffice\PhpSpreadsheet\Style\Font\applyFromArray(), PhpOffice\PhpSpreadsheet\Reader\Xlsx\Styles\readFontStyle(), and PhpOffice\PhpSpreadsheet\Reader\Xls\Style\CellFont\underline().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $bold

PhpOffice\PhpSpreadsheet\Style\Font::$bold = false

protected

Definition at line 33 of file Font.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\Font\getBold().

◆ $color

PhpOffice\PhpSpreadsheet\Style\Font::$color

protected

Definition at line 75 of file Font.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\Font\getColor(), and PhpOffice\PhpSpreadsheet\Style\Font\setColor().

◆ $colorIndex

PhpOffice\PhpSpreadsheet\Style\Font::$colorIndex

Definition at line 80 of file Font.php.

◆ $italic

PhpOffice\PhpSpreadsheet\Style\Font::$italic = false

protected

Definition at line 40 of file Font.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\Font\getItalic().

◆ $name

PhpOffice\PhpSpreadsheet\Style\Font::$name = 'Calibri'

protected

Definition at line 19 of file Font.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\Font\getName().

◆ $size

PhpOffice\PhpSpreadsheet\Style\Font::$size = 11

protected

Definition at line 26 of file Font.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\Font\getSize().

◆ $strikethrough

PhpOffice\PhpSpreadsheet\Style\Font::$strikethrough = false

protected

Definition at line 68 of file Font.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\Font\getStrikethrough().

◆ $subscript

PhpOffice\PhpSpreadsheet\Style\Font::$subscript = false

protected

Definition at line 54 of file Font.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\Font\getSubscript().

◆ $superscript

PhpOffice\PhpSpreadsheet\Style\Font::$superscript = false

protected

Definition at line 47 of file Font.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\Font\getSuperscript().

◆ $underline

PhpOffice\PhpSpreadsheet\Style\Font::$underline = self::UNDERLINE_NONE

protected

Definition at line 61 of file Font.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\Font\getUnderline().

◆ UNDERLINE_DOUBLE

const PhpOffice\PhpSpreadsheet\Style\Font::UNDERLINE_DOUBLE = 'double'

Definition at line 9 of file Font.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Ods\Cell\Style\mapUnderlineStyle(), and PhpOffice\PhpSpreadsheet\Reader\Xlsx\Chart\parseRichText().

◆ UNDERLINE_DOUBLEACCOUNTING

const PhpOffice\PhpSpreadsheet\Style\Font::UNDERLINE_DOUBLEACCOUNTING = 'doubleAccounting'

Definition at line 10 of file Font.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Ods\Cell\Style\mapUnderlineStyle().

◆ UNDERLINE_NONE

const PhpOffice\PhpSpreadsheet\Style\Font::UNDERLINE_NONE = 'none'

Definition at line 8 of file Font.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\createCSSStyleFont(), PhpOffice\PhpSpreadsheet\Reader\Xlsx\Chart\parseRichText(), PhpOffice\PhpSpreadsheet\Style\Font\setUnderline(), and PhpOffice\PhpSpreadsheet\Writer\Ods\Cell\Style\writeTextProperties().

◆ UNDERLINE_SINGLE

const PhpOffice\PhpSpreadsheet\Style\Font::UNDERLINE_SINGLE = 'single'

Definition at line 11 of file Font.php.

Referenced by PhpOffice\PhpSpreadsheet\Helper\Html\buildTextRun(), PhpOffice\PhpSpreadsheet\Writer\Ods\Cell\Style\mapUnderlineStyle(), PhpOffice\PhpSpreadsheet\Reader\Xlsx\Chart\parseRichText(), and PhpOffice\PhpSpreadsheet\Reader\Xlsx\Styles\readFontStyle().

◆ UNDERLINE_SINGLEACCOUNTING

const PhpOffice\PhpSpreadsheet\Style\Font::UNDERLINE_SINGLEACCOUNTING = 'singleAccounting'

Definition at line 12 of file Font.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Ods\Cell\Style\mapUnderlineStyle().

The documentation for this class was generated from the following file:

libs/composer/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Style/Font.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ applyFromArray()

◆ exportArray1()

◆ getBold()

◆ getColor()

◆ getHashCode()

◆ getItalic()

◆ getName()

◆ getSharedComponent()

◆ getSize()

◆ getStrikethrough()

◆ getStyleArray()

◆ getSubscript()

◆ getSuperscript()

◆ getUnderline()

◆ setBold()

◆ setColor()

◆ setItalic()

◆ setName()

◆ setSize()

◆ setStrikethrough()

◆ setSubscript()

◆ setSuperscript()

◆ setUnderline()

Field Documentation

◆ $bold

◆ $color

◆ $colorIndex

◆ $italic

◆ $name

◆ $size

◆ $strikethrough

◆ $subscript

◆ $superscript

◆ $underline

◆ UNDERLINE_DOUBLE

◆ UNDERLINE_DOUBLEACCOUNTING

◆ UNDERLINE_NONE

◆ UNDERLINE_SINGLE

◆ UNDERLINE_SINGLEACCOUNTING