PHPExcel_CachedObjectStorage
[ class tree: PHPExcel_CachedObjectStorage ] [ index: PHPExcel_CachedObjectStorage ] [ all elements ]

Class: PHPExcel_CachedObjectStorage_CacheBase

Source Location: /PHPExcel/CachedObjectStorage/CacheBase.php

Class Overview


PHPExcel_CachedObjectStorage_CacheBase


Author(s):

Copyright:

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

Variables

Methods


Child classes:

PHPExcel_CachedObjectStorage_APC
PHPExcel_CachedObjectStorage_APC
PHPExcel_CachedObjectStorage_DiscISAM
PHPExcel_CachedObjectStorage_DiscISAM
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_Wincache
PHPExcel_CachedObjectStorage_Wincache

Class Details

[line 36]
PHPExcel_CachedObjectStorage_CacheBase



Tags:

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


[ Top ]


Class Variables

$_cellCache = array()

[line 66]

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 ]

$_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


constructor __construct [line 69]


method copyCellCollection [line 167]

void copyCellCollection( $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_PHPTemp::copyCellCollection()
Clone the cell collection
PHPExcel_CachedObjectStorage_Wincache::copyCellCollection()
Clone the cell collection

Parameters:

PHPExcel_Worksheet   $parent  

[ Top ]

method deleteCacheData [line 113]

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_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 131]

array getCellList( )

Get a list of all cell addresses currently held in cache



Tags:

return:  of string
access:  public


[ Top ]

method getSortedCellList [line 141]

void getSortedCellList( )

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



Tags:

access:  public


[ Top ]

method isDataSet [line 84]

void 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_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 100]

void updateCacheData( $cell)

Add or Update a cell in cache



Tags:

throws:  Exception
access:  public


Parameters:

PHPExcel_Cell   $cell   Cell to update

[ Top ]

method _getUniqueID [line 153]

void _getUniqueID( )



Tags:

access:  protected


[ Top ]


Documentation generated on Thu, 26 Aug 2010 17:40:38 +0200 by phpDocumentor 1.4.3