Overview

Packages

  • JAMA
  • None
  • PHP
  • PHPExcel
    • CachedObjectStorage
    • Calculation
    • Cell
    • Chart
      • Renderer
    • Reader
      • Excel2007
      • Excel5
    • RichText
    • Settings
    • Shared
      • Escher
      • OLE
      • Trend
      • ZipArchive
    • Style
    • Worksheet
      • Drawing
    • Writer
      • 2007
      • CSV
      • Excel2007
      • Excel5
      • HTML
      • PDF

Classes

  • PHPExcel_CachedObjectStorage_APC
  • PHPExcel_CachedObjectStorage_CacheBase
  • PHPExcel_CachedObjectStorage_DiscISAM
  • PHPExcel_CachedObjectStorage_Igbinary
  • PHPExcel_CachedObjectStorage_Memcache
  • PHPExcel_CachedObjectStorage_Memory
  • PHPExcel_CachedObjectStorage_MemoryGZip
  • PHPExcel_CachedObjectStorage_MemorySerialized
  • PHPExcel_CachedObjectStorage_PHPTemp
  • PHPExcel_CachedObjectStorage_SQLite
  • PHPExcel_CachedObjectStorage_SQLite3
  • PHPExcel_CachedObjectStorage_Wincache
  • PHPExcel_CachedObjectStorageFactory

Interfaces

  • PHPExcel_CachedObjectStorage_ICache
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo
  • Download

Class PHPExcel_CachedObjectStorage_CacheBase

PHPExcel_CachedObjectStorage_CacheBase

Direct known subclasses

PHPExcel_CachedObjectStorage_APC, PHPExcel_CachedObjectStorage_DiscISAM, PHPExcel_CachedObjectStorage_Wincache, PHPExcel_CachedObjectStorage_Igbinary, PHPExcel_CachedObjectStorage_Memcache, PHPExcel_CachedObjectStorage_Memory, PHPExcel_CachedObjectStorage_MemoryGZip, PHPExcel_CachedObjectStorage_MemorySerialized, PHPExcel_CachedObjectStorage_PHPTemp, PHPExcel_CachedObjectStorage_SQLite, PHPExcel_CachedObjectStorage_SQLite3
Abstract
Package: PHPExcel\CachedObjectStorage
Category: PHPExcel
Copyright: Copyright (c) 2006 - 2014 PHPExcel (http://www.codeplex.com/PHPExcel)
License: LGPL
Located at controlador/include/phpexcel/PHPExcel/CachedObjectStorage/CacheBase.php
Methods summary
public
# __construct( PHPExcel_Worksheet $parent )

Initialise this new cell collection

Initialise this new cell collection

Parameters

$parent
The worksheet for this cell collection
public PHPExcel_Worksheet
# getParent( )

Return the parent worksheet for this cell collection

Return the parent worksheet for this cell collection

Returns

PHPExcel_Worksheet
public boolean
# isDataSet( string $pCoord )

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

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

Parameters

$pCoord
Coordinate address of the cell to check

Returns

boolean
public boolean
# moveCell( string $fromAddress, string $toAddress )

Move a cell object from one address to another

Move a cell object from one address to another

Parameters

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

Returns

boolean
public
# updateCacheData( PHPExcel_Cell $cell )

Add or Update a cell in cache

Add or Update a cell in cache

Parameters

$cell
Cell to update

Throws

PHPExcel_Exception
public
# deleteCacheData( string $pCoord )

Delete a cell in cache identified by coordinate address

Delete a cell in cache identified by coordinate address

Parameters

$pCoord
Coordinate address of the cell to delete

Throws

PHPExcel_Exception
public array
# getCellList( )

Get a list of all cell addresses currently held in cache

Get a list of all cell addresses currently held in cache

Returns

array
of string
public
# getSortedCellList( )

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

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

public array
# getHighestRowAndColumn( )

Get highest worksheet column and highest row that have cell records

Get highest worksheet column and highest row that have cell records

Returns

array
Highest column name and highest row number
public string
# getCurrentAddress( )

Return the cell address of the currently active cell object

Return the cell address of the currently active cell object

Returns

string
public string
# getCurrentColumn( )

Return the column address of the currently active cell object

Return the column address of the currently active cell object

Returns

string
public string
# getCurrentRow( )

Return the row address of the currently active cell object

Return the row address of the currently active cell object

Returns

string
public string
# getHighestColumn( string $row = null )

Get highest worksheet column

Get highest worksheet column

Parameters

$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
public integer
# getHighestRow( string $column = null )

Get highest worksheet row

Get highest worksheet row

Parameters

$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
protected string
# _getUniqueID( )

Generate a unique ID for cache referencing

Generate a unique ID for cache referencing

Returns

string
Unique Reference
public
# copyCellCollection( PHPExcel_Worksheet $parent )

Clone the cell collection

Clone the cell collection

Parameters

$parent
The new worksheet
public static boolean
# 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

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
Properties summary
protected PHPExcel_Worksheet $_parent

Parent worksheet

Parent worksheet

#
protected PHPExcel_Cell $_currentObject

The currently active Cell

The currently active Cell

# null
protected string $_currentObjectID

Coordinate address of the currently active Cell

Coordinate address of the currently active Cell

# null
protected boolean $_currentCellIsDirty

Flag indicating whether the currently active Cell requires saving

Flag indicating whether the currently active Cell requires saving

# true
protected array $_cellCache

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

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

# array()
Autene API documentation generated by ApiGen