[ Index ]

PHP Cross Reference of Unnamed Project

title

Body

[close]

/lib/phpexcel/PHPExcel/ -> ReferenceHelper.php (summary)

[Source view] [Print] [Project Stats]

(no description)

File Size: 913 lines (48 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

PHPExcel_ReferenceHelper:: (22 methods):
  getInstance()
  __construct()
  columnSort()
  columnReverseSort()
  cellSort()
  cellReverseSort()
  cellAddressInDeleteRange()
  adjustPageBreaks()
  adjustComments()
  adjustHyperlinks()
  adjustDataValidations()
  adjustMergeCells()
  adjustProtectedCells()
  adjustColumnDimensions()
  adjustRowDimensions()
  insertNewBefore()
  updateFormulaReferences()
  updateCellReference()
  updateNamedFormulas()
  updateCellRange()
  updateSingleCellReference()
  __clone()


Class: PHPExcel_ReferenceHelper  - X-Ref

PHPExcel_ReferenceHelper (Singleton)

Copyright (c) 2006 - 2015 PHPExcel

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA

getInstance()   X-Ref
Get an instance of this class

return: PHPExcel_ReferenceHelper

__construct()   X-Ref
Create a new PHPExcel_ReferenceHelper


columnSort($a, $b)   X-Ref
Compare two column addresses
Intended for use as a Callback function for sorting column addresses by column

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

columnReverseSort($a, $b)   X-Ref
Compare two column addresses
Intended for use as a Callback function for reverse sorting column addresses by column

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

cellSort($a, $b)   X-Ref
Compare two cell addresses
Intended for use as a Callback function for sorting cell addresses by column and row

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

cellReverseSort($a, $b)   X-Ref
Compare two cell addresses
Intended for use as a Callback function for sorting cell addresses by column and row

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

cellAddressInDeleteRange($cellAddress, $beforeRow, $pNumRows, $beforeColumnIndex, $pNumCols)   X-Ref
Test whether a cell address falls within a defined range of cells

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

adjustPageBreaks(PHPExcel_Worksheet $pSheet, $pBefore, $beforeColumnIndex, $pNumCols, $beforeRow, $pNumRows)   X-Ref
Update page breaks when inserting/deleting rows/columns

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

adjustComments($pSheet, $pBefore, $beforeColumnIndex, $pNumCols, $beforeRow, $pNumRows)   X-Ref
Update cell comments when inserting/deleting rows/columns

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

adjustHyperlinks($pSheet, $pBefore, $beforeColumnIndex, $pNumCols, $beforeRow, $pNumRows)   X-Ref
Update hyperlinks when inserting/deleting rows/columns

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

adjustDataValidations($pSheet, $pBefore, $beforeColumnIndex, $pNumCols, $beforeRow, $pNumRows)   X-Ref
Update data validations when inserting/deleting rows/columns

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

adjustMergeCells($pSheet, $pBefore, $beforeColumnIndex, $pNumCols, $beforeRow, $pNumRows)   X-Ref
Update merged cells when inserting/deleting rows/columns

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

adjustProtectedCells($pSheet, $pBefore, $beforeColumnIndex, $pNumCols, $beforeRow, $pNumRows)   X-Ref
Update protected cells when inserting/deleting rows/columns

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

adjustColumnDimensions($pSheet, $pBefore, $beforeColumnIndex, $pNumCols, $beforeRow, $pNumRows)   X-Ref
Update column dimensions when inserting/deleting rows/columns

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

adjustRowDimensions($pSheet, $pBefore, $beforeColumnIndex, $pNumCols, $beforeRow, $pNumRows)   X-Ref
Update row dimensions when inserting/deleting rows/columns

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

insertNewBefore($pBefore = 'A1', $pNumCols = 0, $pNumRows = 0, PHPExcel_Worksheet $pSheet = null)   X-Ref
Insert a new column or row, updating all possible related data

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

updateFormulaReferences($pFormula = '', $pBefore = 'A1', $pNumCols = 0, $pNumRows = 0, $sheetName = '')   X-Ref
Update references within formulas

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

updateCellReference($pCellRange = 'A1', $pBefore = 'A1', $pNumCols = 0, $pNumRows = 0)   X-Ref
Update cell reference

param: string    $pCellRange            Cell range
param: int        $pBefore            Insert before this one
param: int        $pNumCols            Number of columns to increment
param: int        $pNumRows            Number of rows to increment
return: string    Updated cell range

updateNamedFormulas(PHPExcel $pPhpExcel, $oldName = '', $newName = '')   X-Ref
Update named formulas (i.e. containing worksheet references / named ranges)

param: PHPExcel $pPhpExcel    Object to update
param: string $oldName        Old name (name to replace)
param: string $newName        New name

updateCellRange($pCellRange = 'A1:A1', $pBefore = 'A1', $pNumCols = 0, $pNumRows = 0)   X-Ref
Update cell range

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

updateSingleCellReference($pCellReference = 'A1', $pBefore = 'A1', $pNumCols = 0, $pNumRows = 0)   X-Ref
Update single cell reference

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

__clone()   X-Ref
__clone implementation. Cloning should not be allowed in a Singleton!



Generated: Thu Aug 11 10:00:09 2016 Cross-referenced by PHPXref 0.7.1