PHPExcel_CachedObjectStorage
[ class tree: PHPExcel_CachedObjectStorage ] [ index: PHPExcel_CachedObjectStorage ] [ all elements ]
Packages:
PHPExcel
com-tecnick-tcpdf
JAMA
Math_Stats
PHPExcel_CachedObjectStorage
PHPExcel_Calculation
PHPExcel_Cell
PHPExcel_Chart
PHPExcel_Chart_Renderer
PHPExcel_Reader
PHPExcel_Reader_Excel5
PHPExcel_Reader_Excel2007
PHPExcel_RichText
PHPExcel_Settings
PHPExcel_Shared
PHPExcel_Shared_Escher
PHPExcel_Shared_OLE
PHPExcel_Shared_Trend
PHPExcel_Shared_ZipArchive
PHPExcel_Style
PHPExcel_Worksheet
PHPExcel_Worksheet_Drawing
PHPExcel_Writer
PHPExcel_Writer_Excel5
PHPExcel_Writer_Excel2007


Files:
APC.php
CacheBase.php
CachedObjectStorageFactory.php
DiscISAM.php
ICache.php
Igbinary.php
Memcache.php
Memory.php
MemoryGZip.php
MemorySerialized.php
PHPTemp.php
SQLite.php
SQLite3.php
Wincache.php

Interfaces:
PHPExcel_CachedObjectStorage_ICache
Classes:
PHPExcel_CachedObjectStorageFactory
PHPExcel_CachedObjectStorage_APC
PHPExcel_CachedObjectStorage_CacheBase
PHPExcel_CachedObjectStorage_DiscISAM
PHPExcel_CachedObjectStorage_Igbinary
PHPExcel_CachedObjectStorage_Memcache
PHPExcel_CachedObjectStorage_Memory
PHPExcel_CachedObjectStorage_MemoryGZip
PHPExcel_CachedObjectStorage_MemorySerialized
PHPExcel_CachedObjectStorage_PHPTemp
PHPExcel_CachedObjectStorage_SQLite
PHPExcel_CachedObjectStorage_SQLite3
PHPExcel_CachedObjectStorage_Wincache

Class: PHPExcel_CachedObjectStorage_ICache

Source Location: /PHPExcel/CachedObjectStorage/ICache.php

Interface Overview




PHPExcel_CachedObjectStorage_ICache




Author(s):


    
        





      
  


Copyright:


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


        






Methods
























Class Details



[line 36]

PHPExcel_CachedObjectStorage_ICache





Tags:





  

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










[ Top ]








Class Methods



  

	
	
static method cacheMethodIsAvailable [line 110]

	

    

    

		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
  









	
        
[ Top ]

  


  

	
	
method addCacheData [line 46]

	

    

    

		void addCacheData(
string
$pCoord, PHPExcel_Cell
$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(
PHPExcel_Worksheet
$parent)
    

    


	
		Clone the cell collection





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        PHPExcel_Worksheet  
        $parent  
        The new worksheet
      

        

    


        
[ 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 87]

	

    

    

		array getCellList(
)
    

    


	
		Get a list of all cell addresses currently held in cache





Tags:





  

    return:  of string
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getSortedCellList [line 94]

	

    

    

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

	

    

    

		boolean 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(
PHPExcel_Cell
$cell)
    

    


	
		Add or Update a cell in cache





Tags:





  

    throws:  Exception
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        PHPExcel_Cell  
        $cell  
        Cell to update
      

        

    


        
[ Top ]

  






        

		    

		    Documentation generated on Sat, 19 May 2012 14:37:33 +0200 by phpDocumentor 1.4.4