Constants

REFHELPER_REGEXP_CELLREF

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

Regular Expressions

REFHELPER_REGEXP_CELLRANGE

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

REFHELPER_REGEXP_ROWRANGE

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

REFHELPER_REGEXP_COLRANGE

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

Properties

Methods

columnSort()

columnSort(string  $a, string  $b) : integer

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

integer

columnReverseSort()

columnReverseSort(string  $a, string  $b) : integer

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

integer

cellSort()

cellSort(string  $a, string  $b) : integer

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

integer

cellReverseSort()

cellReverseSort(string  $a, string  $b) : integer

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

integer

insertNewBefore()

insertNewBefore(string  $pBefore = 'A1', integer  $pNumCols, integer  $pNumRows, \PHPExcel_Worksheet  $pSheet = NULL) 

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

Parameters

string $pBefore

Insert before this cell address (e.g. 'A1')

integer $pNumCols

Number of columns to insert/delete (negative values indicate deletion)

integer $pNumRows

Number of rows to insert/delete (negative values indicate deletion)

\PHPExcel_Worksheet $pSheet

The worksheet that we're editing

Throws

\PHPExcel_Exception

updateFormulaReferences()

updateFormulaReferences(string  $pFormula = '', integer  $pBefore = 'A1', integer  $pNumCols, integer  $pNumRows, string  $sheetName = '') : string

Update references within formulas

Parameters

string $pFormula

Formula to update

integer $pBefore

Insert before this one

integer $pNumCols

Number of columns to insert

integer $pNumRows

Number of rows to insert

string $sheetName

Worksheet name/title

Throws

\PHPExcel_Exception

Returns

string —

Updated formula

updateCellReference()

updateCellReference(string  $pCellRange = 'A1', integer  $pBefore = 'A1', integer  $pNumCols, integer  $pNumRows) : string

Update cell reference

Parameters

string $pCellRange

Cell range

integer $pBefore

Insert before this one

integer $pNumCols

Number of columns to increment

integer $pNumRows

Number of rows to increment

Throws

\PHPExcel_Exception

Returns

string —

Updated cell range

updateNamedFormulas()

updateNamedFormulas(\PHPExcel  $pPhpExcel, string  $oldName = '', string  $newName = '') 

Update named formulas (i.e. containing worksheet references / named ranges)

Parameters

\PHPExcel $pPhpExcel

Object to update

string $oldName

Old name (name to replace)

string $newName

New name

__clone()

__clone() 

__clone implementation. Cloning should not be allowed in a Singleton!

Throws

\PHPExcel_Exception

__construct()

__construct() 

Create a new PHPExcel_ReferenceHelper

_adjustPageBreaks()

_adjustPageBreaks(\PHPExcel_Worksheet  $pSheet, string  $pBefore, integer  $beforeColumnIndex, integer  $pNumCols, integer  $beforeRow, integer  $pNumRows) 

Update page breaks when inserting/deleting rows/columns

Parameters

\PHPExcel_Worksheet $pSheet

The worksheet that we're editing

string $pBefore

Insert/Delete before this cell address (e.g. 'A1')

integer $beforeColumnIndex

Index number of the column we're inserting/deleting before

integer $pNumCols

Number of columns to insert/delete (negative values indicate deletion)

integer $beforeRow

Number of the row we're inserting/deleting before

integer $pNumRows

Number of rows to insert/delete (negative values indicate deletion)

_adjustComments()

_adjustComments(\PHPExcel_Worksheet  $pSheet, string  $pBefore, integer  $beforeColumnIndex, integer  $pNumCols, integer  $beforeRow, integer  $pNumRows) 

Update cell comments when inserting/deleting rows/columns

Parameters

\PHPExcel_Worksheet $pSheet

The worksheet that we're editing

string $pBefore

Insert/Delete before this cell address (e.g. 'A1')

integer $beforeColumnIndex

Index number of the column we're inserting/deleting before

integer $pNumCols

Number of columns to insert/delete (negative values indicate deletion)

integer $beforeRow

Number of the row we're inserting/deleting before

integer $pNumRows

Number of rows to insert/delete (negative values indicate deletion)

_adjustHyperlinks()

_adjustHyperlinks(\PHPExcel_Worksheet  $pSheet, string  $pBefore, integer  $beforeColumnIndex, integer  $pNumCols, integer  $beforeRow, integer  $pNumRows) 

Update hyperlinks when inserting/deleting rows/columns

Parameters

\PHPExcel_Worksheet $pSheet

The worksheet that we're editing

string $pBefore

Insert/Delete before this cell address (e.g. 'A1')

integer $beforeColumnIndex

Index number of the column we're inserting/deleting before

integer $pNumCols

Number of columns to insert/delete (negative values indicate deletion)

integer $beforeRow

Number of the row we're inserting/deleting before

integer $pNumRows

Number of rows to insert/delete (negative values indicate deletion)

_adjustDataValidations()

_adjustDataValidations(\PHPExcel_Worksheet  $pSheet, string  $pBefore, integer  $beforeColumnIndex, integer  $pNumCols, integer  $beforeRow, integer  $pNumRows) 

Update data validations when inserting/deleting rows/columns

Parameters

\PHPExcel_Worksheet $pSheet

The worksheet that we're editing

string $pBefore

Insert/Delete before this cell address (e.g. 'A1')

integer $beforeColumnIndex

Index number of the column we're inserting/deleting before

integer $pNumCols

Number of columns to insert/delete (negative values indicate deletion)

integer $beforeRow

Number of the row we're inserting/deleting before

integer $pNumRows

Number of rows to insert/delete (negative values indicate deletion)

_adjustMergeCells()

_adjustMergeCells(\PHPExcel_Worksheet  $pSheet, string  $pBefore, integer  $beforeColumnIndex, integer  $pNumCols, integer  $beforeRow, integer  $pNumRows) 

Update merged cells when inserting/deleting rows/columns

Parameters

\PHPExcel_Worksheet $pSheet

The worksheet that we're editing

string $pBefore

Insert/Delete before this cell address (e.g. 'A1')

integer $beforeColumnIndex

Index number of the column we're inserting/deleting before

integer $pNumCols

Number of columns to insert/delete (negative values indicate deletion)

integer $beforeRow

Number of the row we're inserting/deleting before

integer $pNumRows

Number of rows to insert/delete (negative values indicate deletion)

_adjustProtectedCells()

_adjustProtectedCells(\PHPExcel_Worksheet  $pSheet, string  $pBefore, integer  $beforeColumnIndex, integer  $pNumCols, integer  $beforeRow, integer  $pNumRows) 

Update protected cells when inserting/deleting rows/columns

Parameters

\PHPExcel_Worksheet $pSheet

The worksheet that we're editing

string $pBefore

Insert/Delete before this cell address (e.g. 'A1')

integer $beforeColumnIndex

Index number of the column we're inserting/deleting before

integer $pNumCols

Number of columns to insert/delete (negative values indicate deletion)

integer $beforeRow

Number of the row we're inserting/deleting before

integer $pNumRows

Number of rows to insert/delete (negative values indicate deletion)

_adjustColumnDimensions()

_adjustColumnDimensions(\PHPExcel_Worksheet  $pSheet, string  $pBefore, integer  $beforeColumnIndex, integer  $pNumCols, integer  $beforeRow, integer  $pNumRows) 

Update column dimensions when inserting/deleting rows/columns

Parameters

\PHPExcel_Worksheet $pSheet

The worksheet that we're editing

string $pBefore

Insert/Delete before this cell address (e.g. 'A1')

integer $beforeColumnIndex

Index number of the column we're inserting/deleting before

integer $pNumCols

Number of columns to insert/delete (negative values indicate deletion)

integer $beforeRow

Number of the row we're inserting/deleting before

integer $pNumRows

Number of rows to insert/delete (negative values indicate deletion)

_adjustRowDimensions()

_adjustRowDimensions(\PHPExcel_Worksheet  $pSheet, string  $pBefore, integer  $beforeColumnIndex, integer  $pNumCols, integer  $beforeRow, integer  $pNumRows) 

Update row dimensions when inserting/deleting rows/columns

Parameters

\PHPExcel_Worksheet $pSheet

The worksheet that we're editing

string $pBefore

Insert/Delete before this cell address (e.g. 'A1')

integer $beforeColumnIndex

Index number of the column we're inserting/deleting before

integer $pNumCols

Number of columns to insert/delete (negative values indicate deletion)

integer $beforeRow

Number of the row we're inserting/deleting before

integer $pNumRows

Number of rows to insert/delete (negative values indicate deletion)

cellAddressInDeleteRange()

cellAddressInDeleteRange(string  $cellAddress, integer  $beforeRow, integer  $pNumRows, integer  $beforeColumnIndex, integer  $pNumCols) : boolean

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

Parameters

string $cellAddress

Address of the cell we're testing

integer $beforeRow

Number of the row we're inserting/deleting before

integer $pNumRows

Number of rows to insert/delete (negative values indicate deletion)

integer $beforeColumnIndex

Index number of the column we're inserting/deleting before

integer $pNumCols

Number of columns to insert/delete (negative values indicate deletion)

Returns

boolean

_updateCellRange()

_updateCellRange(string  $pCellRange = 'A1:A1', integer  $pBefore = 'A1', integer  $pNumCols, integer  $pNumRows) : string

Update cell range

Parameters

string $pCellRange

Cell range (e.g. 'B2:D4', 'B:C' or '2:3')

integer $pBefore

Insert before this one

integer $pNumCols

Number of columns to increment

integer $pNumRows

Number of rows to increment

Throws

\PHPExcel_Exception

Returns

string —

Updated cell range

_updateSingleCellReference()

_updateSingleCellReference(string  $pCellReference = 'A1', integer  $pBefore = 'A1', integer  $pNumCols, integer  $pNumRows) : string

Update single cell reference

Parameters

string $pCellReference

Single cell reference

integer $pBefore

Insert before this one

integer $pNumCols

Number of columns to increment

integer $pNumRows

Number of rows to increment

Throws

\PHPExcel_Exception

Returns

string —

Updated cell reference