PHPExcel

# Class: PHPExcel_ReferenceHelper Source Location: /PHPExcel/ReferenceHelper.php
### Class Overview
PHPExcel_ReferenceHelper (Singleton) #### Author(s): #### Copyright: Copyright (c) 2006 - 2010 PHPExcel (http://www.codeplex.com/PHPExcel) | ### Variables $_instance | ### Methods __construct getInstance insertNewBefore updateCellReference updateFormulaReferences updateNamedFormulas _updateCellRange _updateSingleCellReference __clone
### Class Details [line 66] PHPExcel_ReferenceHelper (Singleton) PHPExcel_ReferenceHelper (Singleton) #### Tags:
copyright: | Copyright (c) 2006 - 2010 PHPExcel (http://www.codeplex.com/PHPExcel)
[ Top ] ### Class Variables #### static $_instance = [line 73] Instance of this class Instance of this class #### Tags:
access: | private
Type: | PHPExcel_ReferenceHelper
[ Top ] ### Class Methods ### static method getInstance [line 80]
`static PHPExcel_ReferenceHelper getInstance( )`
Get an instance of this class Get an instance of this class #### Tags:
access: | public
[ Top ] ### constructor __construct [line 91]
`PHPExcel_ReferenceHelper __construct( )`
Create a new PHPExcel_ReferenceHelper Create a new PHPExcel_ReferenceHelper #### Tags:
access: | protected
[ Top ] ### method insertNewBefore [line 102]
`void insertNewBefore( [int $pBefore = 'A1'], [int $pNumCols = 0], [int $pNumRows = 0], [ $pSheet = null])`
Insert a new column, updating all possible related data Insert a new column, updating all possible related data #### Tags:
throws: | Exception
access: | public
#### Parameters:
int | $pBefore | Insert before this one
int | $pNumCols | Number of columns to insert
int | $pNumRows | Number of rows to insert
PHPExcel_Worksheet | $pSheet |
[ Top ] ### method updateCellReference [line 434]
`string updateCellReference( [string $pCellRange = 'A1'], [int $pBefore = 'A1'], [int $pNumCols = 0], [int $pNumRows = 0])`
Update cell reference Update cell reference #### Tags:
return: | Updated cell range
throws: | Exception
access: | public
#### Parameters:
string | $pCellRange | Cell range
int | $pBefore | Insert before this one
int | $pNumCols | Number of columns to increment
int | $pNumRows | Number of rows to increment
[ Top ] ### method updateFormulaReferences [line 379]
`string updateFormulaReferences( [string $pFormula = ''], [int $pBefore = 'A1'], [int $pNumCols = 0], [int $pNumRows = 0])`
Update references within formulas Update references within formulas #### Tags:
return: | Updated formula
throws: | Exception
access: | public
#### Parameters:
string | $pFormula | Formula to update
int | $pBefore | Insert before this one
int | $pNumCols | Number of columns to insert
int | $pNumRows | Number of rows to insert
[ Top ] ### method updateNamedFormulas [line 458]
`void updateNamedFormulas( PHPExcel $pPhpExcel, [string $oldName = ''], [string $newName = ''])`
Update named formulas (i. Update named formulas (i.e. containing worksheet references / named ranges) #### Tags:
access: | public
#### Parameters:
PHPExcel | $pPhpExcel | Object to update
string | $oldName | Old name (name to replace)
string | $newName | New name
[ Top ] ### method _updateCellRange [line 487]
`string _updateCellRange( [string $pCellRange = 'A1:A1'], [int $pBefore = 'A1'], [int $pNumCols = 0], [int $pNumRows = 0])`
Update cell range Update cell range #### Tags:
return: | Updated cell range
throws: | Exception
access: | private
#### Parameters:
string | $pCellRange | Cell range
int | $pBefore | Insert before this one
int | $pNumCols | Number of columns to increment
int | $pNumRows | Number of rows to increment
[ Top ] ### method _updateSingleCellReference [line 514]
`string _updateSingleCellReference( [string $pCellReference = 'A1'], [int $pBefore = 'A1'], [int $pNumCols = 0], [int $pNumRows = 0])`
Update single cell reference Update single cell reference #### Tags:
return: | Updated cell reference
throws: | Exception
access: | private
#### Parameters:
string | $pCellReference | Single cell reference
int | $pBefore | Insert before this one
int | $pNumCols | Number of columns to increment
int | $pNumRows | Number of rows to increment
[ Top ] ### method __clone [line 563]
`void __clone( )`
__clone implementation. __clone implementation. Cloning should not be allowed in a Singleton! #### Tags:
throws: | Exception
access: | public
[ Top ] Documentation generated on Mon, 11 Jan 2010 08:13:13 +0100 by phpDocumentor 1.4.1