Inheritance diagram for PHPExcel_CachedObjectStorage_DiscISAM:

Collaboration diagram for PHPExcel_CachedObjectStorage_DiscISAM:

Public Member Functions
	addCacheData ($pCoord, PHPExcel_Cell $cell)
	Add or Update a cell in cache identified by coordinate address. More...

	getCacheData ($pCoord)
	Get cell at a specific coordinate. More...

	getCellList ()
	Get a list of all cell addresses currently held in cache. More...

	copyCellCollection (PHPExcel_Worksheet $parent)
	Clone the cell collection. More...

	unsetWorksheetCells ()
	Clear the cell collection and disconnect from our parent. More...

	__construct (PHPExcel_Worksheet $parent, $arguments)
	Initialise this new cell collection. More...

	__destruct ()
	Destroy this cell collection. More...

Public Member Functions inherited from PHPExcel_CachedObjectStorage_CacheBase
	__construct (PHPExcel_Worksheet $parent)
	Initialise this new cell collection. More...

	getParent ()
	Return the parent worksheet for this cell collection. More...

	isDataSet ($pCoord)
	Is a value set in the current PHPExcel_CachedObjectStorage_ICache for an indexed cell? More...

	moveCell ($fromAddress, $toAddress)
	Move a cell object from one address to another. More...

	updateCacheData (PHPExcel_Cell $cell)
	Add or Update a cell in cache. More...

	deleteCacheData ($pCoord)
	Delete a cell in cache identified by coordinate address. More...

	getCellList ()
	Get a list of all cell addresses currently held in cache. More...

	getSortedCellList ()
	Sort the list of all cell addresses currently held in cache by row and column. More...

	getHighestRowAndColumn ()
	Get highest worksheet column and highest row that have cell records. More...

	getCurrentAddress ()
	Return the cell address of the currently active cell object. More...

	getCurrentColumn ()
	Return the column address of the currently active cell object. More...

	getCurrentRow ()
	Return the row address of the currently active cell object. More...

	getHighestColumn ($row=null)
	Get highest worksheet column. More...

	getHighestRow ($column=null)
	Get highest worksheet row. More...

	copyCellCollection (PHPExcel_Worksheet $parent)
	Clone the cell collection. More...

	removeRow ($row)
	Remove a row, deleting all cells in that row. More...

	removeColumn ($column)
	Remove a column, deleting all cells in that column. More...

Public Member Functions inherited from PHPExcel_CachedObjectStorage_ICache
	updateCacheData (PHPExcel_Cell $cell)
	Add or Update a cell in cache. More...

	deleteCacheData ($pCoord)
	Delete a cell in cache identified by coordinate address. More...

	isDataSet ($pCoord)
	Is a value set in the current PHPExcel_CachedObjectStorage_ICache for an indexed cell? More...

	getSortedCellList ()
	Get the list of all cell addresses currently held in cache sorted by column and row. More...

Protected Member Functions
	_storeData ()
	Store cell data in cache for the current cell object if it's "dirty", and the 'nullify' the current cell object. More...

Protected Member Functions inherited from PHPExcel_CachedObjectStorage_CacheBase
	_getUniqueID ()
	Generate a unique ID for cache referencing. More...

Private Attributes
	$_fileName = NULL

	$_fileHandle = NULL

	$_cacheDirectory = NULL

Additional Inherited Members
Static Public Member Functions inherited from PHPExcel_CachedObjectStorage_CacheBase
static	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. More...

Static Public Member Functions inherited from PHPExcel_CachedObjectStorage_ICache
static	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. More...

Protected Attributes inherited from PHPExcel_CachedObjectStorage_CacheBase
	$_parent

	$_currentObject = null

	$_currentObjectID = null

	$_currentCellIsDirty = true

	$_cellCache = array()

Detailed Description

Definition at line 36 of file DiscISAM.php.

Constructor & Destructor Documentation

◆ __construct()

PHPExcel_CachedObjectStorage_DiscISAM::__construct	(	PHPExcel_Worksheet	$parent,
			$arguments
	)

Initialise this new cell collection.

Parameters

PHPExcel_Worksheet	$parent	The worksheet for this cell collection
	array	of mixed $arguments Additional initialisation arguments

Definition at line 194 of file DiscISAM.php.

References PHPExcel_CachedObjectStorage_CacheBase\_getUniqueID(), and PHPExcel_Shared_File\sys_get_temp_dir().

                                                                             {
                 $this->_cacheDirectory  = ((isset($arguments['dir'])) && ($arguments['dir'] !== NULL))
                                                                         ? $arguments['dir']
                                                                         : PHPExcel_Shared_File::sys_get_temp_dir();
 
                 parent::__construct($parent);
                 if (is_null($this->_fileHandle)) {
                         $baseUnique = $this->_getUniqueID();
                         $this->_fileName = $this->_cacheDirectory.'/PHPExcel.'.$baseUnique.'.cache';
                         $this->_fileHandle = fopen($this->_fileName,'a+');
                 }
         }       //      function __construct()

Here is the call graph for this function:

◆ __destruct()

PHPExcel_CachedObjectStorage_DiscISAM::__destruct ( )

Destroy this cell collection.

Definition at line 211 of file DiscISAM.php.

Referenced by unsetWorksheetCells().

                                      {
                 if (!is_null($this->_fileHandle)) {
                         fclose($this->_fileHandle);
                         unlink($this->_fileName);
                 }
                 $this->_fileHandle = null;
         }       //      function __destruct()

Here is the caller graph for this function:

Member Function Documentation

◆ _storeData()

PHPExcel_CachedObjectStorage_DiscISAM::_storeData ( )

protected

Store cell data in cache for the current cell object if it's "dirty", and the 'nullify' the current cell object.

Returns: void

Exceptions

PHPExcel_Exception

Definition at line 67 of file DiscISAM.php.

References PHPExcel_CachedObjectStorage_CacheBase\$_currentObjectID, and array.

Referenced by addCacheData(), getCacheData(), and getCellList().

                                         {
                 if ($this->_currentCellIsDirty && !empty($this->_currentObjectID)) {
                         $this->_currentObject->detach();
 
                         fseek($this->_fileHandle,0,SEEK_END);
 
                         $this->_cellCache[$this->_currentObjectID] = array(
                 'ptr' => ftell($this->_fileHandle),
                                 'sz'  => fwrite($this->_fileHandle, serialize($this->_currentObject))
                         );
                         $this->_currentCellIsDirty = false;
                 }
                 $this->_currentObjectID = $this->_currentObject = null;
         }       //      function _storeData()

Here is the caller graph for this function:

◆ addCacheData()

PHPExcel_CachedObjectStorage_DiscISAM::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: PHPExcel_Cell

Exceptions

PHPExcel_Exception

Implements PHPExcel_CachedObjectStorage_ICache.

Definition at line 91 of file DiscISAM.php.

References _storeData().

                                                                    {
                 if (($pCoord !== $this->_currentObjectID) && ($this->_currentObjectID !== null)) {
                         $this->_storeData();
                 }
 
                 $this->_currentObjectID = $pCoord;
                 $this->_currentObject = $cell;
                 $this->_currentCellIsDirty = true;
 
                 return $cell;
         }       //      function addCacheData()

Here is the call graph for this function:

◆ copyCellCollection()

PHPExcel_CachedObjectStorage_DiscISAM::copyCellCollection ( PHPExcel_Worksheet $parent )

Clone the cell collection.

Parameters

PHPExcel_Worksheet $parent The new worksheet

Returns: void

Implements PHPExcel_CachedObjectStorage_ICache.

Definition at line 155 of file DiscISAM.php.

References PHPExcel_CachedObjectStorage_CacheBase\_getUniqueID().

                                                                        {
                 parent::copyCellCollection($parent);
                 //      Get a new id for the new file name
                 $baseUnique = $this->_getUniqueID();
                 $newFileName = $this->_cacheDirectory.'/PHPExcel.'.$baseUnique.'.cache';
                 //      Copy the existing cell cache file
                 copy ($this->_fileName,$newFileName);
                 $this->_fileName = $newFileName;
                 //      Open the copied cell cache file
                 $this->_fileHandle = fopen($this->_fileName,'a+');
         }       //      function copyCellCollection()

Here is the call graph for this function:

◆ getCacheData()

PHPExcel_CachedObjectStorage_DiscISAM::getCacheData ( $pCoord )

Get cell at a specific coordinate.

Parameters

string $pCoord Coordinate of the cell

Exceptions

PHPExcel_Exception

Returns: PHPExcel_Cell Cell that was found, or null if not found

Implements PHPExcel_CachedObjectStorage_ICache.

Definition at line 111 of file DiscISAM.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;
                 fseek($this->_fileHandle, $this->_cellCache[$pCoord]['ptr']);
                 $this->_currentObject = unserialize(fread($this->_fileHandle, $this->_cellCache[$pCoord]['sz']));
         //    Re-attach this as the cell's parent
         $this->_currentObject->attach($this);
 
                 //      Return requested entry
                 return $this->_currentObject;
         }       //      function getCacheData()

Here is the call graph for this function:

◆ getCellList()

PHPExcel_CachedObjectStorage_DiscISAM::getCellList ( )

Get a list of all cell addresses currently held in cache.

Returns: string[]

Implements PHPExcel_CachedObjectStorage_ICache.

Definition at line 140 of file DiscISAM.php.

References _storeData().

                                       {
                 if ($this->_currentObjectID !== null) {
                         $this->_storeData();
                 }
 
                 return parent::getCellList();
         }

Here is the call graph for this function:

◆ unsetWorksheetCells()

PHPExcel_CachedObjectStorage_DiscISAM::unsetWorksheetCells ( )

Clear the cell collection and disconnect from our parent.

Returns: void

Definition at line 173 of file DiscISAM.php.

References __destruct(), and array.

                                               {
                 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;
 
                 //      Close down the temporary cache file
                 $this->__destruct();
         }       //      function unsetWorksheetCells()

Here is the call graph for this function:

Field Documentation

◆ $_cacheDirectory

PHPExcel_CachedObjectStorage_DiscISAM::$_cacheDirectory = NULL

private

Definition at line 57 of file DiscISAM.php.

◆ $_fileHandle

PHPExcel_CachedObjectStorage_DiscISAM::$_fileHandle = NULL

private

Definition at line 50 of file DiscISAM.php.

◆ $_fileName

PHPExcel_CachedObjectStorage_DiscISAM::$_fileName = NULL

private

Definition at line 43 of file DiscISAM.php.

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

libs/composer/vendor/phpoffice/phpexcel/Classes/PHPExcel/CachedObjectStorage/DiscISAM.php

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

◆ __destruct()

Member Function Documentation

◆ _storeData()

◆ addCacheData()

◆ copyCellCollection()

◆ getCacheData()

◆ getCellList()

◆ unsetWorksheetCells()

Field Documentation

◆ $_cacheDirectory

◆ $_fileHandle

◆ $_fileName