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_Settings.html 36 KiB

3 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528
  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_Settings</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_getCacheStorageClass" title="getCacheStorageClass :: Return the name of the class that is currently being used for cell cacheing"><span class="description">Return the name of the class that is currently being used for cell cacheing</span><pre>getCacheStorageClass()</pre></a></li>
  96. <li class="method public "><a href="#method_getCacheStorageMethod" title="getCacheStorageMethod :: Return the name of the method that is currently configured for cell cacheing"><span class="description">Return the name of the method that is currently configured for cell cacheing</span><pre>getCacheStorageMethod()</pre></a></li>
  97. <li class="method public "><a href="#method_getChartRendererName" title="getChartRendererName :: Return the Chart Rendering Library that PHPExcel is currently configured to use (e.g."><span class="description">Return the Chart Rendering Library that PHPExcel is currently configured to use (e.g.</span><pre>getChartRendererName()</pre></a></li>
  98. <li class="method public "><a href="#method_getChartRendererPath" title="getChartRendererPath :: Return the directory path to the Chart Rendering Library that PHPExcel is currently configured to use"><span class="description">Return the directory path to the Chart Rendering Library that PHPExcel is currently configured to use</span><pre>getChartRendererPath()</pre></a></li>
  99. <li class="method public "><a href="#method_getLibXmlLoaderOptions" title="getLibXmlLoaderOptions :: Get default options for libxml loader."><span class="description">Get default options for libxml loader.</span><pre>getLibXmlLoaderOptions()</pre></a></li>
  100. <li class="method public "><a href="#method_getPdfRendererName" title="getPdfRendererName :: Return the PDF Rendering Library that PHPExcel is currently configured to use (e.g."><span class="description">Return the PDF Rendering Library that PHPExcel is currently configured to use (e.g.</span><pre>getPdfRendererName()</pre></a></li>
  101. <li class="method public "><a href="#method_getPdfRendererPath" title="getPdfRendererPath :: Return the directory path to the PDF Rendering Library that PHPExcel is currently configured to use"><span class="description">Return the directory path to the PDF Rendering Library that PHPExcel is currently configured to use</span><pre>getPdfRendererPath()</pre></a></li>
  102. <li class="method public "><a href="#method_getZipClass" title="getZipClass :: Return the name of the Zip handler Class that PHPExcel is configured to use (PCLZip or ZipArchive)
  103. or Zip file management"><span class="description">Return the name of the Zip handler Class that PHPExcel is configured to use (PCLZip or ZipArchive)
  104. or Zip file management</span><pre>getZipClass()</pre></a></li>
  105. <li class="method public "><a href="#method_setCacheStorageMethod" title="setCacheStorageMethod :: Set the method that should be used for cell cacheing"><span class="description">Set the method that should be used for cell cacheing</span><pre>setCacheStorageMethod()</pre></a></li>
  106. <li class="method public "><a href="#method_setChartRenderer" title="setChartRenderer :: Set details of the external library that PHPExcel should use for rendering charts"><span class="description">Set details of the external library that PHPExcel should use for rendering charts</span><pre>setChartRenderer()</pre></a></li>
  107. <li class="method public "><a href="#method_setChartRendererName" title="setChartRendererName :: Identify to PHPExcel the external library to use for rendering charts"><span class="description">Identify to PHPExcel the external library to use for rendering charts</span><pre>setChartRendererName()</pre></a></li>
  108. <li class="method public "><a href="#method_setChartRendererPath" title="setChartRendererPath :: Tell PHPExcel where to find the external library to use for rendering charts"><span class="description">Tell PHPExcel where to find the external library to use for rendering charts</span><pre>setChartRendererPath()</pre></a></li>
  109. <li class="method public "><a href="#method_setLibXmlLoaderOptions" title="setLibXmlLoaderOptions :: Set default options for libxml loader"><span class="description">Set default options for libxml loader</span><pre>setLibXmlLoaderOptions()</pre></a></li>
  110. <li class="method public "><a href="#method_setLocale" title="setLocale :: Set the locale code to use for formula translations and any special formatting"><span class="description">Set the locale code to use for formula translations and any special formatting</span><pre>setLocale()</pre></a></li>
  111. <li class="method public "><a href="#method_setPdfRenderer" title="setPdfRenderer :: Set details of the external library that PHPExcel should use for rendering PDF files"><span class="description">Set details of the external library that PHPExcel should use for rendering PDF files</span><pre>setPdfRenderer()</pre></a></li>
  112. <li class="method public "><a href="#method_setPdfRendererName" title="setPdfRendererName :: Identify to PHPExcel the external library to use for rendering PDF files"><span class="description">Identify to PHPExcel the external library to use for rendering PDF files</span><pre>setPdfRendererName()</pre></a></li>
  113. <li class="method public "><a href="#method_setPdfRendererPath" title="setPdfRendererPath :: Tell PHPExcel where to find the external library to use for rendering PDF files"><span class="description">Tell PHPExcel where to find the external library to use for rendering PDF files</span><pre>setPdfRendererPath()</pre></a></li>
  114. <li class="method public "><a href="#method_setZipClass" title="setZipClass :: Set the Zip handler Class that PHPExcel should use for Zip file management (PCLZip or ZipArchive)"><span class="description">Set the Zip handler Class that PHPExcel should use for Zip file management (PCLZip or ZipArchive)</span><pre>setZipClass()</pre></a></li>
  115. </ul>
  116. </li>
  117. <li class="nav-header">
  118. <i class="icon-custom icon-property"></i> Properties
  119. <ul></ul>
  120. </li>
  121. <li class="nav-header private">» Private
  122. <ul>
  123. <li class="property private "><a href="#property__chartRendererName" title="$_chartRendererName :: Name of the external Library used for rendering charts
  124. e.g."><span class="description"></span><pre>$_chartRendererName</pre></a></li>
  125. <li class="property private "><a href="#property__chartRendererPath" title="$_chartRendererPath :: Directory Path to the external Library used for rendering charts"><span class="description"></span><pre>$_chartRendererPath</pre></a></li>
  126. <li class="property private "><a href="#property__chartRenderers" title="$_chartRenderers :: "><span class="description"></span><pre>$_chartRenderers</pre></a></li>
  127. <li class="property private "><a href="#property__libXmlLoaderOptions" title="$_libXmlLoaderOptions :: Default options for libxml loader"><span class="description"></span><pre>$_libXmlLoaderOptions</pre></a></li>
  128. <li class="property private "><a href="#property__pdfRendererName" title="$_pdfRendererName :: Name of the external Library used for rendering PDF files
  129. e.g."><span class="description"></span><pre>$_pdfRendererName</pre></a></li>
  130. <li class="property private "><a href="#property__pdfRendererPath" title="$_pdfRendererPath :: Directory Path to the external Library used for rendering PDF files"><span class="description"></span><pre>$_pdfRendererPath</pre></a></li>
  131. <li class="property private "><a href="#property__pdfRenderers" title="$_pdfRenderers :: "><span class="description"></span><pre>$_pdfRenderers</pre></a></li>
  132. <li class="property private "><a href="#property__zipClass" title="$_zipClass :: Name of the class used for Zip file management
  133. e.g."><span class="description"></span><pre>$_zipClass</pre></a></li>
  134. </ul>
  135. </li>
  136. <li class="nav-header">
  137. <i class="icon-custom icon-constant"></i> Constants
  138. <ul>
  139. <li class="constant "><a href="#constant_CHART_RENDERER_JPGRAPH" title="CHART_RENDERER_JPGRAPH :: Optional Chart Rendering libraries"><span class="description">Optional Chart Rendering libraries</span><pre>CHART_RENDERER_JPGRAPH</pre></a></li>
  140. <li class="constant "><a href="#constant_PCLZIP" title="PCLZIP :: Available Zip library classes"><span class="description">Available Zip library classes</span><pre>PCLZIP</pre></a></li>
  141. <li class="constant "><a href="#constant_PDF_RENDERER_DOMPDF" title="PDF_RENDERER_DOMPDF :: "><span class="description">PDF_RENDERER_DOMPDF</span><pre>PDF_RENDERER_DOMPDF</pre></a></li>
  142. <li class="constant "><a href="#constant_PDF_RENDERER_MPDF" title="PDF_RENDERER_MPDF :: "><span class="description">PDF_RENDERER_MPDF</span><pre>PDF_RENDERER_MPDF</pre></a></li>
  143. <li class="constant "><a href="#constant_PDF_RENDERER_TCPDF" title="PDF_RENDERER_TCPDF :: Optional PDF Rendering libraries"><span class="description">Optional PDF Rendering libraries</span><pre>PDF_RENDERER_TCPDF</pre></a></li>
  144. <li class="constant "><a href="#constant_ZIPARCHIVE" title="ZIPARCHIVE :: "><span class="description">ZIPARCHIVE</span><pre>ZIPARCHIVE</pre></a></li>
  145. </ul>
  146. </li>
  147. </ul>
  148. </div>
  149. <div class="span8">
  150. <a id="\PHPExcel_Settings"></a><ul class="breadcrumb">
  151. <li>
  152. <a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
  153. </li>
  154. <li><a href="../namespaces/global.html">global</a></li>
  155. <li class="active">
  156. <span class="divider">\</span><a href="../classes/PHPExcel_Settings.html">PHPExcel_Settings</a>
  157. </li>
  158. </ul>
  159. <div class="element class"><div class="details">
  160. <h3>
  161. <i class="icon-custom icon-method"></i> Methods</h3>
  162. <a id="method_getCacheStorageClass"></a><div class="element clickable method public method_getCacheStorageClass" data-toggle="collapse" data-target=".method_getCacheStorageClass .collapse">
  163. <h2>Return the name of the class that is currently being used for cell cacheing</h2>
  164. <pre>getCacheStorageClass() : string</pre>
  165. <div class="labels"><span class="label">Static</span></div>
  166. <div class="row collapse"><div class="detail-description">
  167. <div class="long_description"></div>
  168. <h3>Returns</h3>
  169. <div class="subelement response">
  170. <code>string</code>Name of the class currently being used for cacheing</div>
  171. </div></div>
  172. </div>
  173. <a id="method_getCacheStorageMethod"></a><div class="element clickable method public method_getCacheStorageMethod" data-toggle="collapse" data-target=".method_getCacheStorageMethod .collapse">
  174. <h2>Return the name of the method that is currently configured for cell cacheing</h2>
  175. <pre>getCacheStorageMethod() : string</pre>
  176. <div class="labels"><span class="label">Static</span></div>
  177. <div class="row collapse"><div class="detail-description">
  178. <div class="long_description"></div>
  179. <h3>Returns</h3>
  180. <div class="subelement response">
  181. <code>string</code>Name of the cacheing method</div>
  182. </div></div>
  183. </div>
  184. <a id="method_getChartRendererName"></a><div class="element clickable method public method_getChartRendererName" data-toggle="collapse" data-target=".method_getChartRendererName .collapse">
  185. <h2>Return the Chart Rendering Library that PHPExcel is currently configured to use (e.g.</h2>
  186. <pre>getChartRendererName() : string | NULL</pre>
  187. <div class="labels"><span class="label">Static</span></div>
  188. <div class="row collapse"><div class="detail-description">
  189. <div class="long_description"><p>jpgraph)</p></div>
  190. <h3>Returns</h3>
  191. <div class="subelement response">
  192. <code>string</code><code>NULL</code>Internal reference name of the Chart Rendering Library that PHPExcel is
  193. currently configured to use
  194. e.g. PHPExcel_Settings::CHART_RENDERER_JPGRAPH</div>
  195. </div></div>
  196. </div>
  197. <a id="method_getChartRendererPath"></a><div class="element clickable method public method_getChartRendererPath" data-toggle="collapse" data-target=".method_getChartRendererPath .collapse">
  198. <h2>Return the directory path to the Chart Rendering Library that PHPExcel is currently configured to use</h2>
  199. <pre>getChartRendererPath() : string | NULL</pre>
  200. <div class="labels"><span class="label">Static</span></div>
  201. <div class="row collapse"><div class="detail-description">
  202. <div class="long_description"></div>
  203. <h3>Returns</h3>
  204. <div class="subelement response">
  205. <code>string</code><code>NULL</code>Directory Path to the Chart Rendering Library that PHPExcel is
  206. currently configured to use</div>
  207. </div></div>
  208. </div>
  209. <a id="method_getLibXmlLoaderOptions"></a><div class="element clickable method public method_getLibXmlLoaderOptions" data-toggle="collapse" data-target=".method_getLibXmlLoaderOptions .collapse">
  210. <h2>Get default options for libxml loader.</h2>
  211. <pre>getLibXmlLoaderOptions() : int</pre>
  212. <div class="labels"><span class="label">Static</span></div>
  213. <div class="row collapse"><div class="detail-description">
  214. <div class="long_description"><p>Defaults to LIBXML_DTDLOAD | LIBXML_DTDATTR when not set explicitly.</p></div>
  215. <h3>Returns</h3>
  216. <div class="subelement response">
  217. <code>int</code>Default options for libxml loader</div>
  218. </div></div>
  219. </div>
  220. <a id="method_getPdfRendererName"></a><div class="element clickable method public method_getPdfRendererName" data-toggle="collapse" data-target=".method_getPdfRendererName .collapse">
  221. <h2>Return the PDF Rendering Library that PHPExcel is currently configured to use (e.g.</h2>
  222. <pre>getPdfRendererName() : string | NULL</pre>
  223. <div class="labels"><span class="label">Static</span></div>
  224. <div class="row collapse"><div class="detail-description">
  225. <div class="long_description"><p>dompdf)</p></div>
  226. <h3>Returns</h3>
  227. <div class="subelement response">
  228. <code>string</code><code>NULL</code>Internal reference name of the PDF Rendering Library that PHPExcel is
  229. currently configured to use
  230. e.g. PHPExcel_Settings::PDF_RENDERER_TCPDF,
  231. PHPExcel_Settings::PDF_RENDERER_DOMPDF
  232. or PHPExcel_Settings::PDF_RENDERER_MPDF</div>
  233. </div></div>
  234. </div>
  235. <a id="method_getPdfRendererPath"></a><div class="element clickable method public method_getPdfRendererPath" data-toggle="collapse" data-target=".method_getPdfRendererPath .collapse">
  236. <h2>Return the directory path to the PDF Rendering Library that PHPExcel is currently configured to use</h2>
  237. <pre>getPdfRendererPath() : string | NULL</pre>
  238. <div class="labels"><span class="label">Static</span></div>
  239. <div class="row collapse"><div class="detail-description">
  240. <div class="long_description"></div>
  241. <h3>Returns</h3>
  242. <div class="subelement response">
  243. <code>string</code><code>NULL</code>Directory Path to the PDF Rendering Library that PHPExcel is
  244. currently configured to use</div>
  245. </div></div>
  246. </div>
  247. <a id="method_getZipClass"></a><div class="element clickable method public method_getZipClass" data-toggle="collapse" data-target=".method_getZipClass .collapse">
  248. <h2>Return the name of the Zip handler Class that PHPExcel is configured to use (PCLZip or ZipArchive)
  249. or Zip file management</h2>
  250. <pre>getZipClass() : string</pre>
  251. <div class="labels"><span class="label">Static</span></div>
  252. <div class="row collapse"><div class="detail-description">
  253. <div class="long_description"></div>
  254. <h3>Returns</h3>
  255. <div class="subelement response">
  256. <code>string</code>Name of the Zip handler Class that PHPExcel is configured to use
  257. for Zip file management
  258. e.g. PHPExcel_Settings::PCLZip or PHPExcel_Settings::ZipArchive</div>
  259. </div></div>
  260. </div>
  261. <a id="method_setCacheStorageMethod"></a><div class="element clickable method public method_setCacheStorageMethod" data-toggle="collapse" data-target=".method_setCacheStorageMethod .collapse">
  262. <h2>Set the method that should be used for cell cacheing</h2>
  263. <pre>setCacheStorageMethod(string $method, array $arguments) : boolean</pre>
  264. <div class="labels"><span class="label">Static</span></div>
  265. <div class="row collapse"><div class="detail-description">
  266. <div class="long_description"></div>
  267. <h3>Parameters</h3>
  268. <div class="subelement argument">
  269. <h4>$method</h4>
  270. <code>string</code><p>Name of the cacheing method</p></div>
  271. <div class="subelement argument">
  272. <h4>$arguments</h4>
  273. <code>array</code><p>Optional configuration arguments for the cacheing method</p></div>
  274. <h3>Returns</h3>
  275. <div class="subelement response">
  276. <code>boolean</code>Success or failure</div>
  277. </div></div>
  278. </div>
  279. <a id="method_setChartRenderer"></a><div class="element clickable method public method_setChartRenderer" data-toggle="collapse" data-target=".method_setChartRenderer .collapse">
  280. <h2>Set details of the external library that PHPExcel should use for rendering charts</h2>
  281. <pre>setChartRenderer(string $libraryName, string $libraryBaseDir) : boolean</pre>
  282. <div class="labels"><span class="label">Static</span></div>
  283. <div class="row collapse"><div class="detail-description">
  284. <div class="long_description"></div>
  285. <h3>Parameters</h3>
  286. <div class="subelement argument">
  287. <h4>$libraryName</h4>
  288. <code>string</code><p>Internal reference name of the library
  289. e.g. PHPExcel_Settings::CHART_RENDERER_JPGRAPH</p></div>
  290. <div class="subelement argument">
  291. <h4>$libraryBaseDir</h4>
  292. <code>string</code><p>Directory path to the library's base folder</p>
  293. </div>
  294. <h3>Returns</h3>
  295. <div class="subelement response">
  296. <code>boolean</code>Success or failure</div>
  297. </div></div>
  298. </div>
  299. <a id="method_setChartRendererName"></a><div class="element clickable method public method_setChartRendererName" data-toggle="collapse" data-target=".method_setChartRendererName .collapse">
  300. <h2>Identify to PHPExcel the external library to use for rendering charts</h2>
  301. <pre>setChartRendererName(string $libraryName) : boolean</pre>
  302. <div class="labels"><span class="label">Static</span></div>
  303. <div class="row collapse"><div class="detail-description">
  304. <div class="long_description"></div>
  305. <h3>Parameters</h3>
  306. <div class="subelement argument">
  307. <h4>$libraryName</h4>
  308. <code>string</code><p>Internal reference name of the library
  309. e.g. PHPExcel_Settings::CHART_RENDERER_JPGRAPH</p></div>
  310. <h3>Returns</h3>
  311. <div class="subelement response">
  312. <code>boolean</code>Success or failure</div>
  313. </div></div>
  314. </div>
  315. <a id="method_setChartRendererPath"></a><div class="element clickable method public method_setChartRendererPath" data-toggle="collapse" data-target=".method_setChartRendererPath .collapse">
  316. <h2>Tell PHPExcel where to find the external library to use for rendering charts</h2>
  317. <pre>setChartRendererPath(string $libraryBaseDir) : boolean</pre>
  318. <div class="labels"><span class="label">Static</span></div>
  319. <div class="row collapse"><div class="detail-description">
  320. <div class="long_description"></div>
  321. <h3>Parameters</h3>
  322. <div class="subelement argument">
  323. <h4>$libraryBaseDir</h4>
  324. <code>string</code><p>Directory path to the library's base folder</p>
  325. </div>
  326. <h3>Returns</h3>
  327. <div class="subelement response">
  328. <code>boolean</code>Success or failure</div>
  329. </div></div>
  330. </div>
  331. <a id="method_setLibXmlLoaderOptions"></a><div class="element clickable method public method_setLibXmlLoaderOptions" data-toggle="collapse" data-target=".method_setLibXmlLoaderOptions .collapse">
  332. <h2>Set default options for libxml loader</h2>
  333. <pre>setLibXmlLoaderOptions(int $options) </pre>
  334. <div class="labels"><span class="label">Static</span></div>
  335. <div class="row collapse"><div class="detail-description">
  336. <div class="long_description"></div>
  337. <h3>Parameters</h3>
  338. <div class="subelement argument">
  339. <h4>$options</h4>
  340. <code>int</code><p>Default options for libxml loader</p></div>
  341. </div></div>
  342. </div>
  343. <a id="method_setLocale"></a><div class="element clickable method public method_setLocale" data-toggle="collapse" data-target=".method_setLocale .collapse">
  344. <h2>Set the locale code to use for formula translations and any special formatting</h2>
  345. <pre>setLocale(string $locale) : boolean</pre>
  346. <div class="labels"><span class="label">Static</span></div>
  347. <div class="row collapse"><div class="detail-description">
  348. <div class="long_description"></div>
  349. <h3>Parameters</h3>
  350. <div class="subelement argument">
  351. <h4>$locale</h4>
  352. <code>string</code><p>The locale code to use (e.g. "fr" or "pt_br" or "en_uk")</p>
  353. </div>
  354. <h3>Returns</h3>
  355. <div class="subelement response">
  356. <code>boolean</code>Success or failure</div>
  357. </div></div>
  358. </div>
  359. <a id="method_setPdfRenderer"></a><div class="element clickable method public method_setPdfRenderer" data-toggle="collapse" data-target=".method_setPdfRenderer .collapse">
  360. <h2>Set details of the external library that PHPExcel should use for rendering PDF files</h2>
  361. <pre>setPdfRenderer(string $libraryName, string $libraryBaseDir) : boolean</pre>
  362. <div class="labels"><span class="label">Static</span></div>
  363. <div class="row collapse"><div class="detail-description">
  364. <div class="long_description"></div>
  365. <h3>Parameters</h3>
  366. <div class="subelement argument">
  367. <h4>$libraryName</h4>
  368. <code>string</code><p>Internal reference name of the library
  369. e.g. PHPExcel_Settings::PDF_RENDERER_TCPDF,
  370. PHPExcel_Settings::PDF_RENDERER_DOMPDF
  371. or PHPExcel_Settings::PDF_RENDERER_MPDF</p></div>
  372. <div class="subelement argument">
  373. <h4>$libraryBaseDir</h4>
  374. <code>string</code><p>Directory path to the library's base folder</p>
  375. </div>
  376. <h3>Returns</h3>
  377. <div class="subelement response">
  378. <code>boolean</code>Success or failure</div>
  379. </div></div>
  380. </div>
  381. <a id="method_setPdfRendererName"></a><div class="element clickable method public method_setPdfRendererName" data-toggle="collapse" data-target=".method_setPdfRendererName .collapse">
  382. <h2>Identify to PHPExcel the external library to use for rendering PDF files</h2>
  383. <pre>setPdfRendererName(string $libraryName) : boolean</pre>
  384. <div class="labels"><span class="label">Static</span></div>
  385. <div class="row collapse"><div class="detail-description">
  386. <div class="long_description"></div>
  387. <h3>Parameters</h3>
  388. <div class="subelement argument">
  389. <h4>$libraryName</h4>
  390. <code>string</code><p>Internal reference name of the library
  391. e.g. PHPExcel_Settings::PDF_RENDERER_TCPDF,
  392. PHPExcel_Settings::PDF_RENDERER_DOMPDF
  393. or PHPExcel_Settings::PDF_RENDERER_MPDF</p></div>
  394. <h3>Returns</h3>
  395. <div class="subelement response">
  396. <code>boolean</code>Success or failure</div>
  397. </div></div>
  398. </div>
  399. <a id="method_setPdfRendererPath"></a><div class="element clickable method public method_setPdfRendererPath" data-toggle="collapse" data-target=".method_setPdfRendererPath .collapse">
  400. <h2>Tell PHPExcel where to find the external library to use for rendering PDF files</h2>
  401. <pre>setPdfRendererPath(string $libraryBaseDir) : boolean</pre>
  402. <div class="labels"><span class="label">Static</span></div>
  403. <div class="row collapse"><div class="detail-description">
  404. <div class="long_description"></div>
  405. <h3>Parameters</h3>
  406. <div class="subelement argument">
  407. <h4>$libraryBaseDir</h4>
  408. <code>string</code><p>Directory path to the library's base folder</p>
  409. </div>
  410. <h3>Returns</h3>
  411. <div class="subelement response">
  412. <code>boolean</code>Success or failure</div>
  413. </div></div>
  414. </div>
  415. <a id="method_setZipClass"></a><div class="element clickable method public method_setZipClass" data-toggle="collapse" data-target=".method_setZipClass .collapse">
  416. <h2>Set the Zip handler Class that PHPExcel should use for Zip file management (PCLZip or ZipArchive)</h2>
  417. <pre>setZipClass(string $zipClass) : boolean</pre>
  418. <div class="labels"><span class="label">Static</span></div>
  419. <div class="row collapse"><div class="detail-description">
  420. <div class="long_description"></div>
  421. <h3>Parameters</h3>
  422. <div class="subelement argument">
  423. <h4>$zipClass</h4>
  424. <code>string</code><p>The Zip handler class that PHPExcel should use for Zip file management
  425. e.g. PHPExcel_Settings::PCLZip or PHPExcel_Settings::ZipArchive</p></div>
  426. <h3>Returns</h3>
  427. <div class="subelement response">
  428. <code>boolean</code>Success or failure</div>
  429. </div></div>
  430. </div>
  431. <h3>
  432. <i class="icon-custom icon-property"></i> Properties</h3>
  433. <a id="property__chartRendererName"> </a><div class="element clickable property private property__chartRendererName" data-toggle="collapse" data-target=".property__chartRendererName .collapse">
  434. <h2></h2>
  435. <pre>$_chartRendererName : string</pre>
  436. <div class="labels"></div>
  437. <div class="row collapse"><div class="detail-description"><div class="long_description"><p>jpgraph</p></div></div></div>
  438. </div>
  439. <a id="property__chartRendererPath"> </a><div class="element clickable property private property__chartRendererPath" data-toggle="collapse" data-target=".property__chartRendererPath .collapse">
  440. <h2></h2>
  441. <pre>$_chartRendererPath : string</pre>
  442. <div class="labels"></div>
  443. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  444. </div>
  445. <a id="property__chartRenderers"> </a><div class="element clickable property private property__chartRenderers" data-toggle="collapse" data-target=".property__chartRenderers .collapse">
  446. <h2></h2>
  447. <pre>$_chartRenderers </pre>
  448. <div class="labels"></div>
  449. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  450. </div>
  451. <a id="property__libXmlLoaderOptions"> </a><div class="element clickable property private property__libXmlLoaderOptions" data-toggle="collapse" data-target=".property__libXmlLoaderOptions .collapse">
  452. <h2></h2>
  453. <pre>$_libXmlLoaderOptions : int</pre>
  454. <div class="labels"></div>
  455. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  456. </div>
  457. <a id="property__pdfRendererName"> </a><div class="element clickable property private property__pdfRendererName" data-toggle="collapse" data-target=".property__pdfRendererName .collapse">
  458. <h2></h2>
  459. <pre>$_pdfRendererName : string</pre>
  460. <div class="labels"></div>
  461. <div class="row collapse"><div class="detail-description"><div class="long_description"><p>mPDF</p></div></div></div>
  462. </div>
  463. <a id="property__pdfRendererPath"> </a><div class="element clickable property private property__pdfRendererPath" data-toggle="collapse" data-target=".property__pdfRendererPath .collapse">
  464. <h2></h2>
  465. <pre>$_pdfRendererPath : string</pre>
  466. <div class="labels"></div>
  467. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  468. </div>
  469. <a id="property__pdfRenderers"> </a><div class="element clickable property private property__pdfRenderers" data-toggle="collapse" data-target=".property__pdfRenderers .collapse">
  470. <h2></h2>
  471. <pre>$_pdfRenderers </pre>
  472. <div class="labels"></div>
  473. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  474. </div>
  475. <a id="property__zipClass"> </a><div class="element clickable property private property__zipClass" data-toggle="collapse" data-target=".property__zipClass .collapse">
  476. <h2></h2>
  477. <pre>$_zipClass : string</pre>
  478. <div class="labels"></div>
  479. <div class="row collapse"><div class="detail-description"><div class="long_description"><p>ZipArchive</p></div></div></div>
  480. </div>
  481. <h3>
  482. <i class="icon-custom icon-constant"></i> Constants</h3>
  483. <a id="constant_CHART_RENDERER_JPGRAPH"> </a><div class="element clickable constant constant_CHART_RENDERER_JPGRAPH" data-toggle="collapse" data-target=".constant_CHART_RENDERER_JPGRAPH .collapse">
  484. <h2>Optional Chart Rendering libraries</h2>
  485. <pre>CHART_RENDERER_JPGRAPH </pre>
  486. <div class="labels"></div>
  487. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  488. </div>
  489. <a id="constant_PCLZIP"> </a><div class="element clickable constant constant_PCLZIP" data-toggle="collapse" data-target=".constant_PCLZIP .collapse">
  490. <h2>Available Zip library classes</h2>
  491. <pre>PCLZIP </pre>
  492. <div class="labels"></div>
  493. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  494. </div>
  495. <a id="constant_PDF_RENDERER_DOMPDF"> </a><div class="element clickable constant constant_PDF_RENDERER_DOMPDF" data-toggle="collapse" data-target=".constant_PDF_RENDERER_DOMPDF .collapse">
  496. <h2>PDF_RENDERER_DOMPDF</h2>
  497. <pre>PDF_RENDERER_DOMPDF </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="constant_PDF_RENDERER_MPDF"> </a><div class="element clickable constant constant_PDF_RENDERER_MPDF" data-toggle="collapse" data-target=".constant_PDF_RENDERER_MPDF .collapse">
  502. <h2>PDF_RENDERER_MPDF</h2>
  503. <pre>PDF_RENDERER_MPDF </pre>
  504. <div class="labels"></div>
  505. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  506. </div>
  507. <a id="constant_PDF_RENDERER_TCPDF"> </a><div class="element clickable constant constant_PDF_RENDERER_TCPDF" data-toggle="collapse" data-target=".constant_PDF_RENDERER_TCPDF .collapse">
  508. <h2>Optional PDF Rendering libraries</h2>
  509. <pre>PDF_RENDERER_TCPDF </pre>
  510. <div class="labels"></div>
  511. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  512. </div>
  513. <a id="constant_ZIPARCHIVE"> </a><div class="element clickable constant constant_ZIPARCHIVE" data-toggle="collapse" data-target=".constant_ZIPARCHIVE .collapse">
  514. <h2>ZIPARCHIVE</h2>
  515. <pre>ZIPARCHIVE </pre>
  516. <div class="labels"></div>
  517. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  518. </div>
  519. </div></div>
  520. </div>
  521. </div>
  522. <div class="row"><footer class="span12">
  523. 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>
  524. Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a12</a> and<br>
  525. generated on 2014-03-02T15:27:36Z.<br></footer></div>
  526. </div>
  527. </body>
  528. </html>