Inheritance diagram for PHPExcel_CachedObjectStorage_SQLite:

Collaboration diagram for PHPExcel_CachedObjectStorage_SQLite:

Public Member Functions
	addCacheData ($pCoord, PHPExcel_Cell $cell)
	Add or Update a cell in cache identified by coordinate address. More...

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

	isDataSet ($pCoord)
	Is a value set for an indexed cell? More...

	deleteCacheData ($pCoord)
	Delete a cell in cache identified by coordinate address. More...

	moveCell ($fromAddress, $toAddress)
	Move a cell object from one address to another. More...

	getCellList ()
	Get a list of all cell addresses currently held in cache. 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)
	Initialise this new cell collection. 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
	$_TableName = null

	$_DBHandle = 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 SQLite.php.

Constructor & Destructor Documentation

◆ __construct()

PHPExcel_CachedObjectStorage_SQLite::__construct ( PHPExcel_Worksheet $parent )

Initialise this new cell collection.

Parameters

PHPExcel_Worksheet $parent The worksheet for this cell collection

Definition at line 266 of file SQLite.php.

References PHPExcel_CachedObjectStorage_CacheBase\_getUniqueID().

                                                                 {
                 parent::__construct($parent);
                 if (is_null($this->_DBHandle)) {
                         $this->_TableName = str_replace('.','_',$this->_getUniqueID());
                         $_DBName = ':memory:';
 
                         $this->_DBHandle = new SQLiteDatabase($_DBName);
                         if ($this->_DBHandle === false)
                                 throw new PHPExcel_Exception(sqlite_error_string($this->_DBHandle->lastError()));
                         if (!$this->_DBHandle->queryExec('CREATE TABLE kvp_'.$this->_TableName.' (id VARCHAR(12) PRIMARY KEY, value BLOB)'))
                                 throw new PHPExcel_Exception(sqlite_error_string($this->_DBHandle->lastError()));
                 }
         }       //      function __construct()

Here is the call graph for this function:

◆ __destruct()

PHPExcel_CachedObjectStorage_SQLite::__destruct ( )

Destroy this cell collection.

Definition at line 284 of file SQLite.php.

Referenced by unsetWorksheetCells().

                                      {
                 if (!is_null($this->_DBHandle)) {
                         $this->_DBHandle->queryExec('DROP TABLE kvp_'.$this->_TableName);
                 }
                 $this->_DBHandle = null;
         }       //      function __destruct()

Here is the caller graph for this function:

Member Function Documentation

◆ _storeData()

PHPExcel_CachedObjectStorage_SQLite::_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 59 of file SQLite.php.

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

                                         {
                 if ($this->_currentCellIsDirty && !empty($this->_currentObjectID)) {
                         $this->_currentObject->detach();
 
                         if (!$this->_DBHandle->queryExec("INSERT OR REPLACE INTO kvp_".$this->_TableName." VALUES('".$this->_currentObjectID."','".sqlite_escape_string(serialize($this->_currentObject))."')"))
                                 throw new PHPExcel_Exception(sqlite_error_string($this->_DBHandle->lastError()));
                         $this->_currentCellIsDirty = false;
                 }
                 $this->_currentObjectID = $this->_currentObject = null;
         }       //      function _storeData()

Here is the caller graph for this function:

◆ addCacheData()

PHPExcel_CachedObjectStorage_SQLite::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 79 of file SQLite.php.

References _storeData().

                                                                    {
                 if (($pCoord !== $this->_currentObjectID) && ($this->_currentObjectID !== null)) {
                         $this->_storeData();
                 }
 
                 $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_SQLite::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 298 of file SQLite.php.

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

◆ copyCellCollection()

PHPExcel_CachedObjectStorage_SQLite::copyCellCollection ( PHPExcel_Worksheet $parent )

Clone the cell collection.

Parameters

PHPExcel_Worksheet $parent The new worksheet

Returns: void

Implements PHPExcel_CachedObjectStorage_ICache.

Definition at line 228 of file SQLite.php.

References PHPExcel_CachedObjectStorage_CacheBase\$_currentCellIsDirty, PHPExcel_CachedObjectStorage_CacheBase\_getUniqueID(), and _storeData().

                                                                        {
                 $this->_currentCellIsDirty;
         $this->_storeData();
 
                 //      Get a new id for the new table name
                 $tableName = str_replace('.','_',$this->_getUniqueID());
                 if (!$this->_DBHandle->queryExec('CREATE TABLE kvp_'.$tableName.' (id VARCHAR(12) PRIMARY KEY, value BLOB)
                                                                                                         AS SELECT * FROM kvp_'.$this->_TableName))
                         throw new PHPExcel_Exception(sqlite_error_string($this->_DBHandle->lastError()));
 
                 //      Copy the existing cell cache file
                 $this->_TableName = $tableName;
         }       //      function copyCellCollection()

Here is the call graph for this function:

◆ deleteCacheData()

PHPExcel_CachedObjectStorage_SQLite::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 157 of file SQLite.php.

References $query.

                                                  {
                 if ($pCoord === $this->_currentObjectID) {
                         $this->_currentObject->detach();
                         $this->_currentObjectID = $this->_currentObject = null;
                 }
 
                 //      Check if the requested entry exists in the cache
                 $query = "DELETE FROM kvp_".$this->_TableName." WHERE id='".$pCoord."'";
                 if (!$this->_DBHandle->queryExec($query))
                         throw new PHPExcel_Exception(sqlite_error_string($this->_DBHandle->lastError()));
 
                 $this->_currentCellIsDirty = false;
         }       //      function deleteCacheData()

◆ getCacheData()

PHPExcel_CachedObjectStorage_SQLite::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 99 of file SQLite.php.

References PHPExcel_CachedObjectStorage_CacheBase\$_currentObject, $query, and _storeData().

                                               {
                 if ($pCoord === $this->_currentObjectID) {
                         return $this->_currentObject;
                 }
                 $this->_storeData();
 
                 $query = "SELECT value FROM kvp_".$this->_TableName." WHERE id='".$pCoord."'";
                 $cellResultSet = $this->_DBHandle->query($query,SQLITE_ASSOC);
                 if ($cellResultSet === false) {
                         throw new PHPExcel_Exception(sqlite_error_string($this->_DBHandle->lastError()));
                 } elseif ($cellResultSet->numRows() == 0) {
                         //      Return null if requested entry doesn't exist in cache
                         return null;
                 }
 
                 //      Set current entry to the requested entry
                 $this->_currentObjectID = $pCoord;
 
                 $cellResult = $cellResultSet->fetchSingle();
                 $this->_currentObject = unserialize($cellResult);
         //    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_SQLite::getCellList ( )

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

Returns: string[]

Implements PHPExcel_CachedObjectStorage_ICache.

Definition at line 203 of file SQLite.php.

References $query, $row, _storeData(), and array.

                                       {
                 if ($this->_currentObjectID !== null) {
                         $this->_storeData();
                 }
 
                 $query = "SELECT id FROM kvp_".$this->_TableName;
                 $cellIdsResult = $this->_DBHandle->unbufferedQuery($query,SQLITE_ASSOC);
                 if ($cellIdsResult === false)
                         throw new PHPExcel_Exception(sqlite_error_string($this->_DBHandle->lastError()));
 
                 $cellKeys = array();
                 foreach($cellIdsResult as $row) {
                         $cellKeys[] = $row['id'];
                 }
 
                 return $cellKeys;
         }       //      function getCellList()

Here is the call graph for this function:

◆ isDataSet()

PHPExcel_CachedObjectStorage_SQLite::isDataSet ( $pCoord )

Is a value set for an indexed cell?

Parameters

string $pCoord Coordinate address of the cell to check

Returns: boolean

Implements PHPExcel_CachedObjectStorage_ICache.

Definition at line 133 of file SQLite.php.

References $query.

                                            {
                 if ($pCoord === $this->_currentObjectID) {
                         return true;
                 }
 
                 //      Check if the requested entry exists in the cache
                 $query = "SELECT id FROM kvp_".$this->_TableName." WHERE id='".$pCoord."'";
                 $cellResultSet = $this->_DBHandle->query($query,SQLITE_ASSOC);
                 if ($cellResultSet === false) {
                         throw new PHPExcel_Exception(sqlite_error_string($this->_DBHandle->lastError()));
                 } elseif ($cellResultSet->numRows() == 0) {
                         //      Return null if requested entry doesn't exist in cache
                         return false;
                 }
                 return true;
         }       //      function isDataSet()

◆ moveCell()

PHPExcel_CachedObjectStorage_SQLite::moveCell	(	$fromAddress,
		$toAddress
	)

Move a cell object from one address to another.

Parameters

string	$fromAddress	Current address of the cell to move
string	$toAddress	Destination address of the cell to move

Returns: boolean

Definition at line 179 of file SQLite.php.

References $query, $result, and $toAddress.

                                                            {
                 if ($fromAddress === $this->_currentObjectID) {
                         $this->_currentObjectID = $toAddress;
                 }
 
                 $query = "DELETE FROM kvp_".$this->_TableName." WHERE id='".$toAddress."'";
                 $result = $this->_DBHandle->exec($query);
                 if ($result === false)
                         throw new PHPExcel_Exception($this->_DBHandle->lastErrorMsg());
 
                 $query = "UPDATE kvp_".$this->_TableName." SET id='".$toAddress."' WHERE id='".$fromAddress."'";
                 $result = $this->_DBHandle->exec($query);
                 if ($result === false)
                         throw new PHPExcel_Exception($this->_DBHandle->lastErrorMsg());
 
                 return TRUE;
         }       //      function moveCell()

◆ unsetWorksheetCells()

PHPExcel_CachedObjectStorage_SQLite::unsetWorksheetCells ( )

Clear the cell collection and disconnect from our parent.

Returns: void

Definition at line 248 of file SQLite.php.

References __destruct().

                                               {
                 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()

Here is the call graph for this function:

Field Documentation

◆ $_DBHandle

PHPExcel_CachedObjectStorage_SQLite::$_DBHandle = null

private

Definition at line 50 of file SQLite.php.

◆ $_TableName

PHPExcel_CachedObjectStorage_SQLite::$_TableName = null

private

Definition at line 43 of file SQLite.php.

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

libs/composer/vendor/phpoffice/phpexcel/Classes/PHPExcel/CachedObjectStorage/SQLite.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()

◆ getCacheData()

◆ getCellList()

◆ isDataSet()

◆ moveCell()

◆ unsetWorksheetCells()

Field Documentation

◆ $_DBHandle

◆ $_TableName