You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

PHPExcel_Calculation.html 88 KiB

3 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470
  1. <!DOCTYPE html><html lang="en">
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  4. <meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
  5. <meta charset="utf-8">
  6. <title>PHPExcel classes » \PHPExcel_Calculation</title>
  7. <meta name="author" content="Mike van Riel">
  8. <meta name="description" content="">
  9. <link href="../css/template.css" rel="stylesheet" media="all">
  10. <script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
  11. <link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
  12. <link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
  13. <link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
  14. </head>
  15. <body>
  16. <div class="navbar navbar-fixed-top">
  17. <div class="navbar-inner"><div class="container">
  18. <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">PHPExcel classes</a><div class="nav-collapse"><ul class="nav">
  19. <li class="dropdown">
  20. <a href="#api" class="dropdown-toggle" data-toggle="dropdown">
  21. API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
  22. <li><a>Packages</a></li>
  23. <li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
  24. <li><a href="../packages/JAMA.html"><i class="icon-folder-open"></i> JAMA</a></li>
  25. <li><a href="../packages/JAMA%0D%0ACholesky%20decomposition%20class%0D%0AFor%20a%20symmetric,%20positive%20definite%20matrix%20A,%20the%20Cholesky%20decomposition%0D%0Ais%20an%20lower%20triangular%20matrix%20L%20so%20that%20A%20=%20L*L'.html"><i class="icon-folder-open"></i> JAMA
  26. Cholesky decomposition class
  27. For a symmetric, positive definite matrix A, the Cholesky decomposition
  28. is an lower triangular matrix L so that A = L*L'</a></li>
  29. <li><a href="../packages/JAMA%0D%0AClass%20to%20obtain%20eigenvalues%20and%20eigenvectors%20of%20a%20real%20matrix.html"><i class="icon-folder-open"></i> JAMA
  30. Class to obtain eigenvalues and eigenvectors of a real matrix</a></li>
  31. <li><a href="../packages/JAMA%0D%0AError%20handling.html"><i class="icon-folder-open"></i> JAMA
  32. Error handling</a></li>
  33. <li><a href="../packages/JAMA%0D%0AFor%20an%20m-by-n%20matrix%20A%20with%20m%20&gt;=%20n,%20the%20LU%20decomposition%20is%20an%20m-by-n%0D%0Aunit%20lower%20triangular%20matrix%20L,%20an%20n-by-n%20upper%20triangular%20matrix%20U,%0D%0Aand%20a%20permutation%20vector%20piv%20of%20length%20m%20so%20that%20A(piv,:)%20=%20L*U.html"><i class="icon-folder-open"></i> JAMA
  34. For an m-by-n matrix A with m &gt;= n, the LU decomposition is an m-by-n
  35. unit lower triangular matrix L, an n-by-n upper triangular matrix U,
  36. and a permutation vector piv of length m so that A(piv,:) = L*U</a></li>
  37. <li><a href="../packages/JAMA%0D%0AFor%20an%20m-by-n%20matrix%20A%20with%20m%20&gt;=%20n,%20the%20QR%20decomposition%20is%20an%20m-by-n%0D%0Aorthogonal%20matrix%20Q%20and%20an%20n-by-n%20upper%20triangular%20matrix%20R%20so%20that%0D%0AA%20=%20Q*R.html"><i class="icon-folder-open"></i> JAMA
  38. For an m-by-n matrix A with m &gt;= n, the QR decomposition is an m-by-n
  39. orthogonal matrix Q and an n-by-n upper triangular matrix R so that
  40. A = Q*R</a></li>
  41. <li><a href="../packages/JAMA%0D%0AFor%20an%20m-by-n%20matrix%20A%20with%20m%20&gt;=%20n,%20the%20singular%20value%20decomposition%20is%0D%0Aan%20m-by-n%20orthogonal%20matrix%20U,%20an%20n-by-n%20diagonal%20matrix%20S,%20and%0D%0Aan%20n-by-n%20orthogonal%20matrix%20V%20so%20that%20A%20=%20U*S*V'.html"><i class="icon-folder-open"></i> JAMA
  42. For an m-by-n matrix A with m &gt;= n, the singular value decomposition is
  43. an m-by-n orthogonal matrix U, an n-by-n diagonal matrix S, and
  44. an n-by-n orthogonal matrix V so that A = U*S*V'</a></li>
  45. <li><a href="../packages/JAMA%0D%0APythagorean%20Theorem:%0D%0Aa%20=%203%0D%0Ab%20=%204%0D%0Ar%20=%20sqrt(square(a)%20+%20square(b))%0D%0Ar%20=%205%0D%0Ar%20=%20sqrt(a%5E2%20+%20b%5E2)%20without%20under.overflow.html"><i class="icon-folder-open"></i> JAMA
  46. Pythagorean Theorem:
  47. a = 3
  48. b = 4
  49. r = sqrt(square(a) + square(b))
  50. r = 5
  51. r = sqrt(a^2 + b^2) without under/overflow</a></li>
  52. <li><a href="../packages/PHPExcel.html"><i class="icon-folder-open"></i> PHPExcel</a></li>
  53. </ul>
  54. </li>
  55. <li class="dropdown" id="charts-menu">
  56. <a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
  57. Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
  58. </li>
  59. <li class="dropdown" id="reports-menu">
  60. <a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
  61. Reports <b class="caret"></b></a><ul class="dropdown-menu">
  62. <li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
  63. <span class="label label-info">551</span></a></li>
  64. <li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
  65. <ul>
  66. <li>todo 
  67. <span class="label label-info">19</span>
  68. </li>
  69. <li>fixme 
  70. <span class="label label-info">10</span>
  71. </li>
  72. </ul></a></li>
  73. <li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
  74. <span class="label label-info">12</span></a></li>
  75. </ul>
  76. </li>
  77. </ul></div>
  78. </div></div>
  79. <div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
  80. </div>
  81. <div id="___" class="container">
  82. <noscript><div class="alert alert-warning">
  83. Javascript is disabled; several features are only available
  84. if Javascript is enabled.
  85. </div></noscript>
  86. <div class="row">
  87. <div class="span4">
  88. <span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
  89. <button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
  90. </div>
  91. <ul class="side-nav nav nav-list">
  92. <li class="nav-header">
  93. <i class="icon-custom icon-method"></i> Methods
  94. <ul>
  95. <li class="method public "><a href="#method___clone" title="__clone :: __clone implementation."><span class="description">__clone implementation.</span><pre>__clone()</pre></a></li>
  96. <li class="method public "><a href="#method___destruct" title="__destruct :: "><span class="description">__destruct()
  97. </span><pre>__destruct()</pre></a></li>
  98. <li class="method public "><a href="#method__calculateFormulaValue" title="_calculateFormulaValue :: Parse a cell formula and calculate its value"><span class="description">Parse a cell formula and calculate its value</span><pre>_calculateFormulaValue()</pre></a></li>
  99. <li class="method public "><a href="#method__getMatrixDimensions" title="_getMatrixDimensions :: Read the dimensions of a matrix, and re-index it with straight numeric keys starting from row 0, column 0"><span class="description">Read the dimensions of a matrix, and re-index it with straight numeric keys starting from row 0, column 0</span><pre>_getMatrixDimensions()</pre></a></li>
  100. <li class="method public "><a href="#method__localeFunc" title="_localeFunc :: "><span class="description">_localeFunc()
  101. </span><pre>_localeFunc()</pre></a></li>
  102. <li class="method public "><a href="#method__translateFormulaToEnglish" title="_translateFormulaToEnglish :: "><span class="description">_translateFormulaToEnglish()
  103. </span><pre>_translateFormulaToEnglish()</pre></a></li>
  104. <li class="method public "><a href="#method__translateFormulaToLocale" title="_translateFormulaToLocale :: "><span class="description">_translateFormulaToLocale()
  105. </span><pre>_translateFormulaToLocale()</pre></a></li>
  106. <li class="method public "><a href="#method__translateSeparator" title="_translateSeparator :: "><span class="description">_translateSeparator()
  107. </span><pre>_translateSeparator()</pre></a></li>
  108. <li class="method public "><a href="#method__unwrapResult" title="_unwrapResult :: Remove quotes used as a wrapper to identify string values"><span class="description">Remove quotes used as a wrapper to identify string values</span><pre>_unwrapResult()</pre></a></li>
  109. <li class="method public "><a href="#method__wrapResult" title="_wrapResult :: Wrap string values in quotes"><span class="description">Wrap string values in quotes</span><pre>_wrapResult()</pre></a></li>
  110. <li class="method public "><a href="#method_calculate" title="calculate :: Calculate cell value (using formula from a cell ID)
  111. Retained for backward compatibility"><span class="description">Calculate cell value (using formula from a cell ID)
  112. Retained for backward compatibility</span><pre>calculate()</pre></a></li>
  113. <li class="method public "><a href="#method_calculateCellValue" title="calculateCellValue :: Calculate the value of a cell formula"><span class="description">Calculate the value of a cell formula</span><pre>calculateCellValue()</pre></a></li>
  114. <li class="method public "><a href="#method_calculateFormula" title="calculateFormula :: Calculate the value of a formula"><span class="description">Calculate the value of a formula</span><pre>calculateFormula()</pre></a></li>
  115. <li class="method public "><a href="#method_clearCalculationCache" title="clearCalculationCache :: Clear calculation cache"><span class="description">Clear calculation cache</span><pre>clearCalculationCache()</pre></a></li>
  116. <li class="method public "><a href="#method_clearCalculationCacheForWorksheet" title="clearCalculationCacheForWorksheet :: Clear calculation cache for a specified worksheet"><span class="description">Clear calculation cache for a specified worksheet</span><pre>clearCalculationCacheForWorksheet()</pre></a></li>
  117. <li class="method public "><a href="#method_disableCalculationCache" title="disableCalculationCache :: Disable calculation cache"><span class="description">Disable calculation cache</span><pre>disableCalculationCache()</pre></a></li>
  118. <li class="method public "><a href="#method_enableCalculationCache" title="enableCalculationCache :: Enable calculation cache"><span class="description">Enable calculation cache</span><pre>enableCalculationCache()</pre></a></li>
  119. <li class="method public "><a href="#method_extractCellRange" title="extractCellRange :: Extract range values"><span class="description">Extract range values</span><pre>extractCellRange()</pre></a></li>
  120. <li class="method public "><a href="#method_extractNamedRange" title="extractNamedRange :: Extract range values"><span class="description">Extract range values</span><pre>extractNamedRange()</pre></a></li>
  121. <li class="method public "><a href="#method_flushInstance" title="flushInstance :: Flush the calculation cache for any existing instance of this class
  122. but only if a PHPExcel_Calculation instance exists"><span class="description">Flush the calculation cache for any existing instance of this class
  123. but only if a PHPExcel_Calculation instance exists</span><pre>flushInstance()</pre></a></li>
  124. <li class="method public "><a href="#method_getArrayReturnType" title="getArrayReturnType :: Return the Array Return Type (Array or Value of first element in the array)"><span class="description">Return the Array Return Type (Array or Value of first element in the array)</span><pre>getArrayReturnType()</pre></a></li>
  125. <li class="method public "><a href="#method_getCalculationCacheEnabled" title="getCalculationCacheEnabled :: Is calculation caching enabled?"><span class="description">Is calculation caching enabled?</span><pre>getCalculationCacheEnabled()</pre></a></li>
  126. <li class="method public "><a href="#method_getDebugLog" title="getDebugLog :: Get the debuglog for this claculation engine instance"><span class="description">Get the debuglog for this claculation engine instance</span><pre>getDebugLog()</pre></a></li>
  127. <li class="method public "><a href="#method_getFALSE" title="getFALSE :: Return the locale-specific translation of FALSE"><span class="description">Return the locale-specific translation of FALSE</span><pre>getFALSE()</pre></a></li>
  128. <li class="method public "><a href="#method_getInstance" title="getInstance :: Get an instance of this class"><span class="description">Get an instance of this class</span><pre>getInstance()</pre></a></li>
  129. <li class="method public "><a href="#method_getLocale" title="getLocale :: Get the currently defined locale code"><span class="description">Get the currently defined locale code</span><pre>getLocale()</pre></a></li>
  130. <li class="method public "><a href="#method_getTRUE" title="getTRUE :: Return the locale-specific translation of TRUE"><span class="description">Return the locale-specific translation of TRUE</span><pre>getTRUE()</pre></a></li>
  131. <li class="method public "><a href="#method_getValueFromCache" title="getValueFromCache :: "><span class="description">getValueFromCache()
  132. </span><pre>getValueFromCache()</pre></a></li>
  133. <li class="method public "><a href="#method_isImplemented" title="isImplemented :: Is a specific function implemented?"><span class="description">Is a specific function implemented?</span><pre>isImplemented()</pre></a></li>
  134. <li class="method public "><a href="#method_listAllFunctionNames" title="listAllFunctionNames :: Get a list of all Excel function names"><span class="description">Get a list of all Excel function names</span><pre>listAllFunctionNames()</pre></a></li>
  135. <li class="method public "><a href="#method_listFunctionNames" title="listFunctionNames :: Get a list of implemented Excel function names"><span class="description">Get a list of implemented Excel function names</span><pre>listFunctionNames()</pre></a></li>
  136. <li class="method public "><a href="#method_listFunctions" title="listFunctions :: Get a list of all implemented functions as an array of function objects"><span class="description">Get a list of all implemented functions as an array of function objects</span><pre>listFunctions()</pre></a></li>
  137. <li class="method public "><a href="#method_parseFormula" title="parseFormula :: Validate and parse a formula string"><span class="description">Validate and parse a formula string</span><pre>parseFormula()</pre></a></li>
  138. <li class="method public "><a href="#method_renameCalculationCacheForWorksheet" title="renameCalculationCacheForWorksheet :: Rename calculation cache for a specified worksheet"><span class="description">Rename calculation cache for a specified worksheet</span><pre>renameCalculationCacheForWorksheet()</pre></a></li>
  139. <li class="method public "><a href="#method_saveValueToCache" title="saveValueToCache :: "><span class="description">saveValueToCache()
  140. </span><pre>saveValueToCache()</pre></a></li>
  141. <li class="method public "><a href="#method_setArrayReturnType" title="setArrayReturnType :: Set the Array Return Type (Array or Value of first element in the array)"><span class="description">Set the Array Return Type (Array or Value of first element in the array)</span><pre>setArrayReturnType()</pre></a></li>
  142. <li class="method public "><a href="#method_setCalculationCacheEnabled" title="setCalculationCacheEnabled :: Enable/disable calculation cache"><span class="description">Enable/disable calculation cache</span><pre>setCalculationCacheEnabled()</pre></a></li>
  143. <li class="method public "><a href="#method_setLocale" title="setLocale :: Set the locale code"><span class="description">Set the locale code</span><pre>setLocale()</pre></a></li>
  144. <li class="method public "><a href="#method_unsetInstance" title="unsetInstance :: Unset an instance of this class"><span class="description">Unset an instance of this class</span><pre>unsetInstance()</pre></a></li>
  145. </ul>
  146. </li>
  147. <li class="nav-header protected">» Protected
  148. <ul><li class="method protected "><a href="#method__raiseFormulaError" title="_raiseFormulaError :: "><span class="description">_raiseFormulaError()
  149. </span><pre>_raiseFormulaError()</pre></a></li></ul>
  150. </li>
  151. <li class="nav-header private">» Private
  152. <ul>
  153. <li class="method private "><a href="#method___construct" title="__construct :: "><span class="description">__construct()
  154. </span><pre>__construct()</pre></a></li>
  155. <li class="method private "><a href="#method__checkMatrixOperands" title="_checkMatrixOperands :: Ensure that paired matrix operands are both matrices and of the same size"><span class="description">Ensure that paired matrix operands are both matrices and of the same size</span><pre>_checkMatrixOperands()</pre></a></li>
  156. <li class="method private "><a href="#method__convertMatrixReferences" title="_convertMatrixReferences :: "><span class="description">_convertMatrixReferences()
  157. </span><pre>_convertMatrixReferences()</pre></a></li>
  158. <li class="method private "><a href="#method__dataTestReference" title="_dataTestReference :: "><span class="description">_dataTestReference()
  159. </span><pre>_dataTestReference()</pre></a></li>
  160. <li class="method private "><a href="#method__executeBinaryComparisonOperation" title="_executeBinaryComparisonOperation :: "><span class="description">_executeBinaryComparisonOperation()
  161. </span><pre>_executeBinaryComparisonOperation()</pre></a></li>
  162. <li class="method private "><a href="#method__executeNumericBinaryOperation" title="_executeNumericBinaryOperation :: "><span class="description">_executeNumericBinaryOperation()
  163. </span><pre>_executeNumericBinaryOperation()</pre></a></li>
  164. <li class="method private "><a href="#method__loadLocales" title="_loadLocales :: "><span class="description">_loadLocales()
  165. </span><pre>_loadLocales()</pre></a></li>
  166. <li class="method private "><a href="#method__mkMatrix" title="_mkMatrix :: "><span class="description">_mkMatrix()
  167. </span><pre>_mkMatrix()</pre></a></li>
  168. <li class="method private "><a href="#method__parseFormula" title="_parseFormula :: "><span class="description">_parseFormula()
  169. </span><pre>_parseFormula()</pre></a></li>
  170. <li class="method private "><a href="#method__processTokenStack" title="_processTokenStack :: "><span class="description">_processTokenStack()
  171. </span><pre>_processTokenStack()</pre></a></li>
  172. <li class="method private "><a href="#method__resizeMatricesExtend" title="_resizeMatricesExtend :: Ensure that paired matrix operands are both matrices of the same size"><span class="description">Ensure that paired matrix operands are both matrices of the same size</span><pre>_resizeMatricesExtend()</pre></a></li>
  173. <li class="method private "><a href="#method__resizeMatricesShrink" title="_resizeMatricesShrink :: Ensure that paired matrix operands are both matrices of the same size"><span class="description">Ensure that paired matrix operands are both matrices of the same size</span><pre>_resizeMatricesShrink()</pre></a></li>
  174. <li class="method private "><a href="#method__showTypeDetails" title="_showTypeDetails :: Format type and details of an operand for display in the log (based on operand type)"><span class="description">Format type and details of an operand for display in the log (based on operand type)</span><pre>_showTypeDetails()</pre></a></li>
  175. <li class="method private "><a href="#method__showValue" title="_showValue :: Format details of an operand for display in the log (based on operand type)"><span class="description">Format details of an operand for display in the log (based on operand type)</span><pre>_showValue()</pre></a></li>
  176. <li class="method private "><a href="#method__translateFormula" title="_translateFormula :: "><span class="description">_translateFormula()
  177. </span><pre>_translateFormula()</pre></a></li>
  178. <li class="method private "><a href="#method__validateBinaryOperand" title="_validateBinaryOperand :: "><span class="description">_validateBinaryOperand()
  179. </span><pre>_validateBinaryOperand()</pre></a></li>
  180. <li class="method private "><a href="#method_strcmpLowercaseFirst" title="strcmpLowercaseFirst :: Compare two strings in the same way as strcmp() except that lowercase come before uppercase letters"><span class="description">Compare two strings in the same way as strcmp() except that lowercase come before uppercase letters</span><pre>strcmpLowercaseFirst()</pre></a></li>
  181. </ul>
  182. </li>
  183. <li class="nav-header">
  184. <i class="icon-custom icon-property"></i> Properties
  185. <ul>
  186. <li class="property public "><a href="#property__localeBoolean" title="$_localeBoolean :: Locale-specific translations for Excel constants (True, False and Null)"><span class="description"></span><pre>$_localeBoolean</pre></a></li>
  187. <li class="property public "><a href="#property_cyclicFormulaCount" title="$cyclicFormulaCount :: Number of iterations for cyclic formulae"><span class="description"></span><pre>$cyclicFormulaCount</pre></a></li>
  188. <li class="property public "><a href="#property_formulaError" title="$formulaError :: Error message for any error that was raised/thrown by the calculation engine"><span class="description"></span><pre>$formulaError</pre></a></li>
  189. <li class="property public "><a href="#property_suppressFormulaErrors" title="$suppressFormulaErrors :: Flag to determine how formula errors should be handled
  190. If true, then a user error will be triggered
  191. If false, then an exception will be thrown"><span class="description"></span><pre>$suppressFormulaErrors</pre></a></li>
  192. </ul>
  193. </li>
  194. <li class="nav-header private">» Private
  195. <ul>
  196. <li class="property private "><a href="#property__ExcelConstants" title="$_ExcelConstants :: Excel constant string translations to their PHP equivalents
  197. Constant conversion from text name/value to actual (datatyped) value"><span class="description"></span><pre>$_ExcelConstants</pre></a></li>
  198. <li class="property private "><a href="#property__PHPExcelFunctions" title="$_PHPExcelFunctions :: "><span class="description"></span><pre>$_PHPExcelFunctions</pre></a></li>
  199. <li class="property private "><a href="#property__binaryOperators" title="$_binaryOperators :: List of binary operators (those that expect two operands)"><span class="description"></span><pre>$_binaryOperators</pre></a></li>
  200. <li class="property private "><a href="#property__calculationCache" title="$_calculationCache :: Calculation cache"><span class="description"></span><pre>$_calculationCache</pre></a></li>
  201. <li class="property private "><a href="#property__calculationCacheEnabled" title="$_calculationCacheEnabled :: Calculation cache enabled"><span class="description"></span><pre>$_calculationCacheEnabled</pre></a></li>
  202. <li class="property private "><a href="#property__comparisonOperators" title="$_comparisonOperators :: "><span class="description"></span><pre>$_comparisonOperators</pre></a></li>
  203. <li class="property private "><a href="#property__controlFunctions" title="$_controlFunctions :: "><span class="description"></span><pre>$_controlFunctions</pre></a></li>
  204. <li class="property private "><a href="#property__cyclicFormulaCell" title="$_cyclicFormulaCell :: "><span class="description"></span><pre>$_cyclicFormulaCell</pre></a></li>
  205. <li class="property private "><a href="#property__cyclicFormulaCount" title="$_cyclicFormulaCount :: Current iteration counter for cyclic formulae
  206. If the value is 0 (or less) then cyclic formulae will throw an exception,
  207. otherwise they will iterate to the limit defined here before returning a result"><span class="description"></span><pre>$_cyclicFormulaCount</pre></a></li>
  208. <li class="property private "><a href="#property__cyclicReferenceStack" title="$_cyclicReferenceStack :: An array of the nested cell references accessed by the calculation engine, used for the debug log"><span class="description"></span><pre>$_cyclicReferenceStack</pre></a></li>
  209. <li class="property private "><a href="#property__instance" title="$_instance :: Instance of this class"><span class="description"></span><pre>$_instance</pre></a></li>
  210. <li class="property private "><a href="#property__localeArgumentSeparator" title="$_localeArgumentSeparator :: Locale-specific argument separator for function arguments"><span class="description"></span><pre>$_localeArgumentSeparator</pre></a></li>
  211. <li class="property private "><a href="#property__localeFunctions" title="$_localeFunctions :: "><span class="description"></span><pre>$_localeFunctions</pre></a></li>
  212. <li class="property private "><a href="#property__localeLanguage" title="$_localeLanguage :: The current locale setting"><span class="description"></span><pre>$_localeLanguage</pre></a></li>
  213. <li class="property private "><a href="#property__operatorAssociativity" title="$_operatorAssociativity :: "><span class="description"></span><pre>$_operatorAssociativity</pre></a></li>
  214. <li class="property private "><a href="#property__operatorPrecedence" title="$_operatorPrecedence :: "><span class="description"></span><pre>$_operatorPrecedence</pre></a></li>
  215. <li class="property private "><a href="#property__operators" title="$_operators :: List of operators that can be used within formulae
  216. The true/false value indicates whether it is a binary operator or a unary operator"><span class="description"></span><pre>$_operators</pre></a></li>
  217. <li class="property private "><a href="#property__savedPrecision" title="$_savedPrecision :: Precision used for calculations"><span class="description"></span><pre>$_savedPrecision</pre></a></li>
  218. <li class="property private "><a href="#property__validLocaleLanguages" title="$_validLocaleLanguages :: List of available locale settings
  219. Note that this is read for the locale subdirectory only when requested"><span class="description"></span><pre>$_validLocaleLanguages</pre></a></li>
  220. <li class="property private "><a href="#property__workbook" title="$_workbook :: Instance of the workbook this Calculation Engine is using"><span class="description"></span><pre>$_workbook</pre></a></li>
  221. <li class="property private "><a href="#property__workbookSets" title="$_workbookSets :: List of instances of the calculation engine that we've instantiated for individual workbooks"><span class="description"></span><pre>$_workbookSets</pre></a></li>
  222. <li class="property private "><a href="#property_debugLog" title="$debugLog :: The debug log generated by the calculation engine"><span class="description"></span><pre>$debugLog</pre></a></li>
  223. <li class="property private "><a href="#property_functionReplaceFromExcel" title="$functionReplaceFromExcel :: "><span class="description"></span><pre>$functionReplaceFromExcel</pre></a></li>
  224. <li class="property private "><a href="#property_functionReplaceFromLocale" title="$functionReplaceFromLocale :: "><span class="description"></span><pre>$functionReplaceFromLocale</pre></a></li>
  225. <li class="property private "><a href="#property_functionReplaceToExcel" title="$functionReplaceToExcel :: "><span class="description"></span><pre>$functionReplaceToExcel</pre></a></li>
  226. <li class="property private "><a href="#property_functionReplaceToLocale" title="$functionReplaceToLocale :: "><span class="description"></span><pre>$functionReplaceToLocale</pre></a></li>
  227. <li class="property private "><a href="#property_returnArrayAsType" title="$returnArrayAsType :: "><span class="description"></span><pre>$returnArrayAsType</pre></a></li>
  228. </ul>
  229. </li>
  230. <li class="nav-header">
  231. <i class="icon-custom icon-constant"></i> Constants
  232. <ul>
  233. <li class="constant "><a href="#constant_CALCULATION_REGEXP_CELLREF" title="CALCULATION_REGEXP_CELLREF :: "><span class="description">CALCULATION_REGEXP_CELLREF</span><pre>CALCULATION_REGEXP_CELLREF</pre></a></li>
  234. <li class="constant "><a href="#constant_CALCULATION_REGEXP_ERROR" title="CALCULATION_REGEXP_ERROR :: "><span class="description">CALCULATION_REGEXP_ERROR</span><pre>CALCULATION_REGEXP_ERROR</pre></a></li>
  235. <li class="constant "><a href="#constant_CALCULATION_REGEXP_FUNCTION" title="CALCULATION_REGEXP_FUNCTION :: "><span class="description">CALCULATION_REGEXP_FUNCTION</span><pre>CALCULATION_REGEXP_FUNCTION</pre></a></li>
  236. <li class="constant "><a href="#constant_CALCULATION_REGEXP_NAMEDRANGE" title="CALCULATION_REGEXP_NAMEDRANGE :: "><span class="description">CALCULATION_REGEXP_NAMEDRANGE</span><pre>CALCULATION_REGEXP_NAMEDRANGE</pre></a></li>
  237. <li class="constant "><a href="#constant_CALCULATION_REGEXP_NUMBER" title="CALCULATION_REGEXP_NUMBER :: "><span class="description">CALCULATION_REGEXP_NUMBER</span><pre>CALCULATION_REGEXP_NUMBER</pre></a></li>
  238. <li class="constant "><a href="#constant_CALCULATION_REGEXP_OPENBRACE" title="CALCULATION_REGEXP_OPENBRACE :: "><span class="description">CALCULATION_REGEXP_OPENBRACE</span><pre>CALCULATION_REGEXP_OPENBRACE</pre></a></li>
  239. <li class="constant "><a href="#constant_CALCULATION_REGEXP_STRING" title="CALCULATION_REGEXP_STRING :: "><span class="description">CALCULATION_REGEXP_STRING</span><pre>CALCULATION_REGEXP_STRING</pre></a></li>
  240. <li class="constant "><a href="#constant_RETURN_ARRAY_AS_ARRAY" title="RETURN_ARRAY_AS_ARRAY :: "><span class="description">RETURN_ARRAY_AS_ARRAY</span><pre>RETURN_ARRAY_AS_ARRAY</pre></a></li>
  241. <li class="constant "><a href="#constant_RETURN_ARRAY_AS_ERROR" title="RETURN_ARRAY_AS_ERROR :: constants"><span class="description">constants</span><pre>RETURN_ARRAY_AS_ERROR</pre></a></li>
  242. <li class="constant "><a href="#constant_RETURN_ARRAY_AS_VALUE" title="RETURN_ARRAY_AS_VALUE :: "><span class="description">RETURN_ARRAY_AS_VALUE</span><pre>RETURN_ARRAY_AS_VALUE</pre></a></li>
  243. </ul>
  244. </li>
  245. </ul>
  246. </div>
  247. <div class="span8">
  248. <a id="\PHPExcel_Calculation"></a><ul class="breadcrumb">
  249. <li>
  250. <a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
  251. </li>
  252. <li><a href="../namespaces/global.html">global</a></li>
  253. <li class="active">
  254. <span class="divider">\</span><a href="../classes/PHPExcel_Calculation.html">PHPExcel_Calculation</a>
  255. </li>
  256. </ul>
  257. <div class="element class">
  258. <p class="short_description">PHPExcel_Calculation (Multiton)</p>
  259. <div class="details">
  260. <div class="long_description"></div>
  261. <table class="table table-bordered">
  262. <tr>
  263. <th>category</th>
  264. <td>PHPExcel</td>
  265. </tr>
  266. <tr>
  267. <th>package</th>
  268. <td><a href="../packages/PHPExcel.Calculation.html">PHPExcel_Calculation</a></td>
  269. </tr>
  270. <tr>
  271. <th>copyright</th>
  272. <td>Copyright (c) 2006 - 2014 PHPExcel (http://www.codeplex.com/PHPExcel)</td>
  273. </tr>
  274. </table>
  275. <h3>
  276. <i class="icon-custom icon-method"></i> Methods</h3>
  277. <a id="method___clone"></a><div class="element clickable method public method___clone" data-toggle="collapse" data-target=".method___clone .collapse">
  278. <h2>__clone implementation.</h2>
  279. <pre>__clone() </pre>
  280. <div class="labels"></div>
  281. <div class="row collapse"><div class="detail-description">
  282. <div class="long_description"><p>Cloning should not be allowed in a Singleton!</p></div>
  283. <table class="table table-bordered"><tr>
  284. <th>access</th>
  285. <td>public</td>
  286. </tr></table>
  287. <h3>Exceptions</h3>
  288. <table class="table table-bordered"><tr>
  289. <th><code><a href="../classes/PHPExcel_Calculation_Exception.html">\PHPExcel_Calculation_Exception</a></code></th>
  290. <td></td>
  291. </tr></table>
  292. </div></div>
  293. </div>
  294. <a id="method___destruct"></a><div class="element clickable method public method___destruct" data-toggle="collapse" data-target=".method___destruct .collapse">
  295. <h2>__destruct()
  296. </h2>
  297. <pre>__destruct() </pre>
  298. <div class="labels"></div>
  299. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  300. </div>
  301. <a id="method__calculateFormulaValue"></a><div class="element clickable method public method__calculateFormulaValue" data-toggle="collapse" data-target=".method__calculateFormulaValue .collapse">
  302. <h2>Parse a cell formula and calculate its value</h2>
  303. <pre>_calculateFormulaValue(string $formula, string $cellID, \PHPExcel_Cell $pCell) : mixed</pre>
  304. <div class="labels"></div>
  305. <div class="row collapse"><div class="detail-description">
  306. <div class="long_description"></div>
  307. <h3>Parameters</h3>
  308. <div class="subelement argument">
  309. <h4>$formula</h4>
  310. <code>string</code><p>The formula to parse and calculate</p></div>
  311. <div class="subelement argument">
  312. <h4>$cellID</h4>
  313. <code>string</code><p>The ID (e.g. A3) of the cell that we are calculating</p>
  314. </div>
  315. <div class="subelement argument">
  316. <h4>$pCell</h4>
  317. <code><a href="../classes/PHPExcel_Cell.html">\PHPExcel_Cell</a></code><p>Cell to calculate</p></div>
  318. <h3>Exceptions</h3>
  319. <table class="table table-bordered"><tr>
  320. <th><code><a href="../classes/PHPExcel_Calculation_Exception.html">\PHPExcel_Calculation_Exception</a></code></th>
  321. <td></td>
  322. </tr></table>
  323. <h3>Returns</h3>
  324. <div class="subelement response"><code>mixed</code></div>
  325. </div></div>
  326. </div>
  327. <a id="method__getMatrixDimensions"></a><div class="element clickable method public method__getMatrixDimensions" data-toggle="collapse" data-target=".method__getMatrixDimensions .collapse">
  328. <h2>Read the dimensions of a matrix, and re-index it with straight numeric keys starting from row 0, column 0</h2>
  329. <pre>_getMatrixDimensions(mixed $matrix) : array</pre>
  330. <div class="labels"><span class="label">Static</span></div>
  331. <div class="row collapse"><div class="detail-description">
  332. <div class="long_description"></div>
  333. <h3>Parameters</h3>
  334. <div class="subelement argument">
  335. <h4>$matrix</h4>
  336. <code>mixed</code><p>&$matrix matrix operand</p>
  337. </div>
  338. <h3>Returns</h3>
  339. <div class="subelement response">
  340. <code>array</code>An array comprising the number of rows, and number of columns</div>
  341. </div></div>
  342. </div>
  343. <a id="method__localeFunc"></a><div class="element clickable method public method__localeFunc" data-toggle="collapse" data-target=".method__localeFunc .collapse">
  344. <h2>_localeFunc()
  345. </h2>
  346. <pre>_localeFunc($function) </pre>
  347. <div class="labels"><span class="label">Static</span></div>
  348. <div class="row collapse"><div class="detail-description">
  349. <div class="long_description"></div>
  350. <h3>Parameters</h3>
  351. <div class="subelement argument"><h4>$function</h4></div>
  352. </div></div>
  353. </div>
  354. <a id="method__translateFormulaToEnglish"></a><div class="element clickable method public method__translateFormulaToEnglish" data-toggle="collapse" data-target=".method__translateFormulaToEnglish .collapse">
  355. <h2>_translateFormulaToEnglish()
  356. </h2>
  357. <pre>_translateFormulaToEnglish($formula) </pre>
  358. <div class="labels"></div>
  359. <div class="row collapse"><div class="detail-description">
  360. <div class="long_description"></div>
  361. <h3>Parameters</h3>
  362. <div class="subelement argument"><h4>$formula</h4></div>
  363. </div></div>
  364. </div>
  365. <a id="method__translateFormulaToLocale"></a><div class="element clickable method public method__translateFormulaToLocale" data-toggle="collapse" data-target=".method__translateFormulaToLocale .collapse">
  366. <h2>_translateFormulaToLocale()
  367. </h2>
  368. <pre>_translateFormulaToLocale($formula) </pre>
  369. <div class="labels"></div>
  370. <div class="row collapse"><div class="detail-description">
  371. <div class="long_description"></div>
  372. <h3>Parameters</h3>
  373. <div class="subelement argument"><h4>$formula</h4></div>
  374. </div></div>
  375. </div>
  376. <a id="method__translateSeparator"></a><div class="element clickable method public method__translateSeparator" data-toggle="collapse" data-target=".method__translateSeparator .collapse">
  377. <h2>_translateSeparator()
  378. </h2>
  379. <pre>_translateSeparator($fromSeparator, $toSeparator, $formula, $inBraces) </pre>
  380. <div class="labels"><span class="label">Static</span></div>
  381. <div class="row collapse"><div class="detail-description">
  382. <div class="long_description"></div>
  383. <h3>Parameters</h3>
  384. <div class="subelement argument"><h4>$fromSeparator</h4></div>
  385. <div class="subelement argument"><h4>$toSeparator</h4></div>
  386. <div class="subelement argument"><h4>$formula</h4></div>
  387. <div class="subelement argument"><h4>$inBraces</h4></div>
  388. </div></div>
  389. </div>
  390. <a id="method__unwrapResult"></a><div class="element clickable method public method__unwrapResult" data-toggle="collapse" data-target=".method__unwrapResult .collapse">
  391. <h2>Remove quotes used as a wrapper to identify string values</h2>
  392. <pre>_unwrapResult(mixed $value) : mixed</pre>
  393. <div class="labels"><span class="label">Static</span></div>
  394. <div class="row collapse"><div class="detail-description">
  395. <div class="long_description"></div>
  396. <h3>Parameters</h3>
  397. <div class="subelement argument">
  398. <h4>$value</h4>
  399. <code>mixed</code>
  400. </div>
  401. <h3>Returns</h3>
  402. <div class="subelement response"><code>mixed</code></div>
  403. </div></div>
  404. </div>
  405. <a id="method__wrapResult"></a><div class="element clickable method public method__wrapResult" data-toggle="collapse" data-target=".method__wrapResult .collapse">
  406. <h2>Wrap string values in quotes</h2>
  407. <pre>_wrapResult(mixed $value) : mixed</pre>
  408. <div class="labels"><span class="label">Static</span></div>
  409. <div class="row collapse"><div class="detail-description">
  410. <div class="long_description"></div>
  411. <h3>Parameters</h3>
  412. <div class="subelement argument">
  413. <h4>$value</h4>
  414. <code>mixed</code>
  415. </div>
  416. <h3>Returns</h3>
  417. <div class="subelement response"><code>mixed</code></div>
  418. </div></div>
  419. </div>
  420. <a id="method_calculate"></a><div class="element clickable method public method_calculate" data-toggle="collapse" data-target=".method_calculate .collapse">
  421. <h2>Calculate cell value (using formula from a cell ID)
  422. Retained for backward compatibility</h2>
  423. <pre>calculate(\PHPExcel_Cell $pCell) : mixed</pre>
  424. <div class="labels"></div>
  425. <div class="row collapse"><div class="detail-description">
  426. <div class="long_description"></div>
  427. <table class="table table-bordered"><tr>
  428. <th>access</th>
  429. <td>public</td>
  430. </tr></table>
  431. <h3>Parameters</h3>
  432. <div class="subelement argument">
  433. <h4>$pCell</h4>
  434. <code><a href="../classes/PHPExcel_Cell.html">\PHPExcel_Cell</a></code><p>Cell to calculate</p></div>
  435. <h3>Exceptions</h3>
  436. <table class="table table-bordered"><tr>
  437. <th><code><a href="../classes/PHPExcel_Calculation_Exception.html">\PHPExcel_Calculation_Exception</a></code></th>
  438. <td></td>
  439. </tr></table>
  440. <h3>Returns</h3>
  441. <div class="subelement response"><code>mixed</code></div>
  442. </div></div>
  443. </div>
  444. <a id="method_calculateCellValue"></a><div class="element clickable method public method_calculateCellValue" data-toggle="collapse" data-target=".method_calculateCellValue .collapse">
  445. <h2>Calculate the value of a cell formula</h2>
  446. <pre>calculateCellValue(\PHPExcel_Cell $pCell, Boolean $resetLog) : mixed</pre>
  447. <div class="labels"></div>
  448. <div class="row collapse"><div class="detail-description">
  449. <div class="long_description"></div>
  450. <table class="table table-bordered"><tr>
  451. <th>access</th>
  452. <td>public</td>
  453. </tr></table>
  454. <h3>Parameters</h3>
  455. <div class="subelement argument">
  456. <h4>$pCell</h4>
  457. <code><a href="../classes/PHPExcel_Cell.html">\PHPExcel_Cell</a></code><p>Cell to calculate</p></div>
  458. <div class="subelement argument">
  459. <h4>$resetLog</h4>
  460. <code>Boolean</code><p>Flag indicating whether the debug log should be reset or not</p></div>
  461. <h3>Exceptions</h3>
  462. <table class="table table-bordered"><tr>
  463. <th><code><a href="../classes/PHPExcel_Calculation_Exception.html">\PHPExcel_Calculation_Exception</a></code></th>
  464. <td></td>
  465. </tr></table>
  466. <h3>Returns</h3>
  467. <div class="subelement response"><code>mixed</code></div>
  468. </div></div>
  469. </div>
  470. <a id="method_calculateFormula"></a><div class="element clickable method public method_calculateFormula" data-toggle="collapse" data-target=".method_calculateFormula .collapse">
  471. <h2>Calculate the value of a formula</h2>
  472. <pre>calculateFormula(string $formula, string $cellID, \PHPExcel_Cell $pCell) : mixed</pre>
  473. <div class="labels"></div>
  474. <div class="row collapse"><div class="detail-description">
  475. <div class="long_description"></div>
  476. <h3>Parameters</h3>
  477. <div class="subelement argument">
  478. <h4>$formula</h4>
  479. <code>string</code><p>Formula to parse</p></div>
  480. <div class="subelement argument">
  481. <h4>$cellID</h4>
  482. <code>string</code><p>Address of the cell to calculate</p></div>
  483. <div class="subelement argument">
  484. <h4>$pCell</h4>
  485. <code><a href="../classes/PHPExcel_Cell.html">\PHPExcel_Cell</a></code><p>Cell to calculate</p></div>
  486. <h3>Exceptions</h3>
  487. <table class="table table-bordered"><tr>
  488. <th><code><a href="../classes/PHPExcel_Calculation_Exception.html">\PHPExcel_Calculation_Exception</a></code></th>
  489. <td></td>
  490. </tr></table>
  491. <h3>Returns</h3>
  492. <div class="subelement response"><code>mixed</code></div>
  493. </div></div>
  494. </div>
  495. <a id="method_clearCalculationCache"></a><div class="element clickable method public method_clearCalculationCache" data-toggle="collapse" data-target=".method_clearCalculationCache .collapse">
  496. <h2>Clear calculation cache</h2>
  497. <pre>clearCalculationCache() </pre>
  498. <div class="labels"></div>
  499. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  500. </div>
  501. <a id="method_clearCalculationCacheForWorksheet"></a><div class="element clickable method public method_clearCalculationCacheForWorksheet" data-toggle="collapse" data-target=".method_clearCalculationCacheForWorksheet .collapse">
  502. <h2>Clear calculation cache for a specified worksheet</h2>
  503. <pre>clearCalculationCacheForWorksheet(string $worksheetName) </pre>
  504. <div class="labels"></div>
  505. <div class="row collapse"><div class="detail-description">
  506. <div class="long_description"></div>
  507. <h3>Parameters</h3>
  508. <div class="subelement argument">
  509. <h4>$worksheetName</h4>
  510. <code>string</code>
  511. </div>
  512. </div></div>
  513. </div>
  514. <a id="method_disableCalculationCache"></a><div class="element clickable method public method_disableCalculationCache" data-toggle="collapse" data-target=".method_disableCalculationCache .collapse">
  515. <h2>Disable calculation cache</h2>
  516. <pre>disableCalculationCache() </pre>
  517. <div class="labels"></div>
  518. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  519. </div>
  520. <a id="method_enableCalculationCache"></a><div class="element clickable method public method_enableCalculationCache" data-toggle="collapse" data-target=".method_enableCalculationCache .collapse">
  521. <h2>Enable calculation cache</h2>
  522. <pre>enableCalculationCache() </pre>
  523. <div class="labels"></div>
  524. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  525. </div>
  526. <a id="method_extractCellRange"></a><div class="element clickable method public method_extractCellRange" data-toggle="collapse" data-target=".method_extractCellRange .collapse">
  527. <h2>Extract range values</h2>
  528. <pre>extractCellRange(string $pRange, \PHPExcel_Worksheet $pSheet, boolean $resetLog) : mixed</pre>
  529. <div class="labels"></div>
  530. <div class="row collapse"><div class="detail-description">
  531. <div class="long_description"></div>
  532. <h3>Parameters</h3>
  533. <div class="subelement argument">
  534. <h4>$pRange</h4>
  535. <code>string</code><p>&$pRange String based range representation</p>
  536. </div>
  537. <div class="subelement argument">
  538. <h4>$pSheet</h4>
  539. <code><a href="../classes/PHPExcel_Worksheet.html">\PHPExcel_Worksheet</a></code><p>Worksheet</p></div>
  540. <div class="subelement argument">
  541. <h4>$resetLog</h4>
  542. <code>boolean</code><p>Flag indicating whether calculation log should be reset or not</p></div>
  543. <h3>Exceptions</h3>
  544. <table class="table table-bordered"><tr>
  545. <th><code><a href="../classes/PHPExcel_Calculation_Exception.html">\PHPExcel_Calculation_Exception</a></code></th>
  546. <td></td>
  547. </tr></table>
  548. <h3>Returns</h3>
  549. <div class="subelement response">
  550. <code>mixed</code>Array of values in range if range contains more than one element. Otherwise, a single value is returned.</div>
  551. </div></div>
  552. </div>
  553. <a id="method_extractNamedRange"></a><div class="element clickable method public method_extractNamedRange" data-toggle="collapse" data-target=".method_extractNamedRange .collapse">
  554. <h2>Extract range values</h2>
  555. <pre>extractNamedRange(string $pRange, \PHPExcel_Worksheet $pSheet, boolean $resetLog) : mixed</pre>
  556. <div class="labels"></div>
  557. <div class="row collapse"><div class="detail-description">
  558. <div class="long_description"></div>
  559. <h3>Parameters</h3>
  560. <div class="subelement argument">
  561. <h4>$pRange</h4>
  562. <code>string</code><p>&$pRange String based range representation</p>
  563. </div>
  564. <div class="subelement argument">
  565. <h4>$pSheet</h4>
  566. <code><a href="../classes/PHPExcel_Worksheet.html">\PHPExcel_Worksheet</a></code><p>Worksheet</p></div>
  567. <div class="subelement argument">
  568. <h4>$resetLog</h4>
  569. <code>boolean</code><p>Flag indicating whether calculation log should be reset or not</p></div>
  570. <h3>Exceptions</h3>
  571. <table class="table table-bordered"><tr>
  572. <th><code><a href="../classes/PHPExcel_Calculation_Exception.html">\PHPExcel_Calculation_Exception</a></code></th>
  573. <td></td>
  574. </tr></table>
  575. <h3>Returns</h3>
  576. <div class="subelement response">
  577. <code>mixed</code>Array of values in range if range contains more than one element. Otherwise, a single value is returned.</div>
  578. </div></div>
  579. </div>
  580. <a id="method_flushInstance"></a><div class="element clickable method public method_flushInstance" data-toggle="collapse" data-target=".method_flushInstance .collapse">
  581. <h2>Flush the calculation cache for any existing instance of this class
  582. but only if a PHPExcel_Calculation instance exists</h2>
  583. <pre>flushInstance() : null</pre>
  584. <div class="labels"></div>
  585. <div class="row collapse"><div class="detail-description">
  586. <div class="long_description"></div>
  587. <table class="table table-bordered"><tr>
  588. <th>access</th>
  589. <td>public</td>
  590. </tr></table>
  591. <h3>Returns</h3>
  592. <div class="subelement response"><code>null</code></div>
  593. </div></div>
  594. </div>
  595. <a id="method_getArrayReturnType"></a><div class="element clickable method public method_getArrayReturnType" data-toggle="collapse" data-target=".method_getArrayReturnType .collapse">
  596. <h2>Return the Array Return Type (Array or Value of first element in the array)</h2>
  597. <pre>getArrayReturnType() : string</pre>
  598. <div class="labels"><span class="label">Static</span></div>
  599. <div class="row collapse"><div class="detail-description">
  600. <div class="long_description"></div>
  601. <table class="table table-bordered"><tr>
  602. <th>access</th>
  603. <td>public</td>
  604. </tr></table>
  605. <h3>Returns</h3>
  606. <div class="subelement response">
  607. <code>string</code>$returnType Array return type</div>
  608. </div></div>
  609. </div>
  610. <a id="method_getCalculationCacheEnabled"></a><div class="element clickable method public method_getCalculationCacheEnabled" data-toggle="collapse" data-target=".method_getCalculationCacheEnabled .collapse">
  611. <h2>Is calculation caching enabled?</h2>
  612. <pre>getCalculationCacheEnabled() : boolean</pre>
  613. <div class="labels"></div>
  614. <div class="row collapse"><div class="detail-description">
  615. <div class="long_description"></div>
  616. <table class="table table-bordered"><tr>
  617. <th>access</th>
  618. <td>public</td>
  619. </tr></table>
  620. <h3>Returns</h3>
  621. <div class="subelement response"><code>boolean</code></div>
  622. </div></div>
  623. </div>
  624. <a id="method_getDebugLog"></a><div class="element clickable method public method_getDebugLog" data-toggle="collapse" data-target=".method_getDebugLog .collapse">
  625. <h2>Get the debuglog for this claculation engine instance</h2>
  626. <pre>getDebugLog() : <a href="../classes/PHPExcel_CalcEngine_Logger.html">\PHPExcel_CalcEngine_Logger</a></pre>
  627. <div class="labels"></div>
  628. <div class="row collapse"><div class="detail-description">
  629. <div class="long_description"></div>
  630. <table class="table table-bordered"><tr>
  631. <th>access</th>
  632. <td>public</td>
  633. </tr></table>
  634. <h3>Returns</h3>
  635. <div class="subelement response"><code><a href="../classes/PHPExcel_CalcEngine_Logger.html">\PHPExcel_CalcEngine_Logger</a></code></div>
  636. </div></div>
  637. </div>
  638. <a id="method_getFALSE"></a><div class="element clickable method public method_getFALSE" data-toggle="collapse" data-target=".method_getFALSE .collapse">
  639. <h2>Return the locale-specific translation of FALSE</h2>
  640. <pre>getFALSE() : string</pre>
  641. <div class="labels"><span class="label">Static</span></div>
  642. <div class="row collapse"><div class="detail-description">
  643. <div class="long_description"></div>
  644. <table class="table table-bordered"><tr>
  645. <th>access</th>
  646. <td>public</td>
  647. </tr></table>
  648. <h3>Returns</h3>
  649. <div class="subelement response">
  650. <code>string</code>locale-specific translation of FALSE</div>
  651. </div></div>
  652. </div>
  653. <a id="method_getInstance"></a><div class="element clickable method public method_getInstance" data-toggle="collapse" data-target=".method_getInstance .collapse">
  654. <h2>Get an instance of this class</h2>
  655. <pre>getInstance(\PHPExcel $workbook) : <a href="../classes/PHPExcel_Calculation.html">\PHPExcel_Calculation</a></pre>
  656. <div class="labels"><span class="label">Static</span></div>
  657. <div class="row collapse"><div class="detail-description">
  658. <div class="long_description"></div>
  659. <table class="table table-bordered"><tr>
  660. <th>access</th>
  661. <td>public</td>
  662. </tr></table>
  663. <h3>Parameters</h3>
  664. <div class="subelement argument">
  665. <h4>$workbook</h4>
  666. <code><a href="../classes/PHPExcel.html">\PHPExcel</a></code><p>Injected workbook for working with a PHPExcel object,
  667. or NULL to create a standalone claculation engine</p></div>
  668. <h3>Returns</h3>
  669. <div class="subelement response"><code><a href="../classes/PHPExcel_Calculation.html">\PHPExcel_Calculation</a></code></div>
  670. </div></div>
  671. </div>
  672. <a id="method_getLocale"></a><div class="element clickable method public method_getLocale" data-toggle="collapse" data-target=".method_getLocale .collapse">
  673. <h2>Get the currently defined locale code</h2>
  674. <pre>getLocale() : string</pre>
  675. <div class="labels"></div>
  676. <div class="row collapse"><div class="detail-description">
  677. <div class="long_description"></div>
  678. <h3>Returns</h3>
  679. <div class="subelement response"><code>string</code></div>
  680. </div></div>
  681. </div>
  682. <a id="method_getTRUE"></a><div class="element clickable method public method_getTRUE" data-toggle="collapse" data-target=".method_getTRUE .collapse">
  683. <h2>Return the locale-specific translation of TRUE</h2>
  684. <pre>getTRUE() : string</pre>
  685. <div class="labels"><span class="label">Static</span></div>
  686. <div class="row collapse"><div class="detail-description">
  687. <div class="long_description"></div>
  688. <table class="table table-bordered"><tr>
  689. <th>access</th>
  690. <td>public</td>
  691. </tr></table>
  692. <h3>Returns</h3>
  693. <div class="subelement response">
  694. <code>string</code>locale-specific translation of TRUE</div>
  695. </div></div>
  696. </div>
  697. <a id="method_getValueFromCache"></a><div class="element clickable method public method_getValueFromCache" data-toggle="collapse" data-target=".method_getValueFromCache .collapse">
  698. <h2>getValueFromCache()
  699. </h2>
  700. <pre>getValueFromCache($worksheetName, $cellID, $cellValue) </pre>
  701. <div class="labels"></div>
  702. <div class="row collapse"><div class="detail-description">
  703. <div class="long_description"></div>
  704. <h3>Parameters</h3>
  705. <div class="subelement argument"><h4>$worksheetName</h4></div>
  706. <div class="subelement argument"><h4>$cellID</h4></div>
  707. <div class="subelement argument"><h4>$cellValue</h4></div>
  708. </div></div>
  709. </div>
  710. <a id="method_isImplemented"></a><div class="element clickable method public method_isImplemented" data-toggle="collapse" data-target=".method_isImplemented .collapse">
  711. <h2>Is a specific function implemented?</h2>
  712. <pre>isImplemented(string $pFunction) : boolean</pre>
  713. <div class="labels"></div>
  714. <div class="row collapse"><div class="detail-description">
  715. <div class="long_description"></div>
  716. <h3>Parameters</h3>
  717. <div class="subelement argument">
  718. <h4>$pFunction</h4>
  719. <code>string</code><p>Function Name</p></div>
  720. <h3>Returns</h3>
  721. <div class="subelement response"><code>boolean</code></div>
  722. </div></div>
  723. </div>
  724. <a id="method_listAllFunctionNames"></a><div class="element clickable method public method_listAllFunctionNames" data-toggle="collapse" data-target=".method_listAllFunctionNames .collapse">
  725. <h2>Get a list of all Excel function names</h2>
  726. <pre>listAllFunctionNames() : array</pre>
  727. <div class="labels"></div>
  728. <div class="row collapse"><div class="detail-description">
  729. <div class="long_description"></div>
  730. <h3>Returns</h3>
  731. <div class="subelement response"><code>array</code></div>
  732. </div></div>
  733. </div>
  734. <a id="method_listFunctionNames"></a><div class="element clickable method public method_listFunctionNames" data-toggle="collapse" data-target=".method_listFunctionNames .collapse">
  735. <h2>Get a list of implemented Excel function names</h2>
  736. <pre>listFunctionNames() : array</pre>
  737. <div class="labels"></div>
  738. <div class="row collapse"><div class="detail-description">
  739. <div class="long_description"></div>
  740. <h3>Returns</h3>
  741. <div class="subelement response"><code>array</code></div>
  742. </div></div>
  743. </div>
  744. <a id="method_listFunctions"></a><div class="element clickable method public method_listFunctions" data-toggle="collapse" data-target=".method_listFunctions .collapse">
  745. <h2>Get a list of all implemented functions as an array of function objects</h2>
  746. <pre>listFunctions() : array</pre>
  747. <div class="labels"></div>
  748. <div class="row collapse"><div class="detail-description">
  749. <div class="long_description"></div>
  750. <h3>Returns</h3>
  751. <div class="subelement response">
  752. <code>array</code>of PHPExcel_Calculation_Function</div>
  753. </div></div>
  754. </div>
  755. <a id="method_parseFormula"></a><div class="element clickable method public method_parseFormula" data-toggle="collapse" data-target=".method_parseFormula .collapse">
  756. <h2>Validate and parse a formula string</h2>
  757. <pre>parseFormula(string $formula) : array</pre>
  758. <div class="labels"></div>
  759. <div class="row collapse"><div class="detail-description">
  760. <div class="long_description"></div>
  761. <h3>Parameters</h3>
  762. <div class="subelement argument">
  763. <h4>$formula</h4>
  764. <code>string</code><p>Formula to parse</p></div>
  765. <h3>Exceptions</h3>
  766. <table class="table table-bordered"><tr>
  767. <th><code><a href="../classes/PHPExcel_Calculation_Exception.html">\PHPExcel_Calculation_Exception</a></code></th>
  768. <td></td>
  769. </tr></table>
  770. <h3>Returns</h3>
  771. <div class="subelement response"><code>array</code></div>
  772. </div></div>
  773. </div>
  774. <a id="method_renameCalculationCacheForWorksheet"></a><div class="element clickable method public method_renameCalculationCacheForWorksheet" data-toggle="collapse" data-target=".method_renameCalculationCacheForWorksheet .collapse">
  775. <h2>Rename calculation cache for a specified worksheet</h2>
  776. <pre>renameCalculationCacheForWorksheet(string $fromWorksheetName, string $toWorksheetName) </pre>
  777. <div class="labels"></div>
  778. <div class="row collapse"><div class="detail-description">
  779. <div class="long_description"></div>
  780. <h3>Parameters</h3>
  781. <div class="subelement argument">
  782. <h4>$fromWorksheetName</h4>
  783. <code>string</code>
  784. </div>
  785. <div class="subelement argument">
  786. <h4>$toWorksheetName</h4>
  787. <code>string</code>
  788. </div>
  789. </div></div>
  790. </div>
  791. <a id="method_saveValueToCache"></a><div class="element clickable method public method_saveValueToCache" data-toggle="collapse" data-target=".method_saveValueToCache .collapse">
  792. <h2>saveValueToCache()
  793. </h2>
  794. <pre>saveValueToCache($worksheetName, $cellID, $cellValue) </pre>
  795. <div class="labels"></div>
  796. <div class="row collapse"><div class="detail-description">
  797. <div class="long_description"></div>
  798. <h3>Parameters</h3>
  799. <div class="subelement argument"><h4>$worksheetName</h4></div>
  800. <div class="subelement argument"><h4>$cellID</h4></div>
  801. <div class="subelement argument"><h4>$cellValue</h4></div>
  802. </div></div>
  803. </div>
  804. <a id="method_setArrayReturnType"></a><div class="element clickable method public method_setArrayReturnType" data-toggle="collapse" data-target=".method_setArrayReturnType .collapse">
  805. <h2>Set the Array Return Type (Array or Value of first element in the array)</h2>
  806. <pre>setArrayReturnType(string $returnType) : boolean</pre>
  807. <div class="labels"><span class="label">Static</span></div>
  808. <div class="row collapse"><div class="detail-description">
  809. <div class="long_description"></div>
  810. <table class="table table-bordered"><tr>
  811. <th>access</th>
  812. <td>public</td>
  813. </tr></table>
  814. <h3>Parameters</h3>
  815. <div class="subelement argument">
  816. <h4>$returnType</h4>
  817. <code>string</code><p>Array return type</p></div>
  818. <h3>Returns</h3>
  819. <div class="subelement response">
  820. <code>boolean</code>Success or failure</div>
  821. </div></div>
  822. </div>
  823. <a id="method_setCalculationCacheEnabled"></a><div class="element clickable method public method_setCalculationCacheEnabled" data-toggle="collapse" data-target=".method_setCalculationCacheEnabled .collapse">
  824. <h2>Enable/disable calculation cache</h2>
  825. <pre>setCalculationCacheEnabled(boolean $pValue) </pre>
  826. <div class="labels"></div>
  827. <div class="row collapse"><div class="detail-description">
  828. <div class="long_description"></div>
  829. <table class="table table-bordered"><tr>
  830. <th>access</th>
  831. <td>public</td>
  832. </tr></table>
  833. <h3>Parameters</h3>
  834. <div class="subelement argument">
  835. <h4>$pValue</h4>
  836. <code>boolean</code>
  837. </div>
  838. </div></div>
  839. </div>
  840. <a id="method_setLocale"></a><div class="element clickable method public method_setLocale" data-toggle="collapse" data-target=".method_setLocale .collapse">
  841. <h2>Set the locale code</h2>
  842. <pre>setLocale(string $locale) : boolean</pre>
  843. <div class="labels"></div>
  844. <div class="row collapse"><div class="detail-description">
  845. <div class="long_description"></div>
  846. <h3>Parameters</h3>
  847. <div class="subelement argument">
  848. <h4>$locale</h4>
  849. <code>string</code><p>The locale to use for formula translation</p></div>
  850. <h3>Returns</h3>
  851. <div class="subelement response"><code>boolean</code></div>
  852. </div></div>
  853. </div>
  854. <a id="method_unsetInstance"></a><div class="element clickable method public method_unsetInstance" data-toggle="collapse" data-target=".method_unsetInstance .collapse">
  855. <h2>Unset an instance of this class</h2>
  856. <pre>unsetInstance(\PHPExcel $workbook) </pre>
  857. <div class="labels"><span class="label">Static</span></div>
  858. <div class="row collapse"><div class="detail-description">
  859. <div class="long_description"></div>
  860. <table class="table table-bordered"><tr>
  861. <th>access</th>
  862. <td>public</td>
  863. </tr></table>
  864. <h3>Parameters</h3>
  865. <div class="subelement argument">
  866. <h4>$workbook</h4>
  867. <code><a href="../classes/PHPExcel.html">\PHPExcel</a></code><p>Injected workbook identifying the instance to unset</p></div>
  868. </div></div>
  869. </div>
  870. <a id="method__raiseFormulaError"></a><div class="element clickable method protected method__raiseFormulaError" data-toggle="collapse" data-target=".method__raiseFormulaError .collapse">
  871. <h2>_raiseFormulaError()
  872. </h2>
  873. <pre>_raiseFormulaError($errorMessage) </pre>
  874. <div class="labels"></div>
  875. <div class="row collapse"><div class="detail-description">
  876. <div class="long_description"></div>
  877. <h3>Parameters</h3>
  878. <div class="subelement argument"><h4>$errorMessage</h4></div>
  879. </div></div>
  880. </div>
  881. <a id="method___construct"></a><div class="element clickable method private method___construct" data-toggle="collapse" data-target=".method___construct .collapse">
  882. <h2>__construct()
  883. </h2>
  884. <pre>__construct(\PHPExcel $workbook) </pre>
  885. <div class="labels"></div>
  886. <div class="row collapse"><div class="detail-description">
  887. <div class="long_description"></div>
  888. <h3>Parameters</h3>
  889. <div class="subelement argument"><h4>$workbook</h4></div>
  890. </div></div>
  891. </div>
  892. <a id="method__checkMatrixOperands"></a><div class="element clickable method private method__checkMatrixOperands" data-toggle="collapse" data-target=".method__checkMatrixOperands .collapse">
  893. <h2>Ensure that paired matrix operands are both matrices and of the same size</h2>
  894. <pre>_checkMatrixOperands(mixed $operand1, mixed $operand2, integer $resize) </pre>
  895. <div class="labels"><span class="label">Static</span></div>
  896. <div class="row collapse"><div class="detail-description">
  897. <div class="long_description"></div>
  898. <h3>Parameters</h3>
  899. <div class="subelement argument">
  900. <h4>$operand1</h4>
  901. <code>mixed</code><p>&$operand1 First matrix operand</p>
  902. </div>
  903. <div class="subelement argument">
  904. <h4>$operand2</h4>
  905. <code>mixed</code><p>&$operand2 Second matrix operand</p>
  906. </div>
  907. <div class="subelement argument">
  908. <h4>$resize</h4>
  909. <code>integer</code><p>Flag indicating whether the matrices should be resized to match
  910. and (if so), whether the smaller dimension should grow or the
  911. larger should shrink.
  912. 0 = no resize
  913. 1 = shrink to fit
  914. 2 = extend to fit</p>
  915. </div>
  916. </div></div>
  917. </div>
  918. <a id="method__convertMatrixReferences"></a><div class="element clickable method private method__convertMatrixReferences" data-toggle="collapse" data-target=".method__convertMatrixReferences .collapse">
  919. <h2>_convertMatrixReferences()
  920. </h2>
  921. <pre>_convertMatrixReferences($formula) </pre>
  922. <div class="labels"><span class="label">Static</span></div>
  923. <div class="row collapse"><div class="detail-description">
  924. <div class="long_description"></div>
  925. <h3>Parameters</h3>
  926. <div class="subelement argument"><h4>$formula</h4></div>
  927. </div></div>
  928. </div>
  929. <a id="method__dataTestReference"></a><div class="element clickable method private method__dataTestReference" data-toggle="collapse" data-target=".method__dataTestReference .collapse">
  930. <h2>_dataTestReference()
  931. </h2>
  932. <pre>_dataTestReference($operandData) </pre>
  933. <div class="labels"><span class="label">Static</span></div>
  934. <div class="row collapse"><div class="detail-description">
  935. <div class="long_description"></div>
  936. <h3>Parameters</h3>
  937. <div class="subelement argument"><h4>$operandData</h4></div>
  938. </div></div>
  939. </div>
  940. <a id="method__executeBinaryComparisonOperation"></a><div class="element clickable method private method__executeBinaryComparisonOperation" data-toggle="collapse" data-target=".method__executeBinaryComparisonOperation .collapse">
  941. <h2>_executeBinaryComparisonOperation()
  942. </h2>
  943. <pre>_executeBinaryComparisonOperation($cellID, $operand1, $operand2, $operation, $stack, $recursingArrays) </pre>
  944. <div class="labels"></div>
  945. <div class="row collapse"><div class="detail-description">
  946. <div class="long_description"></div>
  947. <h3>Parameters</h3>
  948. <div class="subelement argument"><h4>$cellID</h4></div>
  949. <div class="subelement argument"><h4>$operand1</h4></div>
  950. <div class="subelement argument"><h4>$operand2</h4></div>
  951. <div class="subelement argument"><h4>$operation</h4></div>
  952. <div class="subelement argument"><h4>$stack</h4></div>
  953. <div class="subelement argument"><h4>$recursingArrays</h4></div>
  954. </div></div>
  955. </div>
  956. <a id="method__executeNumericBinaryOperation"></a><div class="element clickable method private method__executeNumericBinaryOperation" data-toggle="collapse" data-target=".method__executeNumericBinaryOperation .collapse">
  957. <h2>_executeNumericBinaryOperation()
  958. </h2>
  959. <pre>_executeNumericBinaryOperation($cellID, $operand1, $operand2, $operation, $matrixFunction, $stack) </pre>
  960. <div class="labels"></div>
  961. <div class="row collapse"><div class="detail-description">
  962. <div class="long_description"></div>
  963. <h3>Parameters</h3>
  964. <div class="subelement argument"><h4>$cellID</h4></div>
  965. <div class="subelement argument"><h4>$operand1</h4></div>
  966. <div class="subelement argument"><h4>$operand2</h4></div>
  967. <div class="subelement argument"><h4>$operation</h4></div>
  968. <div class="subelement argument"><h4>$matrixFunction</h4></div>
  969. <div class="subelement argument"><h4>$stack</h4></div>
  970. </div></div>
  971. </div>
  972. <a id="method__loadLocales"></a><div class="element clickable method private method__loadLocales" data-toggle="collapse" data-target=".method__loadLocales .collapse">
  973. <h2>_loadLocales()
  974. </h2>
  975. <pre>_loadLocales() </pre>
  976. <div class="labels"><span class="label">Static</span></div>
  977. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  978. </div>
  979. <a id="method__mkMatrix"></a><div class="element clickable method private method__mkMatrix" data-toggle="collapse" data-target=".method__mkMatrix .collapse">
  980. <h2>_mkMatrix()
  981. </h2>
  982. <pre>_mkMatrix() </pre>
  983. <div class="labels"><span class="label">Static</span></div>
  984. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  985. </div>
  986. <a id="method__parseFormula"></a><div class="element clickable method private method__parseFormula" data-toggle="collapse" data-target=".method__parseFormula .collapse">
  987. <h2>_parseFormula()
  988. </h2>
  989. <pre>_parseFormula($formula, \PHPExcel_Cell $pCell) </pre>
  990. <div class="labels"></div>
  991. <div class="row collapse"><div class="detail-description">
  992. <div class="long_description"></div>
  993. <h3>Parameters</h3>
  994. <div class="subelement argument"><h4>$formula</h4></div>
  995. <div class="subelement argument"><h4>$pCell</h4></div>
  996. </div></div>
  997. </div>
  998. <a id="method__processTokenStack"></a><div class="element clickable method private method__processTokenStack" data-toggle="collapse" data-target=".method__processTokenStack .collapse">
  999. <h2>_processTokenStack()
  1000. </h2>
  1001. <pre>_processTokenStack($tokens, $cellID, \PHPExcel_Cell $pCell) </pre>
  1002. <div class="labels"></div>
  1003. <div class="row collapse"><div class="detail-description">
  1004. <div class="long_description"></div>
  1005. <h3>Parameters</h3>
  1006. <div class="subelement argument"><h4>$tokens</h4></div>
  1007. <div class="subelement argument"><h4>$cellID</h4></div>
  1008. <div class="subelement argument"><h4>$pCell</h4></div>
  1009. </div></div>
  1010. </div>
  1011. <a id="method__resizeMatricesExtend"></a><div class="element clickable method private method__resizeMatricesExtend" data-toggle="collapse" data-target=".method__resizeMatricesExtend .collapse">
  1012. <h2>Ensure that paired matrix operands are both matrices of the same size</h2>
  1013. <pre>_resizeMatricesExtend(mixed $matrix1, mixed $matrix2, integer $matrix1Rows, integer $matrix1Columns, integer $matrix2Rows, integer $matrix2Columns) </pre>
  1014. <div class="labels"><span class="label">Static</span></div>
  1015. <div class="row collapse"><div class="detail-description">
  1016. <div class="long_description"></div>
  1017. <h3>Parameters</h3>
  1018. <div class="subelement argument">
  1019. <h4>$matrix1</h4>
  1020. <code>mixed</code><p>&$matrix1 First matrix operand</p>
  1021. </div>
  1022. <div class="subelement argument">
  1023. <h4>$matrix2</h4>
  1024. <code>mixed</code><p>&$matrix2 Second matrix operand</p>
  1025. </div>
  1026. <div class="subelement argument">
  1027. <h4>$matrix1Rows</h4>
  1028. <code>integer</code><p>Row size of first matrix operand</p></div>
  1029. <div class="subelement argument">
  1030. <h4>$matrix1Columns</h4>
  1031. <code>integer</code><p>Column size of first matrix operand</p></div>
  1032. <div class="subelement argument">
  1033. <h4>$matrix2Rows</h4>
  1034. <code>integer</code><p>Row size of second matrix operand</p></div>
  1035. <div class="subelement argument">
  1036. <h4>$matrix2Columns</h4>
  1037. <code>integer</code><p>Column size of second matrix operand</p></div>
  1038. </div></div>
  1039. </div>
  1040. <a id="method__resizeMatricesShrink"></a><div class="element clickable method private method__resizeMatricesShrink" data-toggle="collapse" data-target=".method__resizeMatricesShrink .collapse">
  1041. <h2>Ensure that paired matrix operands are both matrices of the same size</h2>
  1042. <pre>_resizeMatricesShrink(mixed $matrix1, mixed $matrix2, integer $matrix1Rows, integer $matrix1Columns, integer $matrix2Rows, integer $matrix2Columns) </pre>
  1043. <div class="labels"><span class="label">Static</span></div>
  1044. <div class="row collapse"><div class="detail-description">
  1045. <div class="long_description"></div>
  1046. <h3>Parameters</h3>
  1047. <div class="subelement argument">
  1048. <h4>$matrix1</h4>
  1049. <code>mixed</code><p>&$matrix1 First matrix operand</p>
  1050. </div>
  1051. <div class="subelement argument">
  1052. <h4>$matrix2</h4>
  1053. <code>mixed</code><p>&$matrix2 Second matrix operand</p>
  1054. </div>
  1055. <div class="subelement argument">
  1056. <h4>$matrix1Rows</h4>
  1057. <code>integer</code><p>Row size of first matrix operand</p></div>
  1058. <div class="subelement argument">
  1059. <h4>$matrix1Columns</h4>
  1060. <code>integer</code><p>Column size of first matrix operand</p></div>
  1061. <div class="subelement argument">
  1062. <h4>$matrix2Rows</h4>
  1063. <code>integer</code><p>Row size of second matrix operand</p></div>
  1064. <div class="subelement argument">
  1065. <h4>$matrix2Columns</h4>
  1066. <code>integer</code><p>Column size of second matrix operand</p></div>
  1067. </div></div>
  1068. </div>
  1069. <a id="method__showTypeDetails"></a><div class="element clickable method private method__showTypeDetails" data-toggle="collapse" data-target=".method__showTypeDetails .collapse">
  1070. <h2>Format type and details of an operand for display in the log (based on operand type)</h2>
  1071. <pre>_showTypeDetails(mixed $value) : mixed</pre>
  1072. <div class="labels"></div>
  1073. <div class="row collapse"><div class="detail-description">
  1074. <div class="long_description"></div>
  1075. <h3>Parameters</h3>
  1076. <div class="subelement argument">
  1077. <h4>$value</h4>
  1078. <code>mixed</code><p>First matrix operand</p></div>
  1079. <h3>Returns</h3>
  1080. <div class="subelement response"><code>mixed</code></div>
  1081. </div></div>
  1082. </div>
  1083. <a id="method__showValue"></a><div class="element clickable method private method__showValue" data-toggle="collapse" data-target=".method__showValue .collapse">
  1084. <h2>Format details of an operand for display in the log (based on operand type)</h2>
  1085. <pre>_showValue(mixed $value) : mixed</pre>
  1086. <div class="labels"></div>
  1087. <div class="row collapse"><div class="detail-description">
  1088. <div class="long_description"></div>
  1089. <h3>Parameters</h3>
  1090. <div class="subelement argument">
  1091. <h4>$value</h4>
  1092. <code>mixed</code><p>First matrix operand</p></div>
  1093. <h3>Returns</h3>
  1094. <div class="subelement response"><code>mixed</code></div>
  1095. </div></div>
  1096. </div>
  1097. <a id="method__translateFormula"></a><div class="element clickable method private method__translateFormula" data-toggle="collapse" data-target=".method__translateFormula .collapse">
  1098. <h2>_translateFormula()
  1099. </h2>
  1100. <pre>_translateFormula($from, $to, $formula, $fromSeparator, $toSeparator) </pre>
  1101. <div class="labels"><span class="label">Static</span></div>
  1102. <div class="row collapse"><div class="detail-description">
  1103. <div class="long_description"></div>
  1104. <h3>Parameters</h3>
  1105. <div class="subelement argument"><h4>$from</h4></div>
  1106. <div class="subelement argument"><h4>$to</h4></div>
  1107. <div class="subelement argument"><h4>$formula</h4></div>
  1108. <div class="subelement argument"><h4>$fromSeparator</h4></div>
  1109. <div class="subelement argument"><h4>$toSeparator</h4></div>
  1110. </div></div>
  1111. </div>
  1112. <a id="method__validateBinaryOperand"></a><div class="element clickable method private method__validateBinaryOperand" data-toggle="collapse" data-target=".method__validateBinaryOperand .collapse">
  1113. <h2>_validateBinaryOperand()
  1114. </h2>
  1115. <pre>_validateBinaryOperand($cellID, $operand, $stack) </pre>
  1116. <div class="labels"></div>
  1117. <div class="row collapse"><div class="detail-description">
  1118. <div class="long_description"></div>
  1119. <h3>Parameters</h3>
  1120. <div class="subelement argument"><h4>$cellID</h4></div>
  1121. <div class="subelement argument"><h4>$operand</h4></div>
  1122. <div class="subelement argument"><h4>$stack</h4></div>
  1123. </div></div>
  1124. </div>
  1125. <a id="method_strcmpLowercaseFirst"></a><div class="element clickable method private method_strcmpLowercaseFirst" data-toggle="collapse" data-target=".method_strcmpLowercaseFirst .collapse">
  1126. <h2>Compare two strings in the same way as strcmp() except that lowercase come before uppercase letters</h2>
  1127. <pre>strcmpLowercaseFirst(string $str1, string $str2) : integer</pre>
  1128. <div class="labels"></div>
  1129. <div class="row collapse"><div class="detail-description">
  1130. <div class="long_description"></div>
  1131. <h3>Parameters</h3>
  1132. <div class="subelement argument">
  1133. <h4>$str1</h4>
  1134. <code>string</code>
  1135. </div>
  1136. <div class="subelement argument">
  1137. <h4>$str2</h4>
  1138. <code>string</code>
  1139. </div>
  1140. <h3>Returns</h3>
  1141. <div class="subelement response"><code>integer</code></div>
  1142. </div></div>
  1143. </div>
  1144. <h3>
  1145. <i class="icon-custom icon-property"></i> Properties</h3>
  1146. <a id="property__localeBoolean"> </a><div class="element clickable property public property__localeBoolean" data-toggle="collapse" data-target=".property__localeBoolean .collapse">
  1147. <h2></h2>
  1148. <pre>$_localeBoolean : string[]</pre>
  1149. <div class="labels"></div>
  1150. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  1151. </div>
  1152. <a id="property_cyclicFormulaCount"> </a><div class="element clickable property public property_cyclicFormulaCount" data-toggle="collapse" data-target=".property_cyclicFormulaCount .collapse">
  1153. <h2></h2>
  1154. <pre>$cyclicFormulaCount : integer</pre>
  1155. <div class="labels"></div>
  1156. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  1157. </div>
  1158. <a id="property_formulaError"> </a><div class="element clickable property public property_formulaError" data-toggle="collapse" data-target=".property_formulaError .collapse">
  1159. <h2></h2>
  1160. <pre>$formulaError : string</pre>
  1161. <div class="labels"></div>
  1162. <div class="row collapse"><div class="detail-description">
  1163. <div class="long_description"></div>
  1164. <table class="table table-bordered"><tr>
  1165. <th>access</th>
  1166. <td>public</td>
  1167. </tr></table>
  1168. </div></div>
  1169. </div>
  1170. <a id="property_suppressFormulaErrors"> </a><div class="element clickable property public property_suppressFormulaErrors" data-toggle="collapse" data-target=".property_suppressFormulaErrors .collapse">
  1171. <h2></h2>
  1172. <pre>$suppressFormulaErrors : boolean</pre>
  1173. <div class="labels"></div>
  1174. <div class="row collapse"><div class="detail-description">
  1175. <div class="long_description"></div>
  1176. <table class="table table-bordered"><tr>
  1177. <th>access</th>
  1178. <td>public</td>
  1179. </tr></table>
  1180. </div></div>
  1181. </div>
  1182. <a id="property__ExcelConstants"> </a><div class="element clickable property private property__ExcelConstants" data-toggle="collapse" data-target=".property__ExcelConstants .collapse">
  1183. <h2></h2>
  1184. <pre>$_ExcelConstants : string[]</pre>
  1185. <div class="labels"></div>
  1186. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  1187. </div>
  1188. <a id="property__PHPExcelFunctions"> </a><div class="element clickable property private property__PHPExcelFunctions" data-toggle="collapse" data-target=".property__PHPExcelFunctions .collapse">
  1189. <h2></h2>
  1190. <pre>$_PHPExcelFunctions </pre>
  1191. <div class="labels"></div>
  1192. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  1193. </div>
  1194. <a id="property__binaryOperators"> </a><div class="element clickable property private property__binaryOperators" data-toggle="collapse" data-target=".property__binaryOperators .collapse">
  1195. <h2></h2>
  1196. <pre>$_binaryOperators : array</pre>
  1197. <div class="labels"></div>
  1198. <div class="row collapse"><div class="detail-description">
  1199. <div class="long_description"></div>
  1200. <table class="table table-bordered"><tr>
  1201. <th>access</th>
  1202. <td>private</td>
  1203. </tr></table>
  1204. </div></div>
  1205. </div>
  1206. <a id="property__calculationCache"> </a><div class="element clickable property private property__calculationCache" data-toggle="collapse" data-target=".property__calculationCache .collapse">
  1207. <h2></h2>
  1208. <pre>$_calculationCache : array</pre>
  1209. <div class="labels"></div>
  1210. <div class="row collapse"><div class="detail-description">
  1211. <div class="long_description"></div>
  1212. <table class="table table-bordered"><tr>
  1213. <th>access</th>
  1214. <td>private</td>
  1215. </tr></table>
  1216. </div></div>
  1217. </div>
  1218. <a id="property__calculationCacheEnabled"> </a><div class="element clickable property private property__calculationCacheEnabled" data-toggle="collapse" data-target=".property__calculationCacheEnabled .collapse">
  1219. <h2></h2>
  1220. <pre>$_calculationCacheEnabled : boolean</pre>
  1221. <div class="labels"></div>
  1222. <div class="row collapse"><div class="detail-description">
  1223. <div class="long_description"></div>
  1224. <table class="table table-bordered"><tr>
  1225. <th>access</th>
  1226. <td>private</td>
  1227. </tr></table>
  1228. </div></div>
  1229. </div>
  1230. <a id="property__comparisonOperators"> </a><div class="element clickable property private property__comparisonOperators" data-toggle="collapse" data-target=".property__comparisonOperators .collapse">
  1231. <h2></h2>
  1232. <pre>$_comparisonOperators </pre>
  1233. <div class="labels"></div>
  1234. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  1235. </div>
  1236. <a id="property__controlFunctions"> </a><div class="element clickable property private property__controlFunctions" data-toggle="collapse" data-target=".property__controlFunctions .collapse">
  1237. <h2></h2>
  1238. <pre>$_controlFunctions </pre>
  1239. <div class="labels"></div>
  1240. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  1241. </div>
  1242. <a id="property__cyclicFormulaCell"> </a><div class="element clickable property private property__cyclicFormulaCell" data-toggle="collapse" data-target=".property__cyclicFormulaCell .collapse">
  1243. <h2></h2>
  1244. <pre>$_cyclicFormulaCell </pre>
  1245. <div class="labels"></div>
  1246. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  1247. </div>
  1248. <a id="property__cyclicFormulaCount"> </a><div class="element clickable property private property__cyclicFormulaCount" data-toggle="collapse" data-target=".property__cyclicFormulaCount .collapse">
  1249. <h2></h2>
  1250. <pre>$_cyclicFormulaCount : integer</pre>
  1251. <div class="labels"></div>
  1252. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  1253. </div>
  1254. <a id="property__cyclicReferenceStack"> </a><div class="element clickable property private property__cyclicReferenceStack" data-toggle="collapse" data-target=".property__cyclicReferenceStack .collapse">
  1255. <h2></h2>
  1256. <pre>$_cyclicReferenceStack : array</pre>
  1257. <div class="labels"></div>
  1258. <div class="row collapse"><div class="detail-description">
  1259. <div class="long_description"></div>
  1260. <table class="table table-bordered"><tr>
  1261. <th>access</th>
  1262. <td>private</td>
  1263. </tr></table>
  1264. </div></div>
  1265. </div>
  1266. <a id="property__instance"> </a><div class="element clickable property private property__instance" data-toggle="collapse" data-target=".property__instance .collapse">
  1267. <h2></h2>
  1268. <pre>$_instance : <a href="../classes/PHPExcel_Calculation.html">\PHPExcel_Calculation</a></pre>
  1269. <div class="labels"></div>
  1270. <div class="row collapse"><div class="detail-description">
  1271. <div class="long_description"></div>
  1272. <table class="table table-bordered"><tr>
  1273. <th>access</th>
  1274. <td>private</td>
  1275. </tr></table>
  1276. </div></div>
  1277. </div>
  1278. <a id="property__localeArgumentSeparator"> </a><div class="element clickable property private property__localeArgumentSeparator" data-toggle="collapse" data-target=".property__localeArgumentSeparator .collapse">
  1279. <h2></h2>
  1280. <pre>$_localeArgumentSeparator : string</pre>
  1281. <div class="labels"></div>
  1282. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  1283. </div>
  1284. <a id="property__localeFunctions"> </a><div class="element clickable property private property__localeFunctions" data-toggle="collapse" data-target=".property__localeFunctions .collapse">
  1285. <h2></h2>
  1286. <pre>$_localeFunctions </pre>
  1287. <div class="labels"></div>
  1288. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  1289. </div>
  1290. <a id="property__localeLanguage"> </a><div class="element clickable property private property__localeLanguage" data-toggle="collapse" data-target=".property__localeLanguage .collapse">
  1291. <h2></h2>
  1292. <pre>$_localeLanguage : string</pre>
  1293. <div class="labels"></div>
  1294. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  1295. </div>
  1296. <a id="property__operatorAssociativity"> </a><div class="element clickable property private property__operatorAssociativity" data-toggle="collapse" data-target=".property__operatorAssociativity .collapse">
  1297. <h2></h2>
  1298. <pre>$_operatorAssociativity </pre>
  1299. <div class="labels"></div>
  1300. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  1301. </div>
  1302. <a id="property__operatorPrecedence"> </a><div class="element clickable property private property__operatorPrecedence" data-toggle="collapse" data-target=".property__operatorPrecedence .collapse">
  1303. <h2></h2>
  1304. <pre>$_operatorPrecedence </pre>
  1305. <div class="labels"></div>
  1306. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  1307. </div>
  1308. <a id="property__operators"> </a><div class="element clickable property private property__operators" data-toggle="collapse" data-target=".property__operators .collapse">
  1309. <h2></h2>
  1310. <pre>$_operators : array</pre>
  1311. <div class="labels"></div>
  1312. <div class="row collapse"><div class="detail-description">
  1313. <div class="long_description"></div>
  1314. <table class="table table-bordered"><tr>
  1315. <th>access</th>
  1316. <td>private</td>
  1317. </tr></table>
  1318. </div></div>
  1319. </div>
  1320. <a id="property__savedPrecision"> </a><div class="element clickable property private property__savedPrecision" data-toggle="collapse" data-target=".property__savedPrecision .collapse">
  1321. <h2></h2>
  1322. <pre>$_savedPrecision : integer</pre>
  1323. <div class="labels"></div>
  1324. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  1325. </div>
  1326. <a id="property__validLocaleLanguages"> </a><div class="element clickable property private property__validLocaleLanguages" data-toggle="collapse" data-target=".property__validLocaleLanguages .collapse">
  1327. <h2></h2>
  1328. <pre>$_validLocaleLanguages : string[]</pre>
  1329. <div class="labels"></div>
  1330. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  1331. </div>
  1332. <a id="property__workbook"> </a><div class="element clickable property private property__workbook" data-toggle="collapse" data-target=".property__workbook .collapse">
  1333. <h2></h2>
  1334. <pre>$_workbook : <a href="../classes/PHPExcel.html">\PHPExcel</a></pre>
  1335. <div class="labels"></div>
  1336. <div class="row collapse"><div class="detail-description">
  1337. <div class="long_description"></div>
  1338. <table class="table table-bordered"><tr>
  1339. <th>access</th>
  1340. <td>private</td>
  1341. </tr></table>
  1342. </div></div>
  1343. </div>
  1344. <a id="property__workbookSets"> </a><div class="element clickable property private property__workbookSets" data-toggle="collapse" data-target=".property__workbookSets .collapse">
  1345. <h2></h2>
  1346. <pre>$_workbookSets : <a href="PHPExcel.Calculation.html#%5CPHPExcel_Calculation">\PHPExcel_Calculation[]</a></pre>
  1347. <div class="labels"></div>
  1348. <div class="row collapse"><div class="detail-description">
  1349. <div class="long_description"></div>
  1350. <table class="table table-bordered"><tr>
  1351. <th>access</th>
  1352. <td>private</td>
  1353. </tr></table>
  1354. </div></div>
  1355. </div>
  1356. <a id="property_debugLog"> </a><div class="element clickable property private property_debugLog" data-toggle="collapse" data-target=".property_debugLog .collapse">
  1357. <h2></h2>
  1358. <pre>$debugLog : <a href="../classes/PHPExcel_CalcEngine_Logger.html">\PHPExcel_CalcEngine_Logger</a></pre>
  1359. <div class="labels"></div>
  1360. <div class="row collapse"><div class="detail-description">
  1361. <div class="long_description"></div>
  1362. <table class="table table-bordered"><tr>
  1363. <th>access</th>
  1364. <td>private</td>
  1365. </tr></table>
  1366. </div></div>
  1367. </div>
  1368. <a id="property_functionReplaceFromExcel"> </a><div class="element clickable property private property_functionReplaceFromExcel" data-toggle="collapse" data-target=".property_functionReplaceFromExcel .collapse">
  1369. <h2></h2>
  1370. <pre>$functionReplaceFromExcel </pre>
  1371. <div class="labels"></div>
  1372. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  1373. </div>
  1374. <a id="property_functionReplaceFromLocale"> </a><div class="element clickable property private property_functionReplaceFromLocale" data-toggle="collapse" data-target=".property_functionReplaceFromLocale .collapse">
  1375. <h2></h2>
  1376. <pre>$functionReplaceFromLocale </pre>
  1377. <div class="labels"></div>
  1378. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  1379. </div>
  1380. <a id="property_functionReplaceToExcel"> </a><div class="element clickable property private property_functionReplaceToExcel" data-toggle="collapse" data-target=".property_functionReplaceToExcel .collapse">
  1381. <h2></h2>
  1382. <pre>$functionReplaceToExcel </pre>
  1383. <div class="labels"></div>
  1384. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  1385. </div>
  1386. <a id="property_functionReplaceToLocale"> </a><div class="element clickable property private property_functionReplaceToLocale" data-toggle="collapse" data-target=".property_functionReplaceToLocale .collapse">
  1387. <h2></h2>
  1388. <pre>$functionReplaceToLocale </pre>
  1389. <div class="labels"></div>
  1390. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  1391. </div>
  1392. <a id="property_returnArrayAsType"> </a><div class="element clickable property private property_returnArrayAsType" data-toggle="collapse" data-target=".property_returnArrayAsType .collapse">
  1393. <h2></h2>
  1394. <pre>$returnArrayAsType </pre>
  1395. <div class="labels"></div>
  1396. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  1397. </div>
  1398. <h3>
  1399. <i class="icon-custom icon-constant"></i> Constants</h3>
  1400. <a id="constant_CALCULATION_REGEXP_CELLREF"> </a><div class="element clickable constant constant_CALCULATION_REGEXP_CELLREF" data-toggle="collapse" data-target=".constant_CALCULATION_REGEXP_CELLREF .collapse">
  1401. <h2>CALCULATION_REGEXP_CELLREF</h2>
  1402. <pre>CALCULATION_REGEXP_CELLREF </pre>
  1403. <div class="labels"></div>
  1404. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  1405. </div>
  1406. <a id="constant_CALCULATION_REGEXP_ERROR"> </a><div class="element clickable constant constant_CALCULATION_REGEXP_ERROR" data-toggle="collapse" data-target=".constant_CALCULATION_REGEXP_ERROR .collapse">
  1407. <h2>CALCULATION_REGEXP_ERROR</h2>
  1408. <pre>CALCULATION_REGEXP_ERROR </pre>
  1409. <div class="labels"></div>
  1410. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  1411. </div>
  1412. <a id="constant_CALCULATION_REGEXP_FUNCTION"> </a><div class="element clickable constant constant_CALCULATION_REGEXP_FUNCTION" data-toggle="collapse" data-target=".constant_CALCULATION_REGEXP_FUNCTION .collapse">
  1413. <h2>CALCULATION_REGEXP_FUNCTION</h2>
  1414. <pre>CALCULATION_REGEXP_FUNCTION </pre>
  1415. <div class="labels"></div>
  1416. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  1417. </div>
  1418. <a id="constant_CALCULATION_REGEXP_NAMEDRANGE"> </a><div class="element clickable constant constant_CALCULATION_REGEXP_NAMEDRANGE" data-toggle="collapse" data-target=".constant_CALCULATION_REGEXP_NAMEDRANGE .collapse">
  1419. <h2>CALCULATION_REGEXP_NAMEDRANGE</h2>
  1420. <pre>CALCULATION_REGEXP_NAMEDRANGE </pre>
  1421. <div class="labels"></div>
  1422. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  1423. </div>
  1424. <a id="constant_CALCULATION_REGEXP_NUMBER"> </a><div class="element clickable constant constant_CALCULATION_REGEXP_NUMBER" data-toggle="collapse" data-target=".constant_CALCULATION_REGEXP_NUMBER .collapse">
  1425. <h2>CALCULATION_REGEXP_NUMBER</h2>
  1426. <pre>CALCULATION_REGEXP_NUMBER </pre>
  1427. <div class="labels"></div>
  1428. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  1429. </div>
  1430. <a id="constant_CALCULATION_REGEXP_OPENBRACE"> </a><div class="element clickable constant constant_CALCULATION_REGEXP_OPENBRACE" data-toggle="collapse" data-target=".constant_CALCULATION_REGEXP_OPENBRACE .collapse">
  1431. <h2>CALCULATION_REGEXP_OPENBRACE</h2>
  1432. <pre>CALCULATION_REGEXP_OPENBRACE </pre>
  1433. <div class="labels"></div>
  1434. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  1435. </div>
  1436. <a id="constant_CALCULATION_REGEXP_STRING"> </a><div class="element clickable constant constant_CALCULATION_REGEXP_STRING" data-toggle="collapse" data-target=".constant_CALCULATION_REGEXP_STRING .collapse">
  1437. <h2>CALCULATION_REGEXP_STRING</h2>
  1438. <pre>CALCULATION_REGEXP_STRING </pre>
  1439. <div class="labels"></div>
  1440. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  1441. </div>
  1442. <a id="constant_RETURN_ARRAY_AS_ARRAY"> </a><div class="element clickable constant constant_RETURN_ARRAY_AS_ARRAY" data-toggle="collapse" data-target=".constant_RETURN_ARRAY_AS_ARRAY .collapse">
  1443. <h2>RETURN_ARRAY_AS_ARRAY</h2>
  1444. <pre>RETURN_ARRAY_AS_ARRAY </pre>
  1445. <div class="labels"></div>
  1446. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  1447. </div>
  1448. <a id="constant_RETURN_ARRAY_AS_ERROR"> </a><div class="element clickable constant constant_RETURN_ARRAY_AS_ERROR" data-toggle="collapse" data-target=".constant_RETURN_ARRAY_AS_ERROR .collapse">
  1449. <h2>constants</h2>
  1450. <pre>RETURN_ARRAY_AS_ERROR </pre>
  1451. <div class="labels"></div>
  1452. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  1453. </div>
  1454. <a id="constant_RETURN_ARRAY_AS_VALUE"> </a><div class="element clickable constant constant_RETURN_ARRAY_AS_VALUE" data-toggle="collapse" data-target=".constant_RETURN_ARRAY_AS_VALUE .collapse">
  1455. <h2>RETURN_ARRAY_AS_VALUE</h2>
  1456. <pre>RETURN_ARRAY_AS_VALUE </pre>
  1457. <div class="labels"></div>
  1458. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  1459. </div>
  1460. </div>
  1461. </div>
  1462. </div>
  1463. </div>
  1464. <div class="row"><footer class="span12">
  1465. Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
  1466. Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a12</a> and<br>
  1467. generated on 2014-03-02T15:27:34Z.<br></footer></div>
  1468. </div>
  1469. </body>
  1470. </html>