Properties

$_currentObject

$_currentObject : \PHPExcel_Cell

The currently active Cell

Type

\PHPExcel_Cell

$_currentObjectID

$_currentObjectID : string

Coordinate address of the currently active Cell

Type

string

$_currentCellIsDirty

$_currentCellIsDirty : boolean

Flag indicating whether the currently active Cell requires saving

Type

boolean

$_cellCache

$_cellCache : array

An array of cells or cell pointers for the worksheet cells held in this cache, and indexed by their coordinate address within the worksheet

Type

array — of mixed

$_TableName

$_TableName : string

Database table name

Type

string

$_DBHandle

$_DBHandle : resource

Database handle

Type

resource

Methods

__construct()

__construct(\PHPExcel_Worksheet  $parent) 

Initialise this new cell collection

Parameters

\PHPExcel_Worksheet $parent

The worksheet for this cell collection

getParent()

getParent() : \PHPExcel_Worksheet

Return the parent worksheet for this cell collection

Returns

\PHPExcel_Worksheet

isDataSet()

isDataSet(string  $pCoord) : boolean

Is a value set for an indexed cell?

Parameters

string $pCoord

Coordinate address of the cell to check

Returns

boolean

moveCell()

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

Move a cell object from one address to another

Parameters

string $fromAddress

Current address of the cell to move

string $toAddress

Destination address of the cell to move

Returns

boolean

updateCacheData()

updateCacheData(\PHPExcel_Cell  $cell) : \PHPExcel_Cell

Add or Update a cell in cache

Parameters

\PHPExcel_Cell $cell

Cell to update

Throws

\PHPExcel_Exception

Returns

\PHPExcel_Cell

deleteCacheData()

deleteCacheData(string  $pCoord) 

Delete a cell in cache identified by coordinate address

Parameters

string $pCoord

Coordinate address of the cell to delete

Throws

\PHPExcel_Exception

getCellList()

getCellList() : array<mixed,string>

Get a list of all cell addresses currently held in cache

Returns

array<mixed,string>

getSortedCellList()

getSortedCellList() : array<mixed,string>

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

Returns

array<mixed,string>

getHighestRowAndColumn()

getHighestRowAndColumn() : array

Get highest worksheet column and highest row that have cell records

Returns

array —

Highest column name and highest row number

getCurrentAddress()

getCurrentAddress() : string

Return the cell address of the currently active cell object

Returns

string

getCurrentColumn()

getCurrentColumn() : string

Return the column address of the currently active cell object

Returns

string

getCurrentRow()

getCurrentRow() : integer

Return the row address of the currently active cell object

Returns

integer

getHighestColumn()

getHighestColumn(string  $row = null) : string

Get highest worksheet column

Parameters

string $row

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

Returns

string —

Highest column name

getHighestRow()

getHighestRow(string  $column = null) : integer

Get highest worksheet row

Parameters

string $column

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

Returns

integer —

Highest row number

copyCellCollection()

copyCellCollection(\PHPExcel_Worksheet  $parent) : void

Clone the cell collection

Parameters

\PHPExcel_Worksheet $parent

The new worksheet

removeRow()

removeRow(string  $row) : void

Remove a row, deleting all cells in that row

Parameters

string $row

Row number to remove

removeColumn()

removeColumn(string  $column) : void

Remove a column, deleting all cells in that column

Parameters

string $column

Column ID to remove

cacheMethodIsAvailable()

cacheMethodIsAvailable() : boolean

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

Returns

boolean

addCacheData()

addCacheData(string  $pCoord, \PHPExcel_Cell  $cell) : \PHPExcel_Cell

Add or Update a cell in cache identified by coordinate address

Parameters

string $pCoord

Coordinate address of the cell to update

\PHPExcel_Cell $cell

Cell to update

Throws

\PHPExcel_Exception

Returns

\PHPExcel_Cell

getCacheData()

getCacheData(string  $pCoord) : \PHPExcel_Cell

Get cell at a specific coordinate

Parameters

string $pCoord

Coordinate of the cell

Throws

\PHPExcel_Exception

Returns

\PHPExcel_Cell

Cell that was found, or null if not found

unsetWorksheetCells()

unsetWorksheetCells() : void

Clear the cell collection and disconnect from our parent

__destruct()

__destruct() 

Destroy this cell collection

_getUniqueID()

_getUniqueID() : string

Generate a unique ID for cache referencing

Returns

string —

Unique Reference

_storeData()

_storeData() : void

Store cell data in cache for the current cell object if it's "dirty", and the 'nullify' the current cell object

Throws

\PHPExcel_Exception