Inheritance diagram for PHPExcel_CachedObjectStorage_Memcache:

Collaboration diagram for PHPExcel_CachedObjectStorage_Memcache:

Public Member Functions
	addCacheData ($pCoord, PHPExcel_Cell $cell)
	Add or Update 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...

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

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

	deleteCacheData ($pCoord)
	Delete a cell in cache identified by coordinate address. 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...

	failureCallback ($host, $port)
	Memcache error handler. 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...

	getSortedCellList ()
	Get the list of all cell addresses currently held in cache sorted by column and row. 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...

Private Attributes
	$_cachePrefix = null

	$_cacheTime = 600

	$_memcache = null

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

Constructor & Destructor Documentation

◆ __construct()

PHPExcel_CachedObjectStorage_Memcache::__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 255 of file Memcache.php.

References PHPExcel_CachedObjectStorage_CacheBase\_getUniqueID(), and array.

                                                                             {
                 $memcacheServer = (isset($arguments['memcacheServer'])) ? $arguments['memcacheServer']  : 'localhost';
                 $memcachePort   = (isset($arguments['memcachePort']))   ? $arguments['memcachePort']    : 11211;
                 $cacheTime              = (isset($arguments['cacheTime']))              ? $arguments['cacheTime']               : 600;
 
                 if (is_null($this->_cachePrefix)) {
                         $baseUnique = $this->_getUniqueID();
                         $this->_cachePrefix = substr(md5($baseUnique),0,8).'.';
 
                         //      Set a new Memcache object and connect to the Memcache server
                         $this->_memcache = new Memcache();
                         if (!$this->_memcache->addServer($memcacheServer, $memcachePort, false, 50, 5, 5, true, array($this, 'failureCallback'))) {
                                 throw new PHPExcel_Exception('Could not connect to MemCache server at '.$memcacheServer.':'.$memcachePort);
                         }
                         $this->_cacheTime = $cacheTime;
 
                         parent::__construct($parent);
                 }
         }       //      function __construct()

Here is the call graph for this function:

◆ __destruct()

PHPExcel_CachedObjectStorage_Memcache::__destruct ( )

Destroy this cell collection.

Definition at line 291 of file Memcache.php.

References getCellList().

Referenced by _storeData(), copyCellCollection(), and unsetWorksheetCells().

                                      {
                 $cacheList = $this->getCellList();
                 foreach($cacheList as $cellID) {
                         $this->_memcache->delete($this->_cachePrefix.$cellID.'.cache');
                 }
         }       //      function __destruct()

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ _storeData()

PHPExcel_CachedObjectStorage_Memcache::_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 Memcache.php.

References __destruct().

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

                                         {
                 if ($this->_currentCellIsDirty && !empty($this->_currentObjectID)) {
                         $this->_currentObject->detach();
 
                         $obj = serialize($this->_currentObject);
                         if (!$this->_memcache->replace($this->_cachePrefix.$this->_currentObjectID.'.cache',$obj,NULL,$this->_cacheTime)) {
                                 if (!$this->_memcache->add($this->_cachePrefix.$this->_currentObjectID.'.cache',$obj,NULL,$this->_cacheTime)) {
                                         $this->__destruct();
                                         throw new PHPExcel_Exception('Failed to store cell '.$this->_currentObjectID.' in MemCache');
                                 }
                         }
                         $this->_currentCellIsDirty = false;
                 }
                 $this->_currentObjectID = $this->_currentObject = null;
         }       //      function _storeData()

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addCacheData()

PHPExcel_CachedObjectStorage_Memcache::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 92 of file Memcache.php.

References _storeData().

                                                                    {
                 if (($pCoord !== $this->_currentObjectID) && ($this->_currentObjectID !== null)) {
                         $this->_storeData();
                 }
                 $this->_cellCache[$pCoord] = true;
 
                 $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_Memcache::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 304 of file Memcache.php.

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

◆ copyCellCollection()

PHPExcel_CachedObjectStorage_Memcache::copyCellCollection ( PHPExcel_Worksheet $parent )

Clone the cell collection.

Parameters

PHPExcel_Worksheet $parent The new worksheet

Returns: void

Implements PHPExcel_CachedObjectStorage_ICache.

Definition at line 204 of file Memcache.php.

References __destruct(), PHPExcel_CachedObjectStorage_CacheBase\_getUniqueID(), and getCellList().

                                                                        {
                 parent::copyCellCollection($parent);
                 //      Get a new id for the new file name
                 $baseUnique = $this->_getUniqueID();
                 $newCachePrefix = substr(md5($baseUnique),0,8).'.';
                 $cacheList = $this->getCellList();
                 foreach($cacheList as $cellID) {
                         if ($cellID != $this->_currentObjectID) {
                                 $obj = $this->_memcache->get($this->_cachePrefix.$cellID.'.cache');
                                 if ($obj === false) {
                                         //      Entry no longer exists in Memcache, so clear it from the cache array
                                         parent::deleteCacheData($cellID);
                                         throw new PHPExcel_Exception('Cell entry '.$cellID.' no longer exists in MemCache');
                                 }
                                 if (!$this->_memcache->add($newCachePrefix.$cellID.'.cache',$obj,NULL,$this->_cacheTime)) {
                                         $this->__destruct();
                                         throw new PHPExcel_Exception('Failed to store cell '.$cellID.' in MemCache');
                                 }
                         }
                 }
                 $this->_cachePrefix = $newCachePrefix;
         }       //      function copyCellCollection()

Here is the call graph for this function:

◆ deleteCacheData()

PHPExcel_CachedObjectStorage_Memcache::deleteCacheData ( $pCoord )

Delete a cell in cache identified by coordinate address.

Parameters

string $pCoord Coordinate address of the cell to delete

Exceptions

PHPExcel_Exception

Implements PHPExcel_CachedObjectStorage_ICache.

Definition at line 189 of file Memcache.php.

                                                  {
                 //      Delete the entry from Memcache
                 $this->_memcache->delete($this->_cachePrefix.$pCoord.'.cache');
 
                 //      Delete the entry from our cell address array
                 parent::deleteCacheData($pCoord);
         }       //      function deleteCacheData()

◆ failureCallback()

PHPExcel_CachedObjectStorage_Memcache::failureCallback	(	$host,
		$port
	)

Memcache error handler.

Parameters

string	$host	Memcache server
integer	$port	Memcache port

Exceptions

PHPExcel_Exception

Definition at line 283 of file Memcache.php.

                                                       {
                 throw new PHPExcel_Exception('memcache '.$host.':'.$port.' failed');
         }

◆ getCacheData()

PHPExcel_CachedObjectStorage_Memcache::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 139 of file Memcache.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 (parent::isDataSet($pCoord)) {
                         $obj = $this->_memcache->get($this->_cachePrefix.$pCoord.'.cache');
                         if ($obj === false) {
                                 //      Entry no longer exists in Memcache, so clear it from the cache array
                                 parent::deleteCacheData($pCoord);
                                 throw new PHPExcel_Exception('Cell entry '.$pCoord.' no longer exists in MemCache');
                         }
                 } else {
                         //      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($obj);
         //    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_Memcache::getCellList ( )

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

Returns: string[]

Implements PHPExcel_CachedObjectStorage_ICache.

Definition at line 174 of file Memcache.php.

References _storeData().

Referenced by __destruct(), and copyCellCollection().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isDataSet()

PHPExcel_CachedObjectStorage_Memcache::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; boolean

Implements PHPExcel_CachedObjectStorage_ICache.

Definition at line 113 of file Memcache.php.

References $success.

                                            {
                 //      Check if the requested entry is the current object, or exists in the cache
                 if (parent::isDataSet($pCoord)) {
                         if ($this->_currentObjectID == $pCoord) {
                                 return true;
                         }
                         //      Check if the requested entry still exists in Memcache
                         $success = $this->_memcache->get($this->_cachePrefix.$pCoord.'.cache');
                         if ($success === false) {
                                 //      Entry no longer exists in Memcache, so clear it from the cache array
                                 parent::deleteCacheData($pCoord);
                                 throw new PHPExcel_Exception('Cell entry '.$pCoord.' no longer exists in MemCache');
                         }
                         return true;
                 }
                 return false;
         }       //      function isDataSet()

◆ unsetWorksheetCells()

PHPExcel_CachedObjectStorage_Memcache::unsetWorksheetCells ( )

Clear the cell collection and disconnect from our parent.

Returns: void

Definition at line 233 of file Memcache.php.

References __destruct(), and array.

                                               {
                 if(!is_null($this->_currentObject)) {
                         $this->_currentObject->detach();
                         $this->_currentObject = $this->_currentObjectID = null;
                 }
 
                 //      Flush the Memcache cache
                 $this->__destruct();
 
                 $this->_cellCache = array();
 
                 //      detach ourself from the worksheet, so that it can then delete this object successfully
                 $this->_parent = null;
         }       //      function unsetWorksheetCells()

Here is the call graph for this function:

Field Documentation

◆ $_cachePrefix

PHPExcel_CachedObjectStorage_Memcache::$_cachePrefix = null

private

Definition at line 43 of file Memcache.php.

◆ $_cacheTime

PHPExcel_CachedObjectStorage_Memcache::$_cacheTime = 600

private

Definition at line 50 of file Memcache.php.

◆ $_memcache

PHPExcel_CachedObjectStorage_Memcache::$_memcache = null

private

Definition at line 57 of file Memcache.php.

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

◆ __destruct()

Member Function Documentation

◆ _storeData()

◆ addCacheData()

◆ cacheMethodIsAvailable()

◆ copyCellCollection()

◆ deleteCacheData()

◆ failureCallback()

◆ getCacheData()

◆ getCellList()

◆ isDataSet()

◆ unsetWorksheetCells()

Field Documentation

◆ $_cachePrefix

◆ $_cacheTime

◆ $_memcache