PHPExcel_CachedObjectStorage_ICache Interface Reference

Inheritance diagram for PHPExcel_CachedObjectStorage_ICache:

Collaboration diagram for PHPExcel_CachedObjectStorage_ICache:

Public Member Functions
	addCacheData ($pCoord, PHPExcel_Cell $cell)
	Add or Update a cell in cache identified by coordinate address.
	updateCacheData (PHPExcel_Cell $cell)
	Add or Update a cell in cache.
	getCacheData ($pCoord)
	Fetch a cell from cache identified by coordinate address.
	deleteCacheData ($pCoord)
	Delete a cell in cache identified by coordinate address.
	isDataSet ($pCoord)
	Is a value set in the current PHPExcel_CachedObjectStorage_ICache for an indexed cell?
	getCellList ()
	Get a list of all cell addresses currently held in cache.
	getSortedCellList ()
	Get the list of all cell addresses currently held in cache sorted by column and row.
	copyCellCollection (PHPExcel_Worksheet $parent)
	Clone the cell collection.

Detailed Description

Definition at line 36 of file ICache.php.

Member Function Documentation

PHPExcel_CachedObjectStorage_ICache::addCacheData	(		$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

Returns

void

Exceptions

Exception

Implemented in PHPExcel_CachedObjectStorage_Wincache, PHPExcel_CachedObjectStorage_Memcache, PHPExcel_CachedObjectStorage_PHPTemp, PHPExcel_CachedObjectStorage_DiscISAM, PHPExcel_CachedObjectStorage_APC, PHPExcel_CachedObjectStorage_MemoryGZip, PHPExcel_CachedObjectStorage_MemorySerialized, and PHPExcel_CachedObjectStorage_Memory.

PHPExcel_CachedObjectStorage_ICache::copyCellCollection

(

PHPExcel_Worksheet

$parent

)

Clone the cell collection.

Returns

void

Implemented in PHPExcel_CachedObjectStorage_Wincache, PHPExcel_CachedObjectStorage_Memcache, PHPExcel_CachedObjectStorage_APC, PHPExcel_CachedObjectStorage_PHPTemp, PHPExcel_CachedObjectStorage_DiscISAM, and PHPExcel_CachedObjectStorage_Memory.

PHPExcel_CachedObjectStorage_ICache::deleteCacheData

(

$pCoord

)

Delete a cell in cache identified by coordinate address.

Parameters

string

$pCoord

Coordinate address of the cell to delete

Exceptions

Exception

Implemented in PHPExcel_CachedObjectStorage_Wincache, PHPExcel_CachedObjectStorage_Memcache, and PHPExcel_CachedObjectStorage_APC.

PHPExcel_CachedObjectStorage_ICache::getCacheData

(

$pCoord

)

Fetch a cell from cache identified by coordinate address.

Parameters

string

$pCoord

Coordinate address of the cell to retrieve

Returns

PHPExcel_Cell Cell that was found, or null if not found

Exceptions

Exception

Implemented in PHPExcel_CachedObjectStorage_Wincache, PHPExcel_CachedObjectStorage_Memcache, PHPExcel_CachedObjectStorage_APC, PHPExcel_CachedObjectStorage_PHPTemp, PHPExcel_CachedObjectStorage_DiscISAM, PHPExcel_CachedObjectStorage_MemoryGZip, PHPExcel_CachedObjectStorage_MemorySerialized, and PHPExcel_CachedObjectStorage_Memory.

PHPExcel_CachedObjectStorage_ICache::getCellList

(

)

Get a list of all cell addresses currently held in cache.

Returns

array of string

PHPExcel_CachedObjectStorage_ICache::getSortedCellList

(

)

Get the list of all cell addresses currently held in cache sorted by column and row.

Returns

void

PHPExcel_CachedObjectStorage_ICache::isDataSet

(

$pCoord

)

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

Parameters

string

$pCoord

Coordinate address of the cell to check

Returns

void

boolean

Implemented in PHPExcel_CachedObjectStorage_Wincache, PHPExcel_CachedObjectStorage_Memcache, and PHPExcel_CachedObjectStorage_APC.

PHPExcel_CachedObjectStorage_ICache::updateCacheData

(

PHPExcel_Cell

$cell

)

Add or Update a cell in cache.

Parameters

PHPExcel_Cell

$cell

Cell to update

Returns

void

Exceptions

Exception

---

The documentation for this interface was generated from the following file:

• Services/Excel/PHPExcel/1.7.6/Classes/PHPExcel/CachedObjectStorage/ICache.php