\PHPExcel_CachedObjectStorage_ICache

PHPExcel_CachedObjectStorage_ICache

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

Summary

Methods
Constants
addCacheData()
updateCacheData()
getCacheData()
deleteCacheData()
isDataSet()
getCellList()
getSortedCellList()
copyCellCollection()
cacheMethodIsAvailable()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

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

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

getCacheData()

getCacheData(string  $pCoord) : \PHPExcel_Cell

Fetch a cell from cache identified by coordinate address

Parameters

string $pCoord

Coordinate address of the cell to retrieve

Throws

\PHPExcel_Exception

Returns

\PHPExcel_Cell

Cell that was found, or null if not found

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

isDataSet()

isDataSet(string  $pCoord) : boolean

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

boolean

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>

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

Returns

array<mixed,string>

copyCellCollection()

copyCellCollection(\PHPExcel_Worksheet  $parent) : void

Clone the cell collection

Parameters

\PHPExcel_Worksheet $parent

The new worksheet

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