PhpOffice\PhpSpreadsheet\RichText\RichText Class Reference

Inheritance diagram for PhpOffice\PhpSpreadsheet\RichText\RichText:

Collaboration diagram for PhpOffice\PhpSpreadsheet\RichText\RichText:

Public Member Functions
	__construct (?Cell $pCell=null)
	Create a new RichText instance. More...
	addText (ITextElement $pText)
	Add text. More...
	createText ($pText)
	Create text. More...
	createTextRun ($pText)
	Create text run. More...
	getPlainText ()
	Get plain text. More...
	__toString ()
	Convert to string. More...
	getRichTextElements ()
	Get Rich Text elements. More...
	setRichTextElements (array $textElements)
	Set Rich Text elements. More...
	getHashCode ()
	Get hash code. More...
	__clone ()
	Implement PHP __clone to create a deep clone, not just a shallow copy. More...

Private Attributes
	$richTextElements

Detailed Description

Definition at line 9 of file RichText.php.

Constructor & Destructor Documentation

__construct()

PhpOffice\PhpSpreadsheet\RichText\RichText::__construct

(

?Cell

$pCell = null

)

Create a new RichText instance.

Parameters

Cell

$pCell

Definition at line 23 of file RichText.php.

References PhpOffice\PhpSpreadsheet\RichText\RichText\addText(), PhpOffice\PhpSpreadsheet\RichText\Run\setFont(), and PhpOffice\PhpSpreadsheet\Cell\DataType\TYPE_STRING.

    {
        // Initialise variables
        $this->richTextElements = [];

        // Rich-Text string attached to cell?
        if ($pCell !== null) {
            // Add cell text and style
            if ($pCell->getValue() != '') {
                $objRun = new Run($pCell->getValue());
                $objRun->setFont(clone $pCell->getWorksheet()->getStyle($pCell->getCoordinate())->getFont());
                $this->addText($objRun);
            }

            // Set parent value
            $pCell->setValueExplicit($this, DataType::TYPE_STRING);
        }
    }

Here is the call graph for this function:

Member Function Documentation

__clone()

PhpOffice\PhpSpreadsheet\RichText\RichText::__clone

(

)

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

Definition at line 159 of file RichText.php.

References $key.

    {
        $vars = get_object_vars($this);
        foreach ($vars as $key => $value) {
            if (is_object($value)) {
                $this->$key = clone $value;
            } else {
                $this->$key = $value;
            }
        }
    }

__toString()

PhpOffice\PhpSpreadsheet\RichText\RichText::__toString

(

)

Convert to string.

Returns

string

Definition at line 109 of file RichText.php.

References PhpOffice\PhpSpreadsheet\RichText\RichText\getPlainText().

    {
        return $this->getPlainText();
    }

Here is the call graph for this function:

addText()

PhpOffice\PhpSpreadsheet\RichText\RichText::addText

(

ITextElement

$pText

)

Add text.

Parameters

ITextElement

$pText

Rich text element

Returns

$this

Definition at line 49 of file RichText.php.

Referenced by PhpOffice\PhpSpreadsheet\RichText\RichText\__construct(), PhpOffice\PhpSpreadsheet\RichText\RichText\createText(), and PhpOffice\PhpSpreadsheet\RichText\RichText\createTextRun().

    {
        $this->richTextElements[] = $pText;

        return $this;
    }

Here is the caller graph for this function:

createText()

PhpOffice\PhpSpreadsheet\RichText\RichText::createText

(

$pText

)

Create text.

Parameters

string

$pText

Text

Returns

TextElement

Definition at line 63 of file RichText.php.

References PhpOffice\PhpSpreadsheet\RichText\RichText\addText().

    {
        $objText = new TextElement($pText);
        $this->addText($objText);

        return $objText;
    }

Here is the call graph for this function:

createTextRun()

PhpOffice\PhpSpreadsheet\RichText\RichText::createTextRun

(

$pText

)

Create text run.

Parameters

string

$pText

Text

Returns

Run

Definition at line 78 of file RichText.php.

References PhpOffice\PhpSpreadsheet\RichText\RichText\addText().

    {
        $objText = new Run($pText);
        $this->addText($objText);

        return $objText;
    }

Here is the call graph for this function:

getHashCode()

PhpOffice\PhpSpreadsheet\RichText\RichText::getHashCode

(

)

Get hash code.

Returns

string Hash code

Implements PhpOffice\PhpSpreadsheet\IComparable.

Definition at line 143 of file RichText.php.

    {
        $hashElements = '';
        foreach ($this->richTextElements as $element) {
            $hashElements .= $element->getHashCode();
        }

        return md5(
            $hashElements .
            __CLASS__
        );
    }

getPlainText()

PhpOffice\PhpSpreadsheet\RichText\RichText::getPlainText

(

)

Get plain text.

Returns

string

Definition at line 91 of file RichText.php.

References $text.

Referenced by PhpOffice\PhpSpreadsheet\RichText\RichText\__toString().

    {
        // Return value
        $returnValue = '';

        // Loop through all ITextElements
        foreach ($this->richTextElements as $text) {
            $returnValue .= $text->getText();
        }

        return $returnValue;
    }

Here is the caller graph for this function:

getRichTextElements()

PhpOffice\PhpSpreadsheet\RichText\RichText::getRichTextElements

(

)

Get Rich Text elements.

Returns

ITextElement[]

Definition at line 119 of file RichText.php.

References PhpOffice\PhpSpreadsheet\RichText\RichText\$richTextElements.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\StringTable\writeRichText().

    {
        return $this->richTextElements;
    }

Here is the caller graph for this function:

setRichTextElements()

PhpOffice\PhpSpreadsheet\RichText\RichText::setRichTextElements

(

array

$textElements

)

Set Rich Text elements.

Parameters

ITextElement[]

$textElements Array of elements

Returns

$this

Definition at line 131 of file RichText.php.

    {
        $this->richTextElements = $textElements;

        return $this;
    }

Field Documentation

$richTextElements

PhpOffice\PhpSpreadsheet\RichText\RichText::$richTextElements

private

Definition at line 16 of file RichText.php.

Referenced by PhpOffice\PhpSpreadsheet\RichText\RichText\getRichTextElements().

---

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

• libs/composer/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/RichText/RichText.php