RichText.php

Go to the documentation of this file.

<?php
if (!defined('PHPEXCEL_ROOT')) {
        define('PHPEXCEL_ROOT', dirname(__FILE__) . '/../');
}

require_once PHPEXCEL_ROOT . 'PHPExcel/IComparable.php';

require_once PHPEXCEL_ROOT . 'PHPExcel/Cell.php';

require_once PHPEXCEL_ROOT . 'PHPExcel/Cell/DataType.php';

require_once PHPEXCEL_ROOT . 'PHPExcel/RichText/ITextElement.php';

require_once PHPEXCEL_ROOT . 'PHPExcel/RichText/TextElement.php';

require_once PHPEXCEL_ROOT . 'PHPExcel/RichText/Run.php';

require_once PHPEXCEL_ROOT . 'PHPExcel/Style/Font.php';

class PHPExcel_RichText implements PHPExcel_IComparable
{
        private $_richTextElements;
        
        private $_parent;
           
    public function __construct(PHPExcel_Cell $pCell = null)
    {
        // Initialise variables
        $this->_richTextElements = array();
        
        // Set parent?
        if (!is_null($pCell)) {
                // Set parent cell
                $this->_parent = $pCell;
                        
                // Add cell text and style
                if ($this->_parent->getValue() != "") {
                        $objRun = new PHPExcel_RichText_Run($this->_parent->getValue());
                        $objRun->setFont(clone $this->_parent->getParent()->getStyle($this->_parent->getCoordinate())->getFont());
                        $this->addText($objRun);
                }
                        
                // Set parent value
                $this->_parent->setValueExplicit($this, PHPExcel_Cell_DataType::TYPE_STRING);
        }
    }
    
    public function addText(PHPExcel_RichText_ITextElement $pText = null)
    {
        $this->_richTextElements[] = $pText;
        return $this;
    }
    
    public function createText($pText = '')
    {
        $objText = new PHPExcel_RichText_TextElement($pText);
        $this->addText($objText);
        return $objText;
    }
    
    public function createTextRun($pText = '')
    {
        $objText = new PHPExcel_RichText_Run($pText);
        $this->addText($objText);
        return $objText;
    }
    
    public function getPlainText()
    {
        // Return value
        $returnValue = '';
        
        // Loop trough all PHPExcel_RichText_ITextElement
        foreach ($this->_richTextElements as $text) {
                $returnValue .= $text->getText();
        }
        
        // Return
        return $returnValue;
    }
    
    public function __toString() {
        return $this->getPlainText();
    }
    
    public function getRichTextElements()
    {
        return $this->_richTextElements;
    }
    
    public function setRichTextElements($pElements = null)
    {
        if (is_array($pElements)) {
                $this->_richTextElements = $pElements;
        } else {
                throw new Exception("Invalid PHPExcel_RichText_ITextElement[] array passed.");
        }
        return $this;
    }
 
    public function getParent() {
        return $this->_parent;
    }
    
    public function setParent(PHPExcel_Cell $value) {
        // Set parent
        $this->_parent = $value;
        
        // Set parent value
        $this->_parent->setValueExplicit($this, PHPExcel_Cell_DataType::TYPE_STRING);
                
                // Verify style information

                $sheet = $this->_parent->getParent();
                $cellFont = $sheet->getStyle($this->_parent->getCoordinate())->getFont()->getSharedComponent();
                foreach ($this->getRichTextElements() as $element) {
                        if (!($element instanceof PHPExcel_RichText_Run)) continue;
                        
                        if ($element->getFont()->getHashCode() == $sheet->getDefaultStyle()->getFont()->getHashCode()) {
                                if ($element->getFont()->getHashCode() != $cellFont->getHashCode()) {
                                        $element->setFont(clone $cellFont);
                                }
                        }
                }
                return $this;
    }
    
        public function getHashCode() {
                $hashElements = '';
                foreach ($this->_richTextElements as $element) {
                        $hashElements .= $element->getHashCode();
                }
                
        return md5(
                  $hashElements
                . __CLASS__
        );
    }
    
    private $_hashIndex;
    
        public function getHashIndex() {
                return $this->_hashIndex;
        }
        
        public function setHashIndex($value) {
                $this->_hashIndex = $value;
        }
    
        public function __clone() {
                $vars = get_object_vars($this);
                foreach ($vars as $key => $value) {
                        if ($key == '_parent') continue;
                        
                        if (is_object($value)) {
                                $this->$key = clone $value;
                        } else {
                                $this->$key = $value;
                        }
                }
        }
}