Gitee
\
addons
formmore
controller
model
validate
loginerror
controller
model
pagemore
controller
model
validate
speed
controller
app
index
behavior
controller
model
validate
org
think
cache
driver
config
driver
console
command
make
optimize
input
output
descriptor
driver
formatter
question
controller
db
builder
connector
exception
debug
exception
log
driver
model
relation
paginator
driver
process
exception
pipes
response
session
driver
template
driver
taglib
view
driver
traits
controller
model
think

\PHPExcel_CachedObjectStorage_Memory

PHPExcel_CachedObjectStorage_Memory

Copyright (c) 2006 - 2015 PHPExcel

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

Summary

Methods
Properties
Constants
__construct()
getParent()
isDataSet()
moveCell()
updateCacheData()
deleteCacheData()
getCellList()
getSortedCellList()
getHighestRowAndColumn()
getCurrentAddress()
getCurrentColumn()
getCurrentRow()
getHighestColumn()
getHighestRow()
copyCellCollection()
removeRow()
removeColumn()
cacheMethodIsAvailable()
addCacheData()
getCacheData()
unsetWorksheetCells()
No public properties found
No constants found
getUniqueID()
storeData()
$parent
$currentObject
$currentObjectID
$currentCellIsDirty
$cellCache
N/A
No private methods found
No private properties found
N/A

Properties

$currentObject

$currentObject : \PHPExcel_Cell

The currently active Cell

Type

\PHPExcel_Cell

$currentObjectID

$currentObjectID : string

Coordinate address of the currently active Cell

Type

string

$currentCellIsDirty

$currentCellIsDirty : boolean

Flag indicating whether the currently active Cell requires saving

Type

boolean

$cellCache

$cellCache : array

An array of cells or cell pointers for the worksheet cells held in this cache, and indexed by their coordinate address within the worksheet

Type

array — of mixed

Methods

__construct()

__construct(\PHPExcel_Worksheet  $parent)

Initialise this new cell collection

Parameters

\PHPExcel_Worksheet $parent

The worksheet for this cell collection

getParent()

getParent() : \PHPExcel_Worksheet

Return the parent worksheet for this cell collection

Returns

\PHPExcel_Worksheet

isDataSet()

isDataSet(string  $pCoord) : boolean

Is a value set in the current PHPExcel_CachedObjectStorage_ICache for an indexed cell?

Parameters

string $pCoord

Coordinate address of the cell to check

Returns

boolean

moveCell()

moveCell(string  $fromAddress, string  $toAddress) : boolean

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

updateCacheData()

updateCacheData(\PHPExcel_Cell  $cell) : \PHPExcel_Cell

Add or Update a cell in cache

Parameters

\PHPExcel_Cell $cell

Cell to update

Throws

\PHPExcel_Exception

Returns

\PHPExcel_Cell

deleteCacheData()

deleteCacheData(string  $pCoord)

Delete a cell in cache identified by coordinate address

Parameters

string $pCoord

Coordinate address of the cell to delete

Throws

\PHPExcel_Exception

getCellList()

getCellList() : array<mixed,string>

Get a list of all cell addresses currently held in cache

Returns

array<mixed,string>

getSortedCellList()

getSortedCellList() : array<mixed,string>

Sort the list of all cell addresses currently held in cache by row and column

Returns

array<mixed,string>

getHighestRowAndColumn()

getHighestRowAndColumn() : array

Get highest worksheet column and highest row that have cell records

Returns

array —

Highest column name and highest row number

getCurrentAddress()

getCurrentAddress() : string

Return the cell address of the currently active cell object

Returns

string

getCurrentColumn()

getCurrentColumn() : string

Return the column address of the currently active cell object

Returns

string

getCurrentRow()

getCurrentRow() : integer

Return the row address of the currently active cell object

Returns

integer

getHighestColumn()

getHighestColumn(string  $row = null) : string

Get highest worksheet column

Parameters

string $row

Return the highest column for the specified row, or the highest column of any row if no row number is passed

Returns

string —

Highest column name

getHighestRow()

getHighestRow(string  $column = null) : integer

Get highest worksheet row

Parameters

string $column

Return the highest row for the specified column, or the highest row of any column if no column letter is passed

Returns

integer —

Highest row number

copyCellCollection()

copyCellCollection(\PHPExcel_Worksheet  $parent) : void

Clone the cell collection

Parameters

\PHPExcel_Worksheet $parent

The new worksheet

removeRow()

removeRow(string  $row) : void

Remove a row, deleting all cells in that row

Parameters

string $row

Row number to remove

removeColumn()

removeColumn(string  $column) : void

Remove a column, deleting all cells in that column

Parameters

string $column

Column ID to remove

cacheMethodIsAvailable()

cacheMethodIsAvailable() : boolean

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

addCacheData()

addCacheData(string  $pCoord, \PHPExcel_Cell  $cell) : \PHPExcel_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

Throws

\PHPExcel_Exception

Returns

\PHPExcel_Cell

getCacheData()

getCacheData(string  $pCoord) : \PHPExcel_Cell

Get cell at a specific coordinate

Parameters

string $pCoord

Coordinate of the cell

Throws

\PHPExcel_Exception

Returns

\PHPExcel_Cell —

Cell that was found, or null if not found

unsetWorksheetCells()

unsetWorksheetCells()

Clear the cell collection and disconnect from our parent

getUniqueID()

getUniqueID() : string

Generate a unique ID for cache referencing

Returns

string —

Unique Reference

storeData()

storeData() : void

Dummy method callable from CacheBase, but unused by Memory cache