DiscISAM.php

Go to the documentation of this file.

<?php
class PHPExcel_CachedObjectStorage_DiscISAM extends PHPExcel_CachedObjectStorage_CacheBase implements PHPExcel_CachedObjectStorage_ICache {

        private $_fileName = NULL;

        private $_fileHandle = NULL;

        private $_cacheDirectory = NULL;


        protected function _storeData() {
                if ($this->_currentCellIsDirty && !empty($this->_currentObjectID)) {
                        $this->_currentObject->detach();

                        fseek($this->_fileHandle,0,SEEK_END);

                        $this->_cellCache[$this->_currentObjectID] = array(
                'ptr' => ftell($this->_fileHandle),
                                'sz'  => fwrite($this->_fileHandle, serialize($this->_currentObject))
                        );
                        $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->_currentObjectID = $pCoord;
                $this->_currentObject = $cell;
                $this->_currentCellIsDirty = true;

                return $cell;
        }       //      function addCacheData()


        public function getCacheData($pCoord) {
                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;
                fseek($this->_fileHandle, $this->_cellCache[$pCoord]['ptr']);
                $this->_currentObject = unserialize(fread($this->_fileHandle, $this->_cellCache[$pCoord]['sz']));
        //    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 copyCellCollection(PHPExcel_Worksheet $parent) {
                parent::copyCellCollection($parent);
                //      Get a new id for the new file name
                $baseUnique = $this->_getUniqueID();
                $newFileName = $this->_cacheDirectory.'/PHPExcel.'.$baseUnique.'.cache';
                //      Copy the existing cell cache file
                copy ($this->_fileName,$newFileName);
                $this->_fileName = $newFileName;
                //      Open the copied cell cache file
                $this->_fileHandle = fopen($this->_fileName,'a+');
        }       //      function copyCellCollection()


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

                //      Close down the temporary cache file
                $this->__destruct();
        }       //      function unsetWorksheetCells()


        public function __construct(PHPExcel_Worksheet $parent, $arguments) {
                $this->_cacheDirectory  = ((isset($arguments['dir'])) && ($arguments['dir'] !== NULL))
                                                                        ? $arguments['dir']
                                                                        : PHPExcel_Shared_File::sys_get_temp_dir();

                parent::__construct($parent);
                if (is_null($this->_fileHandle)) {
                        $baseUnique = $this->_getUniqueID();
                        $this->_fileName = $this->_cacheDirectory.'/PHPExcel.'.$baseUnique.'.cache';
                        $this->_fileHandle = fopen($this->_fileName,'a+');
                }
        }       //      function __construct()


        public function __destruct() {
                if (!is_null($this->_fileHandle)) {
                        fclose($this->_fileHandle);
                        unlink($this->_fileName);
                }
                $this->_fileHandle = null;
        }       //      function __destruct()

}