class PHPExcel_CachedObjectStorage_DiscISAM in Loft Data Grids 7.2

PHPExcel_CachedObjectStorage_DiscISAM

@category PHPExcel @package PHPExcel_CachedObjectStorage @copyright Copyright (c) 2006 - 2014 PHPExcel (http://www.codeplex.com/PHPExcel)

Hierarchy

• class \PHPExcel_CachedObjectStorage_CacheBase
  • class \PHPExcel_CachedObjectStorage_DiscISAM implements PHPExcel_CachedObjectStorage_ICache

File

vendor/phpoffice/phpexcel/Classes/PHPExcel/CachedObjectStorage/DiscISAM.php, line 36

class PHPExcel_CachedObjectStorage_DiscISAM extends PHPExcel_CachedObjectStorage_CacheBase implements PHPExcel_CachedObjectStorage_ICache {

  /**
   * Name of the file for this cache
   *
   * @var string
   */
  private $_fileName = NULL;

  /**
   * File handle for this cache file
   *
   * @var resource
   */
  private $_fileHandle = NULL;

  /**
   * Directory/Folder where the cache file is located
   *
   * @var string
   */
  private $_cacheDirectory = NULL;

  /**
   * Store cell data in cache for the current cell object if it's "dirty",
   *     and the 'nullify' the current cell object
   *
   * @return	void
   * @throws	PHPExcel_Exception
   */
  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()

  /**
   * Add or Update a cell in cache identified by coordinate address
   *
   * @param	string			$pCoord		Coordinate address of the cell to update
   * @param	PHPExcel_Cell	$cell		Cell to update
   * @return	PHPExcel_Cell
   * @throws	PHPExcel_Exception
   */
  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()

  /**
   * Get cell at a specific coordinate
   *
   * @param 	string 			$pCoord		Coordinate of the cell
   * @throws 	PHPExcel_Exception
   * @return 	PHPExcel_Cell 	Cell that was found, or null if not found
   */
  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()

  /**
   * Get a list of all cell addresses currently held in cache
   *
   * @return  string[]
   */
  public function getCellList() {
    if ($this->_currentObjectID !== null) {
      $this
        ->_storeData();
    }
    return parent::getCellList();
  }

  /**
   * Clone the cell collection
   *
   * @param	PHPExcel_Worksheet	$parent		The new worksheet
   * @return	void
   */
  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()

  /**
   * Clear the cell collection and disconnect from our parent
   *
   * @return	void
   */
  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()

  /**
   * Initialise this new cell collection
   *
   * @param	PHPExcel_Worksheet	$parent		The worksheet for this cell collection
   * @param	array of mixed		$arguments	Additional initialisation arguments
   */
  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()

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

}

Members

Name	Modifiers	Type	Description	Overrides
PHPExcel_CachedObjectStorage_CacheBase::$_cellCache	protected	property	* An array of cells or cell pointers for the worksheet cells held in this cache, * and indexed by their coordinate address within the worksheet * *
PHPExcel_CachedObjectStorage_CacheBase::$_currentCellIsDirty	protected	property	* Flag indicating whether the currently active Cell requires saving * *
PHPExcel_CachedObjectStorage_CacheBase::$_currentObject	protected	property	* The currently active Cell * *
PHPExcel_CachedObjectStorage_CacheBase::$_currentObjectID	protected	property	* Coordinate address of the currently active Cell * *
PHPExcel_CachedObjectStorage_CacheBase::$_parent	protected	property	* Parent worksheet * *
PHPExcel_CachedObjectStorage_CacheBase::cacheMethodIsAvailable	public static	function	* Identify whether the caching method is currently available * Some methods are dependent on the availability of certain extensions being enabled in the PHP build * *	6
PHPExcel_CachedObjectStorage_CacheBase::deleteCacheData	public	function	Delete a cell in cache identified by coordinate address	5
PHPExcel_CachedObjectStorage_CacheBase::getCurrentAddress	public	function	* Return the cell address of the currently active cell object * *
PHPExcel_CachedObjectStorage_CacheBase::getCurrentColumn	public	function	* Return the column address of the currently active cell object * *
PHPExcel_CachedObjectStorage_CacheBase::getCurrentRow	public	function	* Return the row address of the currently active cell object * *
PHPExcel_CachedObjectStorage_CacheBase::getHighestColumn	public	function	* Get highest worksheet column *
PHPExcel_CachedObjectStorage_CacheBase::getHighestRow	public	function	* Get highest worksheet row *
PHPExcel_CachedObjectStorage_CacheBase::getHighestRowAndColumn	public	function	* Get highest worksheet column and highest row that have cell records * *
PHPExcel_CachedObjectStorage_CacheBase::getParent	public	function	* Return the parent worksheet for this cell collection * *
PHPExcel_CachedObjectStorage_CacheBase::getSortedCellList	public	function	* Sort the list of all cell addresses currently held in cache by row and column * *
PHPExcel_CachedObjectStorage_CacheBase::isDataSet	public	function	* Is a value set in the current PHPExcel_CachedObjectStorage_ICache for an indexed cell? * *	5
PHPExcel_CachedObjectStorage_CacheBase::moveCell	public	function	* Move a cell object from one address to another * *	2
PHPExcel_CachedObjectStorage_CacheBase::removeColumn	public	function	Remove a column, deleting all cells in that column
PHPExcel_CachedObjectStorage_CacheBase::removeRow	public	function	Remove a row, deleting all cells in that row
PHPExcel_CachedObjectStorage_CacheBase::updateCacheData	public	function	Add or Update a cell in cache
PHPExcel_CachedObjectStorage_CacheBase::_getUniqueID	protected	function	* Generate a unique ID for cache referencing * *
PHPExcel_CachedObjectStorage_DiscISAM::$_cacheDirectory	private	property	* Directory/Folder where the cache file is located * *
PHPExcel_CachedObjectStorage_DiscISAM::$_fileHandle	private	property	* File handle for this cache file * *
PHPExcel_CachedObjectStorage_DiscISAM::$_fileName	private	property	* Name of the file for this cache * *
PHPExcel_CachedObjectStorage_DiscISAM::addCacheData	public	function	Add or Update a cell in cache identified by coordinate address Overrides PHPExcel_CachedObjectStorage_ICache::addCacheData
PHPExcel_CachedObjectStorage_DiscISAM::copyCellCollection	public	function	* Clone the cell collection * * Overrides PHPExcel_CachedObjectStorage_CacheBase::copyCellCollection
PHPExcel_CachedObjectStorage_DiscISAM::getCacheData	public	function	Get cell at a specific coordinate Overrides PHPExcel_CachedObjectStorage_ICache::getCacheData
PHPExcel_CachedObjectStorage_DiscISAM::getCellList	public	function	* Get a list of all cell addresses currently held in cache * * Overrides PHPExcel_CachedObjectStorage_CacheBase::getCellList
PHPExcel_CachedObjectStorage_DiscISAM::unsetWorksheetCells	public	function	* Clear the cell collection and disconnect from our parent * *
PHPExcel_CachedObjectStorage_DiscISAM::_storeData	protected	function	Store cell data in cache for the current cell object if it's "dirty", and the 'nullify' the current cell object
PHPExcel_CachedObjectStorage_DiscISAM::__construct	public	function	* Initialise this new cell collection * * Overrides PHPExcel_CachedObjectStorage_CacheBase::__construct
PHPExcel_CachedObjectStorage_DiscISAM::__destruct	public	function	* Destroy this cell collection