PhpOffice\PhpSpreadsheet\ReferenceHelper Class Reference

Public Member Functions
	__clone ()
	__clone implementation.
	insertNewBefore (string $beforeCellAddress, int $numberOfColumns, int $numberOfRows, Worksheet $worksheet)
	Insert a new column or row, updating all possible related data.
	updateFormulaReferences (string $formula='', string $beforeCellAddress='A1', int $numberOfColumns=0, int $numberOfRows=0, string $worksheetName='', bool $includeAbsoluteReferences=false, bool $onlyAbsoluteReferences=false)
	Update references within formulas.
	updateFormulaReferencesAnyWorksheet (string $formula='', int $numberOfColumns=0, int $numberOfRows=0)
	Update all cell references within a formula, irrespective of worksheet.
	updateNamedFormulae (Spreadsheet $spreadsheet, string $oldName='', string $newName='')
	Update named formulae (i.e.

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

Public Attributes
const	REFHELPER_REGEXP_CELLRANGE = self::SHEETNAME_PART . '?(\$?[a-z]{1,3}\$?\d+):(\$?[a-z]{1,3}\$?\d+)'
const	REFHELPER_REGEXP_CELLREF = self::SHEETNAME_PART . '?(?<![:a-z1-9_\.\$])(\$?[a-z]{1,3}\$?\d+)(?=[^:!\d\'])'
const	REFHELPER_REGEXP_COLRANGE = self::SHEETNAME_PART . '?(\$?[a-z]{1,3}):(\$?[a-z]{1,3})'
const	REFHELPER_REGEXP_ROWRANGE = self::SHEETNAME_PART . '?(\$?\d+):(\$?\d+)'

Protected Member Functions
	__construct ()
	Create a new ReferenceHelper.
	adjustColumnDimensions (Worksheet $worksheet)
	Update column dimensions when inserting/deleting rows/columns.
	adjustComments (Worksheet $worksheet)
	Update cell comments when inserting/deleting rows/columns.
	adjustConditionalFormatting (Worksheet $worksheet, int $numberOfColumns, int $numberOfRows)
	Update conditional formatting styles when inserting/deleting rows/columns.
	adjustDataValidations (Worksheet $worksheet, int $numberOfColumns, int $numberOfRows, string $beforeCellAddress)
	Update data validations when inserting/deleting rows/columns.
	adjustHyperlinks (Worksheet $worksheet, int $numberOfColumns, int $numberOfRows)
	Update hyperlinks when inserting/deleting rows/columns.
	adjustMergeCells (Worksheet $worksheet)
	Update merged cells when inserting/deleting rows/columns.
	adjustPageBreaks (Worksheet $worksheet, int $numberOfColumns, int $numberOfRows)
	Update page breaks when inserting/deleting rows/columns.
	adjustProtectedCells (Worksheet $worksheet, int $numberOfColumns, int $numberOfRows)
	Update protected cells when inserting/deleting rows/columns.
	adjustRowDimensions (Worksheet $worksheet, int $beforeRow, int $numberOfRows)
	Update row dimensions when inserting/deleting rows/columns.

Member Function Documentation

__clone()

PhpOffice\PhpSpreadsheet\ReferenceHelper::__clone ( )

final

__clone implementation.

Cloning should not be allowed in a Singleton!

adjustColumnDimensions()

PhpOffice\PhpSpreadsheet\ReferenceHelper::adjustColumnDimensions ( Worksheet $worksheet )

protected

Update column dimensions when inserting/deleting rows/columns.

Parameters

Worksheet

$worksheet

The worksheet that we're editing

adjustComments()

PhpOffice\PhpSpreadsheet\ReferenceHelper::adjustComments ( Worksheet $worksheet )

protected

Update cell comments when inserting/deleting rows/columns.

Parameters

Worksheet

$worksheet

The worksheet that we're editing

adjustConditionalFormatting()

PhpOffice\PhpSpreadsheet\ReferenceHelper::adjustConditionalFormatting ( Worksheet $worksheet, int $numberOfColumns, int $numberOfRows )

protected

Update conditional formatting styles when inserting/deleting rows/columns.

Parameters

Worksheet	$worksheet	The worksheet that we're editing
int	$numberOfColumns	Number of columns to insert/delete (negative values indicate deletion)
int	$numberOfRows	Number of rows to insert/delete (negative values indicate deletion)

adjustDataValidations()

PhpOffice\PhpSpreadsheet\ReferenceHelper::adjustDataValidations ( Worksheet $worksheet, int $numberOfColumns, int $numberOfRows, string $beforeCellAddress )

protected

Update data validations when inserting/deleting rows/columns.

Parameters

Worksheet	$worksheet	The worksheet that we're editing
int	$numberOfColumns	Number of columns to insert/delete (negative values indicate deletion)
int	$numberOfRows	Number of rows to insert/delete (negative values indicate deletion)

adjustHyperlinks()

PhpOffice\PhpSpreadsheet\ReferenceHelper::adjustHyperlinks ( Worksheet $worksheet, int $numberOfColumns, int $numberOfRows )

protected

Update hyperlinks when inserting/deleting rows/columns.

Parameters

Worksheet	$worksheet	The worksheet that we're editing
int	$numberOfColumns	Number of columns to insert/delete (negative values indicate deletion)
int	$numberOfRows	Number of rows to insert/delete (negative values indicate deletion)

adjustMergeCells()

PhpOffice\PhpSpreadsheet\ReferenceHelper::adjustMergeCells ( Worksheet $worksheet )

protected

Update merged cells when inserting/deleting rows/columns.

Parameters

Worksheet

$worksheet

The worksheet that we're editing

adjustPageBreaks()

PhpOffice\PhpSpreadsheet\ReferenceHelper::adjustPageBreaks ( Worksheet $worksheet, int $numberOfColumns, int $numberOfRows )

protected

Update page breaks when inserting/deleting rows/columns.

Parameters

Worksheet	$worksheet	The worksheet that we're editing
int	$numberOfColumns	Number of columns to insert/delete (negative values indicate deletion)
int	$numberOfRows	Number of rows to insert/delete (negative values indicate deletion)

adjustProtectedCells()

PhpOffice\PhpSpreadsheet\ReferenceHelper::adjustProtectedCells ( Worksheet $worksheet, int $numberOfColumns, int $numberOfRows )

protected

Update protected cells when inserting/deleting rows/columns.

Parameters

Worksheet	$worksheet	The worksheet that we're editing
int	$numberOfColumns	Number of columns to insert/delete (negative values indicate deletion)
int	$numberOfRows	Number of rows to insert/delete (negative values indicate deletion)

adjustRowDimensions()

PhpOffice\PhpSpreadsheet\ReferenceHelper::adjustRowDimensions ( Worksheet $worksheet, int $beforeRow, int $numberOfRows )

protected

Update row dimensions when inserting/deleting rows/columns.

Parameters

Worksheet	$worksheet	The worksheet that we're editing
int	$beforeRow	Number of the row we're inserting/deleting before
int	$numberOfRows	Number of rows to insert/delete (negative values indicate deletion)

cellReverseSort()

static PhpOffice\PhpSpreadsheet\ReferenceHelper::cellReverseSort ( string $a, string $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')

cellSort()

static PhpOffice\PhpSpreadsheet\ReferenceHelper::cellSort ( string $a, string $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')

columnReverseSort()

static PhpOffice\PhpSpreadsheet\ReferenceHelper::columnReverseSort ( string $a, string $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')

columnSort()

static PhpOffice\PhpSpreadsheet\ReferenceHelper::columnSort ( string $a, string $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')

insertNewBefore()

PhpOffice\PhpSpreadsheet\ReferenceHelper::insertNewBefore	(	string	$beforeCellAddress,
		int	$numberOfColumns,
		int	$numberOfRows,
		Worksheet	$worksheet )

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

Parameters

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

updateFormulaReferences()

PhpOffice\PhpSpreadsheet\ReferenceHelper::updateFormulaReferences	(	string	$formula = '',
		string	$beforeCellAddress = 'A1',
		int	$numberOfColumns = 0,
		int	$numberOfRows = 0,
		string	$worksheetName = '',
		bool	$includeAbsoluteReferences = false,
		bool	$onlyAbsoluteReferences = false )

Update references within formulas.

Parameters

string	$formula	Formula to update
string	$beforeCellAddress	Insert before this one
int	$numberOfColumns	Number of columns to insert
int	$numberOfRows	Number of rows to insert
string	$worksheetName	Worksheet name/title

Return values

string

Updated formula

updateNamedFormulae()

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

Update named formulae (i.e.

containing worksheet references / named ranges).

Parameters

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

---

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

• lib/phpspreadsheet/phpspreadsheet/src/PhpSpreadsheet/ReferenceHelper.php