class PHPExcel_CachedObjectStorage_SQLite3 in Loft Data Grids 7.2

Same name and namespace in other branches

6.2 vendor/phpoffice/phpexcel/Classes/PHPExcel/CachedObjectStorage/SQLite3.php \PHPExcel_CachedObjectStorage_SQLite3

PHPExcel_CachedObjectStorage_SQLite3

Hierarchy

class \PHPExcel_CachedObjectStorage_CacheBase
- class \PHPExcel_CachedObjectStorage_SQLite3 implements PHPExcel_CachedObjectStorage_ICache

Expanded class hierarchy of PHPExcel_CachedObjectStorage_SQLite3

File

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

View source

class PHPExcel_CachedObjectStorage_SQLite3 extends PHPExcel_CachedObjectStorage_CacheBase implements PHPExcel_CachedObjectStorage_ICache {

  /**
   * Database table name
   *
   * @var string
   */
  private $_TableName = null;

  /**
   * Database handle
   *
   * @var resource
   */
  private $_DBHandle = null;

  /**
   * Prepared statement for a SQLite3 select query
   *
   * @var SQLite3Stmt
   */
  private $_selectQuery;

  /**
   * Prepared statement for a SQLite3 insert query
   *
   * @var SQLite3Stmt
   */
  private $_insertQuery;

  /**
   * Prepared statement for a SQLite3 update query
   *
   * @var SQLite3Stmt
   */
  private $_updateQuery;

  /**
   * Prepared statement for a SQLite3 delete query
   *
   * @var SQLite3Stmt
   */
  private $_deleteQuery;

  /**
   * 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();
      $this->_insertQuery
        ->bindValue('id', $this->_currentObjectID, SQLITE3_TEXT);
      $this->_insertQuery
        ->bindValue('data', serialize($this->_currentObject), SQLITE3_BLOB);
      $result = $this->_insertQuery
        ->execute();
      if ($result === false) {
        throw new PHPExcel_Exception($this->_DBHandle
          ->lastErrorMsg());
      }
      $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();
    $this->_selectQuery
      ->bindValue('id', $pCoord, SQLITE3_TEXT);
    $cellResult = $this->_selectQuery
      ->execute();
    if ($cellResult === FALSE) {
      throw new PHPExcel_Exception($this->_DBHandle
        ->lastErrorMsg());
    }
    $cellData = $cellResult
      ->fetchArray(SQLITE3_ASSOC);
    if ($cellData === FALSE) {

      //	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($cellData['value']);

    //    Re-attach this as the cell's parent
    $this->_currentObject
      ->attach($this);

    //	Return requested entry
    return $this->_currentObject;
  }

  //	function getCacheData()

  /**
   *	Is a value set for an indexed cell?
   *
   * @param	string		$pCoord		Coordinate address of the cell to check
   * @return	boolean
   */
  public function isDataSet($pCoord) {
    if ($pCoord === $this->_currentObjectID) {
      return TRUE;
    }

    //	Check if the requested entry exists in the cache
    $this->_selectQuery
      ->bindValue('id', $pCoord, SQLITE3_TEXT);
    $cellResult = $this->_selectQuery
      ->execute();
    if ($cellResult === FALSE) {
      throw new PHPExcel_Exception($this->_DBHandle
        ->lastErrorMsg());
    }
    $cellData = $cellResult
      ->fetchArray(SQLITE3_ASSOC);
    return $cellData === FALSE ? FALSE : TRUE;
  }

  //	function isDataSet()

  /**
   *	Delete a cell in cache identified by coordinate address
   *
   * @param	string			$pCoord		Coordinate address of the cell to delete
   * @throws	PHPExcel_Exception
   */
  public function deleteCacheData($pCoord) {
    if ($pCoord === $this->_currentObjectID) {
      $this->_currentObject
        ->detach();
      $this->_currentObjectID = $this->_currentObject = NULL;
    }

    //	Check if the requested entry exists in the cache
    $this->_deleteQuery
      ->bindValue('id', $pCoord, SQLITE3_TEXT);
    $result = $this->_deleteQuery
      ->execute();
    if ($result === FALSE) {
      throw new PHPExcel_Exception($this->_DBHandle
        ->lastErrorMsg());
    }
    $this->_currentCellIsDirty = FALSE;
  }

  //	function deleteCacheData()

  /**
   * Move a cell object from one address to another
   *
   * @param	string		$fromAddress	Current address of the cell to move
   * @param	string		$toAddress		Destination address of the cell to move
   * @return	boolean
   */
  public function moveCell($fromAddress, $toAddress) {
    if ($fromAddress === $this->_currentObjectID) {
      $this->_currentObjectID = $toAddress;
    }
    $this->_deleteQuery
      ->bindValue('id', $toAddress, SQLITE3_TEXT);
    $result = $this->_deleteQuery
      ->execute();
    if ($result === false) {
      throw new PHPExcel_Exception($this->_DBHandle
        ->lastErrorMsg());
    }
    $this->_updateQuery
      ->bindValue('toid', $toAddress, SQLITE3_TEXT);
    $this->_updateQuery
      ->bindValue('fromid', $fromAddress, SQLITE3_TEXT);
    $result = $this->_updateQuery
      ->execute();
    if ($result === false) {
      throw new PHPExcel_Exception($this->_DBHandle
        ->lastErrorMsg());
    }
    return TRUE;
  }

  //	function moveCell()

  /**
   * Get a list of all cell addresses currently held in cache
   *
   * @return	string[]
   */
  public function getCellList() {
    if ($this->_currentObjectID !== null) {
      $this
        ->_storeData();
    }
    $query = "SELECT id FROM kvp_" . $this->_TableName;
    $cellIdsResult = $this->_DBHandle
      ->query($query);
    if ($cellIdsResult === false) {
      throw new PHPExcel_Exception($this->_DBHandle
        ->lastErrorMsg());
    }
    $cellKeys = array();
    while ($row = $cellIdsResult
      ->fetchArray(SQLITE3_ASSOC)) {
      $cellKeys[] = $row['id'];
    }
    return $cellKeys;
  }

  //	function getCellList()

  /**
   * Clone the cell collection
   *
   * @param	PHPExcel_Worksheet	$parent		The new worksheet
   * @return	void
   */
  public function copyCellCollection(PHPExcel_Worksheet $parent) {
    $this->_currentCellIsDirty;
    $this
      ->_storeData();

    //	Get a new id for the new table name
    $tableName = str_replace('.', '_', $this
      ->_getUniqueID());
    if (!$this->_DBHandle
      ->exec('CREATE TABLE kvp_' . $tableName . ' (id VARCHAR(12) PRIMARY KEY, value BLOB)
		                                       AS SELECT * FROM kvp_' . $this->_TableName)) {
      throw new PHPExcel_Exception($this->_DBHandle
        ->lastErrorMsg());
    }

    //	Copy the existing cell cache file
    $this->_TableName = $tableName;
  }

  //	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;
    }

    //	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
   */
  public function __construct(PHPExcel_Worksheet $parent) {
    parent::__construct($parent);
    if (is_null($this->_DBHandle)) {
      $this->_TableName = str_replace('.', '_', $this
        ->_getUniqueID());
      $_DBName = ':memory:';
      $this->_DBHandle = new SQLite3($_DBName);
      if ($this->_DBHandle === false) {
        throw new PHPExcel_Exception($this->_DBHandle
          ->lastErrorMsg());
      }
      if (!$this->_DBHandle
        ->exec('CREATE TABLE kvp_' . $this->_TableName . ' (id VARCHAR(12) PRIMARY KEY, value BLOB)')) {
        throw new PHPExcel_Exception($this->_DBHandle
          ->lastErrorMsg());
      }
    }
    $this->_selectQuery = $this->_DBHandle
      ->prepare("SELECT value FROM kvp_" . $this->_TableName . " WHERE id = :id");
    $this->_insertQuery = $this->_DBHandle
      ->prepare("INSERT OR REPLACE INTO kvp_" . $this->_TableName . " VALUES(:id,:data)");
    $this->_updateQuery = $this->_DBHandle
      ->prepare("UPDATE kvp_" . $this->_TableName . " SET id=:toId WHERE id=:fromId");
    $this->_deleteQuery = $this->_DBHandle
      ->prepare("DELETE FROM kvp_" . $this->_TableName . " WHERE id = :id");
  }

  //	function __construct()

  /**
   * Destroy this cell collection
   */
  public function __destruct() {
    if (!is_null($this->_DBHandle)) {
      $this->_DBHandle
        ->exec('DROP TABLE kvp_' . $this->_TableName);
      $this->_DBHandle
        ->close();
    }
    $this->_DBHandle = null;
  }

  //	function __destruct()

  /**
   * Identify whether the caching method is currently available
   * Some methods are dependent on the availability of certain extensions being enabled in the PHP build
   *
   * @return	boolean
   */
  public static function cacheMethodIsAvailable() {
    if (!class_exists('SQLite3', FALSE)) {
      return false;
    }
    return true;
  }

}

Members

Name	Modifiers	Type	Description
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::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::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_SQLite3::$_DBHandle	private	property	* Database handle * *
PHPExcel_CachedObjectStorage_SQLite3::$_deleteQuery	private	property	* Prepared statement for a SQLite3 delete query * *
PHPExcel_CachedObjectStorage_SQLite3::$_insertQuery	private	property	* Prepared statement for a SQLite3 insert query * *
PHPExcel_CachedObjectStorage_SQLite3::$_selectQuery	private	property	* Prepared statement for a SQLite3 select query * *
PHPExcel_CachedObjectStorage_SQLite3::$_TableName	private	property	* Database table name * *
PHPExcel_CachedObjectStorage_SQLite3::$_updateQuery	private	property	* Prepared statement for a SQLite3 update query * *
PHPExcel_CachedObjectStorage_SQLite3::addCacheData	public	function	Add or Update a cell in cache identified by coordinate address Overrides PHPExcel_CachedObjectStorage_ICache::addCacheData
PHPExcel_CachedObjectStorage_SQLite3::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 * * Overrides PHPExcel_CachedObjectStorage_CacheBase::cacheMethodIsAvailable
PHPExcel_CachedObjectStorage_SQLite3::copyCellCollection	public	function	* Clone the cell collection * * Overrides PHPExcel_CachedObjectStorage_CacheBase::copyCellCollection
PHPExcel_CachedObjectStorage_SQLite3::deleteCacheData	public	function	Delete a cell in cache identified by coordinate address Overrides PHPExcel_CachedObjectStorage_CacheBase::deleteCacheData
PHPExcel_CachedObjectStorage_SQLite3::getCacheData	public	function	Get cell at a specific coordinate Overrides PHPExcel_CachedObjectStorage_ICache::getCacheData
PHPExcel_CachedObjectStorage_SQLite3::getCellList	public	function	* Get a list of all cell addresses currently held in cache * * Overrides PHPExcel_CachedObjectStorage_CacheBase::getCellList
PHPExcel_CachedObjectStorage_SQLite3::isDataSet	public	function	* Is a value set for an indexed cell? * * Overrides PHPExcel_CachedObjectStorage_CacheBase::isDataSet
PHPExcel_CachedObjectStorage_SQLite3::moveCell	public	function	* Move a cell object from one address to another * * Overrides PHPExcel_CachedObjectStorage_CacheBase::moveCell
PHPExcel_CachedObjectStorage_SQLite3::unsetWorksheetCells	public	function	* Clear the cell collection and disconnect from our parent * *
PHPExcel_CachedObjectStorage_SQLite3::_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_SQLite3::__construct	public	function	* Initialise this new cell collection * * Overrides PHPExcel_CachedObjectStorage_CacheBase::__construct
PHPExcel_CachedObjectStorage_SQLite3::__destruct	public	function	* Destroy this cell collection

You are here

class PHPExcel_CachedObjectStorage_SQLite3 in Loft Data Grids 7.2

Hierarchy

File

Members

API Navigation