Collaboration diagram for PhpOffice\PhpSpreadsheet\Cell\Cell:

Public Member Functions
	updateInCollection ()
	Update the cell into the cell collection. More...

	detach ()

	attach (Cells $parent)

	__construct ($pValue, $pDataType, Worksheet $pSheet)
	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)
	Set cell value. More...

	setValueExplicit ($pValue, $pDataType)
	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)
	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)
	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 (?DataValidation $pDataValidation=null)
	Set Data validation rules. More...

	hasValidValue ()
	Does this cell contain valid value? More...

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

	getHyperlink ()
	Get Hyperlink. More...

	setHyperlink (?Hyperlink $pHyperlink=null)
	Set Hyperlink. More...

	getParent ()
	Get cell collection. 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 (Worksheet $parent)
	Re-bind parent. More...

	isInRange ($pRange)
	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)
	Set index to cellXf. More...

	setFormulaAttributes ($pAttributes)
	Set the formula attributes. More...

	getFormulaAttributes ()
	Get the formula attributes. More...

	__toString ()
	Convert to string. More...

Static Public Member Functions
static	compareCells (self $a, self $b)
	Compare 2 cells. More...

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

static	setValueBinder (IValueBinder $binder)
	Set value binder to use. More...

Private Attributes
	$value

	$calculatedValue

	$dataType

	$parent

	$xfIndex = 0

	$formulaAttributes
	Attributes of the formula. More...

Static Private Attributes
static	$valueBinder

Detailed Description

Definition at line 13 of file Cell.php.

Constructor & Destructor Documentation

◆ __construct()

PhpOffice\PhpSpreadsheet\Cell\Cell::__construct	(		$pValue,
			$pDataType,
		Worksheet	$pSheet
	)

Create a new Cell.

Parameters

mixed	$pValue
string	$pDataType

Definition at line 96 of file Cell.php.

    {
        // Initialise cell value
        $this->value = $pValue;
 
        // Set worksheet cache
        $this->parent = $pSheet->getCellCollection();
 
        // Set datatype?
        if ($pDataType !== null) {
            if ($pDataType == DataType::TYPE_STRING2) {
                $pDataType = DataType::TYPE_STRING;
            }
            $this->dataType = $pDataType;
        } elseif (!self::getValueBinder()->bindValue($this, $pValue)) {
            throw new Exception('Value could not be bound to cell.');
        }
    }

References PhpOffice\PhpSpreadsheet\Cell\DataType\TYPE_STRING, and PhpOffice\PhpSpreadsheet\Cell\DataType\TYPE_STRING2.

Member Function Documentation

◆ __clone()

PhpOffice\PhpSpreadsheet\Cell\Cell::__clone ( )

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

Definition at line 616 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;
            }
        }
    }

References $key, and PhpOffice\PhpSpreadsheet\Cell\Cell\$value.

◆ __toString()

PhpOffice\PhpSpreadsheet\Cell\Cell::__toString ( )

Convert to string.

Returns: string

Definition at line 679 of file Cell.php.

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

References PhpOffice\PhpSpreadsheet\Cell\Cell\getValue().

Here is the call graph for this function:

◆ attach()

PhpOffice\PhpSpreadsheet\Cell\Cell::attach ( Cells $parent )

Definition at line 85 of file Cell.php.

                                         : void
    {
        $this->parent = $parent;
    }

References PhpOffice\PhpSpreadsheet\Cell\Cell\$parent.

◆ compareCells()

static PhpOffice\PhpSpreadsheet\Cell\Cell::compareCells	(	self	$a,
		self	$b
	)

static

Compare 2 cells.

Parameters

Cell	$a	Cell a
Cell	$b	Cell b

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

Definition at line 578 of file Cell.php.

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

References PhpOffice\PhpSpreadsheet\Cell\Coordinate\columnIndexFromString().

Here is the call graph for this function:

◆ detach()

PhpOffice\PhpSpreadsheet\Cell\Cell::detach ( )

Definition at line 79 of file Cell.php.

                            : void
    {
        // @phpstan-ignore-next-line
        $this->parent = null;
    }

◆ getCalculatedValue()

PhpOffice\PhpSpreadsheet\Cell\Cell::getCalculatedValue ( $resetLog = true )

Get calculated cell value.

Parameters

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

Returns: mixed

Definition at line 251 of file Cell.php.

    {
        if ($this->dataType == DataType::TYPE_FORMULA) {
            try {
                $index = $this->getWorksheet()->getParent()->getActiveSheetIndex();
                $selected = $this->getWorksheet()->getSelectedCells();
                $result = Calculation::getInstance(
                    $this->getWorksheet()->getParent()
                )->calculateCellValue($this, $resetLog);
                $this->getWorksheet()->setSelectedCells($selected);
                $this->getWorksheet()->getParent()->setActiveSheetIndex($index);
                //    We don't yet handle array returns
                if (is_array($result)) {
                    while (is_array($result)) {
                        $result = array_shift($result);
                    }
                }
            } catch (Exception $ex) {
                if (($ex->getMessage() === 'Unable to access External Workbook') && ($this->calculatedValue !== null)) {
                    return $this->calculatedValue; // Fallback for calculations referencing external files.
                } elseif (preg_match('/[Uu]ndefined (name|offset: 2|array key 2)/', $ex->getMessage()) === 1) {
                    return \PhpOffice\PhpSpreadsheet\Calculation\Functions::NAME();
                }
 
                throw new \PhpOffice\PhpSpreadsheet\Calculation\Exception(
                    $this->getWorksheet()->getTitle() . '!' . $this->getCoordinate() . ' -> ' . $ex->getMessage()
                );
            }
 
            if ($result === '#Not Yet Implemented') {
                return $this->calculatedValue; // Fallback if calculation engine does not support the formula.
            }
 
            return $result;
        } elseif ($this->value instanceof RichText) {
            return $this->value->getPlainText();
        }
 
        return $this->value;
    }

References PhpOffice\PhpSpreadsheet\Cell\Cell\$calculatedValue, $index, $result, PhpOffice\PhpSpreadsheet\Cell\Cell\$value, PhpOffice\PhpSpreadsheet\Cell\Cell\getCoordinate(), PhpOffice\PhpSpreadsheet\Calculation\Calculation\getInstance(), PhpOffice\PhpSpreadsheet\Cell\Cell\getParent(), PhpOffice\PhpSpreadsheet\Cell\Cell\getWorksheet(), and PhpOffice\PhpSpreadsheet\Cell\DataType\TYPE_FORMULA.

Referenced by PhpOffice\PhpSpreadsheet\Cell\Cell\getFormattedValue(), PhpOffice\PhpSpreadsheet\Shared\Date\isDateTime(), and PhpOffice\PhpSpreadsheet\Writer\Xlsx\Worksheet\writeCellFormula().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getColumn()

PhpOffice\PhpSpreadsheet\Cell\Cell::getColumn ( )

Get cell coordinate column.

Returns: string

Definition at line 120 of file Cell.php.

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

Referenced by PhpOffice\PhpSpreadsheet\Calculation\LookupRef\RowColumnInformation\cellColumn(), PhpOffice\PhpSpreadsheet\Calculation\Calculation\evaluateDefinedName(), and PhpOffice\PhpSpreadsheet\Cell\Cell\isInRange().

Here is the caller graph for this function:

◆ getCoordinate()

PhpOffice\PhpSpreadsheet\Cell\Cell::getCoordinate ( )

Get cell coordinate.

Returns: string

Definition at line 140 of file Cell.php.

    {
        return $this->parent->getCurrentCoordinate();
    }

Here is the caller graph for this function:

◆ getDataType()

PhpOffice\PhpSpreadsheet\Cell\Cell::getDataType ( )

Get cell data type.

Returns: string

Definition at line 328 of file Cell.php.

    {
        return $this->dataType;
    }

References PhpOffice\PhpSpreadsheet\Cell\Cell\$dataType.

◆ getDataValidation()

PhpOffice\PhpSpreadsheet\Cell\Cell::getDataValidation ( )

Get Data validation rules.

Returns: DataValidation

Definition at line 379 of file Cell.php.

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

References PhpOffice\PhpSpreadsheet\Cell\Cell\getCoordinate(), and PhpOffice\PhpSpreadsheet\Cell\Cell\getWorksheet().

Referenced by PhpOffice\PhpSpreadsheet\Cell\DataValidator\isValid(), and PhpOffice\PhpSpreadsheet\Cell\DataValidator\isValueInList().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFormattedValue()

PhpOffice\PhpSpreadsheet\Cell\Cell::getFormattedValue ( )

Get cell value with formatting.

Returns: string

Definition at line 160 of file Cell.php.

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

References PhpOffice\PhpSpreadsheet\Cell\Cell\getCalculatedValue(), PhpOffice\PhpSpreadsheet\Cell\Cell\getStyle(), and PhpOffice\PhpSpreadsheet\Style\NumberFormat\toFormattedString().

Here is the call graph for this function:

◆ getFormulaAttributes()

PhpOffice\PhpSpreadsheet\Cell\Cell::getFormulaAttributes ( )

Get the formula attributes.

Definition at line 669 of file Cell.php.

    {
        return $this->formulaAttributes;
    }

References PhpOffice\PhpSpreadsheet\Cell\Cell\$formulaAttributes.

◆ getHyperlink()

PhpOffice\PhpSpreadsheet\Cell\Cell::getHyperlink ( )

Get Hyperlink.

Returns: Hyperlink

Definition at line 437 of file Cell.php.

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

References PhpOffice\PhpSpreadsheet\Cell\Cell\getCoordinate(), and PhpOffice\PhpSpreadsheet\Cell\Cell\getWorksheet().

Referenced by PhpOffice\PhpSpreadsheet\Calculation\LookupRef\Hyperlink\set().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMergeRange()

PhpOffice\PhpSpreadsheet\Cell\Cell::getMergeRange ( )

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

Returns: false|string

Definition at line 517 of file Cell.php.

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

References PhpOffice\PhpSpreadsheet\Cell\Cell\getWorksheet(), and PhpOffice\PhpSpreadsheet\Cell\Cell\isInRange().

Referenced by PhpOffice\PhpSpreadsheet\Cell\Cell\isInMergeRange(), PhpOffice\PhpSpreadsheet\Cell\Cell\isMergeRangeValueCell(), and PhpOffice\PhpSpreadsheet\Writer\Ods\Content\writeCellMerge().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getOldCalculatedValue()

PhpOffice\PhpSpreadsheet\Cell\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 reflect 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 318 of file Cell.php.

    {
        return $this->calculatedValue;
    }

References PhpOffice\PhpSpreadsheet\Cell\Cell\$calculatedValue.

◆ getParent()

PhpOffice\PhpSpreadsheet\Cell\Cell::getParent ( )

Get cell collection.

Returns: Cells

Definition at line 469 of file Cell.php.

    {
        return $this->parent;
    }

References PhpOffice\PhpSpreadsheet\Cell\Cell\$parent.

Referenced by PhpOffice\PhpSpreadsheet\Cell\Cell\getCalculatedValue().

Here is the caller graph for this function:

◆ getRow()

PhpOffice\PhpSpreadsheet\Cell\Cell::getRow ( )

Get cell coordinate row.

Returns: int

Definition at line 130 of file Cell.php.

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

Referenced by PhpOffice\PhpSpreadsheet\Calculation\LookupRef\RowColumnInformation\cellRow(), PhpOffice\PhpSpreadsheet\Calculation\Calculation\evaluateDefinedName(), and PhpOffice\PhpSpreadsheet\Cell\Cell\isInRange().

Here is the caller graph for this function:

◆ getStyle()

PhpOffice\PhpSpreadsheet\Cell\Cell::getStyle ( )

Get cell style.

Returns: Style

Definition at line 533 of file Cell.php.

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

References PhpOffice\PhpSpreadsheet\Cell\Cell\getCoordinate(), and PhpOffice\PhpSpreadsheet\Cell\Cell\getWorksheet().

Referenced by PhpOffice\PhpSpreadsheet\Cell\Cell\getFormattedValue(), and ilExcel\setDateFormat().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getValue()

PhpOffice\PhpSpreadsheet\Cell\Cell::getValue ( )

Get cell value.

Returns: mixed

Definition at line 150 of file Cell.php.

    {
        return $this->value;
    }

References PhpOffice\PhpSpreadsheet\Cell\Cell\$value.

Referenced by PhpOffice\PhpSpreadsheet\Cell\Cell\__toString(), PhpOffice\PhpSpreadsheet\Cell\DataValidator\isValid(), and PhpOffice\PhpSpreadsheet\Cell\DataValidator\isValueInList().

Here is the caller graph for this function:

◆ getValueBinder()

static PhpOffice\PhpSpreadsheet\Cell\Cell::getValueBinder ( )

static

Get value binder to use.

Returns: IValueBinder

Definition at line 596 of file Cell.php.

    {
        if (self::$valueBinder === null) {
            self::$valueBinder = new DefaultValueBinder();
        }
 
        return self::$valueBinder;
    }

References PhpOffice\PhpSpreadsheet\Cell\Cell\$valueBinder.

◆ getWorksheet()

PhpOffice\PhpSpreadsheet\Cell\Cell::getWorksheet ( )

Get parent worksheet.

Returns: Worksheet

Definition at line 479 of file Cell.php.

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

Here is the caller graph for this function:

◆ getXfIndex()

PhpOffice\PhpSpreadsheet\Cell\Cell::getXfIndex ( )

Get index to cellXf.

Returns: int

Definition at line 633 of file Cell.php.

    {
        return $this->xfIndex;
    }

References PhpOffice\PhpSpreadsheet\Cell\Cell\$xfIndex.

◆ hasDataValidation()

PhpOffice\PhpSpreadsheet\Cell\Cell::hasDataValidation ( )

Does this cell contain Data validation rules?

Returns: bool

Definition at line 365 of file Cell.php.

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

References PhpOffice\PhpSpreadsheet\Cell\Cell\getCoordinate(), and PhpOffice\PhpSpreadsheet\Cell\Cell\getWorksheet().

Referenced by PhpOffice\PhpSpreadsheet\Cell\DataValidator\isValid().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasHyperlink()

PhpOffice\PhpSpreadsheet\Cell\Cell::hasHyperlink ( )

Does this cell contain a Hyperlink?

Returns: bool

Definition at line 423 of file Cell.php.

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

References PhpOffice\PhpSpreadsheet\Cell\Cell\getCoordinate(), and PhpOffice\PhpSpreadsheet\Cell\Cell\getWorksheet().

Here is the call graph for this function:

◆ hasValidValue()

PhpOffice\PhpSpreadsheet\Cell\Cell::hasValidValue ( )

Does this cell contain valid value?

Returns: bool

Definition at line 411 of file Cell.php.

    {
        $validator = new DataValidator();
 
        return $validator->isValid($this);
    }

◆ isFormula()

PhpOffice\PhpSpreadsheet\Cell\Cell::isFormula ( )

Identify if the cell contains a formula.

Returns: bool

Definition at line 355 of file Cell.php.

    {
        return $this->dataType == DataType::TYPE_FORMULA;
    }

References PhpOffice\PhpSpreadsheet\Cell\DataType\TYPE_FORMULA.

◆ isInMergeRange()

PhpOffice\PhpSpreadsheet\Cell\Cell::isInMergeRange ( )

Is this cell in a merge range.

Returns: bool

Definition at line 489 of file Cell.php.

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

References PhpOffice\PhpSpreadsheet\Cell\Cell\getMergeRange().

Here is the call graph for this function:

◆ isInRange()

PhpOffice\PhpSpreadsheet\Cell\Cell::isInRange ( $pRange )

Is cell in a specific range?

Parameters

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

Returns: bool

Definition at line 557 of file Cell.php.

    {
        [$rangeStart, $rangeEnd] = Coordinate::rangeBoundaries($pRange);
 
        // Translate properties
        $myColumn = Coordinate::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 PhpOffice\PhpSpreadsheet\Cell\Coordinate\columnIndexFromString(), PhpOffice\PhpSpreadsheet\Cell\Cell\getColumn(), PhpOffice\PhpSpreadsheet\Cell\Cell\getRow(), and PhpOffice\PhpSpreadsheet\Cell\Coordinate\rangeBoundaries().

Referenced by PhpOffice\PhpSpreadsheet\Cell\Cell\getMergeRange().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isMergeRangeValueCell()

PhpOffice\PhpSpreadsheet\Cell\Cell::isMergeRangeValueCell ( )

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

Returns: bool

Definition at line 499 of file Cell.php.

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

References PhpOffice\PhpSpreadsheet\Cell\Cell\getCoordinate(), PhpOffice\PhpSpreadsheet\Cell\Cell\getMergeRange(), and PhpOffice\PhpSpreadsheet\Cell\Coordinate\splitRange().

Referenced by PhpOffice\PhpSpreadsheet\Writer\Ods\Content\writeCellMerge().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rebindParent()

PhpOffice\PhpSpreadsheet\Cell\Cell::rebindParent ( Worksheet $parent )

Re-bind parent.

Returns: Cell

Definition at line 543 of file Cell.php.

    {
        $this->parent = $parent->getCellCollection();
 
        return $this->updateInCollection();
    }

References PhpOffice\PhpSpreadsheet\Cell\Cell\$parent, and PhpOffice\PhpSpreadsheet\Cell\Cell\updateInCollection().

Here is the call graph for this function:

◆ setCalculatedValue()

PhpOffice\PhpSpreadsheet\Cell\Cell::setCalculatedValue ( $pValue )

Set old calculated value (cached).

Parameters

mixed $pValue Value

Returns: Cell

Definition at line 299 of file Cell.php.

    {
        if ($pValue !== null) {
            $this->calculatedValue = (is_numeric($pValue)) ? (float) $pValue : $pValue;
        }
 
        return $this->updateInCollection();
    }

References PhpOffice\PhpSpreadsheet\Cell\Cell\updateInCollection().

Here is the call graph for this function:

◆ setDataType()

PhpOffice\PhpSpreadsheet\Cell\Cell::setDataType ( $pDataType )

Set cell data type.

Parameters

string $pDataType see DataType::TYPE_*

Returns: Cell

Definition at line 340 of file Cell.php.

    {
        if ($pDataType == DataType::TYPE_STRING2) {
            $pDataType = DataType::TYPE_STRING;
        }
        $this->dataType = $pDataType;
 
        return $this->updateInCollection();
    }

References PhpOffice\PhpSpreadsheet\Cell\DataType\TYPE_STRING, PhpOffice\PhpSpreadsheet\Cell\DataType\TYPE_STRING2, and PhpOffice\PhpSpreadsheet\Cell\Cell\updateInCollection().

Here is the call graph for this function:

◆ setDataValidation()

PhpOffice\PhpSpreadsheet\Cell\Cell::setDataValidation ( ?DataValidation $pDataValidation = null )

Set Data validation rules.

Parameters

DataValidation $pDataValidation

Returns: Cell

Definition at line 395 of file Cell.php.

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

References PhpOffice\PhpSpreadsheet\Cell\Cell\getCoordinate(), PhpOffice\PhpSpreadsheet\Cell\Cell\getWorksheet(), and PhpOffice\PhpSpreadsheet\Cell\Cell\updateInCollection().

Here is the call graph for this function:

◆ setFormulaAttributes()

PhpOffice\PhpSpreadsheet\Cell\Cell::setFormulaAttributes ( $pAttributes )

Set the formula attributes.

Parameters

mixed $pAttributes

Returns: $this

Definition at line 659 of file Cell.php.

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

◆ setHyperlink()

PhpOffice\PhpSpreadsheet\Cell\Cell::setHyperlink ( ?Hyperlink $pHyperlink = null )

Set Hyperlink.

Parameters

Hyperlink $pHyperlink

Returns: Cell

Definition at line 453 of file Cell.php.

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

References PhpOffice\PhpSpreadsheet\Cell\Cell\getCoordinate(), PhpOffice\PhpSpreadsheet\Cell\Cell\getWorksheet(), and PhpOffice\PhpSpreadsheet\Cell\Cell\updateInCollection().

Here is the call graph for this function:

◆ setValue()

PhpOffice\PhpSpreadsheet\Cell\Cell::setValue ( $pValue )

Set cell value.

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

Parameters

mixed $pValue Value

Returns: $this

Definition at line 178 of file Cell.php.

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

◆ setValueBinder()

static PhpOffice\PhpSpreadsheet\Cell\Cell::setValueBinder ( IValueBinder $binder )

static

Set value binder to use.

Definition at line 608 of file Cell.php.

                                                               : void
    {
        self::$valueBinder = $binder;
    }

◆ setValueExplicit()

PhpOffice\PhpSpreadsheet\Cell\Cell::setValueExplicit	(	$pValue,
		$pDataType
	)

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, see DataType::TYPE_*

Returns: Cell

Definition at line 195 of file Cell.php.

    {
        // set the value according to data type
        switch ($pDataType) {
            case DataType::TYPE_NULL:
                $this->value = $pValue;
 
                break;
            case DataType::TYPE_STRING2:
                $pDataType = DataType::TYPE_STRING;
            // no break
            case DataType::TYPE_STRING:
                // Synonym for string
            case DataType::TYPE_INLINE:
                // Rich text
                $this->value = DataType::checkString($pValue);
 
                break;
            case DataType::TYPE_NUMERIC:
                if (is_string($pValue) && !is_numeric($pValue)) {
                    throw new Exception('Invalid numeric value for datatype Numeric');
                }
                $this->value = 0 + $pValue;
 
                break;
            case DataType::TYPE_FORMULA:
                $this->value = (string) $pValue;
 
                break;
            case DataType::TYPE_BOOL:
                $this->value = (bool) $pValue;
 
                break;
            case DataType::TYPE_ERROR:
                $this->value = DataType::checkErrorCode($pValue);
 
                break;
            default:
                throw new Exception('Invalid datatype: ' . $pDataType);
 
                break;
        }
 
        // set the datatype
        $this->dataType = $pDataType;
 
        return $this->updateInCollection();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setXfIndex()

PhpOffice\PhpSpreadsheet\Cell\Cell::setXfIndex ( $pValue )

Set index to cellXf.

Parameters

int $pValue

Returns: Cell

Definition at line 645 of file Cell.php.

    {
        $this->xfIndex = $pValue;
 
        return $this->updateInCollection();
    }

References PhpOffice\PhpSpreadsheet\Cell\Cell\updateInCollection().

Here is the call graph for this function:

◆ updateInCollection()

PhpOffice\PhpSpreadsheet\Cell\Cell::updateInCollection ( )

Update the cell into the cell collection.

Returns: $this

Definition at line 72 of file Cell.php.

    {
        $this->parent->update($this);
 
        return $this;
    }

Referenced by PhpOffice\PhpSpreadsheet\Cell\Cell\rebindParent(), PhpOffice\PhpSpreadsheet\Cell\Cell\setCalculatedValue(), PhpOffice\PhpSpreadsheet\Cell\Cell\setDataType(), PhpOffice\PhpSpreadsheet\Cell\Cell\setDataValidation(), PhpOffice\PhpSpreadsheet\Cell\Cell\setHyperlink(), PhpOffice\PhpSpreadsheet\Cell\Cell\setValueExplicit(), and PhpOffice\PhpSpreadsheet\Cell\Cell\setXfIndex().

Here is the caller graph for this function:

Field Documentation

◆ $calculatedValue

PhpOffice\PhpSpreadsheet\Cell\Cell::$calculatedValue

private

Definition at line 39 of file Cell.php.

Referenced by PhpOffice\PhpSpreadsheet\Cell\Cell\getCalculatedValue(), and PhpOffice\PhpSpreadsheet\Cell\Cell\getOldCalculatedValue().

◆ $dataType

PhpOffice\PhpSpreadsheet\Cell\Cell::$dataType

private

Definition at line 46 of file Cell.php.

Referenced by PhpOffice\PhpSpreadsheet\Cell\Cell\getDataType().

◆ $formulaAttributes

PhpOffice\PhpSpreadsheet\Cell\Cell::$formulaAttributes

private

Attributes of the formula.

Definition at line 65 of file Cell.php.

Referenced by PhpOffice\PhpSpreadsheet\Cell\Cell\getFormulaAttributes().

◆ $parent

PhpOffice\PhpSpreadsheet\Cell\Cell::$parent

private

Definition at line 53 of file Cell.php.

Referenced by PhpOffice\PhpSpreadsheet\Cell\Cell\attach(), PhpOffice\PhpSpreadsheet\Cell\Cell\getParent(), and PhpOffice\PhpSpreadsheet\Cell\Cell\rebindParent().

◆ $value

PhpOffice\PhpSpreadsheet\Cell\Cell::$value

private

Definition at line 27 of file Cell.php.

Referenced by PhpOffice\PhpSpreadsheet\Cell\Cell\__clone(), PhpOffice\PhpSpreadsheet\Cell\Cell\getCalculatedValue(), and PhpOffice\PhpSpreadsheet\Cell\Cell\getValue().

◆ $valueBinder

PhpOffice\PhpSpreadsheet\Cell\Cell::$valueBinder

staticprivate

Definition at line 20 of file Cell.php.

Referenced by PhpOffice\PhpSpreadsheet\Cell\Cell\getValueBinder().

◆ $xfIndex

PhpOffice\PhpSpreadsheet\Cell\Cell::$xfIndex = 0

private

Definition at line 60 of file Cell.php.

Referenced by PhpOffice\PhpSpreadsheet\Cell\Cell\getXfIndex().

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

libs/composer/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Cell/Cell.php

Public Member Functions

Static Public Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __clone()

◆ __toString()

◆ attach()

◆ compareCells()

◆ detach()

◆ getCalculatedValue()

◆ getColumn()

◆ getCoordinate()

◆ getDataType()

◆ getDataValidation()

◆ getFormattedValue()

◆ getFormulaAttributes()

◆ getHyperlink()

◆ getMergeRange()

◆ getOldCalculatedValue()

◆ getParent()

◆ getRow()

◆ getStyle()

◆ getValue()

◆ getValueBinder()

◆ getWorksheet()

◆ getXfIndex()

◆ hasDataValidation()

◆ hasHyperlink()

◆ hasValidValue()

◆ isFormula()

◆ isInMergeRange()

◆ isInRange()

◆ isMergeRangeValueCell()

◆ rebindParent()

◆ setCalculatedValue()

◆ setDataType()

◆ setDataValidation()

◆ setFormulaAttributes()

◆ setHyperlink()

◆ setValue()

◆ setValueBinder()

◆ setValueExplicit()

◆ setXfIndex()

◆ updateInCollection()

Field Documentation

◆ $calculatedValue

◆ $dataType

◆ $formulaAttributes

◆ $parent

◆ $value

◆ $valueBinder

◆ $xfIndex