Memcache.php

Go to the documentation of this file.

<?php
class PHPExcel_CachedObjectStorage_Memcache extends PHPExcel_CachedObjectStorage_CacheBase implements PHPExcel_CachedObjectStorage_ICache {

        private $_cachePrefix = null;

        private $_cacheTime = 600;

        private $_memcache = null;


        protected function _storeData() {
                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()


        public function addCacheData($pCoord, PHPExcel_Cell $cell) {
                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()


        public function isDataSet($pCoord) {
                //      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()


        public function getCacheData($pCoord) {
                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()


        public function getCellList() {
                if ($this->_currentObjectID !== null) {
                        $this->_storeData();
                }

                return parent::getCellList();
        }


        public function deleteCacheData($pCoord) {
                //      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()


        public function copyCellCollection(PHPExcel_Worksheet $parent) {
                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()


        public function unsetWorksheetCells() {
                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()


        public function __construct(PHPExcel_Worksheet $parent, $arguments) {
                $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()


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


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

        public static function cacheMethodIsAvailable() {
                if (!function_exists('memcache_add')) {
                        return false;
                }

                return true;
        }

}