PHPExcel_CachedObjectStorage_Igbinary

class PHPExcel_CachedObjectStorage_Igbinary extends PHPExcel_CachedObjectStorage_CacheBase implements PHPExcel_CachedObjectStorage_ICache

PHPExcelCachedObjectStorageIgbinary

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

Methods

__construct(PHPExcel_Worksheet $parent)

Initialise this new cell collection

from PHPExcel_CachedObjectStorage_CacheBase
PHPExcel_Worksheet
getParent()

Return the parent worksheet for this cell collection

from PHPExcel_CachedObjectStorage_CacheBase
boolean
isDataSet(string $pCoord)

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

from PHPExcel_CachedObjectStorage_CacheBase
boolean
moveCell(string $fromAddress, string $toAddress)

Move a cell object from one address to another

from PHPExcel_CachedObjectStorage_CacheBase
PHPExcel_Cell
updateCacheData(PHPExcel_Cell $cell)

Add or Update a cell in cache

from PHPExcel_CachedObjectStorage_CacheBase
deleteCacheData(string $pCoord)

Delete a cell in cache identified by coordinate address

from PHPExcel_CachedObjectStorage_CacheBase
string[]
getCellList()

Get a list of all cell addresses currently held in cache

string[]
getSortedCellList()

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

from PHPExcel_CachedObjectStorage_CacheBase
array
getHighestRowAndColumn()

Get highest worksheet column and highest row that have cell records

from PHPExcel_CachedObjectStorage_CacheBase
string
getCurrentAddress()

Return the cell address of the currently active cell object

from PHPExcel_CachedObjectStorage_CacheBase
string
getCurrentColumn()

Return the column address of the currently active cell object

from PHPExcel_CachedObjectStorage_CacheBase
integer
getCurrentRow()

Return the row address of the currently active cell object

from PHPExcel_CachedObjectStorage_CacheBase
string
getHighestColumn(string $row = null)

Get highest worksheet column

from PHPExcel_CachedObjectStorage_CacheBase
int
getHighestRow(string $column = null)

Get highest worksheet row

from PHPExcel_CachedObjectStorage_CacheBase
void
copyCellCollection(PHPExcel_Worksheet $parent)

Clone the cell collection

from PHPExcel_CachedObjectStorage_CacheBase
void
removeRow(string $row)

Remove a row, deleting all cells in that row

from PHPExcel_CachedObjectStorage_CacheBase
void
removeColumn(string $column)

Remove a column, deleting all cells in that column

from PHPExcel_CachedObjectStorage_CacheBase
static boolean
cacheMethodIsAvailable()

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

PHPExcel_Cell
addCacheData(string $pCoord, PHPExcel_Cell $cell)

Add or Update a cell in cache identified by coordinate address

PHPExcel_Cell
getCacheData(string $pCoord)

Get cell at a specific coordinate

void
unsetWorksheetCells()

Clear the cell collection and disconnect from our parent

Details

in PHPExcel_CachedObjectStorage_CacheBase at line 80
__construct(PHPExcel_Worksheet $parent)

Initialise this new cell collection

Parameters

PHPExcel_Worksheet $parent The worksheet for this cell collection

in PHPExcel_CachedObjectStorage_CacheBase at line 93
PHPExcel_Worksheet getParent()

Return the parent worksheet for this cell collection

Return Value

PHPExcel_Worksheet

in PHPExcel_CachedObjectStorage_CacheBase at line 104
boolean isDataSet(string $pCoord)

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

Parameters

string $pCoord Coordinate address of the cell to check

Return Value

boolean

in PHPExcel_CachedObjectStorage_CacheBase at line 120
boolean moveCell(string $fromAddress, string $toAddress)

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

Return Value

boolean

in PHPExcel_CachedObjectStorage_CacheBase at line 141
PHPExcel_Cell updateCacheData(PHPExcel_Cell $cell)

Add or Update a cell in cache

Parameters

PHPExcel_Cell $cell Cell to update

Return Value

PHPExcel_Cell

Exceptions

PHPExcel_Exception

in PHPExcel_CachedObjectStorage_CacheBase at line 152
deleteCacheData(string $pCoord)

Delete a cell in cache identified by coordinate address

Parameters

string $pCoord Coordinate address of the cell to delete

Exceptions

PHPExcel_Exception

at line 116
string[] getCellList()

Get a list of all cell addresses currently held in cache

Return Value

string[]

in PHPExcel_CachedObjectStorage_CacheBase at line 181
string[] getSortedCellList()

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

Return Value

string[]

in PHPExcel_CachedObjectStorage_CacheBase at line 198
array getHighestRowAndColumn()

Get highest worksheet column and highest row that have cell records

Return Value

array Highest column name and highest row number

in PHPExcel_CachedObjectStorage_CacheBase at line 225
string getCurrentAddress()

Return the cell address of the currently active cell object

Return Value

string

in PHPExcel_CachedObjectStorage_CacheBase at line 235
string getCurrentColumn()

Return the column address of the currently active cell object

Return Value

string

in PHPExcel_CachedObjectStorage_CacheBase at line 246
integer getCurrentRow()

Return the row address of the currently active cell object

Return Value

integer

in PHPExcel_CachedObjectStorage_CacheBase at line 259
string getHighestColumn(string $row = null)

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

Return Value

string Highest column name

in PHPExcel_CachedObjectStorage_CacheBase at line 284
int getHighestRow(string $column = null)

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

Return Value

int Highest row number

in PHPExcel_CachedObjectStorage_CacheBase at line 324
void copyCellCollection(PHPExcel_Worksheet $parent)

Clone the cell collection

Parameters

PHPExcel_Worksheet $parent The new worksheet

Return Value

void

in PHPExcel_CachedObjectStorage_CacheBase at line 341
void removeRow(string $row)

Remove a row, deleting all cells in that row

Parameters

string $row Row number to remove

Return Value

void

in PHPExcel_CachedObjectStorage_CacheBase at line 357
void removeColumn(string $column)

Remove a column, deleting all cells in that column

Parameters

string $column Column ID to remove

Return Value

void

at line 150
static boolean cacheMethodIsAvailable()

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 Value

boolean

at line 66
PHPExcel_Cell addCacheData(string $pCoord, PHPExcel_Cell $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

Return Value

PHPExcel_Cell

Exceptions

PHPExcel_Exception

at line 87
PHPExcel_Cell getCacheData(string $pCoord)

Get cell at a specific coordinate

Parameters

string $pCoord Coordinate address of the cell to retrieve

Return Value

PHPExcel_Cell Cell that was found, or null if not found

Exceptions

PHPExcel_Exception

at line 131
void unsetWorksheetCells()

Clear the cell collection and disconnect from our parent

Return Value

void