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

Class: PHPExcel_CachedObjectStorage_ICache

Source Location: /PHPExcel/CachedObjectStorage/ICache.php

Interface Overview


PHPExcel_CachedObjectStorage_ICache


Author(s):

Copyright:

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

Methods



Class Details

[line 36]
PHPExcel_CachedObjectStorage_ICache



Tags:

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


[ Top ]


Class Methods


method addCacheData [line 46]

void addCacheData( string $pCoord, $cell)

Add or Update a cell in cache identified by coordinate address



Tags:

throws:  Exception
access:  public


Parameters:

string   $pCoord   Coordinate address of the cell to update
PHPExcel_Cell   $cell   Cell to update

[ Top ]

method copyCellCollection [line 102]

void copyCellCollection( $parent)

Clone the cell collection



Tags:

access:  public


Parameters:

PHPExcel_Worksheet   $parent  

[ Top ]

method deleteCacheData [line 72]

void deleteCacheData( string $pCoord)

Delete a cell in cache identified by coordinate address



Tags:

throws:  Exception
access:  public


Parameters:

string   $pCoord   Coordinate address of the cell to delete

[ Top ]

method getCacheData [line 64]

PHPExcel_Cell getCacheData( string $pCoord)

Fetch a cell from cache identified by coordinate address



Tags:

return:  Cell that was found, or null if not found
throws:  Exception
access:  public


Parameters:

string   $pCoord   Coordinate address of the cell to retrieve

[ Top ]

method getCellList [line 88]

array getCellList( )

Get a list of all cell addresses currently held in cache



Tags:

return:  of string
access:  public


[ Top ]

method getSortedCellList [line 95]

void getSortedCellList( )

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



Tags:

access:  public


[ Top ]

method isDataSet [line 81]

void isDataSet( string $pCoord)

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



Tags:

access:  public


Parameters:

string   $pCoord   Coordinate address of the cell to check

[ Top ]

method updateCacheData [line 55]

void updateCacheData( $cell)

Add or Update a cell in cache



Tags:

throws:  Exception
access:  public


Parameters:

PHPExcel_Cell   $cell   Cell to update

[ Top ]


Documentation generated on Thu, 26 Aug 2010 17:43:22 +0200 by phpDocumentor 1.4.3