PHPExcel_Cell

# Class: PHPExcel_Cell Source Location: /PHPExcel/Cell.php
### Class Overview
PHPExcel_Cell #### Author(s): #### Copyright: Copyright (c) 2006 - 2010 PHPExcel (http://www.codeplex.com/PHPExcel) | ### Variables $_calculatedValue $_column $_dataType $_parent $_row $_value $_valueBinder $_xfIndex | ### Methods __construct absoluteCoordinate buildRange columnIndexFromString compareCells coordinateFromString extractAllCellReferencesInRange getCalculatedValue getColumn getCoordinate getDataType getDataValidation getHyperlink getOldCalculatedValue getParent getRow getValue getValueBinder getXfIndex hasDataValidation hasHyperlink isInRange rangeDimension rebindParent setCalculatedValue setDataType setDataValidation setHyperlink setValue setValueBinder setValueExplicit setXfIndex splitRange stringFromColumnIndex __clone
### Class Details [line 69] PHPExcel_Cell PHPExcel_Cell #### Tags:
copyright: | Copyright (c) 2006 - 2010 PHPExcel (http://www.codeplex.com/PHPExcel)
[ Top ] ### Class Variables #### static $_valueBinder = null [line 76] Value binder to use Value binder to use #### Tags:
access: | private
Type: | PHPExcel_Cell_IValueBinder
[ Top ] #### $_calculatedValue = null [line 104] Calculated value of the cell (used for caching) Calculated value of the cell (used for caching) #### Tags:
access: | private
Type: | mixed
[ Top ] #### $_column = [line 83] Column of the cell Column of the cell #### Tags:
access: | private
Type: | string
[ Top ] #### $_dataType = [line 111] Type of the cell data Type of the cell data #### Tags:
access: | private
Type: | string
[ Top ] #### $_parent = [line 118] Parent worksheet Parent worksheet #### Tags:
access: | private
Type: | PHPExcel_Worksheet
[ Top ] #### $_row = [line 90] Row of the cell Row of the cell #### Tags:
access: | private
Type: | int
[ Top ] #### $_value = [line 97] Value of the cell Value of the cell #### Tags:
access: | private
Type: | mixed
[ Top ] #### $_xfIndex = [line 125] Index to cellXf Index to cellXf #### Tags:
access: | private
Type: | int
[ Top ] ### Class Methods ### static method absoluteCoordinate [line 531]
`static string absoluteCoordinate( [string $pCoordinateString = 'A1'])`
Make string coordinate absolute Make string coordinate absolute #### Tags:
return: | Absolute coordinate
throws: | Exception
access: | public
#### Parameters:
string | $pCoordinateString |
[ Top ] ### static method buildRange [line 570]
`static string buildRange( array $pRange)`
Build range from coordinate strings Build range from coordinate strings #### Tags:
return: | String representation of $pRange
throws: | Exception
access: | public
#### Parameters:
array | $pRange | Array containg one or more arrays containing one or two coordinate strings
[ Top ] ### static method columnIndexFromString [line 626]
`static int columnIndexFromString( [string $pString = 'A'])`
Column index from string Column index from string #### Tags:
return: | Column index (base 1 !!!)
throws: | Exception
access: | public
#### Parameters:
string | $pString |
[ Top ] ### static method compareCells [line 739]
`static int compareCells( PHPExcel_Cell $a, PHPExcel_Cell $b)`
Compare 2 cells Compare 2 cells #### Tags:
return: | Result of comparison (always -1 or 1, never zero!)
access: | public
#### Parameters:
PHPExcel_Cell | $a | Cell b
PHPExcel_Cell | $b |
[ Top ] ### static method coordinateFromString [line 506]
`static array coordinateFromString( [string $pCoordinateString = 'A1'])`
Coordinate from string Coordinate from string #### Tags:
return: | Array containing column and row (indexes 0 and 1)
throws: | Exception
access: | public
#### Parameters:
string | $pCoordinateString |
[ Top ] ### static method extractAllCellReferencesInRange [line 665]
`static array extractAllCellReferencesInRange( [string $pRange = 'A1'])`
Extract all cell references in range Extract all cell references in range #### Tags:
return: | Array containing single cell references
access: | public
#### Parameters:
string | $pRange | Range (e.g. A1 or A1:A10 or A1:A10 A100:A1000)
[ Top ] ### static method getValueBinder [line 757]
`static PHPExcel_Cell_IValueBinder getValueBinder( )`
Get value binder to use Get value binder to use #### Tags:
access: | public
[ Top ] ### static method rangeDimension [line 593]
`static array rangeDimension( [string $pRange = 'A1:A1'])`
Calculate range dimension Calculate range dimension #### Tags:
return: | Range dimension (width, height)
access: | public
#### Parameters:
string | $pRange | Cell range (e.g. A1:A1)
[ Top ] ### static method setValueBinder [line 771]
`static void setValueBinder( [PHPExcel_Cell_IValueBinder $binder = null])`
Set value binder to use Set value binder to use #### Tags:
throws: | Exception
access: | public
#### Parameters:
PHPExcel_Cell_IValueBinder | $binder |
[ Top ] ### static method splitRange [line 554]
`static array splitRange( [string $pRange = 'A1:A1'])`
Split range into coordinate strings Split range into coordinate strings #### Tags:
return: | Array containg one or more arrays containing one or two coordinate strings
access: | public
#### Parameters:
string | $pRange |
[ Top ] ### static method stringFromColumnIndex [line 650]
`static string stringFromColumnIndex( [int $pColumnIndex = 0])`
String from columnindex String from columnindex #### Tags:
access: | public
#### Parameters:
int | $pColumnIndex | Column index (base 0 !!!)
[ Top ] ### constructor __construct [line 137]
`PHPExcel_Cell __construct( [string $pColumn = 'A'], [int $pRow = 1], [mixed $pValue = null], [string $pDataType = null], [ $pSheet = null])`
Create a new Cell Create a new Cell #### Tags:
throws: | Exception
access: | public
#### Parameters:
string | $pColumn |
int | $pRow |
mixed | $pValue |
string | $pDataType |
PHPExcel_Worksheet | $pSheet |
[ Top ] ### method getCalculatedValue [line 267]
`mixed getCalculatedValue( [ $resetLog = true])`
Get caluclated cell value Get caluclated cell value #### Tags:
access: | public
#### Parameters:
| $resetLog |
[ Top ] ### method getColumn [line 167]
`string getColumn( )`
Get cell coordinate column Get cell coordinate column #### Tags:
access: | public
[ Top ] ### method getCoordinate [line 187]
`string getCoordinate( )`
Get cell coordinate Get cell coordinate #### Tags:
access: | public
[ Top ] ### method getDataType [line 329]
`string getDataType( )`
Get cell data type Get cell data type #### Tags:
access: | public
[ Top ] ### method getDataValidation [line 365]
`PHPExcel_Cell_DataValidation getDataValidation( )`
Get Data validation Get Data validation #### Tags:
access: | public
[ Top ] ### method getHyperlink [line 412]
`PHPExcel_Cell_Hyperlink getHyperlink( )`
Get Hyperlink Get Hyperlink #### Tags:
throws: | Exception
access: | public
[ Top ] ### method getOldCalculatedValue [line 319]
`mixed getOldCalculatedValue( )`
Get old calculated value (cached) Get old calculated value (cached) #### Tags:
access: | public
[ Top ] ### method getParent [line 444]
`PHPExcel_Worksheet getParent( )`
Get parent Get parent #### Tags:
access: | public
[ Top ] ### method getRow [line 177]
`int getRow( )`
Get cell coordinate row Get cell coordinate row #### Tags:
access: | public
[ Top ] ### method getValue [line 197]
`mixed getValue( )`
Get cell value Get cell value #### Tags:
access: | public
[ Top ] ### method getXfIndex [line 798]
`int getXfIndex( )`
Get index to cellXf Get index to cellXf #### Tags:
access: | public
[ Top ] ### method hasDataValidation [line 351]
`boolean hasDataValidation( )`
Has Data validation? Has Data validation? #### Tags:
access: | public
[ Top ] ### method hasHyperlink [line 397]
`boolean hasHyperlink( )`
Has Hyperlink Has Hyperlink #### Tags:
access: | public
[ Top ] ### method isInRange [line 465]
`boolean isInRange( [string $pRange = 'A1:A1'])`
Is cell in a specific range? Is cell in a specific range? #### Tags:
access: | public
#### Parameters:
string | $pRange | Cell range (e.g. A1:A1)
[ Top ] ### method rebindParent [line 454]
`PHPExcel_Cell rebindParent( $parent)`
Re-bind parent Re-bind parent #### Tags:
access: | public
#### Parameters:
PHPExcel_Worksheet | $parent |
[ Top ] ### method setCalculatedValue [line 306]
`PHPExcel_Cell setCalculatedValue( [mixed $pValue = null])`
Set calculated value (used for caching) Set calculated value (used for caching) #### Tags:
access: | public
#### Parameters:
mixed | $pValue | Value
[ Top ] ### method setDataType [line 340]
`PHPExcel_Cell setDataType( [string $pDataType = PHPExcel_Cell_DataType::TYPE_STRING])`
Set cell data type Set cell data type #### Tags:
access: | public
#### Parameters:
string | $pDataType |
[ Top ] ### method setDataValidation [line 382]
`PHPExcel_Cell setDataValidation( [PHPExcel_Cell_DataValidation $pDataValidation = null])`
Set Data validation Set Data validation #### Tags:
throws: | Exception
access: | public
#### Parameters:
PHPExcel_Cell_DataValidation | $pDataValidation |
[ Top ] ### method setHyperlink [line 429]
`PHPExcel_Cell setHyperlink( [PHPExcel_Cell_Hyperlink $pHyperlink = null])`
Set Hyperlink Set Hyperlink #### Tags:
throws: | Exception
access: | public
#### Parameters:
PHPExcel_Cell_Hyperlink | $pHyperlink |
[ Top ] ### method setValue [line 210]
`PHPExcel_Cell setValue( [mixed $pValue = null])`
Set cell value This clears the cell formula. Set cell value This clears the cell formula. #### Tags:
access: | public
#### Parameters:
mixed | $pValue | Value
[ Top ] ### method setValueExplicit [line 226]
`PHPExcel_Cell setValueExplicit( [mixed $pValue = null], [string $pDataType = PHPExcel_Cell_DataType::TYPE_STRING])`
Set cell value (with explicit data type given) Set cell value (with explicit data type given) #### Tags:
throws: | Exception
access: | public
#### Parameters:
mixed | $pValue | Value
string | $pDataType | Explicit data type
[ Top ] ### method setXfIndex [line 809]
`PHPExcel_Cell setXfIndex( [int $pValue = 0])`
Set index to cellXf Set index to cellXf #### Tags:
access: | public
#### Parameters:
int | $pValue |
[ Top ] ### method __clone [line 782]
`void __clone( )`
Implement PHP __clone to create a deep clone, not just a shallow copy. Implement PHP __clone to create a deep clone, not just a shallow copy. #### Tags:
access: | public
[ Top ] Documentation generated on Mon, 11 Jan 2010 08:07:07 +0100 by phpDocumentor 1.4.1