Docs For Class PHPExcel_CachedObjectStorage

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

Tags:

access:

public

Overridden in child classes as:

PHPExcel_CachedObjectStorage_APC::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_CachedObjectStorage_Igbinary::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_CachedObjectStorage_Memcache::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_CachedObjectStorage_SQLite::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_CachedObjectStorage_SQLite3::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_CachedObjectStorage_Wincache::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

[ Top ]

PHPExcel_CachedObjectStorage_CacheBase __construct(
PHPExcel_Worksheet
$parent)

Initialise this new cell collection

Tags:

access:

public

Overridden in child classes as:

PHPExcel_CachedObjectStorage_APC::__construct(): Initialise this new cell collection

PHPExcel_CachedObjectStorage_DiscISAM::__construct(): Initialise this new cell collection

PHPExcel_CachedObjectStorage_Memcache::__construct(): Initialise this new cell collection

PHPExcel_CachedObjectStorage_PHPTemp::__construct(): Initialise this new cell collection

PHPExcel_CachedObjectStorage_SQLite::__construct(): Initialise this new cell collection

PHPExcel_CachedObjectStorage_SQLite3::__construct(): Initialise this new cell collection

PHPExcel_CachedObjectStorage_Wincache::__construct(): Initialise this new cell collection

Parameters:

PHPExcel_Worksheet

$parent

The worksheet for this cell collection

[ Top ]

void copyCellCollection(
PHPExcel_Worksheet
$parent)

Clone the cell collection

Tags:

access:

public

Overridden in child classes as:

PHPExcel_CachedObjectStorage_APC::copyCellCollection(): Clone the cell collection

PHPExcel_CachedObjectStorage_DiscISAM::copyCellCollection(): Clone the cell collection

PHPExcel_CachedObjectStorage_Memcache::copyCellCollection(): Clone the cell collection

PHPExcel_CachedObjectStorage_Memory::copyCellCollection(): Clone the cell collection

PHPExcel_CachedObjectStorage_PHPTemp::copyCellCollection(): Clone the cell collection

PHPExcel_CachedObjectStorage_SQLite::copyCellCollection(): Clone the cell collection

PHPExcel_CachedObjectStorage_SQLite3::copyCellCollection(): Clone the cell collection

PHPExcel_CachedObjectStorage_Wincache::copyCellCollection(): Clone the cell collection

Parameters:

PHPExcel_Worksheet

$parent

The new worksheet

[ Top ]

void deleteCacheData(
string
$pCoord)

Delete a cell in cache identified by coordinate address

Tags:

throws:	Exception
access:	public

Overridden in child classes as:

PHPExcel_CachedObjectStorage_APC::deleteCacheData(): Delete a cell in cache identified by coordinate address

PHPExcel_CachedObjectStorage_Memcache::deleteCacheData(): Delete a cell in cache identified by coordinate address

PHPExcel_CachedObjectStorage_SQLite::deleteCacheData(): Delete a cell in cache identified by coordinate address

PHPExcel_CachedObjectStorage_SQLite3::deleteCacheData(): Delete a cell in cache identified by coordinate address

PHPExcel_CachedObjectStorage_Wincache::deleteCacheData(): Delete a cell in cache identified by coordinate address

Parameters:

string

$pCoord

Coordinate address of the cell to delete

[ Top ]

array getCellList(
)

Get a list of all cell addresses currently held in cache

Tags:

return:	of string
access:	public

Overridden in child classes as:

PHPExcel_CachedObjectStorage_SQLite::getCellList(): Get a list of all cell addresses currently held in cache

PHPExcel_CachedObjectStorage_SQLite3::getCellList(): Get a list of all cell addresses currently held in cache

[ Top ]

string getHighestColumn(
)

Get highest worksheet column

Tags:

return:	Highest column name
access:	public

[ Top ]

int getHighestRow(
)

Get highest worksheet row

Tags:

return:	Highest row number
access:	public

[ Top ]

array getHighestRowAndColumn(
)

Get highest worksheet column and highest row that have cell records

Tags:

return:	Highest column name and highest row number
access:	public

[ Top ]

void getSortedCellList(
)

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

Tags:

access:

public

[ Top ]

boolean isDataSet(
string
$pCoord)

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

Tags:

access:

public

Overridden in child classes as:

PHPExcel_CachedObjectStorage_APC::isDataSet(): Is a value set in the current PHPExcel_CachedObjectStorage_ICache for an indexed cell?

PHPExcel_CachedObjectStorage_Memcache::isDataSet(): Is a value set in the current PHPExcel_CachedObjectStorage_ICache for an indexed cell?

PHPExcel_CachedObjectStorage_SQLite::isDataSet(): Is a value set for an indexed cell?

PHPExcel_CachedObjectStorage_SQLite3::isDataSet(): Is a value set for an indexed cell?

PHPExcel_CachedObjectStorage_Wincache::isDataSet(): Is a value set in the current PHPExcel_CachedObjectStorage_ICache for an indexed cell?

Parameters:

string

$pCoord

Coordinate address of the cell to check

[ Top ]

void updateCacheData(
PHPExcel_Cell
$cell)

Add or Update a cell in cache

Tags:

throws:	Exception
access:	public

Parameters:

PHPExcel_Cell

$cell

Cell to update

[ Top ]

string _getUniqueID(
)

Generate a unique ID for cache referencing

Tags:

return:	Unique Reference
access:	protected

[ Top ]

Class: PHPExcel_CachedObjectStorage_CacheBase

Class Overview

Author(s):

Copyright:

Variables

Methods

Child classes:

Class Details

Tags:

Class Variables

$_cellCache = array()

Tags:

$_currentCellIsDirty = true

Tags:

$_currentObject = null

Tags:

$_currentObjectID = null

Tags:

$_parent =

Tags:

Class Methods

static method cacheMethodIsAvailable [line 247]

Tags:

constructor __construct [line 81]

Tags:

Parameters:

method copyCellCollection [line 233]

Tags:

Parameters:

method deleteCacheData [line 122]

Tags:

Parameters:

method getCellList [line 141]

Tags:

method getHighestColumn [line 195]

Tags:

method getHighestRow [line 206]

Tags:

method getHighestRowAndColumn [line 169]

Tags:

method getSortedCellList [line 151]

Tags:

method isDataSet [line 95]

Tags:

Parameters:

method updateCacheData [line 111]

Tags:

Parameters:

method _getUniqueID [line 218]

Tags: