PHPExcel_RichText Class Reference

Inheritance diagram for PHPExcel_RichText:

Collaboration diagram for PHPExcel_RichText:

Public Member Functions
	__construct (PHPExcel_Cell $pCell=null)
	Create a new PHPExcel_RichText instance. More...
	addText (PHPExcel_RichText_ITextElement $pText=null)
	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 ($pElements=null)
	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 36 of file RichText.php.

Constructor & Destructor Documentation

__construct()

PHPExcel_RichText::__construct

(

PHPExcel_Cell

$pCell = null

)

Create a new PHPExcel_RichText instance.

Parameters

PHPExcel_Cell

$pCell

Exceptions

PHPExcel_Exception

Definition at line 51 of file RichText.php.

References addText(), array, PHPExcel_RichText_Run\setFont(), and PHPExcel_Cell_DataType\TYPE_STRING.

    {
        // Initialise variables
        $this->_richTextElements = array();

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

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

Here is the call graph for this function:

Member Function Documentation

__clone()

PHPExcel_RichText::__clone

(

)

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

Definition at line 188 of file RichText.php.

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

__toString()

PHPExcel_RichText::__toString

(

)

Convert to string.

Returns

string

Definition at line 135 of file RichText.php.

References getPlainText().

    {
        return $this->getPlainText();
    }

Here is the call graph for this function:

addText()

PHPExcel_RichText::addText

(

PHPExcel_RichText_ITextElement

$pText = null

)

Add text.

Parameters

PHPExcel_RichText_ITextElement

$pText

Rich text element

Exceptions

PHPExcel_Exception

Returns

PHPExcel_RichText

Definition at line 77 of file RichText.php.

Referenced by __construct(), createText(), and createTextRun().

    {
        $this->_richTextElements[] = $pText;
        return $this;
    }

Here is the caller graph for this function:

createText()

PHPExcel_RichText::createText

(

$pText = ''

)

Create text.

Parameters

string

$pText

Text

Returns

PHPExcel_RichText_TextElement

Exceptions

PHPExcel_Exception

Definition at line 90 of file RichText.php.

References addText().

    {
        $objText = new PHPExcel_RichText_TextElement($pText);
        $this->addText($objText);
        return $objText;
    }

Here is the call graph for this function:

createTextRun()

PHPExcel_RichText::createTextRun

(

$pText = ''

)

Create text run.

Parameters

string

$pText

Text

Returns

PHPExcel_RichText_Run

Exceptions

PHPExcel_Exception

Definition at line 104 of file RichText.php.

References addText().

    {
        $objText = new PHPExcel_RichText_Run($pText);
        $this->addText($objText);
        return $objText;
    }

Here is the call graph for this function:

getHashCode()

PHPExcel_RichText::getHashCode

(

)

Get hash code.

Returns

string Hash code

Implements PHPExcel_IComparable.

Definition at line 172 of file RichText.php.

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

        return md5(
              $hashElements
            . __CLASS__
        );
    }

getPlainText()

PHPExcel_RichText::getPlainText

(

)

Get plain text.

Returns

string

Definition at line 116 of file RichText.php.

References $text.

Referenced by __toString().

    {
        // Return value
        $returnValue = '';

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

        // Return
        return $returnValue;
    }

Here is the caller graph for this function:

getRichTextElements()

PHPExcel_RichText::getRichTextElements

(

)

Get Rich Text elements.

Returns

PHPExcel_RichText_ITextElement[]

Definition at line 145 of file RichText.php.

References $_richTextElements.

    {
        return $this->_richTextElements;
    }

setRichTextElements()

PHPExcel_RichText::setRichTextElements

(

$pElements = null

)

Set Rich Text elements.

Parameters

PHPExcel_RichText_ITextElement[]

$pElements Array of elements

Exceptions

PHPExcel_Exception

Returns

PHPExcel_RichText

Definition at line 157 of file RichText.php.

    {
        if (is_array($pElements)) {
            $this->_richTextElements = $pElements;
        } else {
            throw new PHPExcel_Exception("Invalid PHPExcel_RichText_ITextElement[] array passed.");
        }
        return $this;
    }

Field Documentation

$_richTextElements

PHPExcel_RichText::$_richTextElements

private

Definition at line 43 of file RichText.php.

Referenced by getRichTextElements().

---

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

• libs/composer/vendor/phpoffice/phpexcel/Classes/PHPExcel/RichText.php