Collaboration diagram for PHPExcel_Cell:

Public Member Functions
	notifyCacheController ()
	Send notification to the cache controller. More...

	detach ()

	attach (PHPExcel_CachedObjectStorage_CacheBase $parent)

	__construct ($pValue=NULL, $pDataType=NULL, PHPExcel_Worksheet $pSheet=NULL)
	Create a new Cell. More...

	getColumn ()
	Get cell coordinate column. More...

	getRow ()
	Get cell coordinate row. More...

	getCoordinate ()
	Get cell coordinate. More...

	getValue ()
	Get cell value. More...

	getFormattedValue ()
	Get cell value with formatting. More...

	setValue ($pValue=NULL)
	Set cell value. More...

	setValueExplicit ($pValue=NULL, $pDataType=PHPExcel_Cell_DataType::TYPE_STRING)
	Set the value for a cell, with the explicit data type passed to the method (bypassing any use of the value binder) More...

	getCalculatedValue ($resetLog=TRUE)
	Get calculated cell value. More...

	setCalculatedValue ($pValue=NULL)
	Set old calculated value (cached) More...

	getOldCalculatedValue ()
	Get old calculated value (cached) This returns the value last calculated by MS Excel or whichever spreadsheet program was used to create the original spreadsheet file. More...

	getDataType ()
	Get cell data type. More...

	setDataType ($pDataType=PHPExcel_Cell_DataType::TYPE_STRING)
	Set cell data type. More...

	isFormula ()
	Identify if the cell contains a formula. More...

	hasDataValidation ()
	Does this cell contain Data validation rules? More...

	getDataValidation ()
	Get Data validation rules. More...

	setDataValidation (PHPExcel_Cell_DataValidation $pDataValidation=NULL)
	Set Data validation rules. More...

	hasHyperlink ()
	Does this cell contain a Hyperlink? More...

	getHyperlink ()
	Get Hyperlink. More...

	setHyperlink (PHPExcel_Cell_Hyperlink $pHyperlink=NULL)
	Set Hyperlink. More...

	getParent ()
	Get parent worksheet. More...

	getWorksheet ()
	Get parent worksheet. More...

	isInMergeRange ()
	Is this cell in a merge range. More...

	isMergeRangeValueCell ()
	Is this cell the master (top left cell) in a merge range (that holds the actual data value) More...

	getMergeRange ()
	If this cell is in a merge range, then return the range. More...

	getStyle ()
	Get cell style. More...

	rebindParent (PHPExcel_Worksheet $parent)
	Re-bind parent. More...

	isInRange ($pRange='A1:A1')
	Is cell in a specific range? More...

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

	getXfIndex ()
	Get index to cellXf. More...

	setXfIndex ($pValue=0)
	Set index to cellXf. More...

	setFormulaAttributes ($pAttributes)

	getFormulaAttributes ()

	__toString ()
	Convert to string. More...

Static Public Member Functions
static	coordinateFromString ($pCoordinateString='A1')
	Coordinate from string. More...

static	absoluteReference ($pCoordinateString='A1')
	Make string row, column or cell coordinate absolute. More...

static	absoluteCoordinate ($pCoordinateString='A1')
	Make string coordinate absolute. More...

static	splitRange ($pRange='A1:A1')
	Split range into coordinate strings. More...

static	buildRange ($pRange)
	Build range from coordinate strings. More...

static	rangeBoundaries ($pRange='A1:A1')
	Calculate range boundaries. More...

static	rangeDimension ($pRange='A1:A1')
	Calculate range dimension. More...

static	getRangeBoundaries ($pRange='A1:A1')
	Calculate range boundaries. More...

static	columnIndexFromString ($pString='A')
	Column index from string. More...

static	stringFromColumnIndex ($pColumnIndex=0)
	String from columnindex. More...

static	extractAllCellReferencesInRange ($pRange='A1')
	Extract all cell references in range. More...

static	compareCells (PHPExcel_Cell $a, PHPExcel_Cell $b)
	Compare 2 cells. More...

static	getValueBinder ()
	Get value binder to use. More...

static	setValueBinder (PHPExcel_Cell_IValueBinder $binder=NULL)
	Set value binder to use. More...

Data Fields
const	DEFAULT_RANGE = 'A1:A1'

Private Attributes
	$_value

	$_calculatedValue = NULL

	$_dataType

	$_parent

	$_xfIndex = 0

	$_formulaAttributes
	Attributes of the formula. More...

Static Private Attributes
static	$_valueBinder = NULL

Detailed Description

Definition at line 36 of file Cell.php.

Constructor & Destructor Documentation

◆ __construct()

PHPExcel_Cell::__construct	(		$pValue = `NULL`,
			$pDataType = `NULL`,
		PHPExcel_Worksheet	$pSheet = `NULL`
	)

Create a new Cell.

Parameters

mixed	$pValue
string	$pDataType
PHPExcel_Worksheet	$pSheet

Exceptions

PHPExcel_Exception

Definition at line 128 of file Cell.php.

        {
                // Initialise cell value
                $this->_value = $pValue;
 
                // Set worksheet cache
                $this->_parent = $pSheet->getCellCacheController();
 
                // Set datatype?
                if ($pDataType !== NULL) {
                        if ($pDataType == PHPExcel_Cell_DataType::TYPE_STRING2)
                                $pDataType = PHPExcel_Cell_DataType::TYPE_STRING;
                        $this->_dataType = $pDataType;
                } elseif (!self::getValueBinder()->bindValue($this, $pValue)) {
            throw new PHPExcel_Exception("Value could not be bound to cell.");
                }
        }

References PHPExcel_Cell_DataType\TYPE_STRING, and PHPExcel_Cell_DataType\TYPE_STRING2.

Member Function Documentation

◆ __clone()

PHPExcel_Cell::__clone ( )

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

Definition at line 960 of file Cell.php.

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

◆ __toString()

PHPExcel_Cell::__toString ( )

Convert to string.

Returns: string

Definition at line 1016 of file Cell.php.

        {
                return (string) $this->getValue();
        }

References getValue().

Here is the call graph for this function:

◆ absoluteCoordinate()

static PHPExcel_Cell::absoluteCoordinate ( $pCoordinateString = 'A1' )

static

Make string coordinate absolute.

Parameters

string $pCoordinateString e.g. 'A1'

Returns: string Absolute coordinate e.g. '$A$1'

Exceptions

PHPExcel_Exception

Definition at line 631 of file Cell.php.

        {
                if (strpos($pCoordinateString,':') === FALSE && strpos($pCoordinateString,',') === FALSE) {
                        // Split out any worksheet name from the coordinate
                        $worksheet = '';
                        $cellAddress = explode('!',$pCoordinateString);
                        if (count($cellAddress) > 1) {
                                list($worksheet,$pCoordinateString) = $cellAddress;
                        }
                        if ($worksheet > '')    $worksheet .= '!';
 
                        // Create absolute coordinate
                        list($column, $row) = self::coordinateFromString($pCoordinateString);
                        $column = ltrim($column,'$');
                        $row = ltrim($row,'$');
                        return $worksheet . '$' . $column . '$' . $row;
                }
 
                throw new PHPExcel_Exception('Cell coordinate string can not be a range of cells');
        }

References $column, $row, $worksheet, and coordinateFromString().

Referenced by absoluteReference().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ absoluteReference()

static PHPExcel_Cell::absoluteReference ( $pCoordinateString = 'A1' )

static

Make string row, column or cell coordinate absolute.

Parameters

string $pCoordinateString e.g. 'A' or '1' or 'A1' Note that this value can be a row or column reference as well as a cell reference

Returns: string Absolute coordinate e.g. '$A' or '$1' or '$A$1'

Exceptions

PHPExcel_Exception

Definition at line 601 of file Cell.php.

        {
                if (strpos($pCoordinateString,':') === FALSE && strpos($pCoordinateString,',') === FALSE) {
                        // Split out any worksheet name from the reference
                        $worksheet = '';
                        $cellAddress = explode('!',$pCoordinateString);
                        if (count($cellAddress) > 1) {
                                list($worksheet,$pCoordinateString) = $cellAddress;
                        }
                        if ($worksheet > '')    $worksheet .= '!';
 
                        // Create absolute coordinate
                        if (ctype_digit($pCoordinateString)) {
                                return $worksheet . '$' . $pCoordinateString;
                        } elseif (ctype_alpha($pCoordinateString)) {
                                return $worksheet . '$' . strtoupper($pCoordinateString);
                        }
                        return $worksheet . self::absoluteCoordinate($pCoordinateString);
                }
 
                throw new PHPExcel_Exception('Cell coordinate string can not be a range of cells');
        }

References $worksheet, and absoluteCoordinate().

Here is the call graph for this function:

◆ attach()

PHPExcel_Cell::attach ( PHPExcel_CachedObjectStorage_CacheBase $parent )

Definition at line 115 of file Cell.php.

                                                                               {
                $this->_parent = $parent;
        }

◆ buildRange()

static PHPExcel_Cell::buildRange ( $pRange )

static

Build range from coordinate strings.

Parameters

array $pRange Array containg one or more arrays containing one or two coordinate strings

Returns: string String representation of $pRange

Exceptions

PHPExcel_Exception

Definition at line 682 of file Cell.php.

        {
                // Verify range
                if (!is_array($pRange) || empty($pRange) || !is_array($pRange[0])) {
                        throw new PHPExcel_Exception('Range does not contain any information');
                }
 
                // Build range
                $imploded = array();
                $counter = count($pRange);
                for ($i = 0; $i < $counter; ++$i) {
                        $pRange[$i] = implode(':', $pRange[$i]);
                }
                $imploded = implode(',', $pRange);
 
                return $imploded;
        }

References $counter.

Referenced by PHPExcel_ReferenceHelper\_updateCellRange().

Here is the caller graph for this function:

◆ columnIndexFromString()

static PHPExcel_Cell::columnIndexFromString ( $pString = 'A' )

static

Column index from string.

Parameters

string $pString

Returns: int Column index (base 1 !!!)

Definition at line 782 of file Cell.php.

        {
                //      Using a lookup cache adds a slight memory overhead, but boosts speed
                //      caching using a static within the method is faster than a class static,
                //              though it's additional memory overhead
                static $_indexCache = array();
 
                if (isset($_indexCache[$pString]))
                        return $_indexCache[$pString];
 
                //      It's surprising how costly the strtoupper() and ord() calls actually are, so we use a lookup array rather than use ord()
                //              and make it case insensitive to get rid of the strtoupper() as well. Because it's a static, there's no significant
                //              memory overhead either
                static $_columnLookup = array(
                        'A' => 1, 'B' => 2, 'C' => 3, 'D' => 4, 'E' => 5, 'F' => 6, 'G' => 7, 'H' => 8, 'I' => 9, 'J' => 10, 'K' => 11, 'L' => 12, 'M' => 13,
                        'N' => 14, 'O' => 15, 'P' => 16, 'Q' => 17, 'R' => 18, 'S' => 19, 'T' => 20, 'U' => 21, 'V' => 22, 'W' => 23, 'X' => 24, 'Y' => 25, 'Z' => 26,
                        'a' => 1, 'b' => 2, 'c' => 3, 'd' => 4, 'e' => 5, 'f' => 6, 'g' => 7, 'h' => 8, 'i' => 9, 'j' => 10, 'k' => 11, 'l' => 12, 'm' => 13,
                        'n' => 14, 'o' => 15, 'p' => 16, 'q' => 17, 'r' => 18, 's' => 19, 't' => 20, 'u' => 21, 'v' => 22, 'w' => 23, 'x' => 24, 'y' => 25, 'z' => 26
                );
 
                //      We also use the language construct isset() rather than the more costly strlen() function to match the length of $pString
                //              for improved performance
                if (isset($pString{0})) {
                        if (!isset($pString{1})) {
                                $_indexCache[$pString] = $_columnLookup[$pString];
                                return $_indexCache[$pString];
                        } elseif(!isset($pString{2})) {
                                $_indexCache[$pString] = $_columnLookup[$pString{0}] * 26 + $_columnLookup[$pString{1}];
                                return $_indexCache[$pString];
                        } elseif(!isset($pString{3})) {
                                $_indexCache[$pString] = $_columnLookup[$pString{0}] * 676 + $_columnLookup[$pString{1}] * 26 + $_columnLookup[$pString{2}];
                                return $_indexCache[$pString];
                        }
                }
                throw new PHPExcel_Exception("Column string index can not be " . ((isset($pString{0})) ? "longer than 3 characters" : "empty"));
        }

Here is the caller graph for this function:

◆ compareCells()

static PHPExcel_Cell::compareCells	(	PHPExcel_Cell	$a,
		PHPExcel_Cell	$b
	)

static

Compare 2 cells.

Parameters

PHPExcel_Cell	$a	Cell a
PHPExcel_Cell	$b	Cell b

Returns: int Result of comparison (always -1 or 1, never zero!)

Definition at line 917 of file Cell.php.

        {
                if ($a->getRow() < $b->getRow()) {
                        return -1;
                } elseif ($a->getRow() > $b->getRow()) {
                        return 1;
                } elseif (self::columnIndexFromString($a->getColumn()) < self::columnIndexFromString($b->getColumn())) {
                        return -1;
                } else {
                        return 1;
                }
        }

References getColumn(), and getRow().

Here is the call graph for this function:

◆ coordinateFromString()

static PHPExcel_Cell::coordinateFromString ( $pCoordinateString = 'A1' )

static

Coordinate from string.

Parameters

string $pCoordinateString

Returns: array Array containing column and row (indexes 0 and 1)

Exceptions

PHPExcel_Exception

Definition at line 580 of file Cell.php.

        {
                if (preg_match("/^([$]?[A-Z]{1,3})([$]?\d{1,7})$/", $pCoordinateString, $matches)) {
                        return array($matches[1],$matches[2]);
                } elseif ((strpos($pCoordinateString,':') !== FALSE) || (strpos($pCoordinateString,',') !== FALSE)) {
                        throw new PHPExcel_Exception('Cell coordinate string can not be a range of cells');
                } elseif ($pCoordinateString == '') {
                        throw new PHPExcel_Exception('Cell coordinate can not be zero-length string');
                }
 
                throw new PHPExcel_Exception('Invalid cell coordinate '.$pCoordinateString);
        }

Here is the caller graph for this function:

◆ detach()

PHPExcel_Cell::detach ( )

Definition at line 111 of file Cell.php.

                                 {
                $this->_parent = NULL;
        }

◆ extractAllCellReferencesInRange()

static PHPExcel_Cell::extractAllCellReferencesInRange ( $pRange = 'A1' )

static

Extract all cell references in range.

Parameters

string $pRange Range (e.g. A1 or A1:C10 or A1:E10 A20:E25)

Returns: array Array containing single cell references

Definition at line 854 of file Cell.php.

                                                                               {
                // Returnvalue
                $returnValue = array();
 
                // Explode spaces
                $cellBlocks = explode(' ', str_replace('$', '', strtoupper($pRange)));
                foreach ($cellBlocks as $cellBlock) {
                        // Single cell?
                        if (strpos($cellBlock,':') === FALSE && strpos($cellBlock,',') === FALSE) {
                                $returnValue[] = $cellBlock;
                                continue;
                        }
 
                        // Range...
                        $ranges = self::splitRange($cellBlock);
                        foreach($ranges as $range) {
                                // Single cell?
                                if (!isset($range[1])) {
                                        $returnValue[] = $range[0];
                                        continue;
                                }
 
                                // Range...
                                list($rangeStart, $rangeEnd)    = $range;
                                sscanf($rangeStart,'%[A-Z]%d', $startCol, $startRow);
                                sscanf($rangeEnd,'%[A-Z]%d', $endCol, $endRow);
                                $endCol++;
 
                                // Current data
                                $currentCol     = $startCol;
                                $currentRow     = $startRow;
 
                                // Loop cells
                                while ($currentCol != $endCol) {
                                        while ($currentRow <= $endRow) {
                                                $returnValue[] = $currentCol.$currentRow;
                                                ++$currentRow;
                                        }
                                        ++$currentCol;
                                        $currentRow = $startRow;
                                }
                        }
                }
 
                //      Sort the result by column and row
                $sortKeys = array();
                foreach (array_unique($returnValue) as $coord) {
                        sscanf($coord,'%[A-Z]%d', $column, $row);
                        $sortKeys[sprintf('%3s%09d',$column,$row)] = $coord;
                }
                ksort($sortKeys);
 
                // Return value
                return array_values($sortKeys);
        }

References $column, $row, splitRange(), and sprintf.

Referenced by PHPExcel_Reader_HTML\_processDomElement(), PHPExcel_Reader_Excel5\_readDataValidation(), PHPExcel_Reader_Excel5\_readHyperLink(), PHPExcel_Worksheet\calculateColumnWidths(), PHPExcel_Calculation\extractCellRange(), PHPExcel_Calculation\extractNamedRange(), PHPExcel_Reader_Excel2007\load(), and PHPExcel_Worksheet\mergeCells().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCalculatedValue()

PHPExcel_Cell::getCalculatedValue ( $resetLog = TRUE )

Get calculated cell value.

Deprecated:: Since version 1.7.8 for planned changes to cell for array formula handling

Parameters

boolean $resetLog Whether the calculation engine logger should be reset or not

Returns: mixed

Exceptions

PHPExcel_Exception

Definition at line 270 of file Cell.php.

        {
//echo 'Cell '.$this->getCoordinate().' value is a '.$this->_dataType.' with a value of '.$this->getValue().PHP_EOL;
                if ($this->_dataType == PHPExcel_Cell_DataType::TYPE_FORMULA) {
                        try {
//echo 'Cell value for '.$this->getCoordinate().' is a formula: Calculating value'.PHP_EOL;
                                $result = PHPExcel_Calculation::getInstance(
                                        $this->getWorksheet()->getParent()
                                )->calculateCellValue($this,$resetLog);
//echo $this->getCoordinate().' calculation result is '.$result.PHP_EOL;
                                //      We don't yet handle array returns
                                if (is_array($result)) {
                                        while (is_array($result)) {
                                                $result = array_pop($result);
                                        }
                                }
                        } catch ( PHPExcel_Exception $ex ) {
                                if (($ex->getMessage() === 'Unable to access External Workbook') && ($this->_calculatedValue !== NULL)) {
//echo 'Returning fallback value of '.$this->_calculatedValue.' for cell '.$this->getCoordinate().PHP_EOL;
                                        return $this->_calculatedValue; // Fallback for calculations referencing external files.
                                }
//echo 'Calculation Exception: '.$ex->getMessage().PHP_EOL;
                                $result = '#N/A';
                                throw new PHPExcel_Calculation_Exception(
                                        $this->getWorksheet()->getTitle().'!'.$this->getCoordinate().' -> '.$ex->getMessage()
                                );
                        }
 
                        if ($result === '#Not Yet Implemented') {
//echo 'Returning fallback value of '.$this->_calculatedValue.' for cell '.$this->getCoordinate().PHP_EOL;
                                return $this->_calculatedValue; // Fallback if calculation engine does not support the formula.
                        }
//echo 'Returning calculated value of '.$result.' for cell '.$this->getCoordinate().PHP_EOL;
                        return $result;
                } elseif($this->_value instanceof PHPExcel_RichText) {
//              echo 'Cell value for '.$this->getCoordinate().' is rich text: Returning data value of '.$this->_value.'<br />';
                        return $this->_value->getPlainText();
                }
//              echo 'Cell value for '.$this->getCoordinate().' is not a formula: Returning data value of '.$this->_value.'<br />';
                return $this->_value;
        }

References $_calculatedValue, $_value, $result, getCoordinate(), PHPExcel_Calculation\getInstance(), getParent(), getWorksheet(), and PHPExcel_Cell_DataType\TYPE_FORMULA.

Referenced by getFormattedValue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getColumn()

PHPExcel_Cell::getColumn ( )

Get cell coordinate column.

Returns: string

Definition at line 151 of file Cell.php.

        {
                return $this->_parent->getCurrentColumn();
        }

Referenced by compareCells(), and isInRange().

Here is the caller graph for this function:

◆ getCoordinate()

PHPExcel_Cell::getCoordinate ( )

Get cell coordinate.

Returns: string

Definition at line 171 of file Cell.php.

        {
                return $this->_parent->getCurrentAddress();
        }

Referenced by PHPExcel_Cell_AdvancedValueBinder\bindValue(), getCalculatedValue(), getDataValidation(), getHyperlink(), getStyle(), hasDataValidation(), hasHyperlink(), PHPExcel_Shared_Date\isDateTime(), isMergeRangeValueCell(), setDataValidation(), setHyperlink(), PHPExcel_CachedObjectStorage_CacheBase\updateCacheData(), and PHPExcel_Writer_OpenDocument_Cell_Comment\write().

Here is the caller graph for this function:

◆ getDataType()

PHPExcel_Cell::getDataType ( )

Get cell data type.

Returns: string

Definition at line 347 of file Cell.php.

        {
                return $this->_dataType;
        }

References $_dataType.

◆ getDataValidation()

PHPExcel_Cell::getDataValidation ( )

Get Data validation rules.

Returns: PHPExcel_Cell_DataValidation

Exceptions

PHPExcel_Exception

Definition at line 399 of file Cell.php.

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

References getCoordinate(), and getWorksheet().

Here is the call graph for this function:

◆ getFormattedValue()

PHPExcel_Cell::getFormattedValue ( )

Get cell value with formatting.

Returns: string

Definition at line 191 of file Cell.php.

        {
                return (string) PHPExcel_Style_NumberFormat::toFormattedString(
                                $this->getCalculatedValue(),
                                $this->getStyle()
                                        ->getNumberFormat()->getFormatCode()
                        );
        }

References getCalculatedValue(), getStyle(), and PHPExcel_Style_NumberFormat\toFormattedString().

Here is the call graph for this function:

◆ getFormulaAttributes()

PHPExcel_Cell::getFormulaAttributes ( )

Deprecated:: Since version 1.7.8 for planned changes to cell for array formula handling

Definition at line 1006 of file Cell.php.

        {
                return $this->_formulaAttributes;
        }

References $_formulaAttributes.

◆ getHyperlink()

PHPExcel_Cell::getHyperlink ( )

Get Hyperlink.

Returns: PHPExcel_Cell_Hyperlink

Exceptions

PHPExcel_Exception

Definition at line 447 of file Cell.php.

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

References getCoordinate(), and getWorksheet().

Here is the call graph for this function:

◆ getMergeRange()

PHPExcel_Cell::getMergeRange ( )

If this cell is in a merge range, then return the range.

Returns: string

Definition at line 522 of file Cell.php.

                                    {
        foreach($this->getWorksheet()->getMergeCells() as $mergeRange) {
            if ($this->isInRange($mergeRange)) {
                return $mergeRange;
            }
        }
        return false;
    }

References getWorksheet(), and isInRange().

Referenced by isInMergeRange(), and isMergeRangeValueCell().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getOldCalculatedValue()

PHPExcel_Cell::getOldCalculatedValue ( )

Get old calculated value (cached) This returns the value last calculated by MS Excel or whichever spreadsheet program was used to create the original spreadsheet file.

Note that this value is not guaranteed to refelect the actual calculated value because it is possible that auto-calculation was disabled in the original spreadsheet, and underlying data values used by the formula have changed since it was last calculated.

Returns: mixed

Definition at line 337 of file Cell.php.

        {
                return $this->_calculatedValue;
        }

References $_calculatedValue.

◆ getParent()

PHPExcel_Cell::getParent ( )

Get parent worksheet.

Returns: PHPExcel_CachedObjectStorage_CacheBase

Definition at line 479 of file Cell.php.

                                    {
                return $this->_parent;
        }

References $_parent.

Referenced by getCalculatedValue().

Here is the caller graph for this function:

◆ getRangeBoundaries()

static PHPExcel_Cell::getRangeBoundaries ( $pRange = 'A1:A1' )

static

Calculate range boundaries.

Parameters

string $pRange Cell range (e.g. A1:A1)

Returns: array Range coordinates array(Start Cell, End Cell) where Start Cell and End Cell are arrays (Column ID, Row Number)

Definition at line 756 of file Cell.php.

                                                               :A1')
        {
                // Ensure $pRange is a valid range
                if(empty($pRange)) {
                        $pRange = self::DEFAULT_RANGE;
                }
 
                // Uppercase coordinate
                $pRange = strtoupper($pRange);
 
                // Extract range
                if (strpos($pRange, ':') === FALSE) {
                        $rangeA = $rangeB = $pRange;
                } else {
                        list($rangeA, $rangeB) = explode(':', $pRange);
                }
 
                return array( self::coordinateFromString($rangeA), self::coordinateFromString($rangeB));
        }

References DEFAULT_RANGE.

Referenced by PHPExcel_Reader_Excel5\_includeCellRangeFiltered(), and PHPExcel_Worksheet\shrinkRangeToFit().

Here is the caller graph for this function:

◆ getRow()

PHPExcel_Cell::getRow ( )

Get cell coordinate row.

Returns: int

Definition at line 161 of file Cell.php.

        {
                return $this->_parent->getCurrentRow();
        }

Referenced by compareCells(), and isInRange().

Here is the caller graph for this function:

◆ getStyle()

PHPExcel_Cell::getStyle ( )

Get cell style.

Returns: PHPExcel_Style

Definition at line 536 of file Cell.php.

        {
                return $this->getWorksheet()->getStyle($this->getCoordinate());
        }

References getCoordinate(), and getWorksheet().

Referenced by getFormattedValue(), and ilExcel\setDateFormat().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getValue()

PHPExcel_Cell::getValue ( )

Get cell value.

Returns: mixed

Definition at line 181 of file Cell.php.

        {
                return $this->_value;
        }

References $_value.

Referenced by __toString().

Here is the caller graph for this function:

◆ getValueBinder()

static PHPExcel_Cell::getValueBinder ( )

static

Get value binder to use.

Returns: PHPExcel_Cell_IValueBinder

Definition at line 935 of file Cell.php.

                                                {
                if (self::$_valueBinder === NULL) {
                        self::$_valueBinder = new PHPExcel_Cell_DefaultValueBinder();
                }
 
                return self::$_valueBinder;
        }

References $_valueBinder.

◆ getWorksheet()

PHPExcel_Cell::getWorksheet ( )

Get parent worksheet.

Returns: PHPExcel_Worksheet

Definition at line 488 of file Cell.php.

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

Referenced by PHPExcel_Cell_AdvancedValueBinder\bindValue(), getCalculatedValue(), getDataValidation(), getHyperlink(), getMergeRange(), getStyle(), hasDataValidation(), hasHyperlink(), PHPExcel_Shared_Date\isDateTime(), setDataValidation(), setHyperlink(), and PHPExcel_Writer_OpenDocument_Cell_Comment\write().

Here is the caller graph for this function:

◆ getXfIndex()

PHPExcel_Cell::getXfIndex ( )

Get index to cellXf.

Returns: int

Definition at line 976 of file Cell.php.

        {
                return $this->_xfIndex;
        }

References $_xfIndex.

◆ hasDataValidation()

PHPExcel_Cell::hasDataValidation ( )

Does this cell contain Data validation rules?

Returns: boolean

Exceptions

PHPExcel_Exception

Definition at line 384 of file Cell.php.

        {
                if (!isset($this->_parent)) {
                        throw new PHPExcel_Exception('Cannot check for data validation when cell is not bound to a worksheet');
                }
 
                return $this->getWorksheet()->dataValidationExists($this->getCoordinate());
        }

References getCoordinate(), and getWorksheet().

Here is the call graph for this function:

◆ hasHyperlink()

PHPExcel_Cell::hasHyperlink ( )

Does this cell contain a Hyperlink?

Returns: boolean

Exceptions

PHPExcel_Exception

Definition at line 432 of file Cell.php.

        {
                if (!isset($this->_parent)) {
                        throw new PHPExcel_Exception('Cannot check for hyperlink when cell is not bound to a worksheet');
                }
 
                return $this->getWorksheet()->hyperlinkExists($this->getCoordinate());
        }

References getCoordinate(), and getWorksheet().

Here is the call graph for this function:

◆ isFormula()

PHPExcel_Cell::isFormula ( )

Identify if the cell contains a formula.

Returns: boolean

Definition at line 373 of file Cell.php.

    {
        return $this->_dataType == PHPExcel_Cell_DataType::TYPE_FORMULA;
    }

References PHPExcel_Cell_DataType\TYPE_FORMULA.

◆ isInMergeRange()

PHPExcel_Cell::isInMergeRange ( )

Is this cell in a merge range.

Returns: boolean

Definition at line 497 of file Cell.php.

                                     {
        return (boolean) $this->getMergeRange();
    }

References getMergeRange().

Here is the call graph for this function:

◆ isInRange()

PHPExcel_Cell::isInRange ( $pRange = 'A1:A1' )

Is cell in a specific range?

Parameters

string $pRange Cell range (e.g. A1:A1)

Returns: boolean

Definition at line 559 of file Cell.php.

                                               :A1')
        {
                list($rangeStart,$rangeEnd) = self::rangeBoundaries($pRange);
 
                // Translate properties
                $myColumn       = self::columnIndexFromString($this->getColumn());
                $myRow          = $this->getRow();
 
                // Verify if cell is in range
                return (($rangeStart[0] <= $myColumn) && ($rangeEnd[0] >= $myColumn) &&
                                ($rangeStart[1] <= $myRow) && ($rangeEnd[1] >= $myRow)
                           );
        }

References columnIndexFromString(), getColumn(), getRow(), and rangeBoundaries().

Referenced by getMergeRange().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isMergeRangeValueCell()

PHPExcel_Cell::isMergeRangeValueCell ( )

Is this cell the master (top left cell) in a merge range (that holds the actual data value)

Returns: boolean

Definition at line 506 of file Cell.php.

                                            {
        if ($mergeRange = $this->getMergeRange()) {
            $mergeRange = PHPExcel_Cell::splitRange($mergeRange);
            list($startCell) = $mergeRange[0];
            if ($this->getCoordinate() === $startCell) {
                return true;
            }
        }
        return false;
    }

References getCoordinate(), getMergeRange(), and splitRange().

Here is the call graph for this function:

◆ notifyCacheController()

PHPExcel_Cell::notifyCacheController ( )

Send notification to the cache controller.

Returns: void

Definition at line 105 of file Cell.php.

                                                {
                $this->_parent->updateCacheData($this);
 
                return $this;
        }

Referenced by rebindParent(), setCalculatedValue(), setDataType(), setDataValidation(), setHyperlink(), setValueExplicit(), and setXfIndex().

Here is the caller graph for this function:

◆ rangeBoundaries()

static PHPExcel_Cell::rangeBoundaries ( $pRange = 'A1:A1' )

static

Calculate range boundaries.

Parameters

string $pRange Cell range (e.g. A1:A1)

Returns: array Range coordinates array(Start Cell, End Cell) where Start Cell and End Cell are arrays (Column Number, Row Number)

Definition at line 707 of file Cell.php.

                                                            :A1')
        {
                // Ensure $pRange is a valid range
                if(empty($pRange)) {
                        $pRange = self::DEFAULT_RANGE;
                }
 
                // Uppercase coordinate
                $pRange = strtoupper($pRange);
 
                // Extract range
                if (strpos($pRange, ':') === FALSE) {
                        $rangeA = $rangeB = $pRange;
                } else {
                        list($rangeA, $rangeB) = explode(':', $pRange);
                }
 
                // Calculate range outer borders
                $rangeStart = self::coordinateFromString($rangeA);
                $rangeEnd       = self::coordinateFromString($rangeB);
 
                // Translate column into index
                $rangeStart[0]  = self::columnIndexFromString($rangeStart[0]);
                $rangeEnd[0]    = self::columnIndexFromString($rangeEnd[0]);
 
                return array($rangeStart, $rangeEnd);
        }

References columnIndexFromString(), coordinateFromString(), and DEFAULT_RANGE.

Referenced by PHPExcel_Writer_Excel5\_buildWorksheetEschers(), PHPExcel_Writer_Excel5_Worksheet\_writeAutoFilterInfo(), PHPExcel_Worksheet\duplicateConditionalStyle(), PHPExcel_Worksheet\duplicateStyle(), PHPExcel_Worksheet_AutoFilter\getColumnByOffset(), PHPExcel_ReferenceHelper\insertNewBefore(), isInRange(), rangeDimension(), PHPExcel_Worksheet\rangeToArray(), PHPExcel_Worksheet_AutoFilter\setRange(), PHPExcel_Worksheet_AutoFilter\showHideRows(), and PHPExcel_Worksheet_AutoFilter\testColumnInRange().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rangeDimension()

static PHPExcel_Cell::rangeDimension ( $pRange = 'A1:A1' )

static

Calculate range dimension.

Parameters

string $pRange Cell range (e.g. A1:A1)

Returns: array Range dimension (width, height)

Definition at line 741 of file Cell.php.

                                                           :A1')
        {
                // Calculate range outer borders
                list($rangeStart,$rangeEnd) = self::rangeBoundaries($pRange);
 
                return array( ($rangeEnd[0] - $rangeStart[0] + 1), ($rangeEnd[1] - $rangeStart[1] + 1) );
        }

References rangeBoundaries().

Referenced by PHPExcel_Chart_DataSeriesValues\refresh().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rebindParent()

PHPExcel_Cell::rebindParent ( PHPExcel_Worksheet $parent )

Re-bind parent.

Parameters

PHPExcel_Worksheet $parent

Returns: PHPExcel_Cell

Definition at line 547 of file Cell.php.

                                                                 {
                $this->_parent = $parent->getCellCacheController();
 
                return $this->notifyCacheController();
        }

References PHPExcel_Worksheet\getCellCacheController(), and notifyCacheController().

Here is the call graph for this function:

◆ setCalculatedValue()

PHPExcel_Cell::setCalculatedValue ( $pValue = NULL )

Set old calculated value (cached)

Parameters

mixed $pValue Value

Returns: PHPExcel_Cell

Definition at line 318 of file Cell.php.

        {
                if ($pValue !== NULL) {
                        $this->_calculatedValue = (is_numeric($pValue)) ? (float) $pValue : $pValue;
                }
 
                return $this->notifyCacheController();
        }

References notifyCacheController().

Here is the call graph for this function:

◆ setDataType()

PHPExcel_Cell::setDataType ( $pDataType = PHPExcel_Cell_DataType::TYPE_STRING )

Set cell data type.

Parameters

string $pDataType

Returns: PHPExcel_Cell

Definition at line 358 of file Cell.php.

        {
                if ($pDataType == PHPExcel_Cell_DataType::TYPE_STRING2)
                        $pDataType = PHPExcel_Cell_DataType::TYPE_STRING;
 
                $this->_dataType = $pDataType;
 
                return $this->notifyCacheController();
        }

References notifyCacheController(), PHPExcel_Cell_DataType\TYPE_STRING, and PHPExcel_Cell_DataType\TYPE_STRING2.

Here is the call graph for this function:

◆ setDataValidation()

PHPExcel_Cell::setDataValidation ( PHPExcel_Cell_DataValidation $pDataValidation = NULL )

Set Data validation rules.

Parameters

PHPExcel_Cell_DataValidation $pDataValidation

Returns: PHPExcel_Cell

Exceptions

PHPExcel_Exception

Definition at line 415 of file Cell.php.

        {
                if (!isset($this->_parent)) {
                        throw new PHPExcel_Exception('Cannot set data validation for cell that is not bound to a worksheet');
                }
 
                $this->getWorksheet()->setDataValidation($this->getCoordinate(), $pDataValidation);
 
                return $this->notifyCacheController();
        }

References getCoordinate(), getWorksheet(), and notifyCacheController().

Here is the call graph for this function:

◆ setFormulaAttributes()

PHPExcel_Cell::setFormulaAttributes ( $pAttributes )

Deprecated:: Since version 1.7.8 for planned changes to cell for array formula handling

Definition at line 997 of file Cell.php.

        {
                $this->_formulaAttributes = $pAttributes;
                return $this;
        }

◆ setHyperlink()

PHPExcel_Cell::setHyperlink ( PHPExcel_Cell_Hyperlink $pHyperlink = NULL )

Set Hyperlink.

Parameters

PHPExcel_Cell_Hyperlink $pHyperlink

Returns: PHPExcel_Cell

Exceptions

PHPExcel_Exception

Definition at line 463 of file Cell.php.

        {
                if (!isset($this->_parent)) {
                        throw new PHPExcel_Exception('Cannot set hyperlink for cell that is not bound to a worksheet');
                }
 
                $this->getWorksheet()->setHyperlink($this->getCoordinate(), $pHyperlink);
 
                return $this->notifyCacheController();
        }

References getCoordinate(), getWorksheet(), and notifyCacheController().

Here is the call graph for this function:

◆ setValue()

PHPExcel_Cell::setValue ( $pValue = NULL )

Set cell value.

Sets the value for a cell, automatically determining the datatype using the value binder

Parameters

mixed $pValue Value

Returns: PHPExcel_Cell

Exceptions

PHPExcel_Exception

Definition at line 209 of file Cell.php.

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

◆ setValueBinder()

static PHPExcel_Cell::setValueBinder ( PHPExcel_Cell_IValueBinder $binder = NULL )

static

Set value binder to use.

Parameters

PHPExcel_Cell_IValueBinder $binder

Exceptions

PHPExcel_Exception

Definition at line 949 of file Cell.php.

                                                                                         {
                if ($binder === NULL) {
                        throw new PHPExcel_Exception("A PHPExcel_Cell_IValueBinder is required for PHPExcel to function correctly.");
                }
 
                self::$_valueBinder = $binder;
        }

◆ setValueExplicit()

PHPExcel_Cell::setValueExplicit	(	$pValue = `NULL`,
		$pDataType = `PHPExcel_Cell_DataType::TYPE_STRING`
	)

Set the value for a cell, with the explicit data type passed to the method (bypassing any use of the value binder)

Parameters

mixed	$pValue	Value
string	$pDataType	Explicit data type

Returns: PHPExcel_Cell

Exceptions

PHPExcel_Exception

Definition at line 225 of file Cell.php.

        {
                // set the value according to data type
                switch ($pDataType) {
                        case PHPExcel_Cell_DataType::TYPE_NULL:
                                $this->_value = $pValue;
                                break;
                        case PHPExcel_Cell_DataType::TYPE_STRING2:
                                $pDataType = PHPExcel_Cell_DataType::TYPE_STRING;
                        case PHPExcel_Cell_DataType::TYPE_STRING:
                        case PHPExcel_Cell_DataType::TYPE_INLINE:
                                $this->_value = PHPExcel_Cell_DataType::checkString($pValue);
                                break;
                        case PHPExcel_Cell_DataType::TYPE_NUMERIC:
                                $this->_value = (float)$pValue;
                                break;
                        case PHPExcel_Cell_DataType::TYPE_FORMULA:
                                $this->_value = (string)$pValue;
                                break;
                        case PHPExcel_Cell_DataType::TYPE_BOOL:
                                $this->_value = (bool)$pValue;
                                break;
                        case PHPExcel_Cell_DataType::TYPE_ERROR:
                                $this->_value = PHPExcel_Cell_DataType::checkErrorCode($pValue);
                                break;
                        default:
                                throw new PHPExcel_Exception('Invalid datatype: ' . $pDataType);
                                break;
                }
 
                // set the datatype
                $this->_dataType = $pDataType;
 
                return $this->notifyCacheController();
        }

References PHPExcel_Cell_DataType\checkErrorCode(), PHPExcel_Cell_DataType\checkString(), notifyCacheController(), PHPExcel_Cell_DataType\TYPE_BOOL, PHPExcel_Cell_DataType\TYPE_ERROR, PHPExcel_Cell_DataType\TYPE_FORMULA, PHPExcel_Cell_DataType\TYPE_INLINE, PHPExcel_Cell_DataType\TYPE_NULL, PHPExcel_Cell_DataType\TYPE_NUMERIC, PHPExcel_Cell_DataType\TYPE_STRING, and PHPExcel_Cell_DataType\TYPE_STRING2.

Referenced by PHPExcel_Cell_AdvancedValueBinder\bindValue(), and PHPExcel_Cell_DefaultValueBinder\bindValue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setXfIndex()

PHPExcel_Cell::setXfIndex ( $pValue = 0 )

Set index to cellXf.

Parameters

int $pValue

Returns: PHPExcel_Cell

Definition at line 987 of file Cell.php.

        {
                $this->_xfIndex = $pValue;
 
                return $this->notifyCacheController();
        }

References notifyCacheController().

Here is the call graph for this function:

◆ splitRange()

static PHPExcel_Cell::splitRange ( $pRange = 'A1:A1' )

static

Split range into coordinate strings.

Parameters

string $pRange e.g. 'B4:D9' or 'B4:D9,H2:O11' or 'B4'

Returns: array Array containg one or more arrays containing one or two coordinate strings e.g. array('B4','D9') or array(array('B4','D9'),array('H2','O11')) or array('B4')

Definition at line 660 of file Cell.php.

                                                       :A1')
        {
                // Ensure $pRange is a valid range
                if(empty($pRange)) {
                        $pRange = self::DEFAULT_RANGE;
                }
 
                $exploded = explode(',', $pRange);
                $counter = count($exploded);
                for ($i = 0; $i < $counter; ++$i) {
                        $exploded[$i] = explode(':', $exploded[$i]);
                }
                return $exploded;
        }

References $counter, and DEFAULT_RANGE.

Referenced by PHPExcel_Writer_HTML\_calculateSpans(), PHPExcel_ReferenceHelper\_updateCellRange(), PHPExcel_Writer_Excel5_Workbook\_writeAllDefinedNamesBiff8(), PHPExcel_Writer_Excel2007_Worksheet\_writeAutoFilter(), PHPExcel_Writer_Excel2007_Workbook\_writeDefinedNameForNamedRange(), PHPExcel_Writer_Excel5_Worksheet\_writeMergedCells(), PHPExcel_Writer_Excel5_Workbook\_writeNames(), PHPExcel_Writer_Excel5_Worksheet\_writeSelection(), extractAllCellReferencesInRange(), PHPExcel_Calculation\extractNamedRange(), isMergeRangeValueCell(), and PHPExcel_Worksheet\setSelectedCells().

Here is the caller graph for this function:

◆ stringFromColumnIndex()

static PHPExcel_Cell::stringFromColumnIndex ( $pColumnIndex = 0 )

static

String from columnindex.

Parameters

int $pColumnIndex Column index (base 0 !!!)

Returns: string

Definition at line 825 of file Cell.php.

        {
                //      Using a lookup cache adds a slight memory overhead, but boosts speed
                //      caching using a static within the method is faster than a class static,
                //              though it's additional memory overhead
                static $_indexCache = array();
 
                if (!isset($_indexCache[$pColumnIndex])) {
                        // Determine column string
                        if ($pColumnIndex < 26) {
                                $_indexCache[$pColumnIndex] = chr(65 + $pColumnIndex);
                        } elseif ($pColumnIndex < 702) {
                                $_indexCache[$pColumnIndex] = chr(64 + ($pColumnIndex / 26)) .
                                                                                          chr(65 + $pColumnIndex % 26);
                        } else {
                                $_indexCache[$pColumnIndex] = chr(64 + (($pColumnIndex - 26) / 676)) .
                                                                                          chr(65 + ((($pColumnIndex - 26) % 676) / 26)) .
                                                                                          chr(65 + $pColumnIndex % 26);
                        }
                }
                return $_indexCache[$pColumnIndex];
        }

Here is the caller graph for this function:

Field Documentation

◆ $_calculatedValue

PHPExcel_Cell::$_calculatedValue = NULL

private

Definition at line 70 of file Cell.php.

Referenced by getCalculatedValue(), and getOldCalculatedValue().

◆ $_dataType

PHPExcel_Cell::$_dataType

private

Definition at line 77 of file Cell.php.

Referenced by getDataType().

◆ $_formulaAttributes

PHPExcel_Cell::$_formulaAttributes

private

Attributes of the formula.

Definition at line 97 of file Cell.php.

Referenced by getFormulaAttributes().

◆ $_parent

PHPExcel_Cell::$_parent

private

Definition at line 84 of file Cell.php.

Referenced by getParent().

◆ $_value

PHPExcel_Cell::$_value

private

Definition at line 58 of file Cell.php.

Referenced by getCalculatedValue(), and getValue().

◆ $_valueBinder

PHPExcel_Cell::$_valueBinder = NULL

staticprivate

Definition at line 51 of file Cell.php.

Referenced by getValueBinder().

◆ $_xfIndex

PHPExcel_Cell::$_xfIndex = 0

private

Definition at line 91 of file Cell.php.

Referenced by getXfIndex().

◆ DEFAULT_RANGE

const PHPExcel_Cell::DEFAULT_RANGE = 'A1:A1'

Definition at line 44 of file Cell.php.

Referenced by getRangeBoundaries(), rangeBoundaries(), and splitRange().

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

libs/composer/vendor/phpoffice/phpexcel/Classes/PHPExcel/Cell.php

Public Member Functions

Static Public Member Functions

Data Fields

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __clone()

◆ __toString()

◆ absoluteCoordinate()

◆ absoluteReference()

◆ attach()

◆ buildRange()

◆ columnIndexFromString()

◆ compareCells()

◆ coordinateFromString()

◆ detach()

◆ extractAllCellReferencesInRange()

◆ getCalculatedValue()

◆ getColumn()

◆ getCoordinate()

◆ getDataType()

◆ getDataValidation()

◆ getFormattedValue()

◆ getFormulaAttributes()

◆ getHyperlink()

◆ getMergeRange()

◆ getOldCalculatedValue()

◆ getParent()

◆ getRangeBoundaries()

◆ getRow()

◆ getStyle()

◆ getValue()

◆ getValueBinder()

◆ getWorksheet()

◆ getXfIndex()

◆ hasDataValidation()

◆ hasHyperlink()

◆ isFormula()

◆ isInMergeRange()

◆ isInRange()

◆ isMergeRangeValueCell()

◆ notifyCacheController()

◆ rangeBoundaries()

◆ rangeDimension()

◆ rebindParent()

◆ setCalculatedValue()

◆ setDataType()

◆ setDataValidation()

◆ setFormulaAttributes()

◆ setHyperlink()

◆ setValue()

◆ setValueBinder()

◆ setValueExplicit()

◆ setXfIndex()

◆ splitRange()

◆ stringFromColumnIndex()

Field Documentation

◆ $_calculatedValue

◆ $_dataType

◆ $_formulaAttributes

◆ $_parent

◆ $_value

◆ $_valueBinder

◆ $_xfIndex

◆ DEFAULT_RANGE