[ Index ]

PHP Cross Reference of Unnamed Project

title

Body

[close]

/lib/phpexcel/PHPExcel/ -> Cell.php (summary)

(no description)

File Size: 1032 lines (34 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

PHPExcel_Cell:: (51 methods):
  notifyCacheController()
  detach()
  attach()
  __construct()
  getColumn()
  getRow()
  getCoordinate()
  getValue()
  getFormattedValue()
  setValue()
  setValueExplicit()
  getCalculatedValue()
  setCalculatedValue()
  getOldCalculatedValue()
  getDataType()
  setDataType()
  isFormula()
  hasDataValidation()
  getDataValidation()
  setDataValidation()
  hasHyperlink()
  getHyperlink()
  setHyperlink()
  getParent()
  getWorksheet()
  isInMergeRange()
  isMergeRangeValueCell()
  getMergeRange()
  getStyle()
  rebindParent()
  isInRange()
  coordinateFromString()
  absoluteReference()
  absoluteCoordinate()
  splitRange()
  buildRange()
  rangeBoundaries()
  rangeDimension()
  getRangeBoundaries()
  columnIndexFromString()
  stringFromColumnIndex()
  extractAllCellReferencesInRange()
  compareCells()
  getValueBinder()
  setValueBinder()
  __clone()
  getXfIndex()
  setXfIndex()
  setFormulaAttributes()
  getFormulaAttributes()
  __toString()


Class: PHPExcel_Cell  - X-Ref

PHPExcel_Cell

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

notifyCacheController()   X-Ref
Send notification to the cache controller

return: void

detach()   X-Ref
No description

attach(PHPExcel_CachedObjectStorage_CacheBase $parent)   X-Ref
No description

__construct($pValue = null, $pDataType = null, PHPExcel_Worksheet $pSheet = null)   X-Ref
Create a new Cell

param: mixed                $pValue
param: string                $pDataType
param: PHPExcel_Worksheet    $pSheet

getColumn()   X-Ref
Get cell coordinate column

return: string

getRow()   X-Ref
Get cell coordinate row

return: int

getCoordinate()   X-Ref
Get cell coordinate

return: string

getValue()   X-Ref
Get cell value

return: mixed

getFormattedValue()   X-Ref
Get cell value with formatting

return: string

setValue($pValue = null)   X-Ref
Set cell value

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

param: mixed    $pValue                    Value
return: PHPExcel_Cell

setValueExplicit($pValue = null, $pDataType = PHPExcel_Cell_DataType::TYPE_STRING)   X-Ref
Set the value for a cell, with the explicit data type passed to the method (bypassing any use of the value binder)

param: mixed    $pValue            Value
param: string    $pDataType        Explicit data type
return: PHPExcel_Cell

getCalculatedValue($resetLog = true)   X-Ref
Get calculated cell value

param: boolean $resetLog  Whether the calculation engine logger should be reset or not
return: mixed

setCalculatedValue($pValue = null)   X-Ref
Set old calculated value (cached)

param: mixed $pValue    Value
return: PHPExcel_Cell

getOldCalculatedValue()   X-Ref
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.

return: mixed

getDataType()   X-Ref
Get cell data type

return: string

setDataType($pDataType = PHPExcel_Cell_DataType::TYPE_STRING)   X-Ref
Set cell data type

param: string $pDataType
return: PHPExcel_Cell

isFormula()   X-Ref
Identify if the cell contains a formula

return: boolean

hasDataValidation()   X-Ref
Does this cell contain Data validation rules?

return: boolean

getDataValidation()   X-Ref
Get Data validation rules

return: PHPExcel_Cell_DataValidation

setDataValidation(PHPExcel_Cell_DataValidation $pDataValidation = null)   X-Ref
Set Data validation rules

param: PHPExcel_Cell_DataValidation    $pDataValidation
return: PHPExcel_Cell

hasHyperlink()   X-Ref
Does this cell contain a Hyperlink?

return: boolean

getHyperlink()   X-Ref
Get Hyperlink

return: PHPExcel_Cell_Hyperlink

setHyperlink(PHPExcel_Cell_Hyperlink $pHyperlink = null)   X-Ref
Set Hyperlink

param: PHPExcel_Cell_Hyperlink    $pHyperlink
return: PHPExcel_Cell

getParent()   X-Ref
Get parent worksheet

return: PHPExcel_CachedObjectStorage_CacheBase

getWorksheet()   X-Ref
Get parent worksheet

return: PHPExcel_Worksheet

isInMergeRange()   X-Ref
Is this cell in a merge range

return: boolean

isMergeRangeValueCell()   X-Ref
Is this cell the master (top left cell) in a merge range (that holds the actual data value)

return: boolean

getMergeRange()   X-Ref
If this cell is in a merge range, then return the range

return: string

getStyle()   X-Ref
Get cell style

return: PHPExcel_Style

rebindParent(PHPExcel_Worksheet $parent)   X-Ref
Re-bind parent

param: PHPExcel_Worksheet $parent
return: PHPExcel_Cell

isInRange($pRange = 'A1:A1')   X-Ref
Is cell in a specific range?

param: string    $pRange        Cell range (e.g. A1:A1)
return: boolean

coordinateFromString($pCoordinateString = 'A1')   X-Ref
Coordinate from string

param: string    $pCoordinateString
return: array    Array containing column and row (indexes 0 and 1)

absoluteReference($pCoordinateString = 'A1')   X-Ref
Make string row, column or cell coordinate absolute

param: string    $pCoordinateString        e.g. 'A' or '1' or 'A1'
return: string    Absolute coordinate        e.g. '$A' or '$1' or '$A$1'

absoluteCoordinate($pCoordinateString = 'A1')   X-Ref
Make string coordinate absolute

param: string    $pCoordinateString        e.g. 'A1'
return: string    Absolute coordinate        e.g. '$A$1'

splitRange($pRange = 'A1:A1')   X-Ref
Split range into coordinate strings

param: string    $pRange        e.g. 'B4:D9' or 'B4:D9,H2:O11' or 'B4'
return: array    Array containg one or more arrays containing one or two coordinate strings

buildRange($pRange)   X-Ref
Build range from coordinate strings

param: array    $pRange    Array containg one or more arrays containing one or two coordinate strings
return: string    String representation of $pRange

rangeBoundaries($pRange = 'A1:A1')   X-Ref
Calculate range boundaries

param: string    $pRange        Cell range (e.g. A1:A1)
return: array    Range coordinates array(Start Cell, End Cell)

rangeDimension($pRange = 'A1:A1')   X-Ref
Calculate range dimension

param: string    $pRange        Cell range (e.g. A1:A1)
return: array    Range dimension (width, height)

getRangeBoundaries($pRange = 'A1:A1')   X-Ref
Calculate range boundaries

param: string    $pRange        Cell range (e.g. A1:A1)
return: array    Range coordinates array(Start Cell, End Cell)

columnIndexFromString($pString = 'A')   X-Ref
Column index from string

param: string $pString
return: int Column index (base 1 !!!)

stringFromColumnIndex($pColumnIndex = 0)   X-Ref
String from columnindex

param: int $pColumnIndex Column index (base 0 !!!)
return: string

extractAllCellReferencesInRange($pRange = 'A1')   X-Ref
Extract all cell references in range

param: string    $pRange        Range (e.g. A1 or A1:C10 or A1:E10 A20:E25)
return: array    Array containing single cell references

compareCells(PHPExcel_Cell $a, PHPExcel_Cell $b)   X-Ref
Compare 2 cells

param: PHPExcel_Cell    $a    Cell a
param: PHPExcel_Cell    $b    Cell b
return: int        Result of comparison (always -1 or 1, never zero!)

getValueBinder()   X-Ref
Get value binder to use

return: PHPExcel_Cell_IValueBinder

setValueBinder(PHPExcel_Cell_IValueBinder $binder = null)   X-Ref
Set value binder to use

param: PHPExcel_Cell_IValueBinder $binder

__clone()   X-Ref
Implement PHP __clone to create a deep clone, not just a shallow copy.


getXfIndex()   X-Ref
Get index to cellXf

return: int

setXfIndex($pValue = 0)   X-Ref
Set index to cellXf

param: int $pValue
return: PHPExcel_Cell

setFormulaAttributes($pAttributes)   X-Ref


getFormulaAttributes()   X-Ref


__toString()   X-Ref
Convert to string

return: string



Generated: Thu Aug 11 10:00:09 2016 Cross-referenced by PHPXref 0.7.1