[ Index ]

PHP Cross Reference of Unnamed Project

title

Body

[close]

/lib/phpexcel/PHPExcel/CachedObjectStorage/ -> CacheBase.php (summary)

PHPExcel_CachedObjectStorage_CacheBase Copyright (c) 2006 - 2015 PHPExcel

Copyright: Copyright (c) 2006 - 2015 PHPExcel (http://www.codeplex.com/PHPExcel)
License: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt LGPL
Version: ##VERSION##, ##DATE##
File Size: 368 lines (11 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 19 functions

  __construct()
  getParent()
  isDataSet()
  moveCell()
  updateCacheData()
  deleteCacheData()
  getCellList()
  getSortedCellList()
  getHighestRowAndColumn()
  getCurrentAddress()
  getCurrentColumn()
  getCurrentRow()
  getHighestColumn()
  getHighestRow()
  getUniqueID()
  copyCellCollection()
  removeRow()
  removeColumn()
  cacheMethodIsAvailable()

Functions
Functions that are not part of a class:

__construct(PHPExcel_Worksheet $parent)   X-Ref
Initialise this new cell collection

param: PHPExcel_Worksheet    $parent        The worksheet for this cell collection

getParent()   X-Ref
Return the parent worksheet for this cell collection

return: PHPExcel_Worksheet

isDataSet($pCoord)   X-Ref
Is a value set in the current PHPExcel_CachedObjectStorage_ICache for an indexed cell?

param: string        $pCoord        Coordinate address of the cell to check
return: boolean

moveCell($fromAddress, $toAddress)   X-Ref
Move a cell object from one address to another

param: string        $fromAddress    Current address of the cell to move
param: string        $toAddress        Destination address of the cell to move
return: boolean

updateCacheData(PHPExcel_Cell $cell)   X-Ref
Add or Update a cell in cache

param: PHPExcel_Cell    $cell        Cell to update
return: PHPExcel_Cell

deleteCacheData($pCoord)   X-Ref
Delete a cell in cache identified by coordinate address

param: string            $pCoord        Coordinate address of the cell to delete

getCellList()   X-Ref
Get a list of all cell addresses currently held in cache

return: string[]

getSortedCellList()   X-Ref
Sort the list of all cell addresses currently held in cache by row and column

return: string[]

getHighestRowAndColumn()   X-Ref
Get highest worksheet column and highest row that have cell records

return: array Highest column name and highest row number

getCurrentAddress()   X-Ref
Return the cell address of the currently active cell object

return: string

getCurrentColumn()   X-Ref
Return the column address of the currently active cell object

return: string

getCurrentRow()   X-Ref
Return the row address of the currently active cell object

return: integer

getHighestColumn($row = null)   X-Ref
Get highest worksheet column

param: string     $row        Return the highest column for the specified row,
return: string     Highest column name

getHighestRow($column = null)   X-Ref
Get highest worksheet row

param: string     $column     Return the highest row for the specified column,
return: int        Highest row number

getUniqueID()   X-Ref
Generate a unique ID for cache referencing

return: string Unique Reference

copyCellCollection(PHPExcel_Worksheet $parent)   X-Ref
Clone the cell collection

param: PHPExcel_Worksheet    $parent        The new worksheet
return: void

removeRow($row)   X-Ref
Remove a row, deleting all cells in that row

param: string    $row    Row number to remove
return: void

removeColumn($column)   X-Ref
Remove a column, deleting all cells in that column

param: string    $column    Column ID to remove
return: void

cacheMethodIsAvailable()   X-Ref
Identify whether the caching method is currently available
Some methods are dependent on the availability of certain extensions being enabled in the PHP build

return: boolean



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