Inheritance diagram for PHPExcel_CachedObjectStorage_Igbinary:

Collaboration diagram for PHPExcel_CachedObjectStorage_Igbinary:

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...

	unsetWorksheetCells ()
	Clear the cell collection and disconnect from our parent. 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...

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

Static Public Member Functions
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_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...

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...

Additional Inherited Members
Protected Attributes inherited from PHPExcel_CachedObjectStorage_CacheBase
	$_parent

	$_currentObject = null

	$_currentObjectID = null

	$_currentCellIsDirty = true

	$_cellCache = array()

Detailed Description

Definition at line 36 of file Igbinary.php.

Member Function Documentation

◆ _storeData()

PHPExcel_CachedObjectStorage_Igbinary::_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 45 of file Igbinary.php.

References PHPExcel_CachedObjectStorage_CacheBase\$_currentObjectID.

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

                                         {
                 if ($this->_currentCellIsDirty && !empty($this->_currentObjectID)) {
                         $this->_currentObject->detach();
 
                         $this->_cellCache[$this->_currentObjectID] = igbinary_serialize($this->_currentObject);
                         $this->_currentCellIsDirty = false;
                 }
                 $this->_currentObjectID = $this->_currentObject = null;
         }       //      function _storeData()

Here is the caller graph for this function:

◆ addCacheData()

PHPExcel_CachedObjectStorage_Igbinary::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 64 of file Igbinary.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:

◆ cacheMethodIsAvailable()

static PHPExcel_CachedObjectStorage_Igbinary::cacheMethodIsAvailable ( )

static

Identify whether the caching method is currently available Some methods are dependent on the availability of certain extensions being enabled in the PHP build.

Returns: boolean

Implements PHPExcel_CachedObjectStorage_ICache.

Definition at line 144 of file Igbinary.php.

                                                         {
                 if (!function_exists('igbinary_serialize')) {
                         return false;
                 }
 
                 return true;
         }

◆ getCacheData()

PHPExcel_CachedObjectStorage_Igbinary::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 84 of file Igbinary.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 = igbinary_unserialize($this->_cellCache[$pCoord]);
         //    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_Igbinary::getCellList ( )

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

Returns: string[]

Implements PHPExcel_CachedObjectStorage_ICache.

Definition at line 112 of file Igbinary.php.

References _storeData().

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

Here is the call graph for this function:

◆ unsetWorksheetCells()

PHPExcel_CachedObjectStorage_Igbinary::unsetWorksheetCells ( )

Clear the cell collection and disconnect from our parent.

Returns: void

Definition at line 126 of file Igbinary.php.

References 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;
         }       //      function unsetWorksheetCells()

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _storeData()

◆ addCacheData()

◆ cacheMethodIsAvailable()

◆ getCacheData()

◆ getCellList()

◆ unsetWorksheetCells()