PHPExcel_CachedObjectStorage_MemoryGZip Class Reference

Inheritance diagram for PHPExcel_CachedObjectStorage_MemoryGZip:

Collaboration diagram for PHPExcel_CachedObjectStorage_MemoryGZip:

Public Member Functions
	addCacheData ($pCoord, PHPExcel_Cell $cell)
	Add or Update a cell in cache identified by coordinate address.
	getCacheData ($pCoord)
	Get cell at a specific coordinate.
	unsetWorksheetCells ()
Public Member Functions inherited from PHPExcel_CachedObjectStorage_CacheBase
	__construct (PHPExcel_Worksheet $parent)
	isDataSet ($pCoord)
	Is a value set in the current PHPExcel_CachedObjectStorage_ICache for an indexed cell?
	updateCacheData (PHPExcel_Cell $cell)
	Add or Update a cell in cache.
	deleteCacheData ($pCoord)
	Delete a cell in cache identified by coordinate address.
	getCellList ()
	Get a list of all cell addresses currently held in cache.
	getSortedCellList ()
	Sort the list of all cell addresses currently held in cache by row and column.
	copyCellCollection (PHPExcel_Worksheet $parent)
	Clone the cell collection.
Public Member Functions inherited from PHPExcel_CachedObjectStorage_ICache
	updateCacheData (PHPExcel_Cell $cell)
	Add or Update a cell in cache.
	deleteCacheData ($pCoord)
	Delete a cell in cache identified by coordinate address.
	isDataSet ($pCoord)
	Is a value set in the current PHPExcel_CachedObjectStorage_ICache for an indexed cell?
	getCellList ()
	Get a list of all cell addresses currently held in cache.
	getSortedCellList ()
	Get the list of all cell addresses currently held in cache sorted by column and row.
	copyCellCollection (PHPExcel_Worksheet $parent)
	Clone the cell collection.

Private Member Functions
	_storeData ()

Additional Inherited Members
Protected Member Functions inherited from PHPExcel_CachedObjectStorage_CacheBase
	_getUniqueID ()
Protected Attributes inherited from PHPExcel_CachedObjectStorage_CacheBase
	$_parent
	$_currentObject = null
	$_currentObjectID = null
	$_cellCache = array()

Detailed Description

Definition at line 36 of file MemoryGZip.php.

Member Function Documentation

PHPExcel_CachedObjectStorage_MemoryGZip::_storeData ( )

private

Definition at line 38 of file MemoryGZip.php.

References PHPExcel_CachedObjectStorage_CacheBase\$_currentObjectID.

Referenced by addCacheData(), and getCacheData().

                                      {
                $this->_currentObject->detach();

                $this->_cellCache[$this->_currentObjectID] = gzdeflate(serialize($this->_currentObject));
                $this->_currentObjectID = $this->_currentObject = null;
        }       //      function _storeData()

Here is the caller graph for this function:

PHPExcel_CachedObjectStorage_MemoryGZip::addCacheData	(		$pCoord,
		PHPExcel_Cell	$cell
	)

Add or Update a cell in cache identified by coordinate address.

Parameters

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

Returns

void

Exceptions

Exception

Implements PHPExcel_CachedObjectStorage_ICache.

Definition at line 54 of file MemoryGZip.php.

References _storeData().

                                                                   {
                if (($pCoord !== $this->_currentObjectID) && ($this->_currentObjectID !== null)) {
                        $this->_storeData();
                }

                $this->_currentObjectID = $pCoord;
                $this->_currentObject = $cell;

                return $cell;
        }       //      function addCacheData()

Here is the call graph for this function:

PHPExcel_CachedObjectStorage_MemoryGZip::getCacheData

(

$pCoord

)

Get cell at a specific coordinate.

Parameters

string

$pCoord

Coordinate of the cell

Exceptions

Exception

Returns

PHPExcel_Cell Cell that was found, or null if not found

Implements PHPExcel_CachedObjectStorage_ICache.

Definition at line 73 of file MemoryGZip.php.

References PHPExcel_CachedObjectStorage_CacheBase\$_currentObject, and _storeData().

                                              {
                if ($pCoord === $this->_currentObjectID) {
                        return $this->_currentObject;
                }
                $this->_storeData();

                //      Check if the entry that has been requested actually exists
                if (!isset($this->_cellCache[$pCoord])) {
                        //      Return null if requested entry doesn't exist in cache
                        return null;
                }

                //      Set current entry to the requested entry
                $this->_currentObjectID = $pCoord;
                $this->_currentObject = unserialize(gzinflate($this->_cellCache[$pCoord]));
                //      Re-attach the parent worksheet
                $this->_currentObject->attach($this->_parent);

                //      Return requested entry
                return $this->_currentObject;
        }       //      function getCacheData()

Here is the call graph for this function:

PHPExcel_CachedObjectStorage_MemoryGZip::unsetWorksheetCells

(

)

Definition at line 96 of file MemoryGZip.php.

                                              {
                if(!is_null($this->_currentObject)) {
                        $this->_currentObject->detach();
                        $this->_currentObject = $this->_currentObjectID = null;
                }
                $this->_cellCache = array();

                //      detach ourself from the worksheet, so that it can then delete this object successfully
                $this->_parent = null;
        }       //      function unsetWorksheetCells()

---

The documentation for this class was generated from the following file:

• Services/Excel/PHPExcel/1.7.6/Classes/PHPExcel/CachedObjectStorage/MemoryGZip.php