PHPExcel classes
Back to top  

PHPExcel_CachedObjectStorage_CacheBase

category PHPExcel
package PHPExcel_CachedObjectStorage
copyright Copyright (c) 2006 - 2014 PHPExcel (http://www.codeplex.com/PHPExcel)

 Methods

Initialise this new cell collection

__construct(\PHPExcel_Worksheet $parent) 

Parameters

$parent

\PHPExcel_Worksheet

The worksheet for this cell collection

Identify whether the caching method is currently available Some methods are dependent on the availability of certain extensions being enabled in the PHP build

cacheMethodIsAvailable() : boolean
Static

Returns

boolean

Clone the cell collection

copyCellCollection(\PHPExcel_Worksheet $parent) : void

Parameters

$parent

\PHPExcel_Worksheet

The new worksheet

Delete a cell in cache identified by coordinate address

deleteCacheData(string $pCoord) 

Parameters

$pCoord

string

Coordinate address of the cell to delete

Exceptions

\PHPExcel_Exception

Get a list of all cell addresses currently held in cache

getCellList() : array

Returns

arrayof string

Return the cell address of the currently active cell object

getCurrentAddress() : string

Returns

string

Return the column address of the currently active cell object

getCurrentColumn() : string

Returns

string

Return the row address of the currently active cell object

getCurrentRow() : string

Returns

string

Get highest worksheet column

getHighestColumn(string $row) : string

Parameters

$row

string

Return the highest column for the specified row, or the highest column of any row if no row number is passed

Returns

stringHighest column name

Get highest worksheet row

getHighestRow(string $column) : int

Parameters

$column

string

Return the highest row for the specified column, or the highest row of any column if no column letter is passed

Returns

intHighest row number

Get highest worksheet column and highest row that have cell records

getHighestRowAndColumn() : array

Returns

arrayHighest column name and highest row number

Return the parent worksheet for this cell collection

getParent() : \PHPExcel_Worksheet

Returns

\PHPExcel_Worksheet

Sort the list of all cell addresses currently held in cache by row and column

getSortedCellList() : void

Is a value set in the current PHPExcel_CachedObjectStorage_ICache for an indexed cell?

isDataSet(string $pCoord) : boolean

Parameters

$pCoord

string

Coordinate address of the cell to check

Returns

boolean

Move a cell object from one address to another

moveCell(string $fromAddress, string $toAddress) : boolean

Parameters

$fromAddress

string

Current address of the cell to move

$toAddress

string

Destination address of the cell to move

Returns

boolean

Add or Update a cell in cache

updateCacheData(\PHPExcel_Cell $cell) : void

Parameters

$cell

\PHPExcel_Cell

Cell to update

Exceptions

\PHPExcel_Exception

Generate a unique ID for cache referencing

_getUniqueID() : string

Returns

stringUnique Reference

 Properties

 

$_cellCache : array
 

$_currentCellIsDirty : boolean
 

$_currentObject : \PHPExcel_Cell
 

$_currentObjectID : string
 

$_parent : \PHPExcel_Worksheet