[ Index ]

PHP Cross Reference of Unnamed Project

title

Body

[close]

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

(no description)

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

Defines 1 class

PHPExcel_Calculation:: (57 methods):
  __construct()
  __destruct()
  loadLocales()
  getInstance()
  unsetInstance()
  flushInstance()
  getDebugLog()
  __clone()
  getTRUE()
  getFALSE()
  setArrayReturnType()
  getArrayReturnType()
  getCalculationCacheEnabled()
  setCalculationCacheEnabled()
  enableCalculationCache()
  disableCalculationCache()
  clearCalculationCache()
  clearCalculationCacheForWorksheet()
  renameCalculationCacheForWorksheet()
  getLocale()
  setLocale()
  translateSeparator()
  translateFormula()
  _translateFormulaToLocale()
  _translateFormulaToEnglish()
  localeFunc()
  wrapResult()
  unwrapResult()
  calculate()
  calculateCellValue()
  parseFormula()
  calculateFormula()
  getValueFromCache()
  saveValueToCache()
  _calculateFormulaValue()
  checkMatrixOperands()
  getMatrixDimensions()
  resizeMatricesShrink()
  resizeMatricesExtend()
  showValue()
  showTypeDetails()
  convertMatrixReferences()
  mkMatrix()
  _parseFormula()
  dataTestReference()
  processTokenStack()
  validateBinaryOperand()
  executeBinaryComparisonOperation()
  strcmpLowercaseFirst()
  executeNumericBinaryOperation()
  raiseFormulaError()
  extractCellRange()
  extractNamedRange()
  isImplemented()
  listFunctions()
  listAllFunctionNames()
  listFunctionNames()


Class: PHPExcel_Calculation  - X-Ref

PHPExcel_Calculation (Multiton)

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

__construct(PHPExcel $workbook = null)   X-Ref
No description

__destruct()   X-Ref
No description

loadLocales()   X-Ref
No description

getInstance(PHPExcel $workbook = null)   X-Ref
Get an instance of this class

param: PHPExcel $workbook  Injected workbook for working with a PHPExcel object,
return: PHPExcel_Calculation

unsetInstance(PHPExcel $workbook = null)   X-Ref
Unset an instance of this class

param: PHPExcel $workbook  Injected workbook identifying the instance to unset

flushInstance()   X-Ref
Flush the calculation cache for any existing instance of this class
but only if a PHPExcel_Calculation instance exists

return: null

getDebugLog()   X-Ref
Get the debuglog for this claculation engine instance

return: PHPExcel_CalcEngine_Logger

__clone()   X-Ref
__clone implementation. Cloning should not be allowed in a Singleton!


getTRUE()   X-Ref
Return the locale-specific translation of TRUE

return: string        locale-specific translation of TRUE

getFALSE()   X-Ref
Return the locale-specific translation of FALSE

return: string        locale-specific translation of FALSE

setArrayReturnType($returnType)   X-Ref
Set the Array Return Type (Array or Value of first element in the array)

param: string    $returnType            Array return type
return: boolean                    Success or failure

getArrayReturnType()   X-Ref
Return the Array Return Type (Array or Value of first element in the array)

return: string        $returnType            Array return type

getCalculationCacheEnabled()   X-Ref
Is calculation caching enabled?

return: boolean

setCalculationCacheEnabled($pValue = true)   X-Ref
Enable/disable calculation cache

param: boolean $pValue

enableCalculationCache()   X-Ref
Enable calculation cache


disableCalculationCache()   X-Ref
Disable calculation cache


clearCalculationCache()   X-Ref
Clear calculation cache


clearCalculationCacheForWorksheet($worksheetName)   X-Ref
Clear calculation cache for a specified worksheet

param: string $worksheetName

renameCalculationCacheForWorksheet($fromWorksheetName, $toWorksheetName)   X-Ref
Rename calculation cache for a specified worksheet

param: string $fromWorksheetName
param: string $toWorksheetName

getLocale()   X-Ref
Get the currently defined locale code

return: string

setLocale($locale = 'en_us')   X-Ref
Set the locale code

param: string $locale  The locale to use for formula translation
return: boolean

translateSeparator($fromSeparator, $toSeparator, $formula, &$inBraces)   X-Ref
No description

translateFormula($from, $to, $formula, $fromSeparator, $toSeparator)   X-Ref
No description

_translateFormulaToLocale($formula)   X-Ref
No description

_translateFormulaToEnglish($formula)   X-Ref
No description

localeFunc($function)   X-Ref
No description

wrapResult($value)   X-Ref
Wrap string values in quotes

param: mixed $value
return: mixed

unwrapResult($value)   X-Ref
Remove quotes used as a wrapper to identify string values

param: mixed $value
return: mixed

calculate(PHPExcel_Cell $pCell = null)   X-Ref
Calculate cell value (using formula from a cell ID)
Retained for backward compatibility

param: PHPExcel_Cell    $pCell    Cell to calculate
return: mixed

calculateCellValue(PHPExcel_Cell $pCell = null, $resetLog = true)   X-Ref
Calculate the value of a cell formula

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

parseFormula($formula)   X-Ref
Validate and parse a formula string

param: string        $formula        Formula to parse
return: array

calculateFormula($formula, $cellID = null, PHPExcel_Cell $pCell = null)   X-Ref
Calculate the value of a formula

param: string            $formula    Formula to parse
param: string            $cellID        Address of the cell to calculate
param: PHPExcel_Cell    $pCell        Cell to calculate
return: mixed

getValueFromCache($cellReference, &$cellValue)   X-Ref
No description

saveValueToCache($cellReference, $cellValue)   X-Ref
No description

_calculateFormulaValue($formula, $cellID = null, PHPExcel_Cell $pCell = null)   X-Ref
Parse a cell formula and calculate its value

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

checkMatrixOperands(&$operand1, &$operand2, $resize = 1)   X-Ref
Ensure that paired matrix operands are both matrices and of the same size

param: mixed        &$operand1    First matrix operand
param: mixed        &$operand2    Second matrix operand
param: integer        $resize        Flag indicating whether the matrices should be resized to match

getMatrixDimensions(&$matrix)   X-Ref
Read the dimensions of a matrix, and re-index it with straight numeric keys starting from row 0, column 0

param: mixed        &$matrix        matrix operand
return: array        An array comprising the number of rows, and number of columns

resizeMatricesShrink(&$matrix1, &$matrix2, $matrix1Rows, $matrix1Columns, $matrix2Rows, $matrix2Columns)   X-Ref
Ensure that paired matrix operands are both matrices of the same size

param: mixed        &$matrix1        First matrix operand
param: mixed        &$matrix2        Second matrix operand
param: integer        $matrix1Rows    Row size of first matrix operand
param: integer        $matrix1Columns    Column size of first matrix operand
param: integer        $matrix2Rows    Row size of second matrix operand
param: integer        $matrix2Columns    Column size of second matrix operand

resizeMatricesExtend(&$matrix1, &$matrix2, $matrix1Rows, $matrix1Columns, $matrix2Rows, $matrix2Columns)   X-Ref
Ensure that paired matrix operands are both matrices of the same size

param: mixed        &$matrix1    First matrix operand
param: mixed        &$matrix2    Second matrix operand
param: integer        $matrix1Rows    Row size of first matrix operand
param: integer        $matrix1Columns    Column size of first matrix operand
param: integer        $matrix2Rows    Row size of second matrix operand
param: integer        $matrix2Columns    Column size of second matrix operand

showValue($value)   X-Ref
Format details of an operand for display in the log (based on operand type)

param: mixed        $value    First matrix operand
return: mixed

showTypeDetails($value)   X-Ref
Format type and details of an operand for display in the log (based on operand type)

param: mixed        $value    First matrix operand
return: mixed

convertMatrixReferences($formula)   X-Ref
No description

mkMatrix()   X-Ref
No description

_parseFormula($formula, PHPExcel_Cell $pCell = null)   X-Ref
No description

dataTestReference(&$operandData)   X-Ref
No description

processTokenStack($tokens, $cellID = null, PHPExcel_Cell $pCell = null)   X-Ref
No description

validateBinaryOperand($cellID, &$operand, &$stack)   X-Ref
No description

executeBinaryComparisonOperation($cellID, $operand1, $operand2, $operation, &$stack, $recursingArrays = false)   X-Ref
No description

strcmpLowercaseFirst($str1, $str2)   X-Ref
Compare two strings in the same way as strcmp() except that lowercase come before uppercase letters

param: string    $str1    First string value for the comparison
param: string    $str2    Second string value for the comparison
return: integer

executeNumericBinaryOperation($cellID, $operand1, $operand2, $operation, $matrixFunction, &$stack)   X-Ref
No description

raiseFormulaError($errorMessage)   X-Ref
No description

extractCellRange(&$pRange = 'A1', PHPExcel_Worksheet $pSheet = null, $resetLog = true)   X-Ref
Extract range values

param: string                &$pRange    String based range representation
param: PHPExcel_Worksheet    $pSheet        Worksheet
param: boolean                $resetLog    Flag indicating whether calculation log should be reset or not
return: mixed                Array of values in range if range contains more than one element. Otherwise, a single value is returned.

extractNamedRange(&$pRange = 'A1', PHPExcel_Worksheet $pSheet = null, $resetLog = true)   X-Ref
Extract range values

param: string                &$pRange    String based range representation
param: PHPExcel_Worksheet    $pSheet        Worksheet
param: boolean                $resetLog    Flag indicating whether calculation log should be reset or not
return: mixed                Array of values in range if range contains more than one element. Otherwise, a single value is returned.

isImplemented($pFunction = '')   X-Ref
Is a specific function implemented?

param: string    $pFunction    Function Name
return: boolean

listFunctions()   X-Ref
Get a list of all implemented functions as an array of function objects

return: array of PHPExcel_Calculation_Function

listAllFunctionNames()   X-Ref
Get a list of all Excel function names

return: array

listFunctionNames()   X-Ref
Get a list of implemented Excel function names

return: array



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