Cell.php

Go to the documentation of this file.

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

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

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

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

require_once PHPEXCEL_ROOT . 'PHPExcel/Worksheet.php';

require_once PHPEXCEL_ROOT . 'PHPExcel/Calculation.php';

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

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

require_once PHPEXCEL_ROOT . 'PHPExcel/Shared/String.php';


class PHPExcel_Cell
{
        private static $_valueBinder = null;

        private $_column;

        private $_row;

        private $_value;

        private $_calculatedValue = null;

        private $_dataType;

        private $_parent;

        private $_xfIndex;

        public function __construct($pColumn = 'A', $pRow = 1, $pValue = null, $pDataType = null, PHPExcel_Worksheet $pSheet = null)
        {
                // Set value binder?
                if (is_null(self::$_valueBinder)) {
                        self::$_valueBinder = new PHPExcel_Cell_DefaultValueBinder();
                }

                // Initialise cell coordinate
                $this->_column = strtoupper($pColumn);
                $this->_row = $pRow;

                // Initialise cell value
                $this->_value = $pValue;

                // Set worksheet
                $this->_parent = $pSheet;

                // Set datatype?
                if (!is_null($pDataType)) {
                        $this->_dataType = $pDataType;
                } else {
                        if (!self::getValueBinder()->bindValue($this, $pValue)) {
                                throw new Exception("Value could not be bound to cell.");
                        }
                }

                // set default index to cellXf
                $this->_xfIndex = 0;
        }

        public function getColumn()
        {
                return strtoupper($this->_column);
        }

        public function getRow()
        {
                return $this->_row;
        }

        public function getCoordinate()
        {
                return $this->_column . $this->_row;
        }

        public function getValue()
        {
                return $this->_value;
        }

        public function setValue($pValue = null)
        {
                if (!self::getValueBinder()->bindValue($this, $pValue)) {
                        throw new Exception("Value could not be bound to cell.");
                }
                return $this;
        }

        public function setValueExplicit($pValue = null, $pDataType = PHPExcel_Cell_DataType::TYPE_STRING)
        {
                // check strings that they are ok
                // TODO: fix also for RichText
                if ($pDataType == PHPExcel_Cell_DataType::TYPE_STRING && !($pValue instanceof PHPExcel_RichText)) {
                        // string must never be longer than 32,767 characters, truncate if necessary
                        $pValue = PHPExcel_Shared_String::Substring($pValue, 0, 32767);

                        // we require that newline is represented as "\n" in core, not as "\r\n" or "\r"
                        $pValue = str_replace(array("\r\n", "\r"), "\n", $pValue);
                }

                $this->_value           = $pValue;
                $this->_dataType        = $pDataType;
                return $this;
        }

        public function getCalculatedValue($resetLog=true)
        {
//              echo 'Cell '.$this->getCoordinate().' value is a '.$this->_dataType.' with a value of '.$this->getValue().'<br />';
                if (!is_null($this->_calculatedValue) && $this->_dataType == PHPExcel_Cell_DataType::TYPE_FORMULA) {
                        try {
//                              echo 'Cell value for '.$this->getCoordinate().' is a formula: Calculating value<br />';
                                $result = PHPExcel_Calculation::getInstance()->calculateCellValue($this,$resetLog);
                        } catch ( Exception $ex ) {
//                              echo 'Calculation Exception: '.$ex->getMessage().'<br />';
                                $result = '#N/A';
                        }

                        if ((is_string($result)) && ($result == '#Not Yet Implemented')) {
//                              echo 'Returning fallback value of '.$this->_calculatedValue.' for cell '.$this->getCoordinate().'<br />';
                                return $this->_calculatedValue; // Fallback if calculation engine does not support the formula.
                        } else {
//                              echo 'Returning calculated value of '.$result.' for cell '.$this->getCoordinate().'<br />';
                                return $result;
                        }
                }

                if (is_null($this->_value)) {
//                      echo 'Cell '.$this->getCoordinate().' has no value, formula or otherwise<br />';
                        return null;
                } else if ($this->_dataType != PHPExcel_Cell_DataType::TYPE_FORMULA) {
//                      echo 'Cell value for '.$this->getCoordinate().' is not a formula: Returning data value of '.$this->_value.'<br />';
                        return $this->_value;
                } else {
//                      echo 'Cell value is a formula: Calculating value<br />';
                        return PHPExcel_Calculation::getInstance()->calculateCellValue($this,$resetLog);
                }
        }

        public function setCalculatedValue($pValue = null)
        {
                if (!is_null($pValue)) {
                        $this->_calculatedValue = $pValue;
                }
                return $this;
        }

        public function getOldCalculatedValue()
        {
                return $this->_calculatedValue;
        }

        public function getDataType()
        {
                return $this->_dataType;
        }

        public function setDataType($pDataType = PHPExcel_Cell_DataType::TYPE_STRING)
        {
                $this->_dataType = $pDataType;
                return $this;
        }

        public function hasDataValidation()
        {
                if (!isset($this->_parent)) {
                        throw new Exception('Cannot check for data validation when cell is not bound to a worksheet');
                }

                return $this->_parent->dataValidationExists($this->getCoordinate());
        }

        public function getDataValidation()
        {
                if (!isset($this->_parent)) {
                        throw new Exception('Cannot get data validation for cell that is not bound to a worksheet');
                }

                $dataValidation = $this->_parent->getDataValidation($this->getCoordinate());
                return $dataValidation;
        }

        public function setDataValidation(PHPExcel_Cell_DataValidation $pDataValidation = null)
        {
                if (!isset($this->_parent)) {
                        throw new Exception('Cannot set data validation for cell that is not bound to a worksheet');
                }

                $this->_parent->setDataValidation($this->getCoordinate(), $pDataValidation);
        return $this;
        }

    public function hasHyperlink()
    {
                if (!isset($this->_parent)) {
                        throw new Exception('Cannot check for hyperlink when cell is not bound to a worksheet');
                }

                return $this->_parent->hyperlinkExists($this->getCoordinate());
    }

    public function getHyperlink()
    {
                if (!isset($this->_parent)) {
                        throw new Exception('Cannot get hyperlink for cell that is not bound to a worksheet');
                }

                $hyperlink = $this->_parent->getHyperlink($this->getCoordinate());
                return $hyperlink;
    }

        public function setHyperlink(PHPExcel_Cell_Hyperlink $pHyperlink = null)
        {
                if (!isset($this->_parent)) {
                        throw new Exception('Cannot set hyperlink for cell that is not bound to a worksheet');
                }

                $this->_parent->setHyperlink($this->getCoordinate(), $pHyperlink);
        return $this;
    }

        public function getParent() {
                return $this->_parent;
        }

        public function rebindParent(PHPExcel_Worksheet $parent) {
                $this->_parent = $parent;
                return $this;
        }

        public function isInRange($pRange = 'A1:A1')
        {
                // Uppercase coordinate
                $pRange = strtoupper($pRange);

                // Extract range
                $rangeA         = '';
                $rangeB         = '';
                if (strpos($pRange, ':') === false) {
                        $rangeA = $pRange;
                        $rangeB = $pRange;
                } else {
                        list($rangeA, $rangeB) = explode(':', $pRange);
                }

                // Calculate range outer borders
                $rangeStart = PHPExcel_Cell::coordinateFromString($rangeA);
                $rangeEnd       = PHPExcel_Cell::coordinateFromString($rangeB);

                // Translate column into index
                $rangeStart[0]  = PHPExcel_Cell::columnIndexFromString($rangeStart[0]) - 1;
                $rangeEnd[0]    = PHPExcel_Cell::columnIndexFromString($rangeEnd[0]) - 1;

                // Translate properties
                $myColumn               = PHPExcel_Cell::columnIndexFromString($this->getColumn()) - 1;
                $myRow                  = $this->getRow();

                // Verify if cell is in range
                return (
                                ($rangeStart[0] <= $myColumn && $rangeEnd[0] >= $myColumn) &&
                                ($rangeStart[1] <= $myRow && $rangeEnd[1] >= $myRow)
                );
        }

        public static function coordinateFromString($pCoordinateString = 'A1')
        {
                if (strpos($pCoordinateString,':') !== false) {
                        throw new Exception('Cell coordinate string can not be a range of cells.');
                } else if ($pCoordinateString == '') {
                        throw new Exception('Cell coordinate can not be zero-length string.');
                } else {
                        // Column
                        $column = '';

                        // Row
                        $row = '';

                        // Convert a cell reference
                        if (preg_match("/([$]?[A-Z]+)([$]?\d+)/", $pCoordinateString, $matches)) {
                                list(, $column, $row) = $matches;
                        }

                        // Return array
                        return array($column, $row);
                }
        }

        public static function absoluteCoordinate($pCoordinateString = 'A1')
        {
                if (strpos($pCoordinateString,':') === false && strpos($pCoordinateString,',') === false) {
                        // Return value
                        $returnValue = '';

                        // Create absolute coordinate
                        list($column, $row) = PHPExcel_Cell::coordinateFromString($pCoordinateString);
                        $returnValue = '$' . $column . '$' . $row;

                        // Return
                        return $returnValue;
                } else {
                        throw new Exception("Coordinate string should not be a cell range.");
                }
        }

        public static function splitRange($pRange = 'A1:A1')
        {
                $exploded = explode(',', $pRange);
                for ($i = 0; $i < count($exploded); ++$i) {
                        $exploded[$i] = explode(':', $exploded[$i]);
                }
                return $exploded;
        }

        public static function buildRange($pRange)
        {
                // Verify range
                if (!is_array($pRange) || count($pRange) == 0 || !is_array($pRange[0])) {
                        throw new Exception('Range does not contain any information.');
                }

                // Build range
                $imploded = array();
                for ($i = 0; $i < count($pRange); ++$i) {
                        $pRange[$i] = implode(':', $pRange[$i]);
                }
                $imploded = implode(',', $pRange);

                return $imploded;
        }

        public static function rangeDimension($pRange = 'A1:A1')
        {
                // Uppercase coordinate
                $pRange = strtoupper($pRange);

                // Extract range
                $rangeA         = '';
                $rangeB         = '';
                if (strpos($pRange, ':') === false) {
                        $rangeA = $pRange;
                        $rangeB = $pRange;
                } else {
                        list($rangeA, $rangeB) = explode(':', $pRange);
                }

                // Calculate range outer borders
                $rangeStart = PHPExcel_Cell::coordinateFromString($rangeA);
                $rangeEnd       = PHPExcel_Cell::coordinateFromString($rangeB);

                // Translate column into index
                $rangeStart[0]  = PHPExcel_Cell::columnIndexFromString($rangeStart[0]);
                $rangeEnd[0]    = PHPExcel_Cell::columnIndexFromString($rangeEnd[0]);

                return array( ($rangeEnd[0] - $rangeStart[0] + 1), ($rangeEnd[1] - $rangeStart[1] + 1) );
        }

        public static function columnIndexFromString($pString = 'A')
        {
                // Convert to uppercase
                $pString = strtoupper($pString);

                $strLen = strlen($pString);
                // Convert column to integer
                if ($strLen == 1) {
                        return (ord($pString{0}) - 64);
                } elseif ($strLen == 2) {
                        return $result = ((1 + (ord($pString{0}) - 65)) * 26) + (ord($pString{1}) - 64);
                } elseif ($strLen == 3) {
                        return ((1 + (ord($pString{0}) - 65)) * 676) + ((1 + (ord($pString{1}) - 65)) * 26) + (ord($pString{2}) - 64);
                } else {
                        throw new Exception("Column string index can not be " . ($strLen != 0 ? "longer than 3 characters" : "empty") . ".");
                }
        }

        public static function stringFromColumnIndex($pColumnIndex = 0)
        {
                // Determine column string
                if ($pColumnIndex < 26) {
                        return chr(65 + $pColumnIndex);
                }
                return PHPExcel_Cell::stringFromColumnIndex((int)($pColumnIndex / 26) -1).chr(65 + $pColumnIndex%26) ;
        }

        public static function extractAllCellReferencesInRange($pRange = 'A1') {
                // Returnvalue
                $returnValue = array();

                // Explode spaces
                $aExplodeSpaces = explode(' ', str_replace('$', '', strtoupper($pRange)));
                foreach ($aExplodeSpaces as $explodedSpaces) {
                        // Single cell?
                        if (strpos($explodedSpaces,':') === false && strpos($explodedSpaces,',') === false) {
                                $col = 'A';
                                $row = 1;
                                list($col, $row) = PHPExcel_Cell::coordinateFromString($explodedSpaces);

                                if (strlen($col) <= 2) {
                                        $returnValue[] = $explodedSpaces;
                                }

                                continue;
                        }

                        // Range...
                        $range = PHPExcel_Cell::splitRange($explodedSpaces);
                        for ($i = 0; $i < count($range); ++$i) {
                                // Single cell?
                                if (count($range[$i]) == 1) {
                                        $col = 'A';
                                        $row = 1;
                                        list($col, $row) = PHPExcel_Cell::coordinateFromString($range[$i]);

                                        if (strlen($col) <= 2) {
                                                $returnValue[] = $explodedSpaces;
                                        }
                                }

                                // Range...
                                $rangeStart             = $rangeEnd             = '';
                                $startingCol    = $startingRow  = $endingCol    = $endingRow    = 0;

                                list($rangeStart, $rangeEnd)            = $range[$i];
                                list($startingCol, $startingRow)        = PHPExcel_Cell::coordinateFromString($rangeStart);
                                list($endingCol, $endingRow)            = PHPExcel_Cell::coordinateFromString($rangeEnd);

                                // Conversions...
                                $startingCol    = PHPExcel_Cell::columnIndexFromString($startingCol);
                                $endingCol              = PHPExcel_Cell::columnIndexFromString($endingCol);

                                // Current data
                                $currentCol     = --$startingCol;
                                $currentRow     = $startingRow;

                                // Loop cells
                                while ($currentCol < $endingCol) {
                                        $loopColumn = PHPExcel_Cell::stringFromColumnIndex($currentCol);
                                        while ($currentRow <= $endingRow) {
                                                $returnValue[] = $loopColumn.$currentRow;
                                                ++$currentRow;
                                        }
                                        ++$currentCol;
                                        $currentRow = $startingRow;
                                }
                        }
                }

                // Return value
                return $returnValue;
        }

        public static function compareCells(PHPExcel_Cell $a, PHPExcel_Cell $b)
        {
                if ($a->_row < $b->_row) {
                        return -1;
                } elseif ($a->_row > $b->_row) {
                        return 1;
                } elseif (PHPExcel_Cell::columnIndexFromString($a->_column) < PHPExcel_Cell::columnIndexFromString($b->_column)) {
                        return -1;
                } else {
                        return 1;
                }
        }

        public static function getValueBinder() {
                return self::$_valueBinder;
        }

        public static function setValueBinder(PHPExcel_Cell_IValueBinder $binder = null) {
                if (is_null($binder)) {
                        throw new Exception("A PHPExcel_Cell_IValueBinder is required for PHPExcel to function correctly.");
                }

                self::$_valueBinder = $binder;
        }

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

        public function getXfIndex()
        {
                return $this->_xfIndex;
        }

        public function setXfIndex($pValue = 0)
        {
                $this->_xfIndex = $pValue;
                return $this;
        }

}