PHPExcel_Cell
[ class tree: PHPExcel_Cell ] [ index: PHPExcel_Cell ] [ all elements ]

Class: PHPExcel_Cell

Source Location: /PHPExcel/Cell.php

Class Overview


PHPExcel_Cell


Author(s):

Copyright:

  • Copyright (c) 2006 - 2009 PHPExcel (http://www.codeplex.com/PHPExcel)

Variables

Methods



Class Details

[line 52]
PHPExcel_Cell

PHPExcel_Cell




Tags:

copyright:  Copyright (c) 2006 - 2009 PHPExcel (http://www.codeplex.com/PHPExcel)


[ Top ]


Class Variables

$_column =

[line 59]

Column of the cell

Column of the cell




Tags:

access:  private

Type:   string


[ Top ]

$_dataType =

[line 80]

Type of the cell data

Type of the cell data




Tags:

access:  private

Type:   string


[ Top ]

$_dataValidation =

[line 87]

Data validation

Data validation




Tags:

access:  private



[ Top ]

$_hyperlink =

[line 94]

Hyperlink

Hyperlink




Tags:

access:  private



[ Top ]

$_parent =

[line 101]

Parent worksheet

Parent worksheet




Tags:

access:  private

Type:   PHPExcel_Worksheet


[ Top ]

$_row =

[line 66]

Row of the cell

Row of the cell




Tags:

access:  private

Type:   int


[ Top ]

$_value =

[line 73]

Value of the cell

Value of the cell




Tags:

access:  private

Type:   mixed


[ Top ]



Class Methods


static method absoluteCoordinate [line 405]

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 columnIndexFromString [line 472]

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 570]

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 375]

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 511]

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 rangeDimension [line 439]

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 splitRange [line 428]

static array splitRange( [string $pRange = 'A1:A1'])

Split range into coordinate strings

Split range into coordinate strings




Tags:

return:  Array containg two coordinate strings
access:  public


Parameters:

string   $pRange  

[ Top ]

static method stringFromColumnIndex [line 496]

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 113]

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 207]

mixed getCalculatedValue( )

Get caluclated cell value

Get caluclated cell value




Tags:

access:  public


[ Top ]

method getColumn [line 138]

string getColumn( )

Get cell coordinate column

Get cell coordinate column




Tags:

access:  public


[ Top ]

method getCoordinate [line 158]

string getCoordinate( )

Get cell coordinate

Get cell coordinate




Tags:

access:  public


[ Top ]

method getDataType [line 223]

string getDataType( )

Get cell data type

Get cell data type




Tags:

access:  public


[ Top ]

method getDataValidation [line 253]

PHPExcel_Cell_DataValidation getDataValidation( )

Get Data validation

Get Data validation




Tags:

access:  public


[ Top ]

method getHyperlink [line 289]

PHPExcel_Cell_Hyperlink getHyperlink( )

Get Hyperlink

Get Hyperlink




Tags:

access:  public


[ Top ]

method getParent [line 315]

PHPExcel_Worksheet getParent( )

Get parent

Get parent




Tags:

access:  public


[ Top ]

method getRow [line 148]

int getRow( )

Get cell coordinate row

Get cell coordinate row




Tags:

access:  public


[ Top ]

method getValue [line 168]

mixed getValue( )

Get cell value

Get cell value




Tags:

access:  public


[ Top ]

method hasDataValidation [line 243]

boolean hasDataValidation( )

Has Data validation?

Has Data validation?




Tags:

access:  public


[ Top ]

method hasHyperlink [line 279]

boolean hasHyperlink( )

Has Hyperlink

Has Hyperlink




Tags:

access:  public


[ Top ]

method isInRange [line 334]

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 324]

void rebindParent( $parent)

Re-bind parent

Re-bind parent




Tags:

access:  public


Parameters:

PHPExcel_Worksheet   $parent  

[ Top ]

method setDataType [line 233]

void 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 268]

void 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 304]

void setHyperlink( [PHPExcel_Cell_Hyperlink $pHyperlink = null])

Set Hyperlink

Set Hyperlink




Tags:

throws:  Exception
access:  public


Parameters:

PHPExcel_Cell_Hyperlink   $pHyperlink  

[ Top ]

method setValue [line 181]

void setValue( [mixed $pValue = null], [bool $pUpdateDataType = true])

Set cell value This clears the cell formula.

Set cell value This clears the cell formula.




Tags:

access:  public


Parameters:

mixed   $pValue   Value
bool   $pUpdateDataType   Update the data type?

[ Top ]

method setValueExplicit [line 196]

void 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:

access:  public


Parameters:

mixed   $pValue   Value
string   $pDataType   Explicit data type

[ Top ]

method __clone [line 586]

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, 05 Jan 2009 20:36:39 +0100 by phpDocumentor 1.4.1