PhpOffice\PhpSpreadsheet\ReferenceHelper Class Reference

Collaboration diagram for PhpOffice\PhpSpreadsheet\ReferenceHelper:

Public Member Functions
	insertNewBefore ($pBefore, $pNumCols, $pNumRows, Worksheet $pSheet)
	Insert a new column or row, updating all possible related data. More...
	updateFormulaReferences ($pFormula='', $pBefore='A1', $pNumCols=0, $pNumRows=0, $sheetName='')
	Update references within formulas. More...
	updateFormulaReferencesAnyWorksheet (string $formula='', int $insertColumns=0, int $insertRows=0)
	Update all cell references within a formula, irrespective of worksheet. More...
	updateCellReference ($pCellRange='A1', $pBefore='A1', $pNumCols=0, $pNumRows=0)
	Update cell reference. More...
	updateNamedFormulas (Spreadsheet $spreadsheet, $oldName='', $newName='')
	Update named formulas (i.e. More...
	__clone ()
	__clone implementation. More...

Static Public Member Functions
static	getInstance ()
	Get an instance of this class. More...
static	columnSort ($a, $b)
	Compare two column addresses Intended for use as a Callback function for sorting column addresses by column. More...
static	columnReverseSort ($a, $b)
	Compare two column addresses Intended for use as a Callback function for reverse sorting column addresses by column. More...
static	cellSort ($a, $b)
	Compare two cell addresses Intended for use as a Callback function for sorting cell addresses by column and row. More...
static	cellReverseSort ($a, $b)
	Compare two cell addresses Intended for use as a Callback function for sorting cell addresses by column and row. More...

Data Fields
const	REFHELPER_REGEXP_CELLREF = '((\w*|\'[^!]*\')!)?(?<![:a-z\$])(\$?[a-z]{1,3}\$?\d+)(?=[^:!\d\'])'
	Constants. More...
const	REFHELPER_REGEXP_CELLRANGE = '((\w*|\'[^!]*\')!)?(\$?[a-z]{1,3}\$?\d+):(\$?[a-z]{1,3}\$?\d+)'
const	REFHELPER_REGEXP_ROWRANGE = '((\w*|\'[^!]*\')!)?(\$?\d+):(\$?\d+)'
const	REFHELPER_REGEXP_COLRANGE = '((\w*|\'[^!]*\')!)?(\$?[a-z]{1,3}):(\$?[a-z]{1,3})'

Protected Member Functions
	__construct ()
	Create a new ReferenceHelper. More...
	adjustPageBreaks (Worksheet $pSheet, $pBefore, $beforeColumnIndex, $pNumCols, $beforeRow, $pNumRows)
	Update page breaks when inserting/deleting rows/columns. More...
	adjustComments ($pSheet, $pBefore, $beforeColumnIndex, $pNumCols, $beforeRow, $pNumRows)
	Update cell comments when inserting/deleting rows/columns. More...
	adjustHyperlinks ($pSheet, $pBefore, $beforeColumnIndex, $pNumCols, $beforeRow, $pNumRows)
	Update hyperlinks when inserting/deleting rows/columns. More...
	adjustDataValidations ($pSheet, $pBefore, $beforeColumnIndex, $pNumCols, $beforeRow, $pNumRows)
	Update data validations when inserting/deleting rows/columns. More...
	adjustMergeCells ($pSheet, $pBefore, $beforeColumnIndex, $pNumCols, $beforeRow, $pNumRows)
	Update merged cells when inserting/deleting rows/columns. More...
	adjustProtectedCells ($pSheet, $pBefore, $beforeColumnIndex, $pNumCols, $beforeRow, $pNumRows)
	Update protected cells when inserting/deleting rows/columns. More...
	adjustColumnDimensions ($pSheet, $pBefore, $beforeColumnIndex, $pNumCols, $beforeRow, $pNumRows)
	Update column dimensions when inserting/deleting rows/columns. More...
	adjustRowDimensions ($pSheet, $pBefore, $beforeColumnIndex, $pNumCols, $beforeRow, $pNumRows)
	Update row dimensions when inserting/deleting rows/columns. More...

Private Member Functions
	updateCellReferencesAllWorksheets (string $formula, int $insertColumns, int $insertRows)
	updateColumnRangesAllWorksheets (string $formula, int $insertColumns)
	updateRowRangesAllWorksheets (string $formula, int $insertRows)
	updateCellRange ($pCellRange='A1:A1', $pBefore='A1', $pNumCols=0, $pNumRows=0)
	Update cell range. More...
	updateSingleCellReference ($pCellReference='A1', $pBefore='A1', $pNumCols=0, $pNumRows=0)
	Update single cell reference. More...

Static Private Member Functions
static	cellAddressInDeleteRange ($cellAddress, $beforeRow, $pNumRows, $beforeColumnIndex, $pNumCols)
	Test whether a cell address falls within a defined range of cells. More...

Static Private Attributes
static	$instance

Detailed Description

Definition at line 10 of file ReferenceHelper.php.

Constructor & Destructor Documentation

__construct()

PhpOffice\PhpSpreadsheet\ReferenceHelper::__construct ( )

protected

Create a new ReferenceHelper.

Definition at line 43 of file ReferenceHelper.php.

    {
    }

Member Function Documentation

__clone()

PhpOffice\PhpSpreadsheet\ReferenceHelper::__clone ( )

final

__clone implementation.

Cloning should not be allowed in a Singleton!

Definition at line 1033 of file ReferenceHelper.php.

    {
        throw new Exception('Cloning a Singleton is not allowed!');
    }

adjustColumnDimensions()

PhpOffice\PhpSpreadsheet\ReferenceHelper::adjustColumnDimensions (   $pSheet,   $pBefore,   $beforeColumnIndex,   $pNumCols,   $beforeRow,   $pNumRows  )

protected

Update column dimensions when inserting/deleting rows/columns.

Parameters

Worksheet	$pSheet	The worksheet that we're editing
string	$pBefore	Insert/Delete before this cell address (e.g. 'A1')
int	$beforeColumnIndex	Index number of the column we're inserting/deleting before
int	$pNumCols	Number of columns to insert/delete (negative values indicate deletion)
int	$beforeRow	Number of the row we're inserting/deleting before
int	$pNumRows	Number of rows to insert/delete (negative values indicate deletion)

Definition at line 315 of file ReferenceHelper.php.

References PhpOffice\PhpSpreadsheet\Cell\Coordinate\coordinateFromString(), and PhpOffice\PhpSpreadsheet\ReferenceHelper\updateCellReference().

Referenced by PhpOffice\PhpSpreadsheet\ReferenceHelper\insertNewBefore().

                                                                                                                      : void
    {
        $aColumnDimensions = array_reverse($pSheet->getColumnDimensions(), true);
        if (!empty($aColumnDimensions)) {
            foreach ($aColumnDimensions as $objColumnDimension) {
                $newReference = $this->updateCellReference($objColumnDimension->getColumnIndex() . '1', $pBefore, $pNumCols, $pNumRows);
                [$newReference] = Coordinate::coordinateFromString($newReference);
                if ($objColumnDimension->getColumnIndex() != $newReference) {
                    $objColumnDimension->setColumnIndex($newReference);
                }
            }
            $pSheet->refreshColumnDimensions();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

adjustComments()

PhpOffice\PhpSpreadsheet\ReferenceHelper::adjustComments (   $pSheet,   $pBefore,   $beforeColumnIndex,   $pNumCols,   $beforeRow,   $pNumRows  )

protected

Update cell comments when inserting/deleting rows/columns.

Parameters

Worksheet	$pSheet	The worksheet that we're editing
string	$pBefore	Insert/Delete before this cell address (e.g. 'A1')
int	$beforeColumnIndex	Index number of the column we're inserting/deleting before
int	$pNumCols	Number of columns to insert/delete (negative values indicate deletion)
int	$beforeRow	Number of the row we're inserting/deleting before
int	$pNumRows	Number of rows to insert/delete (negative values indicate deletion)

Definition at line 193 of file ReferenceHelper.php.

References $key, and PhpOffice\PhpSpreadsheet\ReferenceHelper\updateCellReference().

Referenced by PhpOffice\PhpSpreadsheet\ReferenceHelper\insertNewBefore().

                                                                                                              : void
    {
        $aComments = $pSheet->getComments();
        $aNewComments = []; // the new array of all comments

        foreach ($aComments as $key => &$value) {
            // Any comments inside a deleted range will be ignored
            if (!self::cellAddressInDeleteRange($key, $beforeRow, $pNumRows, $beforeColumnIndex, $pNumCols)) {
                // Otherwise build a new array of comments indexed by the adjusted cell reference
                $newReference = $this->updateCellReference($key, $pBefore, $pNumCols, $pNumRows);
                $aNewComments[$newReference] = $value;
            }
        }
        //    Replace the comments array with the new set of comments
        $pSheet->setComments($aNewComments);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

adjustDataValidations()

PhpOffice\PhpSpreadsheet\ReferenceHelper::adjustDataValidations (   $pSheet,   $pBefore,   $beforeColumnIndex,   $pNumCols,   $beforeRow,   $pNumRows  )

protected

Update data validations when inserting/deleting rows/columns.

Parameters

Worksheet	$pSheet	The worksheet that we're editing
string	$pBefore	Insert/Delete before this cell address (e.g. 'A1')
int	$beforeColumnIndex	Index number of the column we're inserting/deleting before
int	$pNumCols	Number of columns to insert/delete (negative values indicate deletion)
int	$beforeRow	Number of the row we're inserting/deleting before
int	$pNumRows	Number of rows to insert/delete (negative values indicate deletion)

Definition at line 245 of file ReferenceHelper.php.

References $key, and PhpOffice\PhpSpreadsheet\ReferenceHelper\updateCellReference().

Referenced by PhpOffice\PhpSpreadsheet\ReferenceHelper\insertNewBefore().

                                                                                                                     : void
    {
        $aDataValidationCollection = $pSheet->getDataValidationCollection();
        ($pNumCols > 0 || $pNumRows > 0) ?
            uksort($aDataValidationCollection, ['self', 'cellReverseSort']) : uksort($aDataValidationCollection, ['self', 'cellSort']);

        foreach ($aDataValidationCollection as $key => $value) {
            $newReference = $this->updateCellReference($key, $pBefore, $pNumCols, $pNumRows);
            if ($key != $newReference) {
                $pSheet->setDataValidation($newReference, $value);
                $pSheet->setDataValidation($key, null);
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

adjustHyperlinks()

PhpOffice\PhpSpreadsheet\ReferenceHelper::adjustHyperlinks (   $pSheet,   $pBefore,   $beforeColumnIndex,   $pNumCols,   $beforeRow,   $pNumRows  )

protected

Update hyperlinks when inserting/deleting rows/columns.

Parameters

Worksheet	$pSheet	The worksheet that we're editing
string	$pBefore	Insert/Delete before this cell address (e.g. 'A1')
int	$beforeColumnIndex	Index number of the column we're inserting/deleting before
int	$pNumCols	Number of columns to insert/delete (negative values indicate deletion)
int	$beforeRow	Number of the row we're inserting/deleting before
int	$pNumRows	Number of rows to insert/delete (negative values indicate deletion)

Definition at line 220 of file ReferenceHelper.php.

References $key, and PhpOffice\PhpSpreadsheet\ReferenceHelper\updateCellReference().

Referenced by PhpOffice\PhpSpreadsheet\ReferenceHelper\insertNewBefore().

                                                                                                                : void
    {
        $aHyperlinkCollection = $pSheet->getHyperlinkCollection();
        ($pNumCols > 0 || $pNumRows > 0) ?
            uksort($aHyperlinkCollection, ['self', 'cellReverseSort']) : uksort($aHyperlinkCollection, ['self', 'cellSort']);

        foreach ($aHyperlinkCollection as $key => $value) {
            $newReference = $this->updateCellReference($key, $pBefore, $pNumCols, $pNumRows);
            if ($key != $newReference) {
                $pSheet->setHyperlink($newReference, $value);
                $pSheet->setHyperlink($key, null);
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

adjustMergeCells()

PhpOffice\PhpSpreadsheet\ReferenceHelper::adjustMergeCells (   $pSheet,   $pBefore,   $beforeColumnIndex,   $pNumCols,   $beforeRow,   $pNumRows  )

protected

Update merged cells when inserting/deleting rows/columns.

Parameters

Worksheet	$pSheet	The worksheet that we're editing
string	$pBefore	Insert/Delete before this cell address (e.g. 'A1')
int	$beforeColumnIndex	Index number of the column we're inserting/deleting before
int	$pNumCols	Number of columns to insert/delete (negative values indicate deletion)
int	$beforeRow	Number of the row we're inserting/deleting before
int	$pNumRows	Number of rows to insert/delete (negative values indicate deletion)

Definition at line 270 of file ReferenceHelper.php.

References $key, and PhpOffice\PhpSpreadsheet\ReferenceHelper\updateCellReference().

Referenced by PhpOffice\PhpSpreadsheet\ReferenceHelper\insertNewBefore().

                                                                                                                : void
    {
        $aMergeCells = $pSheet->getMergeCells();
        $aNewMergeCells = []; // the new array of all merge cells
        foreach ($aMergeCells as $key => &$value) {
            $newReference = $this->updateCellReference($key, $pBefore, $pNumCols, $pNumRows);
            $aNewMergeCells[$newReference] = $newReference;
        }
        $pSheet->setMergeCells($aNewMergeCells); // replace the merge cells array
    }

Here is the call graph for this function:

Here is the caller graph for this function:

adjustPageBreaks()

PhpOffice\PhpSpreadsheet\ReferenceHelper::adjustPageBreaks ( Worksheet  $pSheet,   $pBefore,   $beforeColumnIndex,   $pNumCols,   $beforeRow,   $pNumRows  )

protected

Update page breaks when inserting/deleting rows/columns.

Parameters

Worksheet	$pSheet	The worksheet that we're editing
string	$pBefore	Insert/Delete before this cell address (e.g. 'A1')
int	$beforeColumnIndex	Index number of the column we're inserting/deleting before
int	$pNumCols	Number of columns to insert/delete (negative values indicate deletion)
int	$beforeRow	Number of the row we're inserting/deleting before
int	$pNumRows	Number of rows to insert/delete (negative values indicate deletion)

Definition at line 160 of file ReferenceHelper.php.

References $key, PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\BREAK_NONE, PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\getBreaks(), PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\setBreak(), and PhpOffice\PhpSpreadsheet\ReferenceHelper\updateCellReference().

Referenced by PhpOffice\PhpSpreadsheet\ReferenceHelper\insertNewBefore().

                                                                                                                          : void
    {
        $aBreaks = $pSheet->getBreaks();
        ($pNumCols > 0 || $pNumRows > 0) ?
            uksort($aBreaks, ['self', 'cellReverseSort']) : uksort($aBreaks, ['self', 'cellSort']);

        foreach ($aBreaks as $key => $value) {
            if (self::cellAddressInDeleteRange($key, $beforeRow, $pNumRows, $beforeColumnIndex, $pNumCols)) {
                //    If we're deleting, then clear any defined breaks that are within the range
                //        of rows/columns that we're deleting
                $pSheet->setBreak($key, Worksheet::BREAK_NONE);
            } else {
                //    Otherwise update any affected breaks by inserting a new break at the appropriate point
                //        and removing the old affected break
                $newReference = $this->updateCellReference($key, $pBefore, $pNumCols, $pNumRows);
                if ($key != $newReference) {
                    $pSheet->setBreak($newReference, $value)
                        ->setBreak($key, Worksheet::BREAK_NONE);
                }
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

adjustProtectedCells()

PhpOffice\PhpSpreadsheet\ReferenceHelper::adjustProtectedCells (   $pSheet,   $pBefore,   $beforeColumnIndex,   $pNumCols,   $beforeRow,   $pNumRows  )

protected

Update protected cells when inserting/deleting rows/columns.

Parameters

Worksheet	$pSheet	The worksheet that we're editing
string	$pBefore	Insert/Delete before this cell address (e.g. 'A1')
int	$beforeColumnIndex	Index number of the column we're inserting/deleting before
int	$pNumCols	Number of columns to insert/delete (negative values indicate deletion)
int	$beforeRow	Number of the row we're inserting/deleting before
int	$pNumRows	Number of rows to insert/delete (negative values indicate deletion)

Definition at line 291 of file ReferenceHelper.php.

References $key, and PhpOffice\PhpSpreadsheet\ReferenceHelper\updateCellReference().

Referenced by PhpOffice\PhpSpreadsheet\ReferenceHelper\insertNewBefore().

                                                                                                                    : void
    {
        $aProtectedCells = $pSheet->getProtectedCells();
        ($pNumCols > 0 || $pNumRows > 0) ?
            uksort($aProtectedCells, ['self', 'cellReverseSort']) : uksort($aProtectedCells, ['self', 'cellSort']);
        foreach ($aProtectedCells as $key => $value) {
            $newReference = $this->updateCellReference($key, $pBefore, $pNumCols, $pNumRows);
            if ($key != $newReference) {
                $pSheet->protectCells($newReference, $value, true);
                $pSheet->unprotectCells($key);
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

adjustRowDimensions()

PhpOffice\PhpSpreadsheet\ReferenceHelper::adjustRowDimensions (   $pSheet,   $pBefore,   $beforeColumnIndex,   $pNumCols,   $beforeRow,   $pNumRows  )

protected

Update row dimensions when inserting/deleting rows/columns.

Parameters

Worksheet	$pSheet	The worksheet that we're editing
string	$pBefore	Insert/Delete before this cell address (e.g. 'A1')
int	$beforeColumnIndex	Index number of the column we're inserting/deleting before
int	$pNumCols	Number of columns to insert/delete (negative values indicate deletion)
int	$beforeRow	Number of the row we're inserting/deleting before
int	$pNumRows	Number of rows to insert/delete (negative values indicate deletion)

Definition at line 340 of file ReferenceHelper.php.

References $i, PhpOffice\PhpSpreadsheet\Cell\Coordinate\coordinateFromString(), and PhpOffice\PhpSpreadsheet\ReferenceHelper\updateCellReference().

Referenced by PhpOffice\PhpSpreadsheet\ReferenceHelper\insertNewBefore().

                                                                                                                   : void
    {
        $aRowDimensions = array_reverse($pSheet->getRowDimensions(), true);
        if (!empty($aRowDimensions)) {
            foreach ($aRowDimensions as $objRowDimension) {
                $newReference = $this->updateCellReference('A' . $objRowDimension->getRowIndex(), $pBefore, $pNumCols, $pNumRows);
                [, $newReference] = Coordinate::coordinateFromString($newReference);
                if ($objRowDimension->getRowIndex() != $newReference) {
                    $objRowDimension->setRowIndex($newReference);
                }
            }
            $pSheet->refreshRowDimensions();

            $copyDimension = $pSheet->getRowDimension($beforeRow - 1);
            for ($i = $beforeRow; $i <= $beforeRow - 1 + $pNumRows; ++$i) {
                $newDimension = $pSheet->getRowDimension($i);
                $newDimension->setRowHeight($copyDimension->getRowHeight());
                $newDimension->setVisible($copyDimension->getVisible());
                $newDimension->setOutlineLevel($copyDimension->getOutlineLevel());
                $newDimension->setCollapsed($copyDimension->getCollapsed());
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

cellAddressInDeleteRange()

static PhpOffice\PhpSpreadsheet\ReferenceHelper::cellAddressInDeleteRange (   $cellAddress,   $beforeRow,   $pNumRows,   $beforeColumnIndex,   $pNumCols  )

staticprivate

Test whether a cell address falls within a defined range of cells.

Parameters

string	$cellAddress	Address of the cell we're testing
int	$beforeRow	Number of the row we're inserting/deleting before
int	$pNumRows	Number of rows to insert/delete (negative values indicate deletion)
int	$beforeColumnIndex	Index number of the column we're inserting/deleting before
int	$pNumCols	Number of columns to insert/delete (negative values indicate deletion)

Returns

bool

Definition at line 128 of file ReferenceHelper.php.

References PhpOffice\PhpSpreadsheet\Cell\Coordinate\columnIndexFromString(), and PhpOffice\PhpSpreadsheet\Cell\Coordinate\coordinateFromString().

    {
        [$cellColumn, $cellRow] = Coordinate::coordinateFromString($cellAddress);
        $cellColumnIndex = Coordinate::columnIndexFromString($cellColumn);
        //    Is cell within the range of rows/columns if we're deleting
        if (
            $pNumRows < 0 &&
            ($cellRow >= ($beforeRow + $pNumRows)) &&
            ($cellRow < $beforeRow)
        ) {
            return true;
        } elseif (
            $pNumCols < 0 &&
            ($cellColumnIndex >= ($beforeColumnIndex + $pNumCols)) &&
            ($cellColumnIndex < $beforeColumnIndex)
        ) {
            return true;
        }

        return false;
    }

Here is the call graph for this function:

cellReverseSort()

static PhpOffice\PhpSpreadsheet\ReferenceHelper::cellReverseSort (   $a,   $b  )

static

Compare two cell addresses Intended for use as a Callback function for sorting cell addresses by column and row.

Parameters

string	$a	First cell to test (e.g. 'AA1')
string	$b	Second cell to test (e.g. 'Z1')

Returns

int

Definition at line 105 of file ReferenceHelper.php.

    {
        [$ac, $ar] = sscanf($a, '%[A-Z]%d');
        [$bc, $br] = sscanf($b, '%[A-Z]%d');

        if ($ar === $br) {
            return -strcasecmp(strlen($ac) . $ac, strlen($bc) . $bc);
        }

        return ($ar < $br) ? 1 : -1;
    }

cellSort()

static PhpOffice\PhpSpreadsheet\ReferenceHelper::cellSort (   $a,   $b  )

static

Compare two cell addresses Intended for use as a Callback function for sorting cell addresses by column and row.

Parameters

string	$a	First cell to test (e.g. 'AA1')
string	$b	Second cell to test (e.g. 'Z1')

Returns

int

Definition at line 84 of file ReferenceHelper.php.

    {
        [$ac, $ar] = sscanf($a, '%[A-Z]%d');
        [$bc, $br] = sscanf($b, '%[A-Z]%d');

        if ($ar === $br) {
            return strcasecmp(strlen($ac) . $ac, strlen($bc) . $bc);
        }

        return ($ar < $br) ? -1 : 1;
    }

columnReverseSort()

static PhpOffice\PhpSpreadsheet\ReferenceHelper::columnReverseSort (   $a,   $b  )

static

Compare two column addresses Intended for use as a Callback function for reverse sorting column addresses by column.

Parameters

string	$a	First column to test (e.g. 'AA')
string	$b	Second column to test (e.g. 'Z')

Returns

int

Definition at line 70 of file ReferenceHelper.php.

    {
        return -strcasecmp(strlen($a) . $a, strlen($b) . $b);
    }

columnSort()

static PhpOffice\PhpSpreadsheet\ReferenceHelper::columnSort (   $a,   $b  )

static

Compare two column addresses Intended for use as a Callback function for sorting column addresses by column.

Parameters

string	$a	First column to test (e.g. 'AA')
string	$b	Second column to test (e.g. 'Z')

Returns

int

Definition at line 56 of file ReferenceHelper.php.

    {
        return strcasecmp(strlen($a) . $a, strlen($b) . $b);
    }

getInstance()

static PhpOffice\PhpSpreadsheet\ReferenceHelper::getInstance ( )

static

Get an instance of this class.

Returns

ReferenceHelper

Definition at line 31 of file ReferenceHelper.php.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xlsx\__construct(), PhpOffice\PhpSpreadsheet\Reader\Gnumeric\__construct(), PhpOffice\PhpSpreadsheet\Calculation\Calculation\__construct(), PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\insertNewColumnBefore(), PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\insertNewRowBefore(), PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\removeColumn(), PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\removeRow(), PhpOffice\PhpSpreadsheet\DefinedName\setName(), and PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\setTitle().

    {
        if (!isset(self::$instance) || (self::$instance === null)) {
            self::$instance = new self();
        }

        return self::$instance;
    }

Here is the caller graph for this function:

insertNewBefore()

PhpOffice\PhpSpreadsheet\ReferenceHelper::insertNewBefore	(		$pBefore,
			$pNumCols,
			$pNumRows,
		Worksheet	$pSheet
	)

Insert a new column or row, updating all possible related data.

Parameters

string	$pBefore	Insert before this cell address (e.g. 'A1')
int	$pNumCols	Number of columns to insert/delete (negative values indicate deletion)
int	$pNumRows	Number of rows to insert/delete (negative values indicate deletion)
Worksheet	$pSheet	The worksheet that we're editing

Definition at line 372 of file ReferenceHelper.php.

References $i, $row, PhpOffice\PhpSpreadsheet\ReferenceHelper\adjustColumnDimensions(), PhpOffice\PhpSpreadsheet\ReferenceHelper\adjustComments(), PhpOffice\PhpSpreadsheet\ReferenceHelper\adjustDataValidations(), PhpOffice\PhpSpreadsheet\ReferenceHelper\adjustHyperlinks(), PhpOffice\PhpSpreadsheet\ReferenceHelper\adjustMergeCells(), PhpOffice\PhpSpreadsheet\ReferenceHelper\adjustPageBreaks(), PhpOffice\PhpSpreadsheet\ReferenceHelper\adjustProtectedCells(), PhpOffice\PhpSpreadsheet\ReferenceHelper\adjustRowDimensions(), PhpOffice\PhpSpreadsheet\Cell\Coordinate\columnIndexFromString(), PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\conditionalStylesExists(), PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\freezePane(), PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\garbageCollect(), PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\getAutoFilter(), PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\getCellCollection(), PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\getConditionalStyles(), PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\getCoordinates(), PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\getDrawingCollection(), PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\getFreezePane(), PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\getHashCode(), PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\getHighestColumn(), PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\getHighestRow(), PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\getPageSetup(), PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\getParent(), PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\getTitle(), PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\getTopLeftCell(), PhpOffice\PhpSpreadsheet\Cell\Coordinate\indexesFromString(), PhpOffice\PhpSpreadsheet\Cell\Coordinate\rangeBoundaries(), PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\removeConditionalStyles(), PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\setAutoFilter(), PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\setConditionalStyles(), PhpOffice\PhpSpreadsheet\Cell\Coordinate\stringFromColumnIndex(), PhpOffice\PhpSpreadsheet\Cell\DataType\TYPE_FORMULA, PhpOffice\PhpSpreadsheet\Cell\DataType\TYPE_NULL, PhpOffice\PhpSpreadsheet\ReferenceHelper\updateCellReference(), and PhpOffice\PhpSpreadsheet\ReferenceHelper\updateFormulaReferences().

                                                                                      : void
    {
        $remove = ($pNumCols < 0 || $pNumRows < 0);
        $allCoordinates = $pSheet->getCoordinates();

        // Get coordinate of $pBefore
        [$beforeColumn, $beforeRow] = Coordinate::indexesFromString($pBefore);

        // Clear cells if we are removing columns or rows
        $highestColumn = $pSheet->getHighestColumn();
        $highestRow = $pSheet->getHighestRow();

        // 1. Clear column strips if we are removing columns
        if ($pNumCols < 0 && $beforeColumn - 2 + $pNumCols > 0) {
            for ($i = 1; $i <= $highestRow - 1; ++$i) {
                for ($j = $beforeColumn - 1 + $pNumCols; $j <= $beforeColumn - 2; ++$j) {
                    $coordinate = Coordinate::stringFromColumnIndex($j + 1) . $i;
                    $pSheet->removeConditionalStyles($coordinate);
                    if ($pSheet->cellExists($coordinate)) {
                        $pSheet->getCell($coordinate)->setValueExplicit('', DataType::TYPE_NULL);
                        $pSheet->getCell($coordinate)->setXfIndex(0);
                    }
                }
            }
        }

        // 2. Clear row strips if we are removing rows
        if ($pNumRows < 0 && $beforeRow - 1 + $pNumRows > 0) {
            for ($i = $beforeColumn - 1; $i <= Coordinate::columnIndexFromString($highestColumn) - 1; ++$i) {
                for ($j = $beforeRow + $pNumRows; $j <= $beforeRow - 1; ++$j) {
                    $coordinate = Coordinate::stringFromColumnIndex($i + 1) . $j;
                    $pSheet->removeConditionalStyles($coordinate);
                    if ($pSheet->cellExists($coordinate)) {
                        $pSheet->getCell($coordinate)->setValueExplicit('', DataType::TYPE_NULL);
                        $pSheet->getCell($coordinate)->setXfIndex(0);
                    }
                }
            }
        }

        // Loop through cells, bottom-up, and change cell coordinate
        if ($remove) {
            // It's faster to reverse and pop than to use unshift, especially with large cell collections
            $allCoordinates = array_reverse($allCoordinates);
        }
        while ($coordinate = array_pop($allCoordinates)) {
            $cell = $pSheet->getCell($coordinate);
            $cellIndex = Coordinate::columnIndexFromString($cell->getColumn());

            if ($cellIndex - 1 + $pNumCols < 0) {
                continue;
            }

            // New coordinate
            $newCoordinate = Coordinate::stringFromColumnIndex($cellIndex + $pNumCols) . ($cell->getRow() + $pNumRows);

            // Should the cell be updated? Move value and cellXf index from one cell to another.
            if (($cellIndex >= $beforeColumn) && ($cell->getRow() >= $beforeRow)) {
                // Update cell styles
                $pSheet->getCell($newCoordinate)->setXfIndex($cell->getXfIndex());

                // Insert this cell at its new location
                if ($cell->getDataType() == DataType::TYPE_FORMULA) {
                    // Formula should be adjusted
                    $pSheet->getCell($newCoordinate)
                        ->setValue($this->updateFormulaReferences($cell->getValue(), $pBefore, $pNumCols, $pNumRows, $pSheet->getTitle()));
                } else {
                    // Formula should not be adjusted
                    $pSheet->getCell($newCoordinate)->setValue($cell->getValue());
                }

                // Clear the original cell
                $pSheet->getCellCollection()->delete($coordinate);
            } else {
                /*    We don't need to update styles for rows/columns before our insertion position,
                        but we do still need to adjust any formulae    in those cells                    */
                if ($cell->getDataType() == DataType::TYPE_FORMULA) {
                    // Formula should be adjusted
                    $cell->setValue($this->updateFormulaReferences($cell->getValue(), $pBefore, $pNumCols, $pNumRows, $pSheet->getTitle()));
                }
            }
        }

        // Duplicate styles for the newly inserted cells
        $highestColumn = $pSheet->getHighestColumn();
        $highestRow = $pSheet->getHighestRow();

        if ($pNumCols > 0 && $beforeColumn - 2 > 0) {
            for ($i = $beforeRow; $i <= $highestRow - 1; ++$i) {
                // Style
                $coordinate = Coordinate::stringFromColumnIndex($beforeColumn - 1) . $i;
                if ($pSheet->cellExists($coordinate)) {
                    $xfIndex = $pSheet->getCell($coordinate)->getXfIndex();
                    $conditionalStyles = $pSheet->conditionalStylesExists($coordinate) ?
                        $pSheet->getConditionalStyles($coordinate) : false;
                    for ($j = $beforeColumn; $j <= $beforeColumn - 1 + $pNumCols; ++$j) {
                        $pSheet->getCellByColumnAndRow($j, $i)->setXfIndex($xfIndex);
                        if ($conditionalStyles) {
                            $cloned = [];
                            foreach ($conditionalStyles as $conditionalStyle) {
                                $cloned[] = clone $conditionalStyle;
                            }
                            $pSheet->setConditionalStyles(Coordinate::stringFromColumnIndex($j) . $i, $cloned);
                        }
                    }
                }
            }
        }

        if ($pNumRows > 0 && $beforeRow - 1 > 0) {
            for ($i = $beforeColumn; $i <= Coordinate::columnIndexFromString($highestColumn); ++$i) {
                // Style
                $coordinate = Coordinate::stringFromColumnIndex($i) . ($beforeRow - 1);
                if ($pSheet->cellExists($coordinate)) {
                    $xfIndex = $pSheet->getCell($coordinate)->getXfIndex();
                    $conditionalStyles = $pSheet->conditionalStylesExists($coordinate) ?
                        $pSheet->getConditionalStyles($coordinate) : false;
                    for ($j = $beforeRow; $j <= $beforeRow - 1 + $pNumRows; ++$j) {
                        $pSheet->getCell(Coordinate::stringFromColumnIndex($i) . $j)->setXfIndex($xfIndex);
                        if ($conditionalStyles) {
                            $cloned = [];
                            foreach ($conditionalStyles as $conditionalStyle) {
                                $cloned[] = clone $conditionalStyle;
                            }
                            $pSheet->setConditionalStyles(Coordinate::stringFromColumnIndex($i) . $j, $cloned);
                        }
                    }
                }
            }
        }

        // Update worksheet: column dimensions
        $this->adjustColumnDimensions($pSheet, $pBefore, $beforeColumn, $pNumCols, $beforeRow, $pNumRows);

        // Update worksheet: row dimensions
        $this->adjustRowDimensions($pSheet, $pBefore, $beforeColumn, $pNumCols, $beforeRow, $pNumRows);

        //    Update worksheet: page breaks
        $this->adjustPageBreaks($pSheet, $pBefore, $beforeColumn, $pNumCols, $beforeRow, $pNumRows);

        //    Update worksheet: comments
        $this->adjustComments($pSheet, $pBefore, $beforeColumn, $pNumCols, $beforeRow, $pNumRows);

        // Update worksheet: hyperlinks
        $this->adjustHyperlinks($pSheet, $pBefore, $beforeColumn, $pNumCols, $beforeRow, $pNumRows);

        // Update worksheet: data validations
        $this->adjustDataValidations($pSheet, $pBefore, $beforeColumn, $pNumCols, $beforeRow, $pNumRows);

        // Update worksheet: merge cells
        $this->adjustMergeCells($pSheet, $pBefore, $beforeColumn, $pNumCols, $beforeRow, $pNumRows);

        // Update worksheet: protected cells
        $this->adjustProtectedCells($pSheet, $pBefore, $beforeColumn, $pNumCols, $beforeRow, $pNumRows);

        // Update worksheet: autofilter
        $autoFilter = $pSheet->getAutoFilter();
        $autoFilterRange = $autoFilter->getRange();
        if (!empty($autoFilterRange)) {
            if ($pNumCols != 0) {
                $autoFilterColumns = $autoFilter->getColumns();
                if (count($autoFilterColumns) > 0) {
                    $column = '';
                    $row = 0;
                    sscanf($pBefore, '%[A-Z]%d', $column, $row);
                    $columnIndex = Coordinate::columnIndexFromString($column);
                    [$rangeStart, $rangeEnd] = Coordinate::rangeBoundaries($autoFilterRange);
                    if ($columnIndex <= $rangeEnd[0]) {
                        if ($pNumCols < 0) {
                            //    If we're actually deleting any columns that fall within the autofilter range,
                            //        then we delete any rules for those columns
                            $deleteColumn = $columnIndex + $pNumCols - 1;
                            $deleteCount = abs($pNumCols);
                            for ($i = 1; $i <= $deleteCount; ++$i) {
                                if (isset($autoFilterColumns[Coordinate::stringFromColumnIndex($deleteColumn + 1)])) {
                                    $autoFilter->clearColumn(Coordinate::stringFromColumnIndex($deleteColumn + 1));
                                }
                                ++$deleteColumn;
                            }
                        }
                        $startCol = ($columnIndex > $rangeStart[0]) ? $columnIndex : $rangeStart[0];

                        //    Shuffle columns in autofilter range
                        if ($pNumCols > 0) {
                            $startColRef = $startCol;
                            $endColRef = $rangeEnd[0];
                            $toColRef = $rangeEnd[0] + $pNumCols;

                            do {
                                $autoFilter->shiftColumn(Coordinate::stringFromColumnIndex($endColRef), Coordinate::stringFromColumnIndex($toColRef));
                                --$endColRef;
                                --$toColRef;
                            } while ($startColRef <= $endColRef);
                        } else {
                            //    For delete, we shuffle from beginning to end to avoid overwriting
                            $startColID = Coordinate::stringFromColumnIndex($startCol);
                            $toColID = Coordinate::stringFromColumnIndex($startCol + $pNumCols);
                            $endColID = Coordinate::stringFromColumnIndex($rangeEnd[0] + 1);
                            do {
                                $autoFilter->shiftColumn($startColID, $toColID);
                                ++$startColID;
                                ++$toColID;
                            } while ($startColID != $endColID);
                        }
                    }
                }
            }
            $pSheet->setAutoFilter($this->updateCellReference($autoFilterRange, $pBefore, $pNumCols, $pNumRows));
        }

        // Update worksheet: freeze pane
        if ($pSheet->getFreezePane()) {
            $splitCell = $pSheet->getFreezePane();
            $topLeftCell = $pSheet->getTopLeftCell();

            $splitCell = $this->updateCellReference($splitCell, $pBefore, $pNumCols, $pNumRows);
            $topLeftCell = $this->updateCellReference($topLeftCell, $pBefore, $pNumCols, $pNumRows);

            $pSheet->freezePane($splitCell, $topLeftCell);
        }

        // Page setup
        if ($pSheet->getPageSetup()->isPrintAreaSet()) {
            $pSheet->getPageSetup()->setPrintArea($this->updateCellReference($pSheet->getPageSetup()->getPrintArea(), $pBefore, $pNumCols, $pNumRows));
        }

        // Update worksheet: drawings
        $aDrawings = $pSheet->getDrawingCollection();
        foreach ($aDrawings as $objDrawing) {
            $newReference = $this->updateCellReference($objDrawing->getCoordinates(), $pBefore, $pNumCols, $pNumRows);
            if ($objDrawing->getCoordinates() != $newReference) {
                $objDrawing->setCoordinates($newReference);
            }
        }

        // Update workbook: define names
        if (count($pSheet->getParent()->getDefinedNames()) > 0) {
            foreach ($pSheet->getParent()->getDefinedNames() as $definedName) {
                if ($definedName->getWorksheet() !== null && $definedName->getWorksheet()->getHashCode() === $pSheet->getHashCode()) {
                    $definedName->setValue($this->updateCellReference($definedName->getValue(), $pBefore, $pNumCols, $pNumRows));
                }
            }
        }

        // Garbage collect
        $pSheet->garbageCollect();
    }

Here is the call graph for this function:

updateCellRange()

PhpOffice\PhpSpreadsheet\ReferenceHelper::updateCellRange (   $pCellRange = 'A1:A1',   $pBefore = 'A1',   $pNumCols = 0,   $pNumRows = 0  )

private

Update cell range.

Parameters

string	$pCellRange	Cell range (e.g. 'B2:D4', 'B:C' or '2:3')
string	$pBefore	Insert before this one
int	$pNumCols	Number of columns to increment
int	$pNumRows	Number of rows to increment

Returns

string Updated cell range

Definition at line 962 of file ReferenceHelper.php.

References $i, $r, PhpOffice\PhpSpreadsheet\Cell\Coordinate\buildRange(), PhpOffice\PhpSpreadsheet\Cell\Coordinate\coordinateFromString(), PhpOffice\PhpSpreadsheet\Cell\Coordinate\coordinateIsRange(), PhpOffice\PhpSpreadsheet\Cell\Coordinate\splitRange(), and PhpOffice\PhpSpreadsheet\ReferenceHelper\updateSingleCellReference().

Referenced by PhpOffice\PhpSpreadsheet\ReferenceHelper\updateCellReference().

                                                      :A1', $pBefore = 'A1', $pNumCols = 0, $pNumRows = 0)
    {
        if (!Coordinate::coordinateIsRange($pCellRange)) {
            throw new Exception('Only cell ranges may be passed to this method.');
        }

        // Update range
        $range = Coordinate::splitRange($pCellRange);
        $ic = count($range);
        for ($i = 0; $i < $ic; ++$i) {
            $jc = count($range[$i]);
            for ($j = 0; $j < $jc; ++$j) {
                if (ctype_alpha($range[$i][$j])) {
                    $r = Coordinate::coordinateFromString($this->updateSingleCellReference($range[$i][$j] . '1', $pBefore, $pNumCols, $pNumRows));
                    $range[$i][$j] = $r[0];
                } elseif (ctype_digit($range[$i][$j])) {
                    $r = Coordinate::coordinateFromString($this->updateSingleCellReference('A' . $range[$i][$j], $pBefore, $pNumCols, $pNumRows));
                    $range[$i][$j] = $r[1];
                } else {
                    $range[$i][$j] = $this->updateSingleCellReference($range[$i][$j], $pBefore, $pNumCols, $pNumRows);
                }
            }
        }

        // Recreate range string
        return Coordinate::buildRange($range);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

updateCellReference()

PhpOffice\PhpSpreadsheet\ReferenceHelper::updateCellReference	(		$pCellRange = 'A1',
			$pBefore = 'A1',
			$pNumCols = 0,
			$pNumRows = 0
	)

Update cell reference.

Parameters

string	$pCellRange	Cell range
string	$pBefore	Insert before this one
int	$pNumCols	Number of columns to increment
int	$pNumRows	Number of rows to increment

Returns

string Updated cell range

Definition at line 906 of file ReferenceHelper.php.

References PhpOffice\PhpSpreadsheet\Cell\Coordinate\coordinateIsRange(), PhpOffice\PhpSpreadsheet\ReferenceHelper\updateCellRange(), and PhpOffice\PhpSpreadsheet\ReferenceHelper\updateSingleCellReference().

Referenced by PhpOffice\PhpSpreadsheet\ReferenceHelper\adjustColumnDimensions(), PhpOffice\PhpSpreadsheet\ReferenceHelper\adjustComments(), PhpOffice\PhpSpreadsheet\ReferenceHelper\adjustDataValidations(), PhpOffice\PhpSpreadsheet\ReferenceHelper\adjustHyperlinks(), PhpOffice\PhpSpreadsheet\ReferenceHelper\adjustMergeCells(), PhpOffice\PhpSpreadsheet\ReferenceHelper\adjustPageBreaks(), PhpOffice\PhpSpreadsheet\ReferenceHelper\adjustProtectedCells(), PhpOffice\PhpSpreadsheet\ReferenceHelper\adjustRowDimensions(), PhpOffice\PhpSpreadsheet\ReferenceHelper\insertNewBefore(), and PhpOffice\PhpSpreadsheet\ReferenceHelper\updateFormulaReferences().

    {
        // Is it in another worksheet? Will not have to update anything.
        if (strpos($pCellRange, '!') !== false) {
            return $pCellRange;
        // Is it a range or a single cell?
        } elseif (!Coordinate::coordinateIsRange($pCellRange)) {
            // Single cell
            return $this->updateSingleCellReference($pCellRange, $pBefore, $pNumCols, $pNumRows);
        } elseif (Coordinate::coordinateIsRange($pCellRange)) {
            // Range
            return $this->updateCellRange($pCellRange, $pBefore, $pNumCols, $pNumRows);
        }

        // Return original
        return $pCellRange;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

updateCellReferencesAllWorksheets()

PhpOffice\PhpSpreadsheet\ReferenceHelper::updateCellReferencesAllWorksheets ( string  $formula, int  $insertColumns, int  $insertRows  )

private

Definition at line 779 of file ReferenceHelper.php.

References $columns, $row, $rows, PhpOffice\PhpSpreadsheet\Calculation\Calculation\CALCULATION_REGEXP_CELLREF_RELATIVE, PhpOffice\PhpSpreadsheet\Cell\Coordinate\columnIndexFromString(), and PhpOffice\PhpSpreadsheet\Cell\Coordinate\stringFromColumnIndex().

Referenced by PhpOffice\PhpSpreadsheet\ReferenceHelper\updateFormulaReferencesAnyWorksheet().

                                                                                                            : string
    {
        $splitCount = preg_match_all(
            '/' . Calculation::CALCULATION_REGEXP_CELLREF_RELATIVE . '/mui',
            $formula,
            $splitRanges,
            PREG_OFFSET_CAPTURE
        );

        $columnLengths = array_map('strlen', array_column($splitRanges[6], 0));
        $rowLengths = array_map('strlen', array_column($splitRanges[7], 0));
        $columnOffsets = array_column($splitRanges[6], 1);
        $rowOffsets = array_column($splitRanges[7], 1);

        $columns = $splitRanges[6];
        $rows = $splitRanges[7];

        while ($splitCount > 0) {
            --$splitCount;
            $columnLength = $columnLengths[$splitCount];
            $rowLength = $rowLengths[$splitCount];
            $columnOffset = $columnOffsets[$splitCount];
            $rowOffset = $rowOffsets[$splitCount];
            $column = $columns[$splitCount][0];
            $row = $rows[$splitCount][0];

            if (!empty($column) && $column[0] !== '$') {
                $column = Coordinate::stringFromColumnIndex(Coordinate::columnIndexFromString($column) + $insertColumns);
                $formula = substr($formula, 0, $columnOffset) . $column . substr($formula, $columnOffset + $columnLength);
            }
            if (!empty($row) && $row[0] !== '$') {
                $row += $insertRows;
                $formula = substr($formula, 0, $rowOffset) . $row . substr($formula, $rowOffset + $rowLength);
            }
        }

        return $formula;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

updateColumnRangesAllWorksheets()

PhpOffice\PhpSpreadsheet\ReferenceHelper::updateColumnRangesAllWorksheets ( string  $formula, int  $insertColumns  )

private

Definition at line 818 of file ReferenceHelper.php.

References PhpOffice\PhpSpreadsheet\Calculation\Calculation\CALCULATION_REGEXP_COLUMNRANGE_RELATIVE, PhpOffice\PhpSpreadsheet\Cell\Coordinate\columnIndexFromString(), and PhpOffice\PhpSpreadsheet\Cell\Coordinate\stringFromColumnIndex().

Referenced by PhpOffice\PhpSpreadsheet\ReferenceHelper\updateFormulaReferencesAnyWorksheet().

                                                                                         : string
    {
        $splitCount = preg_match_all(
            '/' . Calculation::CALCULATION_REGEXP_COLUMNRANGE_RELATIVE . '/mui',
            $formula,
            $splitRanges,
            PREG_OFFSET_CAPTURE
        );

        $fromColumnLengths = array_map('strlen', array_column($splitRanges[1], 0));
        $fromColumnOffsets = array_column($splitRanges[1], 1);
        $toColumnLengths = array_map('strlen', array_column($splitRanges[2], 0));
        $toColumnOffsets = array_column($splitRanges[2], 1);

        $fromColumns = $splitRanges[1];
        $toColumns = $splitRanges[2];

        while ($splitCount > 0) {
            --$splitCount;
            $fromColumnLength = $fromColumnLengths[$splitCount];
            $toColumnLength = $toColumnLengths[$splitCount];
            $fromColumnOffset = $fromColumnOffsets[$splitCount];
            $toColumnOffset = $toColumnOffsets[$splitCount];
            $fromColumn = $fromColumns[$splitCount][0];
            $toColumn = $toColumns[$splitCount][0];

            if (!empty($fromColumn) && $fromColumn[0] !== '$') {
                $fromColumn = Coordinate::stringFromColumnIndex(Coordinate::columnIndexFromString($fromColumn) + $insertColumns);
                $formula = substr($formula, 0, $fromColumnOffset) . $fromColumn . substr($formula, $fromColumnOffset + $fromColumnLength);
            }
            if (!empty($toColumn) && $toColumn[0] !== '$') {
                $toColumn = Coordinate::stringFromColumnIndex(Coordinate::columnIndexFromString($toColumn) + $insertColumns);
                $formula = substr($formula, 0, $toColumnOffset) . $toColumn . substr($formula, $toColumnOffset + $toColumnLength);
            }
        }

        return $formula;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

updateFormulaReferences()

PhpOffice\PhpSpreadsheet\ReferenceHelper::updateFormulaReferences	(		$pFormula = '',
			$pBefore = 'A1',
			$pNumCols = 0,
			$pNumRows = 0,
			$sheetName = ''
	)

Update references within formulas.

Parameters

string	$pFormula	Formula to update
string	$pBefore	Insert before this one
int	$pNumCols	Number of columns to insert
int	$pNumRows	Number of rows to insert
string	$sheetName	Worksheet name/title

Returns

string Updated formula

Definition at line 631 of file ReferenceHelper.php.

References $i, $row, PhpOffice\PhpSpreadsheet\Cell\Coordinate\columnIndexFromString(), PhpOffice\PhpSpreadsheet\Cell\Coordinate\coordinateFromString(), and PhpOffice\PhpSpreadsheet\ReferenceHelper\updateCellReference().

Referenced by PhpOffice\PhpSpreadsheet\ReferenceHelper\insertNewBefore().

    {
        //    Update cell references in the formula
        $formulaBlocks = explode('"', $pFormula);
        $i = false;
        foreach ($formulaBlocks as &$formulaBlock) {
            //    Ignore blocks that were enclosed in quotes (alternating entries in the $formulaBlocks array after the explode)
            if ($i = !$i) {
                $adjustCount = 0;
                $newCellTokens = $cellTokens = [];
                //    Search for row ranges (e.g. 'Sheet1'!3:5 or 3:5) with or without $ absolutes (e.g. $3:5)
                $matchCount = preg_match_all('/' . self::REFHELPER_REGEXP_ROWRANGE . '/i', ' ' . $formulaBlock . ' ', $matches, PREG_SET_ORDER);
                if ($matchCount > 0) {
                    foreach ($matches as $match) {
                        $fromString = ($match[2] > '') ? $match[2] . '!' : '';
                        $fromString .= $match[3] . ':' . $match[4];
                        $modified3 = substr($this->updateCellReference('$A' . $match[3], $pBefore, $pNumCols, $pNumRows), 2);
                        $modified4 = substr($this->updateCellReference('$A' . $match[4], $pBefore, $pNumCols, $pNumRows), 2);

                        if ($match[3] . ':' . $match[4] !== $modified3 . ':' . $modified4) {
                            if (($match[2] == '') || (trim($match[2], "'") == $sheetName)) {
                                $toString = ($match[2] > '') ? $match[2] . '!' : '';
                                $toString .= $modified3 . ':' . $modified4;
                                //    Max worksheet size is 1,048,576 rows by 16,384 columns in Excel 2007, so our adjustments need to be at least one digit more
                                $column = 100000;
                                $row = 10000000 + (int) trim($match[3], '$');
                                $cellIndex = $column . $row;

                                $newCellTokens[$cellIndex] = preg_quote($toString, '/');
                                $cellTokens[$cellIndex] = '/(?<!\d\$\!)' . preg_quote($fromString, '/') . '(?!\d)/i';
                                ++$adjustCount;
                            }
                        }
                    }
                }
                //    Search for column ranges (e.g. 'Sheet1'!C:E or C:E) with or without $ absolutes (e.g. $C:E)
                $matchCount = preg_match_all('/' . self::REFHELPER_REGEXP_COLRANGE . '/i', ' ' . $formulaBlock . ' ', $matches, PREG_SET_ORDER);
                if ($matchCount > 0) {
                    foreach ($matches as $match) {
                        $fromString = ($match[2] > '') ? $match[2] . '!' : '';
                        $fromString .= $match[3] . ':' . $match[4];
                        $modified3 = substr($this->updateCellReference($match[3] . '$1', $pBefore, $pNumCols, $pNumRows), 0, -2);
                        $modified4 = substr($this->updateCellReference($match[4] . '$1', $pBefore, $pNumCols, $pNumRows), 0, -2);

                        if ($match[3] . ':' . $match[4] !== $modified3 . ':' . $modified4) {
                            if (($match[2] == '') || (trim($match[2], "'") == $sheetName)) {
                                $toString = ($match[2] > '') ? $match[2] . '!' : '';
                                $toString .= $modified3 . ':' . $modified4;
                                //    Max worksheet size is 1,048,576 rows by 16,384 columns in Excel 2007, so our adjustments need to be at least one digit more
                                $column = Coordinate::columnIndexFromString(trim($match[3], '$')) + 100000;
                                $row = 10000000;
                                $cellIndex = $column . $row;

                                $newCellTokens[$cellIndex] = preg_quote($toString, '/');
                                $cellTokens[$cellIndex] = '/(?<![A-Z\$\!])' . preg_quote($fromString, '/') . '(?![A-Z])/i';
                                ++$adjustCount;
                            }
                        }
                    }
                }
                //    Search for cell ranges (e.g. 'Sheet1'!A3:C5 or A3:C5) with or without $ absolutes (e.g. $A1:C$5)
                $matchCount = preg_match_all('/' . self::REFHELPER_REGEXP_CELLRANGE . '/i', ' ' . $formulaBlock . ' ', $matches, PREG_SET_ORDER);
                if ($matchCount > 0) {
                    foreach ($matches as $match) {
                        $fromString = ($match[2] > '') ? $match[2] . '!' : '';
                        $fromString .= $match[3] . ':' . $match[4];
                        $modified3 = $this->updateCellReference($match[3], $pBefore, $pNumCols, $pNumRows);
                        $modified4 = $this->updateCellReference($match[4], $pBefore, $pNumCols, $pNumRows);

                        if ($match[3] . $match[4] !== $modified3 . $modified4) {
                            if (($match[2] == '') || (trim($match[2], "'") == $sheetName)) {
                                $toString = ($match[2] > '') ? $match[2] . '!' : '';
                                $toString .= $modified3 . ':' . $modified4;
                                [$column, $row] = Coordinate::coordinateFromString($match[3]);
                                //    Max worksheet size is 1,048,576 rows by 16,384 columns in Excel 2007, so our adjustments need to be at least one digit more
                                $column = Coordinate::columnIndexFromString(trim($column, '$')) + 100000;
                                $row = (int) trim($row, '$') + 10000000;
                                $cellIndex = $column . $row;

                                $newCellTokens[$cellIndex] = preg_quote($toString, '/');
                                $cellTokens[$cellIndex] = '/(?<![A-Z]\$\!)' . preg_quote($fromString, '/') . '(?!\d)/i';
                                ++$adjustCount;
                            }
                        }
                    }
                }
                //    Search for cell references (e.g. 'Sheet1'!A3 or C5) with or without $ absolutes (e.g. $A1 or C$5)
                $matchCount = preg_match_all('/' . self::REFHELPER_REGEXP_CELLREF . '/i', ' ' . $formulaBlock . ' ', $matches, PREG_SET_ORDER);

                if ($matchCount > 0) {
                    foreach ($matches as $match) {
                        $fromString = ($match[2] > '') ? $match[2] . '!' : '';
                        $fromString .= $match[3];

                        $modified3 = $this->updateCellReference($match[3], $pBefore, $pNumCols, $pNumRows);
                        if ($match[3] !== $modified3) {
                            if (($match[2] == '') || (trim($match[2], "'") == $sheetName)) {
                                $toString = ($match[2] > '') ? $match[2] . '!' : '';
                                $toString .= $modified3;
                                [$column, $row] = Coordinate::coordinateFromString($match[3]);
                                //    Max worksheet size is 1,048,576 rows by 16,384 columns in Excel 2007, so our adjustments need to be at least one digit more
                                $column = Coordinate::columnIndexFromString(trim($column, '$')) + 100000;
                                $row = (int) trim($row, '$') + 10000000;
                                $cellIndex = $row . $column;

                                $newCellTokens[$cellIndex] = preg_quote($toString, '/');
                                $cellTokens[$cellIndex] = '/(?<![A-Z\$\!])' . preg_quote($fromString, '/') . '(?!\d)/i';
                                ++$adjustCount;
                            }
                        }
                    }
                }
                if ($adjustCount > 0) {
                    if ($pNumCols > 0 || $pNumRows > 0) {
                        krsort($cellTokens);
                        krsort($newCellTokens);
                    } else {
                        ksort($cellTokens);
                        ksort($newCellTokens);
                    }   //  Update cell references in the formula
                    $formulaBlock = str_replace('\\', '', preg_replace($cellTokens, $newCellTokens, $formulaBlock));
                }
            }
        }
        unset($formulaBlock);

        //    Then rebuild the formula string
        return implode('"', $formulaBlocks);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

updateFormulaReferencesAnyWorksheet()

PhpOffice\PhpSpreadsheet\ReferenceHelper::updateFormulaReferencesAnyWorksheet	(	string	$formula = '',
		int	$insertColumns = 0,
		int	$insertRows = 0
	)

Update all cell references within a formula, irrespective of worksheet.

Definition at line 764 of file ReferenceHelper.php.

References PhpOffice\PhpSpreadsheet\ReferenceHelper\updateCellReferencesAllWorksheets(), PhpOffice\PhpSpreadsheet\ReferenceHelper\updateColumnRangesAllWorksheets(), and PhpOffice\PhpSpreadsheet\ReferenceHelper\updateRowRangesAllWorksheets().

                                                                                                                          : string
    {
        $formula = $this->updateCellReferencesAllWorksheets($formula, $insertColumns, $insertRows);

        if ($insertColumns !== 0) {
            $formula = $this->updateColumnRangesAllWorksheets($formula, $insertColumns);
        }

        if ($insertRows !== 0) {
            $formula = $this->updateRowRangesAllWorksheets($formula, $insertRows);
        }

        return $formula;
    }

Here is the call graph for this function:

updateNamedFormulas()

PhpOffice\PhpSpreadsheet\ReferenceHelper::updateNamedFormulas	(	Spreadsheet	$spreadsheet,
			$oldName = '',
			$newName = ''
	)

Update named formulas (i.e.

containing worksheet references / named ranges).

Parameters

Spreadsheet	$spreadsheet	Object to update
string	$oldName	Old name (name to replace)
string	$newName	New name

Definition at line 931 of file ReferenceHelper.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\getWorksheetIterator(), and PhpOffice\PhpSpreadsheet\Cell\DataType\TYPE_FORMULA.

                                                                                               : void
    {
        if ($oldName == '') {
            return;
        }

        foreach ($spreadsheet->getWorksheetIterator() as $sheet) {
            foreach ($sheet->getCoordinates(false) as $coordinate) {
                $cell = $sheet->getCell($coordinate);
                if (($cell !== null) && ($cell->getDataType() == DataType::TYPE_FORMULA)) {
                    $formula = $cell->getValue();
                    if (strpos($formula, $oldName) !== false) {
                        $formula = str_replace("'" . $oldName . "'!", "'" . $newName . "'!", $formula);
                        $formula = str_replace($oldName . '!', $newName . '!', $formula);
                        $cell->setValueExplicit($formula, DataType::TYPE_FORMULA);
                    }
                }
            }
        }
    }

Here is the call graph for this function:

updateRowRangesAllWorksheets()

PhpOffice\PhpSpreadsheet\ReferenceHelper::updateRowRangesAllWorksheets ( string  $formula, int  $insertRows  )

private

Definition at line 857 of file ReferenceHelper.php.

References PhpOffice\PhpSpreadsheet\Calculation\Calculation\CALCULATION_REGEXP_ROWRANGE_RELATIVE.

Referenced by PhpOffice\PhpSpreadsheet\ReferenceHelper\updateFormulaReferencesAnyWorksheet().

                                                                                   : string
    {
        $splitCount = preg_match_all(
            '/' . Calculation::CALCULATION_REGEXP_ROWRANGE_RELATIVE . '/mui',
            $formula,
            $splitRanges,
            PREG_OFFSET_CAPTURE
        );

        $fromRowLengths = array_map('strlen', array_column($splitRanges[1], 0));
        $fromRowOffsets = array_column($splitRanges[1], 1);
        $toRowLengths = array_map('strlen', array_column($splitRanges[2], 0));
        $toRowOffsets = array_column($splitRanges[2], 1);

        $fromRows = $splitRanges[1];
        $toRows = $splitRanges[2];

        while ($splitCount > 0) {
            --$splitCount;
            $fromRowLength = $fromRowLengths[$splitCount];
            $toRowLength = $toRowLengths[$splitCount];
            $fromRowOffset = $fromRowOffsets[$splitCount];
            $toRowOffset = $toRowOffsets[$splitCount];
            $fromRow = $fromRows[$splitCount][0];
            $toRow = $toRows[$splitCount][0];

            if (!empty($fromRow) && $fromRow[0] !== '$') {
                $fromRow += $insertRows;
                $formula = substr($formula, 0, $fromRowOffset) . $fromRow . substr($formula, $fromRowOffset + $fromRowLength);
            }
            if (!empty($toRow) && $toRow[0] !== '$') {
                $toRow += $insertRows;
                $formula = substr($formula, 0, $toRowOffset) . $toRow . substr($formula, $toRowOffset + $toRowLength);
            }
        }

        return $formula;
    }

Here is the caller graph for this function:

updateSingleCellReference()

PhpOffice\PhpSpreadsheet\ReferenceHelper::updateSingleCellReference (   $pCellReference = 'A1',   $pBefore = 'A1',   $pNumCols = 0,   $pNumRows = 0  )

private

Update single cell reference.

Parameters

string	$pCellReference	Single cell reference
string	$pBefore	Insert before this one
int	$pNumCols	Number of columns to increment
int	$pNumRows	Number of rows to increment

Returns

string Updated cell reference

Definition at line 1000 of file ReferenceHelper.php.

References PhpOffice\PhpSpreadsheet\Cell\Coordinate\columnIndexFromString(), PhpOffice\PhpSpreadsheet\Cell\Coordinate\coordinateFromString(), PhpOffice\PhpSpreadsheet\Cell\Coordinate\coordinateIsRange(), and PhpOffice\PhpSpreadsheet\Cell\Coordinate\stringFromColumnIndex().

Referenced by PhpOffice\PhpSpreadsheet\ReferenceHelper\updateCellRange(), and PhpOffice\PhpSpreadsheet\ReferenceHelper\updateCellReference().

    {
        if (Coordinate::coordinateIsRange($pCellReference)) {
            throw new Exception('Only single cell references may be passed to this method.');
        }

        // Get coordinate of $pBefore
        [$beforeColumn, $beforeRow] = Coordinate::coordinateFromString($pBefore);

        // Get coordinate of $pCellReference
        [$newColumn, $newRow] = Coordinate::coordinateFromString($pCellReference);

        // Verify which parts should be updated
        $updateColumn = (($newColumn[0] != '$') && ($beforeColumn[0] != '$') && (Coordinate::columnIndexFromString($newColumn) >= Coordinate::columnIndexFromString($beforeColumn)));
        $updateRow = (($newRow[0] != '$') && ($beforeRow[0] != '$') && $newRow >= $beforeRow);

        // Create new column reference
        if ($updateColumn) {
            $newColumn = Coordinate::stringFromColumnIndex(Coordinate::columnIndexFromString($newColumn) + $pNumCols);
        }

        // Create new row reference
        if ($updateRow) {
            $newRow = (int) $newRow + $pNumRows;
        }

        // Return new reference
        return $newColumn . $newRow;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$instance

PhpOffice\PhpSpreadsheet\ReferenceHelper::$instance

staticprivate

Definition at line 24 of file ReferenceHelper.php.

REFHELPER_REGEXP_CELLRANGE

const PhpOffice\PhpSpreadsheet\ReferenceHelper::REFHELPER_REGEXP_CELLRANGE = '((\w*|\'[^!]*\')!)?(\$?[a-z]{1,3}\$?\d+):(\$?[a-z]{1,3}\$?\d+)'

Definition at line 15 of file ReferenceHelper.php.

REFHELPER_REGEXP_CELLREF

const PhpOffice\PhpSpreadsheet\ReferenceHelper::REFHELPER_REGEXP_CELLREF = '((\w*|\'[^!]*\')!)?(?<![:a-z\$])(\$?[a-z]{1,3}\$?\d+)(?=[^:!\d\'])'

Constants.

Regular Expressions

Definition at line 14 of file ReferenceHelper.php.

REFHELPER_REGEXP_COLRANGE

const PhpOffice\PhpSpreadsheet\ReferenceHelper::REFHELPER_REGEXP_COLRANGE = '((\w*|\'[^!]*\')!)?(\$?[a-z]{1,3}):(\$?[a-z]{1,3})'

Definition at line 17 of file ReferenceHelper.php.

REFHELPER_REGEXP_ROWRANGE

const PhpOffice\PhpSpreadsheet\ReferenceHelper::REFHELPER_REGEXP_ROWRANGE = '((\w*|\'[^!]*\')!)?(\$?\d+):(\$?\d+)'

Definition at line 16 of file ReferenceHelper.php.

---

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

• libs/composer/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/ReferenceHelper.php