Inheritance diagram for PHPExcel_CachedObjectStorage_CacheBase:

Collaboration diagram for PHPExcel_CachedObjectStorage_CacheBase:

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

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

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

Protected Attributes
	$_parent

	$_currentObject = null

	$_currentObjectID = null

	$_currentCellIsDirty = true

	$_cellCache = array()

Detailed Description

Definition at line 36 of file CacheBase.php.

Constructor & Destructor Documentation

◆ __construct()

PHPExcel_CachedObjectStorage_CacheBase::__construct ( PHPExcel_Worksheet $parent )

Initialise this new cell collection.

Parameters

PHPExcel_Worksheet $parent The worksheet for this cell collection

Definition at line 81 of file CacheBase.php.

                                                                 {
                 //      Set our parent worksheet.
                 //      This is maintained within the cache controller to facilitate re-attaching it to PHPExcel_Cell objects when
                 //              they are woken from a serialized state
                 $this->_parent = $parent;
         }       //      function __construct()

Member Function Documentation

◆ _getUniqueID()

PHPExcel_CachedObjectStorage_CacheBase::_getUniqueID ( )

protected

Generate a unique ID for cache referencing.

Returns: string Unique Reference

Definition at line 311 of file CacheBase.php.

                                           {
                 if (function_exists('posix_getpid')) {
                         $baseUnique = posix_getpid();
                 } else {
                         $baseUnique = mt_rand();
                 }
                 return uniqid($baseUnique,true);
         }

Here is the caller graph for this function:

◆ cacheMethodIsAvailable()

static PHPExcel_CachedObjectStorage_CacheBase::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

Definition at line 372 of file CacheBase.php.

                                                         {
                 return true;
         }

◆ copyCellCollection()

PHPExcel_CachedObjectStorage_CacheBase::copyCellCollection ( PHPExcel_Worksheet $parent )

Clone the cell collection.

Parameters

PHPExcel_Worksheet $parent The new worksheet

Returns: void

Definition at line 326 of file CacheBase.php.

References $_currentCellIsDirty.

                                                                        {
                 $this->_currentCellIsDirty;
         $this->_storeData();
 
                 $this->_parent = $parent;
                 if (($this->_currentObject !== NULL) && (is_object($this->_currentObject))) {
                         $this->_currentObject->attach($this);
                 }
         }       //      function copyCellCollection()

◆ deleteCacheData()

PHPExcel_CachedObjectStorage_CacheBase::deleteCacheData ( $pCoord )

Delete a cell in cache identified by coordinate address.

Parameters

string $pCoord Coordinate address of the cell to delete

Exceptions

PHPExcel_Exception

Definition at line 153 of file CacheBase.php.

Referenced by removeColumn(), and removeRow().

                                                  {
                 if ($pCoord === $this->_currentObjectID && !is_null($this->_currentObject)) {
                         $this->_currentObject->detach();
                         $this->_currentObjectID = $this->_currentObject = null;
                 }
 
                 if (is_object($this->_cellCache[$pCoord])) {
                         $this->_cellCache[$pCoord]->detach();
                         unset($this->_cellCache[$pCoord]);
                 }
                 $this->_currentCellIsDirty = false;
         }       //      function deleteCacheData()

Here is the caller graph for this function:

◆ getCellList()

PHPExcel_CachedObjectStorage_CacheBase::getCellList ( )

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

Returns: string[]

Definition at line 172 of file CacheBase.php.

Referenced by getHighestColumn(), getHighestRow(), getHighestRowAndColumn(), getSortedCellList(), removeColumn(), and removeRow().

                                       {
                 return array_keys($this->_cellCache);
         }       //      function getCellList()

Here is the caller graph for this function:

◆ getCurrentAddress()

PHPExcel_CachedObjectStorage_CacheBase::getCurrentAddress ( )

Return the cell address of the currently active cell object.

Returns: string

Definition at line 227 of file CacheBase.php.

References $_currentObjectID.

         {
                 return $this->_currentObjectID;
         }

◆ getCurrentColumn()

PHPExcel_CachedObjectStorage_CacheBase::getCurrentColumn ( )

Return the column address of the currently active cell object.

Returns: string

Definition at line 237 of file CacheBase.php.

References $column, and $row.

         {
                 sscanf($this->_currentObjectID, '%[A-Z]%d', $column, $row);
                 return $column;
         }

◆ getCurrentRow()

PHPExcel_CachedObjectStorage_CacheBase::getCurrentRow ( )

Return the row address of the currently active cell object.

Returns: integer

Definition at line 248 of file CacheBase.php.

References $column, and $row.

         {
                 sscanf($this->_currentObjectID, '%[A-Z]%d', $column, $row);
                 return (integer) $row;
         }

◆ getHighestColumn()

PHPExcel_CachedObjectStorage_CacheBase::getHighestColumn ( $row = null )

Get highest worksheet column.

Parameters

string $row Return the highest column for the specified row, or the highest column of any row if no row number is passed

Returns: string Highest column name

Definition at line 261 of file CacheBase.php.

References $r, $row, array, PHPExcel_Cell\columnIndexFromString(), getCellList(), getHighestRowAndColumn(), and PHPExcel_Cell\stringFromColumnIndex().

         {
         if ($row == null) {
                 $colRow = $this->getHighestRowAndColumn();
                 return $colRow['column'];
         }
 
         $columnList = array(1);
         foreach ($this->getCellList() as $coord) {
             sscanf($coord,'%[A-Z]%d', $c, $r);
             if ($r != $row) {
                 continue;
             }
             $columnList[] = PHPExcel_Cell::columnIndexFromString($c);
         }
         return PHPExcel_Cell::stringFromColumnIndex(max($columnList) - 1);
     }

Here is the call graph for this function:

◆ getHighestRow()

PHPExcel_CachedObjectStorage_CacheBase::getHighestRow ( $column = null )

Get highest worksheet row.

Parameters

string $column Return the highest row for the specified column, or the highest row of any column if no column letter is passed

Returns: int Highest row number

Definition at line 286 of file CacheBase.php.

References $column, $r, array, getCellList(), and getHighestRowAndColumn().

         {
         if ($column == null) {
                 $colRow = $this->getHighestRowAndColumn();
                 return $colRow['row'];
         }
 
         $rowList = array(0);
         foreach ($this->getCellList() as $coord) {
             sscanf($coord,'%[A-Z]%d', $c, $r);
             if ($c != $column) {
                 continue;
             }
             $rowList[] = $r;
         }
 
         return max($rowList);
         }

Here is the call graph for this function:

◆ getHighestRowAndColumn()

PHPExcel_CachedObjectStorage_CacheBase::getHighestRowAndColumn ( )

Get highest worksheet column and highest row that have cell records.

Returns: array Highest column name and highest row number

Definition at line 200 of file CacheBase.php.

References $r, $row, array, and getCellList().

Referenced by getHighestColumn(), and getHighestRow().

         {
                 // Lookup highest column and highest row
                 $col = array('A' => '1A');
                 $row = array(1);
                 foreach ($this->getCellList() as $coord) {
                         sscanf($coord,'%[A-Z]%d', $c, $r);
                         $row[$r] = $r;
                         $col[$c] = strlen($c).$c;
                 }
                 if (!empty($row)) {
                         // Determine highest column and row
                         $highestRow = max($row);
                         $highestColumn = substr(max($col),1);
                 }
 
                 return array( 'row'        => $highestRow,
                                           'column' => $highestColumn
                                         );
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getParent()

PHPExcel_CachedObjectStorage_CacheBase::getParent ( )

Return the parent worksheet for this cell collection.

Returns: PHPExcel_Worksheet

Definition at line 94 of file CacheBase.php.

References $_parent.

         {
                 return $this->_parent;
         }

◆ getSortedCellList()

PHPExcel_CachedObjectStorage_CacheBase::getSortedCellList ( )

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

Returns: string[]

Definition at line 182 of file CacheBase.php.

References $column, $row, array, and getCellList().

                                             {
                 $sortKeys = array();
                 foreach ($this->getCellList() as $coord) {
                         sscanf($coord,'%[A-Z]%d', $column, $row);
                         $sortKeys[sprintf('%09d%3s',$row,$column)] = $coord;
                 }
                 ksort($sortKeys);
 
                 return array_values($sortKeys);
         }       //      function sortCellList()

Here is the call graph for this function:

◆ isDataSet()

PHPExcel_CachedObjectStorage_CacheBase::isDataSet ( $pCoord )

Is a value set in the current PHPExcel_CachedObjectStorage_ICache for an indexed cell?

Parameters

string $pCoord Coordinate address of the cell to check

Returns: boolean

Definition at line 105 of file CacheBase.php.

                                            {
                 if ($pCoord === $this->_currentObjectID) {
                         return true;
                 }
                 //      Check if the requested entry exists in the cache
                 return isset($this->_cellCache[$pCoord]);
         }       //      function isDataSet()

◆ moveCell()

PHPExcel_CachedObjectStorage_CacheBase::moveCell	(	$fromAddress,
		$toAddress
	)

Move a cell object from one address to another.

Parameters

string	$fromAddress	Current address of the cell to move
string	$toAddress	Destination address of the cell to move

Returns: boolean

Definition at line 121 of file CacheBase.php.

                                                            {
                 if ($fromAddress === $this->_currentObjectID) {
                         $this->_currentObjectID = $toAddress;
                 }
                 $this->_currentCellIsDirty = true;
                 if (isset($this->_cellCache[$fromAddress])) {
                         $this->_cellCache[$toAddress] = &$this->_cellCache[$fromAddress];
                         unset($this->_cellCache[$fromAddress]);
                 }
 
                 return TRUE;
         }       //      function moveCell()

◆ removeColumn()

PHPExcel_CachedObjectStorage_CacheBase::removeColumn ( $column )

Remove a column, deleting all cells in that column.

Parameters

string $column Column ID to remove

Returns: void

Definition at line 357 of file CacheBase.php.

References $column, $r, deleteCacheData(), and getCellList().

                                           {
         foreach ($this->getCellList() as $coord) {
             sscanf($coord,'%[A-Z]%d', $c, $r);
             if ($c == $column) {
                 $this->deleteCacheData($coord);
             }
         }
     }

Here is the call graph for this function:

◆ removeRow()

PHPExcel_CachedObjectStorage_CacheBase::removeRow ( $row )

Remove a row, deleting all cells in that row.

Parameters

string $row Row number to remove

Returns: void

Definition at line 342 of file CacheBase.php.

References $r, $row, deleteCacheData(), and getCellList().

                                     {
         foreach ($this->getCellList() as $coord) {
             sscanf($coord,'%[A-Z]%d', $c, $r);
             if ($r == $row) {
                 $this->deleteCacheData($coord);
             }
         }
     }

Here is the call graph for this function:

◆ updateCacheData()

PHPExcel_CachedObjectStorage_CacheBase::updateCacheData ( PHPExcel_Cell $cell )

Add or Update a cell in cache.

Parameters

PHPExcel_Cell $cell Cell to update

Returns: PHPExcel_Cell

Exceptions

PHPExcel_Exception

Definition at line 142 of file CacheBase.php.

References PHPExcel_Cell\getCoordinate().

                                                              {
                 return $this->addCacheData($cell->getCoordinate(),$cell);
         }       //      function updateCacheData()

Here is the call graph for this function:

Field Documentation

◆ $_cellCache

PHPExcel_CachedObjectStorage_CacheBase::$_cellCache = array()

protected

Definition at line 73 of file CacheBase.php.

◆ $_currentCellIsDirty

PHPExcel_CachedObjectStorage_CacheBase::$_currentCellIsDirty = true

protected

Definition at line 65 of file CacheBase.php.

Referenced by PHPExcel_CachedObjectStorage_SQLite\copyCellCollection(), PHPExcel_CachedObjectStorage_SQLite3\copyCellCollection(), and copyCellCollection().

◆ $_currentObject

PHPExcel_CachedObjectStorage_CacheBase::$_currentObject = null

protected

Definition at line 50 of file CacheBase.php.

◆ $_currentObjectID

PHPExcel_CachedObjectStorage_CacheBase::$_currentObjectID = null

protected

Definition at line 57 of file CacheBase.php.

Referenced by PHPExcel_CachedObjectStorage_Igbinary\_storeData(), PHPExcel_CachedObjectStorage_MemoryGZip\_storeData(), PHPExcel_CachedObjectStorage_MemorySerialized\_storeData(), PHPExcel_CachedObjectStorage_PHPTemp\_storeData(), PHPExcel_CachedObjectStorage_DiscISAM\_storeData(), and getCurrentAddress().

◆ $_parent

PHPExcel_CachedObjectStorage_CacheBase::$_parent

protected

Definition at line 43 of file CacheBase.php.

Referenced by getParent().

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getUniqueID()

◆ cacheMethodIsAvailable()

◆ copyCellCollection()

◆ deleteCacheData()

◆ getCellList()

◆ getCurrentAddress()

◆ getCurrentColumn()

◆ getCurrentRow()

◆ getHighestColumn()

◆ getHighestRow()

◆ getHighestRowAndColumn()

◆ getParent()

◆ getSortedCellList()

◆ isDataSet()

◆ moveCell()

◆ removeColumn()

◆ removeRow()

◆ updateCacheData()

Field Documentation

◆ $_cellCache

◆ $_currentCellIsDirty

◆ $_currentObject

◆ $_currentObjectID

◆ $_parent