interface PHPExcel_CachedObjectStorage_ICache

PHPExcelCachedObjectStorageICache

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

addCacheData(string $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(string $pCoord)

Fetch a cell from cache identified by coordinate address

deleteCacheData(string $pCoord)

Delete a cell in cache identified by coordinate address

boolean
isDataSet(string $pCoord)

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

string[]
getCellList()

Get a list of all cell addresses currently held in cache

string[]
getSortedCellList()

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

void
copyCellCollection(PHPExcel_Worksheet $parent)

Clone the cell collection

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

Details

at line 47
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 56
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

at line 65
PHPExcel_Cell getCacheData(string $pCoord)

Fetch a cell from cache identified by coordinate address

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 73
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 81
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

at line 88
string[] getCellList()

Get a list of all cell addresses currently held in cache

Return Value

string[]

at line 95
string[] getSortedCellList()

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

Return Value

string[]

at line 103
void copyCellCollection(PHPExcel_Worksheet $parent)

Clone the cell collection

Parameters

PHPExcel_Worksheet $parent The new worksheet

Return Value

void

at line 111
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