Docs For Class PHPExcel

static method flushInstance [line 1728]

static null flushInstance(
)

Flush the calculation cache for any existing instance of this class but only if a PHPExcel_Calculation instance exists

Tags:

access:

public

[ Top ]

static method getArrayReturnType [line 1790]

static string getArrayReturnType(
)

Return the Array Return Type (Array or Value of first element in the array)

Tags:

return:	Array return type
access:	public

[ Top ]

static method getFALSE [line 1762]

static string getFALSE(
)

Return the locale-specific translation of FALSE

Tags:

return:	locale-specific translation of FALSE
access:	public

[ Top ]

static method getInstance [line 1712]

static PHPExcel_Calculation getInstance(
)

Get an instance of this class

Tags:

access:

public

[ Top ]

static method getTRUE [line 1752]

static string getTRUE(
)

Return the locale-specific translation of TRUE

Tags:

return:	locale-specific translation of TRUE
access:	public

[ Top ]

static method setArrayReturnType [line 1773]

static boolean setArrayReturnType(
string
$returnType)

Set the Array Return Type (Array or Value of first element in the array)

Tags:

return:	Success or failure
access:	public

Parameters:

string

$returnType

Array return type

[ Top ]

static method _getMatrixDimensions [line 2391]

static array _getMatrixDimensions(
mixed
&$matrix)

Read the dimensions of a matrix, and re-index it with straight numeric keys starting from row 0, column 0

Tags:

return:	An array comprising the number of rows, and number of columns
access:	public

Parameters:

mixed

&$matrix

matrix operand

[ Top ]

static method _localeFunc [line 2056]

static void _localeFunc(

$function)

Tags:

access:

public

Parameters:

$function

[ Top ]

static method _translateSeparator [line 1951]

static void _translateSeparator(

$fromSeparator, 
$toSeparator, 
$formula, 
&$inBraces)

Tags:

access:

public

Parameters:

	$fromSeparator
	$toSeparator
	$formula
	&$inBraces

[ Top ]

static method _unwrapResult [line 2101]

static mixed _unwrapResult(
mixed
$value)

Remove quotes used as a wrapper to identify string values

Tags:

access:

public

Parameters:

mixed

$value

[ Top ]

static method _wrapResult [line 2077]

static mixed _wrapResult(
mixed
$value)

Wrap string values in quotes

Tags:

access:

public

Parameters:

mixed

$value

[ Top ]

method calculate [line 2125]

mixed calculate(
[PHPExcel_Cell
$pCell = null])

Calculate cell value (using formula from a cell ID) Retained for backward compatibility

Tags:

throws:	Exception
access:	public

Parameters:

PHPExcel_Cell

$pCell

Cell to calculate

[ Top ]

method calculateCellValue [line 2143]

mixed calculateCellValue(
[PHPExcel_Cell
$pCell = null], [Boolean
$resetLog = true])

Calculate the value of a cell formula

Tags:

throws:	Exception
access:	public

Parameters:

PHPExcel_Cell	$pCell	Cell to calculate
Boolean	$resetLog	Flag indicating whether the debug log should be reset or not

[ Top ]

method calculateFormula [line 2227]

mixed calculateFormula(
string
$formula, [
$cellID = null], [PHPExcel_Cell
$pCell = null])

Calculate the value of a formula

Tags:

throws:	Exception
access:	public

Parameters:

string	$formula	Formula to parse
	$cellID
PHPExcel_Cell	$pCell

[ Top ]

destructor __destruct [line 1700]

void __destruct(
)

Tags:

access:

public

[ Top ]

method clearCalculationCache [line 1837]

void clearCalculationCache(
)

Clear calculation cache

Tags:

access:

public

[ Top ]

method disableCalculationCache [line 1829]

void disableCalculationCache(
)

Disable calculation cache

Tags:

access:

public

[ Top ]

method enableCalculationCache [line 1821]

void enableCalculationCache(
)

Enable calculation cache

Tags:

access:

public

[ Top ]

method extractCellRange [line 3611]

mixed extractCellRange(
[string
&$pRange = 'A1'], [PHPExcel_Worksheet
$pSheet = null], [
$resetLog = true])

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
	$resetLog

[ Top ]

method extractNamedRange [line 3667]

mixed extractNamedRange(
[string
&$pRange = 'A1'], [PHPExcel_Worksheet
$pSheet = null], [
$resetLog = true])

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
	$resetLog

[ Top ]

method getCalculationCacheEnabled [line 1801]

boolean getCalculationCacheEnabled(
)

Is calculation caching enabled?

Tags:

access:

public

[ Top ]

method getCalculationCacheExpirationTime [line 1847]

float getCalculationCacheExpirationTime(
)

Get calculation cache expiration time

Tags:

access:

public

[ Top ]

method getLocale [line 1869]

string getLocale(
)

Get the currently defined locale code

Tags:

access:

public

[ Top ]

method isImplemented [line 3749]

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

Is a specific function implemented?

Tags:

access:

public

Parameters:

string

$pFunction

Function Name

[ Top ]

method listAllFunctionNames [line 3787]

array listAllFunctionNames(
)

Get a list of all Excel function names

Tags:

access:

public

[ Top ]

method listFunctionNames [line 3796]

array listFunctionNames(
)

Get a list of implemented Excel function names

Tags:

access:

public

[ Top ]

method listFunctions [line 3764]

array listFunctions(
)

Get a list of all implemented functions as an array of function objects

Tags:

return:	of PHPExcel_Calculation_Function
access:	public

[ Top ]

method parseFormula [line 2207]

array parseFormula(
string
$formula)

Validate and parse a formula string

Tags:

throws:	Exception
access:	public

Parameters:

string

$formula

Formula to parse

[ Top ]

method setCalculationCacheEnabled [line 1812]

void setCalculationCacheEnabled(
[boolean
$pValue = true])

Enable/disable calculation cache

Tags:

access:

public

Parameters:

boolean

$pValue

[ Top ]

method setCalculationCacheExpirationTime [line 1857]

void setCalculationCacheExpirationTime(
[float
$pValue = 15])

Set calculation cache expiration time

Tags:

access:

public

Parameters:

float

$pValue

[ Top ]

method setLocale [line 1879]

boolean setLocale(
[
$locale = 'en_us'])

Set the locale code

Tags:

access:

public

Parameters:

$locale

[ Top ]

method _calculateFormulaValue [line 2259]

mixed _calculateFormulaValue(
string
$formula, [string
$cellID = null], [PHPExcel_Cell
$pCell = null])

Parse a cell formula and calculate its value

Tags:

throws:	Exception
access:	public

Parameters:

string	$formula	The formula to parse and calculate
string	$cellID	The ID (e.g. A3) of the cell that we are calculating
PHPExcel_Cell	$pCell	Cell to calculate

[ Top ]

method _raiseFormulaError [line 3595]

void _raiseFormulaError(

$errorMessage)

Tags:

access:

protected

Parameters:

$errorMessage

[ Top ]

method _translateFormulaToEnglish [line 2031]

void _translateFormulaToEnglish(

$formula)

Tags:

access:

public

Parameters:

$formula

[ Top ]

method _translateFormulaToLocale [line 2002]

void _translateFormulaToLocale(

$formula)

Tags:

access:

public

Parameters:

$formula

[ Top ]

method __clone [line 1741]

void __clone(
)

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

Tags:

throws:	Exception
access:	public

[ Top ]

Class: PHPExcel_Calculation

Class Overview

Author(s):

Copyright:

Variables

Constants

Methods

Class Details

Tags:

Class Variables

static $_localeBoolean = array( 'TRUE' => 'TRUE', 'FALSE' => 'FALSE', 'NULL' => 'NULL' )

Tags:

$cyclicFormulaCount = 0

Tags:

$debugLog = array()

Tags:

$echoDebugLog = false

Tags:

$formulaError = null

Tags:

$suppressFormulaErrors = false

Tags:

$writeDebugLog = false

Tags:

Class Methods

static method flushInstance [line 1728]

Tags:

static method getArrayReturnType [line 1790]

Tags:

static method getFALSE [line 1762]

Tags:

static method getInstance [line 1712]

Tags:

static method getTRUE [line 1752]

Tags:

static method setArrayReturnType [line 1773]

Tags:

Parameters:

static method _getMatrixDimensions [line 2391]

Tags:

Parameters:

static method _localeFunc [line 2056]

Tags:

Parameters:

static method _translateSeparator [line 1951]

Tags:

Parameters:

static method _unwrapResult [line 2101]

Tags:

Parameters:

static method _wrapResult [line 2077]

Tags:

Parameters:

method calculate [line 2125]

Tags:

Parameters:

method calculateCellValue [line 2143]

Tags:

Parameters:

method calculateFormula [line 2227]

Tags:

Parameters:

destructor __destruct [line 1700]

Tags:

method clearCalculationCache [line 1837]

Tags:

method disableCalculationCache [line 1829]

Tags:

method enableCalculationCache [line 1821]

Tags:

method extractCellRange [line 3611]

Tags:

Parameters:

method extractNamedRange [line 3667]

Tags:

Parameters:

method getCalculationCacheEnabled [line 1801]

Tags:

method getCalculationCacheExpirationTime [line 1847]

Tags:

static $_localeBoolean = array( 'TRUE' => 'TRUE',
'FALSE' => 'FALSE',
'NULL' => 'NULL'
)

CALCULATION_REGEXP_FUNCTION = '@?([A-Z][A-Z0-9\.])[\s]\('