ILIAS  release_5-3 Revision v5.3.23-19-g915713cf615
PHPExcel_CachedObjectStorage_Igbinary Class Reference
+ 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)
 
 getHighestRow ($column=null)
 
 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
 addCacheData ($pCoord, PHPExcel_Cell $cell)
 Add or Update a cell in cache identified by coordinate address. More...
 
 updateCacheData (PHPExcel_Cell $cell)
 Add or Update a cell in cache. More...
 
 getCacheData ($pCoord)
 Fetch a cell from cache identified by coordinate address. 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...
 
 getCellList ()
 Get a list of all cell addresses currently held in cache. 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 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 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.

45 {
46 if ($this->_currentCellIsDirty && !empty($this->_currentObjectID)) {
47 $this->_currentObject->detach();
48
49 $this->_cellCache[$this->_currentObjectID] = igbinary_serialize($this->_currentObject);
50 $this->_currentCellIsDirty = false;
51 }
52 $this->_currentObjectID = $this->_currentObject = null;
53 } // function _storeData()

References PHPExcel_CachedObjectStorage_CacheBase\$_currentObjectID.

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

+ 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$pCoordCoordinate address of the cell to update
PHPExcel_Cell$cellCell to update
Returns
PHPExcel_Cell
Exceptions
PHPExcel_Exception

Implements PHPExcel_CachedObjectStorage_ICache.

Definition at line 64 of file Igbinary.php.

64 {
65 if (($pCoord !== $this->_currentObjectID) && ($this->_currentObjectID !== null)) {
66 $this->_storeData();
67 }
68
69 $this->_currentObjectID = $pCoord;
70 $this->_currentObject = $cell;
71 $this->_currentCellIsDirty = true;
72
73 return $cell;
74 } // function addCacheData()
_storeData()
Store cell data in cache for the current cell object if it's "dirty", and the 'nullify' the current c...
Definition: Igbinary.php:45

References _storeData().

+ 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

Reimplemented from PHPExcel_CachedObjectStorage_CacheBase.

Definition at line 144 of file Igbinary.php.

144 {
145 if (!function_exists('igbinary_serialize')) {
146 return false;
147 }
148
149 return true;
150 }

◆ getCacheData()

PHPExcel_CachedObjectStorage_Igbinary::getCacheData (   $pCoord)

Get cell at a specific coordinate.

Parameters
string$pCoordCoordinate 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.

84 {
85 if ($pCoord === $this->_currentObjectID) {
87 }
88 $this->_storeData();
89
90 // Check if the entry that has been requested actually exists
91 if (!isset($this->_cellCache[$pCoord])) {
92 // Return null if requested entry doesn't exist in cache
93 return null;
94 }
95
96 // Set current entry to the requested entry
97 $this->_currentObjectID = $pCoord;
98 $this->_currentObject = igbinary_unserialize($this->_cellCache[$pCoord]);
99 // Re-attach this as the cell's parent
100 $this->_currentObject->attach($this);
101
102 // Return requested entry
104 } // function getCacheData()

References PHPExcel_CachedObjectStorage_CacheBase\$_currentObject, and _storeData().

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

Reimplemented from PHPExcel_CachedObjectStorage_CacheBase.

Definition at line 112 of file Igbinary.php.

112 {
113 if ($this->_currentObjectID !== null) {
114 $this->_storeData();
115 }
116
117 return parent::getCellList();
118 }

References _storeData().

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

126 {
127 if(!is_null($this->_currentObject)) {
128 $this->_currentObject->detach();
129 $this->_currentObject = $this->_currentObjectID = null;
130 }
131 $this->_cellCache = array();
132
133 // detach ourself from the worksheet, so that it can then delete this object successfully
134 $this->_parent = null;
135 } // function unsetWorksheetCells()

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