PHPExcel_CachedObjectStorage

# Class: PHPExcel_CachedObjectStorage_CacheBase

Source Location: /PHPExcel/CachedObjectStorage/CacheBase.php

### Class Overview

PHPExcel_CachedObjectStorage_CacheBase

#### Author(s):

#### Copyright:

- Copyright (c) 2006 - 2012 PHPExcel (http://www.codeplex.com/PHPExcel)

### Variables

- $_cellCache
- $_currentCellIsDirty
- $_currentObject
- $_currentObjectID
- $_parent

### Methods

- __construct
- cacheMethodIsAvailable
- copyCellCollection
- deleteCacheData
- getCellList
- getHighestColumn
- getHighestRow
- getHighestRowAndColumn
- getSortedCellList
- isDataSet
- updateCacheData
- _getUniqueID

### Child classes:

PHPExcel_CachedObjectStorage_APC
  PHPExcel_CachedObjectStorage_APC

PHPExcel_CachedObjectStorage_DiscISAM
  PHPExcel_CachedObjectStorage_DiscISAM

PHPExcel_CachedObjectStorage_Igbinary
  PHPExcel_CachedObjectStorage_Igbinary

PHPExcel_CachedObjectStorage_Memcache
  PHPExcel_CachedObjectStorage_Memcache

PHPExcel_CachedObjectStorage_Memory
  PHPExcel_CachedObjectStorage_Memory

PHPExcel_CachedObjectStorage_MemoryGZip
  PHPExcel_CachedObjectStorage_MemoryGZip

PHPExcel_CachedObjectStorage_MemorySerialized
  PHPExcel_CachedObjectStorage_MemorySerialized

PHPExcel_CachedObjectStorage_PHPTemp
  PHPExcel_CachedObjectStorage_PHPTemp

PHPExcel_CachedObjectStorage_SQLite
  PHPExcel_CachedObjectStorage_SQLite

PHPExcel_CachedObjectStorage_SQLite3
  PHPExcel_CachedObjectStorage_SQLite3

PHPExcel_CachedObjectStorage_Wincache
  PHPExcel_CachedObjectStorage_Wincache

### Class Details

[line 36]
PHPExcel_CachedObjectStorage_CacheBase

#### Tags:

copyright: | Copyright (c) 2006 - 2012 PHPExcel (http://www.codeplex.com/PHPExcel)
abstract: |

[ Top ]

### Class Variables

#### $_cellCache = array()

[line 73]

An array of cells or cell pointers for the worksheet cells held in this cache, and indexed by their coordinate address within the worksheet

#### Tags:

var: | of mixed
access: | protected

Type: | array

[ Top ]

#### $_currentCellIsDirty = true

[line 65]

Flag indicating whether the currently active Cell requires saving

#### Tags:

access: | protected

Type: | boolean

[ Top ]

#### $_currentObject = null

[line 50]

The currently active Cell

#### Tags:

access: | protected

Type: | PHPExcel_Cell

[ Top ]

#### $_currentObjectID = null

[line 57]

Coordinate address of the currently active Cell

#### Tags:

access: | protected

Type: | string

[ Top ]

#### $_parent =

[line 43]

Parent worksheet

#### Tags:

access: | protected

Type: | PHPExcel_Worksheet

[ Top ]

### Class Methods

### static method cacheMethodIsAvailable [line 248]

`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 ]

### constructor __construct [line 81]

`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 ]

### method copyCellCollection [line 234]

`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 ]

### method deleteCacheData [line 122]

`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 ]

### method getCellList [line 141]

`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 ]

### method getHighestColumn [line 196]

`string getHighestColumn( )`

Get highest worksheet column

#### Tags:

return: | Highest column name
access: | public

[ Top ]

### method getHighestRow [line 207]

`int getHighestRow( )`

Get highest worksheet row

#### Tags:

return: | Highest row number
access: | public

[ Top ]

### method getHighestRowAndColumn [line 169]

`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 ]

### method getSortedCellList [line 151]

`void getSortedCellList( )`

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

#### Tags:

access: | public

[ Top ]

### method isDataSet [line 95]

`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 ]

### method updateCacheData [line 111]

`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 ]

### method _getUniqueID [line 219]

`string _getUniqueID( )`

Generate a unique ID for cache referencing

#### Tags:

return: | Unique Reference
access: | protected

[ Top ]

Documentation generated on Fri, 12 Oct 2012 00:15:19 +0200 by phpDocumentor 1.4.4