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

Class: PHPExcel_Calculation

Source Location: /PHPExcel/Calculation.php

Class Overview


PHPExcel_Calculation (Singleton)


Author(s):

Copyright:

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

Variables

Methods



Class Details

[line 62]
PHPExcel_Calculation (Singleton)

PHPExcel_Calculation (Singleton)




Tags:

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


[ Top ]


Class Variables

static $_instance =

[line 96]

Instance of this class

Instance of this class




Tags:

access:  private



[ Top ]

$_calculationCache = array ( )

[line 75]

Calculation cache

Calculation cache




Tags:

access:  private

Type:   array


[ Top ]

$_calculationCacheEnabled =  true

[line 82]

Calculation cache enabled

Calculation cache enabled




Tags:

access:  private

Type:   boolean


[ Top ]

$_calculationCacheExpirationTime =  0.01

[line 89]

Calculation cache expiration time

Calculation cache expiration time




Tags:

access:  private

Type:   float


[ Top ]

$_functionMappings =  null

[line 68]

Function mappings (from Excel to PHPExcel)

Function mappings (from Excel to PHPExcel)




Tags:

access:  private

Type:   array


[ Top ]



Class Methods


static method getInstance [line 103]

static PHPExcel_Calculation getInstance( )

Get an instance of this class

Get an instance of this class




Tags:

access:  public


[ Top ]

constructor __construct [line 114]

PHPExcel_Calculation __construct( )

Create a new PHPExcel_Calculation

Create a new PHPExcel_Calculation




Tags:

access:  protected


[ Top ]

method calculate [line 525]

mixed calculate( [PHPExcel_Cell $pCell = null])

Calculate cell value (using formula)

Calculate cell value (using formula)




Tags:

throws:  Exception
access:  public


Parameters:

PHPExcel_Cell   $pCell   Cell to calculate

[ Top ]

method clearCalculationCache [line 496]

void clearCalculationCache( )

Clear calculation cache

Clear calculation cache




Tags:

access:  public


[ Top ]

method extractRange [line 761]

mixed extractRange( [string $pRange = 'A1'], [PHPExcel_Worksheet $pSheet = null])

Extract range values

Extract range values




Tags:

return:  Array of values in range if range contains more than one element. Otherwise, a single value is returned.
throws:  Exception
access:  public


Parameters:

string   $pRange   String based range representation
PHPExcel_Worksheet   $pSheet   Worksheet

[ Top ]

method getCalculationCacheEnabled [line 479]

boolean getCalculationCacheEnabled( )

Is calculation caching enabled?

Is calculation caching enabled?




Tags:

access:  public


[ Top ]

method getCalculationCacheExpirationTime [line 505]

float getCalculationCacheExpirationTime( )

Get calculation cache expiration time

Get calculation cache expiration time




Tags:

access:  public


[ Top ]

method isImplemented [line 816]

boolean isImplemented( [string $pFunction = ''])

Is a specific function implemented?

Is a specific function implemented?




Tags:

access:  public


Parameters:

string   $pFunction   Function

[ Top ]

method listFunctionNames [line 850]

array listFunctionNames( )

Get a list of implemented Excel function names

Get a list of implemented Excel function names




Tags:

access:  public


[ Top ]

method listFunctions [line 830]

array listFunctions( )

Get a list of implemented functions

Get a list of implemented functions




Tags:

access:  public


[ Top ]

method setCalculationCacheEnabled [line 488]

void setCalculationCacheEnabled( boolean $pValue)

Enable/disable calculation cache

Enable/disable calculation cache




Tags:

access:  public


Parameters:

boolean   $pValue  

[ Top ]

method setCalculationCacheExpirationTime [line 514]

void setCalculationCacheExpirationTime( [float $pValue = 0.01])

Set calculation cache expiration time

Set calculation cache expiration time




Tags:

access:  public


Parameters:

float   $pValue  

[ Top ]

method __clone [line 749]

void __clone( )

__clone implementation.

__clone implementation. Cloning should not be allowed in a Singleton!




Tags:

throws:  Exception
access:  public


[ Top ]


Documentation generated on Mon, 27 Oct 2008 08:37:37 +0100 by phpDocumentor 1.4.1