BlueSpice MediaWiki REL1_27
 All Classes Namespaces Files Functions Variables Groups Pages
PHPExcel_Cell Class Reference

Public Member Functions

 notifyCacheController ()
 
 detach ()
 
 attach (PHPExcel_CachedObjectStorage_CacheBase $parent)
 
 __construct ($pValue=NULL, $pDataType=NULL, PHPExcel_Worksheet $pSheet=NULL)
 
 getColumn ()
 
 getRow ()
 
 getCoordinate ()
 
 getValue ()
 
 getFormattedValue ()
 
 setValue ($pValue=NULL)
 
 setValueExplicit ($pValue=NULL, $pDataType=PHPExcel_Cell_DataType::TYPE_STRING)
 
 getCalculatedValue ($resetLog=TRUE)
 
 setCalculatedValue ($pValue=NULL)
 
 getOldCalculatedValue ()
 
 getDataType ()
 
 setDataType ($pDataType=PHPExcel_Cell_DataType::TYPE_STRING)
 
 isFormula ()
 
 hasDataValidation ()
 
 getDataValidation ()
 
 setDataValidation (PHPExcel_Cell_DataValidation $pDataValidation=NULL)
 
 hasHyperlink ()
 
 getHyperlink ()
 
 setHyperlink (PHPExcel_Cell_Hyperlink $pHyperlink=NULL)
 
 getParent ()
 
 getWorksheet ()
 
 getStyle ()
 
 rebindParent (PHPExcel_Worksheet $parent)
 
 isInRange ($pRange= 'A1:A1')
 
 __clone ()
 
 getXfIndex ()
 
 setXfIndex ($pValue=0)
 
 setFormulaAttributes ($pAttributes)
 
 getFormulaAttributes ()
 
 __toString ()
 

Static Public Member Functions

static coordinateFromString ($pCoordinateString= 'A1')
 
static absoluteReference ($pCoordinateString= 'A1')
 
static absoluteCoordinate ($pCoordinateString= 'A1')
 
static splitRange ($pRange= 'A1:A1')
 
static buildRange ($pRange)
 
static rangeBoundaries ($pRange= 'A1:A1')
 
static rangeDimension ($pRange= 'A1:A1')
 
static getRangeBoundaries ($pRange= 'A1:A1')
 
static columnIndexFromString ($pString= 'A')
 
static stringFromColumnIndex ($pColumnIndex=0)
 
static extractAllCellReferencesInRange ($pRange= 'A1')
 
static compareCells (PHPExcel_Cell $a, PHPExcel_Cell $b)
 
static getValueBinder ()
 
static setValueBinder (PHPExcel_Cell_IValueBinder $binder=NULL)
 

Public Attributes

const DEFAULT_RANGE = 'A1:A1'
 

Constructor & Destructor Documentation

PHPExcel_Cell::__construct (   $pValue = NULL,
  $pDataType = NULL,
PHPExcel_Worksheet  $pSheet = NULL 
)

Create a new Cell

Parameters
mixed$pValue
string$pDataType
PHPExcel_Worksheet$pSheet
Exceptions
PHPExcel_Exception

Member Function Documentation

PHPExcel_Cell::__clone ( )

Implement PHP __clone to create a deep clone, not just a shallow copy.

PHPExcel_Cell::__toString ( )

Convert to string

Returns
string
static PHPExcel_Cell::absoluteCoordinate (   $pCoordinateString = 'A1')
static

Make string coordinate absolute

Parameters
string$pCoordinateStringe.g. 'A1'
Returns
string Absolute coordinate e.g. '$A$1'
Exceptions
PHPExcel_Exception
static PHPExcel_Cell::absoluteReference (   $pCoordinateString = 'A1')
static

Make string row, column or cell coordinate absolute

Parameters
string$pCoordinateStringe.g. 'A' or '1' or 'A1' Note that this value can be a row or column reference as well as a cell reference
Returns
string Absolute coordinate e.g. '$A' or '$1' or '$A$1'
Exceptions
PHPExcel_Exception
static PHPExcel_Cell::buildRange (   $pRange)
static

Build range from coordinate strings

Parameters
array$pRangeArray containg one or more arrays containing one or two coordinate strings
Returns
string String representation of $pRange
Exceptions
PHPExcel_Exception
static PHPExcel_Cell::columnIndexFromString (   $pString = 'A')
static

Column index from string

Parameters
string$pString
Returns
int Column index (base 1 !!!)
static PHPExcel_Cell::compareCells ( PHPExcel_Cell  $a,
PHPExcel_Cell  $b 
)
static

Compare 2 cells

Parameters
PHPExcel_Cell$aCell a
PHPExcel_Cell$bCell b
Returns
int Result of comparison (always -1 or 1, never zero!)
static PHPExcel_Cell::coordinateFromString (   $pCoordinateString = 'A1')
static

Coordinate from string

Parameters
string$pCoordinateString
Returns
array Array containing column and row (indexes 0 and 1)
Exceptions
PHPExcel_Exception
static PHPExcel_Cell::extractAllCellReferencesInRange (   $pRange = 'A1')
static

Extract all cell references in range

Parameters
string$pRangeRange (e.g. A1 or A1:C10 or A1:E10 A20:E25)
Returns
array Array containing single cell references
PHPExcel_Cell::getCalculatedValue (   $resetLog = TRUE)

Get calculated cell value

Deprecated:
Since version 1.7.8 for planned changes to cell for array formula handling
Parameters
boolean$resetLogWhether the calculation engine logger should be reset or not
Returns
mixed
Exceptions
PHPExcel_Exception
PHPExcel_Cell::getColumn ( )

Get cell coordinate column

Returns
string
PHPExcel_Cell::getCoordinate ( )

Get cell coordinate

Returns
string
PHPExcel_Cell::getDataType ( )

Get cell data type

Returns
string
PHPExcel_Cell::getDataValidation ( )

Get Data validation rules

Returns
PHPExcel_Cell_DataValidation
Exceptions
PHPExcel_Exception
PHPExcel_Cell::getFormattedValue ( )

Get cell value with formatting

Returns
string
PHPExcel_Cell::getFormulaAttributes ( )
Deprecated:
Since version 1.7.8 for planned changes to cell for array formula handling
PHPExcel_Cell::getHyperlink ( )

Get Hyperlink

Returns
PHPExcel_Cell_Hyperlink
Exceptions
PHPExcel_Exception
PHPExcel_Cell::getOldCalculatedValue ( )

Get old calculated value (cached) This returns the value last calculated by MS Excel or whichever spreadsheet program was used to create the original spreadsheet file. Note that this value is not guaranteed to refelect the actual calculated value because it is possible that auto-calculation was disabled in the original spreadsheet, and underlying data values used by the formula have changed since it was last calculated.

Returns
mixed
PHPExcel_Cell::getParent ( )

Get parent worksheet

Returns
PHPExcel_CachedObjectStorage_CacheBase
static PHPExcel_Cell::getRangeBoundaries (   $pRange = 'A1:A1')
static

Calculate range boundaries

Parameters
string$pRangeCell range (e.g. A1:A1)
Returns
array Range coordinates array(Start Cell, End Cell) where Start Cell and End Cell are arrays (Column ID, Row Number)
PHPExcel_Cell::getRow ( )

Get cell coordinate row

Returns
int
PHPExcel_Cell::getStyle ( )

Get cell style

Returns
PHPExcel_Style
PHPExcel_Cell::getValue ( )

Get cell value

Returns
mixed
static PHPExcel_Cell::getValueBinder ( )
static

Get value binder to use

Returns
PHPExcel_Cell_IValueBinder
PHPExcel_Cell::getWorksheet ( )

Get parent worksheet

Returns
PHPExcel_Worksheet
PHPExcel_Cell::getXfIndex ( )

Get index to cellXf

Returns
int
PHPExcel_Cell::hasDataValidation ( )

Does this cell contain Data validation rules?

Returns
boolean
Exceptions
PHPExcel_Exception
PHPExcel_Cell::hasHyperlink ( )

Does this cell contain a Hyperlink?

Returns
boolean
Exceptions
PHPExcel_Exception
PHPExcel_Cell::isFormula ( )

Identify if the cell contains a formula

Returns
boolean
PHPExcel_Cell::isInRange (   $pRange = 'A1:A1')

Is cell in a specific range?

Parameters
string$pRangeCell range (e.g. A1:A1)
Returns
boolean
PHPExcel_Cell::notifyCacheController ( )

Send notification to the cache controller

Returns
void
static PHPExcel_Cell::rangeBoundaries (   $pRange = 'A1:A1')
static

Calculate range boundaries

Parameters
string$pRangeCell range (e.g. A1:A1)
Returns
array Range coordinates array(Start Cell, End Cell) where Start Cell and End Cell are arrays (Column Number, Row Number)
static PHPExcel_Cell::rangeDimension (   $pRange = 'A1:A1')
static

Calculate range dimension

Parameters
string$pRangeCell range (e.g. A1:A1)
Returns
array Range dimension (width, height)
PHPExcel_Cell::rebindParent ( PHPExcel_Worksheet  $parent)

Re-bind parent

Parameters
PHPExcel_Worksheet$parent
Returns
PHPExcel_Cell
PHPExcel_Cell::setCalculatedValue (   $pValue = NULL)

Set old calculated value (cached)

Parameters
mixed$pValueValue
Returns
PHPExcel_Cell
PHPExcel_Cell::setDataType (   $pDataType = PHPExcel_Cell_DataType::TYPE_STRING)

Set cell data type

Parameters
string$pDataType
Returns
PHPExcel_Cell
PHPExcel_Cell::setDataValidation ( PHPExcel_Cell_DataValidation  $pDataValidation = NULL)

Set Data validation rules

Parameters
PHPExcel_Cell_DataValidation$pDataValidation
Returns
PHPExcel_Cell
Exceptions
PHPExcel_Exception
PHPExcel_Cell::setFormulaAttributes (   $pAttributes)
Deprecated:
Since version 1.7.8 for planned changes to cell for array formula handling
PHPExcel_Cell::setHyperlink ( PHPExcel_Cell_Hyperlink  $pHyperlink = NULL)

Set Hyperlink

Parameters
PHPExcel_Cell_Hyperlink$pHyperlink
Returns
PHPExcel_Cell
Exceptions
PHPExcel_Exception
PHPExcel_Cell::setValue (   $pValue = NULL)

Set cell value

Sets the value for a cell, automatically determining the datatype using the value binder

Parameters
mixed$pValueValue
Returns
PHPExcel_Cell
Exceptions
PHPExcel_Exception
static PHPExcel_Cell::setValueBinder ( PHPExcel_Cell_IValueBinder  $binder = NULL)
static

Set value binder to use

Parameters
PHPExcel_Cell_IValueBinder$binder
Exceptions
PHPExcel_Exception
PHPExcel_Cell::setValueExplicit (   $pValue = NULL,
  $pDataType = PHPExcel_Cell_DataType::TYPE_STRING 
)

Set the value for a cell, with the explicit data type passed to the method (bypassing any use of the value binder)

Parameters
mixed$pValueValue
string$pDataTypeExplicit data type
Returns
PHPExcel_Cell
Exceptions
PHPExcel_Exception
PHPExcel_Cell::setXfIndex (   $pValue = 0)

Set index to cellXf

Parameters
int$pValue
Returns
PHPExcel_Cell
static PHPExcel_Cell::splitRange (   $pRange = 'A1:A1')
static

Split range into coordinate strings

Parameters
string$pRangee.g. 'B4:D9' or 'B4:D9,H2:O11' or 'B4'
Returns
array Array containg one or more arrays containing one or two coordinate strings e.g. array('B4','D9') or array(array('B4','D9'),array('H2','O11')) or array('B4')
static PHPExcel_Cell::stringFromColumnIndex (   $pColumnIndex = 0)
static

String from columnindex

Parameters
int$pColumnIndexColumn index (base 0 !!!)
Returns
string

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