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.
 
 
 
 

617 rivejä
36 KiB

  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_Reader_Gnumeric</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___construct" title="__construct :: Create a new PHPExcel_Reader_Gnumeric"><span class="description">Create a new PHPExcel_Reader_Gnumeric</span><pre>__construct()</pre></a></li>
  96. <li class="method public "><a href="#method_canRead" title="canRead :: Can the current PHPExcel_Reader_IReader read the file?"><span class="description">Can the current PHPExcel_Reader_IReader read the file?</span><pre>canRead()</pre></a></li>
  97. <li class="method public inherited"><a href="#method_getIncludeCharts" title="getIncludeCharts :: Read charts in workbook?
  98. If this is true, then the Reader will include any charts that exist in the workbook."><span class="description">Read charts in workbook?
  99. If this is true, then the Reader will include any charts that exist in the workbook.</span><pre>getIncludeCharts()</pre></a></li>
  100. <li class="method public inherited"><a href="#method_getLoadSheetsOnly" title="getLoadSheetsOnly :: Get which sheets to load
  101. Returns either an array of worksheet names (the list of worksheets that should be loaded), or a null
  102. indicating that all worksheets in the workbook should be loaded."><span class="description">Get which sheets to load
  103. Returns either an array of worksheet names (the list of worksheets that should be loaded), or a null
  104. indicating that all worksheets in the workbook should be loaded.</span><pre>getLoadSheetsOnly()</pre></a></li>
  105. <li class="method public inherited"><a href="#method_getReadDataOnly" title="getReadDataOnly :: Read data only?
  106. If this is true, then the Reader will only read data values for cells, it will not read any formatting information."><span class="description">Read data only?
  107. If this is true, then the Reader will only read data values for cells, it will not read any formatting information.</span><pre>getReadDataOnly()</pre></a></li>
  108. <li class="method public inherited"><a href="#method_getReadFilter" title="getReadFilter :: Read filter"><span class="description">Read filter</span><pre>getReadFilter()</pre></a></li>
  109. <li class="method public "><a href="#method_listWorksheetInfo" title="listWorksheetInfo :: Return worksheet info (Name, Last Column Letter, Last Column Index, Total Rows, Total Columns)"><span class="description">Return worksheet info (Name, Last Column Letter, Last Column Index, Total Rows, Total Columns)</span><pre>listWorksheetInfo()</pre></a></li>
  110. <li class="method public "><a href="#method_listWorksheetNames" title="listWorksheetNames :: Reads names of the worksheets from a file, without parsing the whole file to a PHPExcel object"><span class="description">Reads names of the worksheets from a file, without parsing the whole file to a PHPExcel object</span><pre>listWorksheetNames()</pre></a></li>
  111. <li class="method public "><a href="#method_load" title="load :: Loads PHPExcel from file"><span class="description">Loads PHPExcel from file</span><pre>load()</pre></a></li>
  112. <li class="method public "><a href="#method_loadIntoExisting" title="loadIntoExisting :: Loads PHPExcel from file into PHPExcel instance"><span class="description">Loads PHPExcel from file into PHPExcel instance</span><pre>loadIntoExisting()</pre></a></li>
  113. <li class="method public inherited"><a href="#method_setIncludeCharts" title="setIncludeCharts :: Set read charts in workbook
  114. Set to true, to advise the Reader to include any charts that exist in the workbook."><span class="description">Set read charts in workbook
  115. Set to true, to advise the Reader to include any charts that exist in the workbook.</span><pre>setIncludeCharts()</pre></a></li>
  116. <li class="method public inherited"><a href="#method_setLoadAllSheets" title="setLoadAllSheets :: Set all sheets to load
  117. Tells the Reader to load all worksheets from the workbook."><span class="description">Set all sheets to load
  118. Tells the Reader to load all worksheets from the workbook.</span><pre>setLoadAllSheets()</pre></a></li>
  119. <li class="method public inherited"><a href="#method_setLoadSheetsOnly" title="setLoadSheetsOnly :: Set which sheets to load"><span class="description">Set which sheets to load</span><pre>setLoadSheetsOnly()</pre></a></li>
  120. <li class="method public inherited"><a href="#method_setReadDataOnly" title="setReadDataOnly :: Set read data only
  121. Set to true, to advise the Reader only to read data values for cells, and to ignore any formatting information."><span class="description">Set read data only
  122. Set to true, to advise the Reader only to read data values for cells, and to ignore any formatting information.</span><pre>setReadDataOnly()</pre></a></li>
  123. <li class="method public inherited"><a href="#method_setReadFilter" title="setReadFilter :: Set read filter"><span class="description">Set read filter</span><pre>setReadFilter()</pre></a></li>
  124. </ul>
  125. </li>
  126. <li class="nav-header protected">» Protected
  127. <ul><li class="method protected inherited"><a href="#method__openFile" title="_openFile :: Open file for reading"><span class="description">Open file for reading</span><pre>_openFile()</pre></a></li></ul>
  128. </li>
  129. <li class="nav-header private">» Private
  130. <ul>
  131. <li class="method private "><a href="#method__gzfileGetContents" title="_gzfileGetContents :: "><span class="description">_gzfileGetContents()
  132. </span><pre>_gzfileGetContents()</pre></a></li>
  133. <li class="method private "><a href="#method__parseBorderAttributes" title="_parseBorderAttributes :: "><span class="description">_parseBorderAttributes()
  134. </span><pre>_parseBorderAttributes()</pre></a></li>
  135. <li class="method private "><a href="#method__parseGnumericColour" title="_parseGnumericColour :: "><span class="description">_parseGnumericColour()
  136. </span><pre>_parseGnumericColour()</pre></a></li>
  137. <li class="method private "><a href="#method__parseRichText" title="_parseRichText :: "><span class="description">_parseRichText()
  138. </span><pre>_parseRichText()</pre></a></li>
  139. </ul>
  140. </li>
  141. <li class="nav-header">
  142. <i class="icon-custom icon-property"></i> Properties
  143. <ul></ul>
  144. </li>
  145. <li class="nav-header protected">» Protected
  146. <ul>
  147. <li class="property protected inherited"><a href="#property__fileHandle" title="$_fileHandle :: "><span class="description"></span><pre>$_fileHandle</pre></a></li>
  148. <li class="property protected inherited"><a href="#property__includeCharts" title="$_includeCharts :: Read charts that are defined in the workbook?
  149. Identifies whether the Reader should read the definitions for any charts that exist in the workbook;"><span class="description"></span><pre>$_includeCharts</pre></a></li>
  150. <li class="property protected inherited"><a href="#property__loadSheetsOnly" title="$_loadSheetsOnly :: Restrict which sheets should be loaded?
  151. This property holds an array of worksheet names to be loaded."><span class="description"></span><pre>$_loadSheetsOnly</pre></a></li>
  152. <li class="property protected inherited"><a href="#property__readDataOnly" title="$_readDataOnly :: Read data only?
  153. Identifies whether the Reader should only read data values for cells, and ignore any formatting information;
  154. or whether it should read both data and formatting"><span class="description"></span><pre>$_readDataOnly</pre></a></li>
  155. <li class="property protected inherited"><a href="#property__readFilter" title="$_readFilter :: PHPExcel_Reader_IReadFilter instance"><span class="description"></span><pre>$_readFilter</pre></a></li>
  156. </ul>
  157. </li>
  158. <li class="nav-header private">» Private
  159. <ul>
  160. <li class="property private "><a href="#property__expressions" title="$_expressions :: Shared Expressions"><span class="description"></span><pre>$_expressions</pre></a></li>
  161. <li class="property private "><a href="#property__referenceHelper" title="$_referenceHelper :: "><span class="description"></span><pre>$_referenceHelper</pre></a></li>
  162. <li class="property private "><a href="#property__styles" title="$_styles :: Formats"><span class="description"></span><pre>$_styles</pre></a></li>
  163. </ul>
  164. </li>
  165. </ul>
  166. </div>
  167. <div class="span8">
  168. <a id="\PHPExcel_Reader_Gnumeric"></a><ul class="breadcrumb">
  169. <li>
  170. <a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
  171. </li>
  172. <li><a href="../namespaces/global.html">global</a></li>
  173. <li class="active">
  174. <span class="divider">\</span><a href="../classes/PHPExcel_Reader_Gnumeric.html">PHPExcel_Reader_Gnumeric</a>
  175. </li>
  176. </ul>
  177. <div class="element class">
  178. <p class="short_description">PHPExcel_Reader_Gnumeric</p>
  179. <div class="details">
  180. <div class="long_description"></div>
  181. <table class="table table-bordered">
  182. <tr>
  183. <th>category</th>
  184. <td>PHPExcel</td>
  185. </tr>
  186. <tr>
  187. <th>package</th>
  188. <td><a href="../packages/PHPExcel.Reader.html">PHPExcel_Reader</a></td>
  189. </tr>
  190. <tr>
  191. <th>copyright</th>
  192. <td>Copyright (c) 2006 - 2014 PHPExcel (http://www.codeplex.com/PHPExcel)</td>
  193. </tr>
  194. </table>
  195. <h3>
  196. <i class="icon-custom icon-method"></i> Methods</h3>
  197. <a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse">
  198. <h2>Create a new PHPExcel_Reader_Gnumeric</h2>
  199. <pre>__construct() </pre>
  200. <div class="labels"></div>
  201. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  202. </div>
  203. <a id="method_canRead"></a><div class="element clickable method public method_canRead" data-toggle="collapse" data-target=".method_canRead .collapse">
  204. <h2>Can the current PHPExcel_Reader_IReader read the file?</h2>
  205. <pre>canRead(string $pFilename) : boolean</pre>
  206. <div class="labels"></div>
  207. <div class="row collapse"><div class="detail-description">
  208. <div class="long_description"></div>
  209. <h3>Parameters</h3>
  210. <div class="subelement argument">
  211. <h4>$pFilename</h4>
  212. <code>string</code>
  213. </div>
  214. <h3>Exceptions</h3>
  215. <table class="table table-bordered"><tr>
  216. <th><code><a href="../classes/PHPExcel_Reader_Exception.html">\PHPExcel_Reader_Exception</a></code></th>
  217. <td></td>
  218. </tr></table>
  219. <h3>Returns</h3>
  220. <div class="subelement response"><code>boolean</code></div>
  221. </div></div>
  222. </div>
  223. <a id="method_getIncludeCharts"></a><div class="element clickable method public method_getIncludeCharts" data-toggle="collapse" data-target=".method_getIncludeCharts .collapse">
  224. <h2>Read charts in workbook?
  225. If this is true, then the Reader will include any charts that exist in the workbook.</h2>
  226. <pre>getIncludeCharts() : boolean</pre>
  227. <div class="labels"><span class="label">Inherited</span></div>
  228. <div class="row collapse"><div class="detail-description">
  229. <div class="long_description"><p>Note that a ReadDataOnly value of false overrides, and charts won't be read regardless of the IncludeCharts value.
  230. If false (the default) it will ignore any charts defined in the workbook file.</p></div>
  231. <table class="table table-bordered"><tr>
  232. <th>inherited_from</th>
  233. <td>\PHPExcel_Reader_Abstract::getIncludeCharts()</td>
  234. </tr></table>
  235. <h3>Returns</h3>
  236. <div class="subelement response"><code>boolean</code></div>
  237. </div></div>
  238. </div>
  239. <a id="method_getLoadSheetsOnly"></a><div class="element clickable method public method_getLoadSheetsOnly" data-toggle="collapse" data-target=".method_getLoadSheetsOnly .collapse">
  240. <h2>Get which sheets to load
  241. Returns either an array of worksheet names (the list of worksheets that should be loaded), or a null
  242. indicating that all worksheets in the workbook should be loaded.</h2>
  243. <pre>getLoadSheetsOnly() : mixed</pre>
  244. <div class="labels"><span class="label">Inherited</span></div>
  245. <div class="row collapse"><div class="detail-description">
  246. <div class="long_description"></div>
  247. <table class="table table-bordered"><tr>
  248. <th>inherited_from</th>
  249. <td>\PHPExcel_Reader_Abstract::getLoadSheetsOnly()</td>
  250. </tr></table>
  251. <h3>Returns</h3>
  252. <div class="subelement response"><code>mixed</code></div>
  253. </div></div>
  254. </div>
  255. <a id="method_getReadDataOnly"></a><div class="element clickable method public method_getReadDataOnly" data-toggle="collapse" data-target=".method_getReadDataOnly .collapse">
  256. <h2>Read data only?
  257. If this is true, then the Reader will only read data values for cells, it will not read any formatting information.</h2>
  258. <pre>getReadDataOnly() : boolean</pre>
  259. <div class="labels"><span class="label">Inherited</span></div>
  260. <div class="row collapse"><div class="detail-description">
  261. <div class="long_description"><p>If false (the default) it will read data and formatting.</p></div>
  262. <table class="table table-bordered"><tr>
  263. <th>inherited_from</th>
  264. <td>\PHPExcel_Reader_Abstract::getReadDataOnly()</td>
  265. </tr></table>
  266. <h3>Returns</h3>
  267. <div class="subelement response"><code>boolean</code></div>
  268. </div></div>
  269. </div>
  270. <a id="method_getReadFilter"></a><div class="element clickable method public method_getReadFilter" data-toggle="collapse" data-target=".method_getReadFilter .collapse">
  271. <h2>Read filter</h2>
  272. <pre>getReadFilter() : <a href="../classes/PHPExcel_Reader_IReadFilter.html">\PHPExcel_Reader_IReadFilter</a></pre>
  273. <div class="labels"><span class="label">Inherited</span></div>
  274. <div class="row collapse"><div class="detail-description">
  275. <div class="long_description"></div>
  276. <table class="table table-bordered"><tr>
  277. <th>inherited_from</th>
  278. <td>\PHPExcel_Reader_Abstract::getReadFilter()</td>
  279. </tr></table>
  280. <h3>Returns</h3>
  281. <div class="subelement response"><code><a href="../classes/PHPExcel_Reader_IReadFilter.html">\PHPExcel_Reader_IReadFilter</a></code></div>
  282. </div></div>
  283. </div>
  284. <a id="method_listWorksheetInfo"></a><div class="element clickable method public method_listWorksheetInfo" data-toggle="collapse" data-target=".method_listWorksheetInfo .collapse">
  285. <h2>Return worksheet info (Name, Last Column Letter, Last Column Index, Total Rows, Total Columns)</h2>
  286. <pre>listWorksheetInfo(string $pFilename) </pre>
  287. <div class="labels"></div>
  288. <div class="row collapse"><div class="detail-description">
  289. <div class="long_description"></div>
  290. <h3>Parameters</h3>
  291. <div class="subelement argument">
  292. <h4>$pFilename</h4>
  293. <code>string</code>
  294. </div>
  295. <h3>Exceptions</h3>
  296. <table class="table table-bordered"><tr>
  297. <th><code><a href="../classes/PHPExcel_Reader_Exception.html">\PHPExcel_Reader_Exception</a></code></th>
  298. <td></td>
  299. </tr></table>
  300. </div></div>
  301. </div>
  302. <a id="method_listWorksheetNames"></a><div class="element clickable method public method_listWorksheetNames" data-toggle="collapse" data-target=".method_listWorksheetNames .collapse">
  303. <h2>Reads names of the worksheets from a file, without parsing the whole file to a PHPExcel object</h2>
  304. <pre>listWorksheetNames(string $pFilename) </pre>
  305. <div class="labels"></div>
  306. <div class="row collapse"><div class="detail-description">
  307. <div class="long_description"></div>
  308. <h3>Parameters</h3>
  309. <div class="subelement argument">
  310. <h4>$pFilename</h4>
  311. <code>string</code>
  312. </div>
  313. <h3>Exceptions</h3>
  314. <table class="table table-bordered"><tr>
  315. <th><code><a href="../classes/PHPExcel_Reader_Exception.html">\PHPExcel_Reader_Exception</a></code></th>
  316. <td></td>
  317. </tr></table>
  318. </div></div>
  319. </div>
  320. <a id="method_load"></a><div class="element clickable method public method_load" data-toggle="collapse" data-target=".method_load .collapse">
  321. <h2>Loads PHPExcel from file</h2>
  322. <pre>load(string $pFilename) : <a href="../classes/PHPExcel.html">\PHPExcel</a></pre>
  323. <div class="labels"></div>
  324. <div class="row collapse"><div class="detail-description">
  325. <div class="long_description"></div>
  326. <h3>Parameters</h3>
  327. <div class="subelement argument">
  328. <h4>$pFilename</h4>
  329. <code>string</code>
  330. </div>
  331. <h3>Exceptions</h3>
  332. <table class="table table-bordered"><tr>
  333. <th><code><a href="../classes/PHPExcel_Reader_Exception.html">\PHPExcel_Reader_Exception</a></code></th>
  334. <td></td>
  335. </tr></table>
  336. <h3>Returns</h3>
  337. <div class="subelement response"><code><a href="../classes/PHPExcel.html">\PHPExcel</a></code></div>
  338. </div></div>
  339. </div>
  340. <a id="method_loadIntoExisting"></a><div class="element clickable method public method_loadIntoExisting" data-toggle="collapse" data-target=".method_loadIntoExisting .collapse">
  341. <h2>Loads PHPExcel from file into PHPExcel instance</h2>
  342. <pre>loadIntoExisting(string $pFilename, \PHPExcel $objPHPExcel) : <a href="../classes/PHPExcel.html">\PHPExcel</a></pre>
  343. <div class="labels"></div>
  344. <div class="row collapse"><div class="detail-description">
  345. <div class="long_description"></div>
  346. <h3>Parameters</h3>
  347. <div class="subelement argument">
  348. <h4>$pFilename</h4>
  349. <code>string</code>
  350. </div>
  351. <div class="subelement argument">
  352. <h4>$objPHPExcel</h4>
  353. <code><a href="../classes/PHPExcel.html">\PHPExcel</a></code>
  354. </div>
  355. <h3>Exceptions</h3>
  356. <table class="table table-bordered"><tr>
  357. <th><code><a href="../classes/PHPExcel_Reader_Exception.html">\PHPExcel_Reader_Exception</a></code></th>
  358. <td></td>
  359. </tr></table>
  360. <h3>Returns</h3>
  361. <div class="subelement response"><code><a href="../classes/PHPExcel.html">\PHPExcel</a></code></div>
  362. </div></div>
  363. </div>
  364. <a id="method_setIncludeCharts"></a><div class="element clickable method public method_setIncludeCharts" data-toggle="collapse" data-target=".method_setIncludeCharts .collapse">
  365. <h2>Set read charts in workbook
  366. Set to true, to advise the Reader to include any charts that exist in the workbook.</h2>
  367. <pre>setIncludeCharts(boolean $pValue) : <a href="../classes/PHPExcel_Reader_IReader.html">\PHPExcel_Reader_IReader</a></pre>
  368. <div class="labels"><span class="label">Inherited</span></div>
  369. <div class="row collapse"><div class="detail-description">
  370. <div class="long_description"><p>Note that a ReadDataOnly value of false overrides, and charts won't be read regardless of the IncludeCharts value.
  371. Set to false (the default) to discard charts.</p></div>
  372. <table class="table table-bordered"><tr>
  373. <th>inherited_from</th>
  374. <td>\PHPExcel_Reader_Abstract::setIncludeCharts()</td>
  375. </tr></table>
  376. <h3>Parameters</h3>
  377. <div class="subelement argument">
  378. <h4>$pValue</h4>
  379. <code>boolean</code>
  380. </div>
  381. <h3>Returns</h3>
  382. <div class="subelement response"><code><a href="../classes/PHPExcel_Reader_IReader.html">\PHPExcel_Reader_IReader</a></code></div>
  383. </div></div>
  384. </div>
  385. <a id="method_setLoadAllSheets"></a><div class="element clickable method public method_setLoadAllSheets" data-toggle="collapse" data-target=".method_setLoadAllSheets .collapse">
  386. <h2>Set all sheets to load
  387. Tells the Reader to load all worksheets from the workbook.</h2>
  388. <pre>setLoadAllSheets() : <a href="../classes/PHPExcel_Reader_IReader.html">\PHPExcel_Reader_IReader</a></pre>
  389. <div class="labels"><span class="label">Inherited</span></div>
  390. <div class="row collapse"><div class="detail-description">
  391. <div class="long_description"></div>
  392. <table class="table table-bordered"><tr>
  393. <th>inherited_from</th>
  394. <td>\PHPExcel_Reader_Abstract::setLoadAllSheets()</td>
  395. </tr></table>
  396. <h3>Returns</h3>
  397. <div class="subelement response"><code><a href="../classes/PHPExcel_Reader_IReader.html">\PHPExcel_Reader_IReader</a></code></div>
  398. </div></div>
  399. </div>
  400. <a id="method_setLoadSheetsOnly"></a><div class="element clickable method public method_setLoadSheetsOnly" data-toggle="collapse" data-target=".method_setLoadSheetsOnly .collapse">
  401. <h2>Set which sheets to load</h2>
  402. <pre>setLoadSheetsOnly(mixed $value) : <a href="../classes/PHPExcel_Reader_IReader.html">\PHPExcel_Reader_IReader</a></pre>
  403. <div class="labels"><span class="label">Inherited</span></div>
  404. <div class="row collapse"><div class="detail-description">
  405. <div class="long_description"></div>
  406. <table class="table table-bordered"><tr>
  407. <th>inherited_from</th>
  408. <td>\PHPExcel_Reader_Abstract::setLoadSheetsOnly()</td>
  409. </tr></table>
  410. <h3>Parameters</h3>
  411. <div class="subelement argument">
  412. <h4>$value</h4>
  413. <code>mixed</code><p>This should be either an array of worksheet names to be loaded, or a string containing a single worksheet name.
  414. If NULL, then it tells the Reader to read all worksheets in the workbook</p></div>
  415. <h3>Returns</h3>
  416. <div class="subelement response"><code><a href="../classes/PHPExcel_Reader_IReader.html">\PHPExcel_Reader_IReader</a></code></div>
  417. </div></div>
  418. </div>
  419. <a id="method_setReadDataOnly"></a><div class="element clickable method public method_setReadDataOnly" data-toggle="collapse" data-target=".method_setReadDataOnly .collapse">
  420. <h2>Set read data only
  421. Set to true, to advise the Reader only to read data values for cells, and to ignore any formatting information.</h2>
  422. <pre>setReadDataOnly(boolean $pValue) : <a href="../classes/PHPExcel_Reader_IReader.html">\PHPExcel_Reader_IReader</a></pre>
  423. <div class="labels"><span class="label">Inherited</span></div>
  424. <div class="row collapse"><div class="detail-description">
  425. <div class="long_description"><p>Set to false (the default) to advise the Reader to read both data and formatting for cells.</p></div>
  426. <table class="table table-bordered"><tr>
  427. <th>inherited_from</th>
  428. <td>\PHPExcel_Reader_Abstract::setReadDataOnly()</td>
  429. </tr></table>
  430. <h3>Parameters</h3>
  431. <div class="subelement argument">
  432. <h4>$pValue</h4>
  433. <code>boolean</code>
  434. </div>
  435. <h3>Returns</h3>
  436. <div class="subelement response"><code><a href="../classes/PHPExcel_Reader_IReader.html">\PHPExcel_Reader_IReader</a></code></div>
  437. </div></div>
  438. </div>
  439. <a id="method_setReadFilter"></a><div class="element clickable method public method_setReadFilter" data-toggle="collapse" data-target=".method_setReadFilter .collapse">
  440. <h2>Set read filter</h2>
  441. <pre>setReadFilter(\PHPExcel_Reader_IReadFilter $pValue) : <a href="../classes/PHPExcel_Reader_IReader.html">\PHPExcel_Reader_IReader</a></pre>
  442. <div class="labels"><span class="label">Inherited</span></div>
  443. <div class="row collapse"><div class="detail-description">
  444. <div class="long_description"></div>
  445. <table class="table table-bordered"><tr>
  446. <th>inherited_from</th>
  447. <td>\PHPExcel_Reader_Abstract::setReadFilter()</td>
  448. </tr></table>
  449. <h3>Parameters</h3>
  450. <div class="subelement argument">
  451. <h4>$pValue</h4>
  452. <code><a href="../classes/PHPExcel_Reader_IReadFilter.html">\PHPExcel_Reader_IReadFilter</a></code>
  453. </div>
  454. <h3>Returns</h3>
  455. <div class="subelement response"><code><a href="../classes/PHPExcel_Reader_IReader.html">\PHPExcel_Reader_IReader</a></code></div>
  456. </div></div>
  457. </div>
  458. <a id="method__openFile"></a><div class="element clickable method protected method__openFile" data-toggle="collapse" data-target=".method__openFile .collapse">
  459. <h2>Open file for reading</h2>
  460. <pre>_openFile(string $pFilename) : resource</pre>
  461. <div class="labels"><span class="label">Inherited</span></div>
  462. <div class="row collapse"><div class="detail-description">
  463. <div class="long_description"></div>
  464. <table class="table table-bordered"><tr>
  465. <th>inherited_from</th>
  466. <td>\PHPExcel_Reader_Abstract::_openFile()</td>
  467. </tr></table>
  468. <h3>Parameters</h3>
  469. <div class="subelement argument">
  470. <h4>$pFilename</h4>
  471. <code>string</code>
  472. </div>
  473. <h3>Exceptions</h3>
  474. <table class="table table-bordered"><tr>
  475. <th><code><a href="../classes/PHPExcel_Reader_Exception.html">\PHPExcel_Reader_Exception</a></code></th>
  476. <td></td>
  477. </tr></table>
  478. <h3>Returns</h3>
  479. <div class="subelement response"><code>resource</code></div>
  480. </div></div>
  481. </div>
  482. <a id="method__gzfileGetContents"></a><div class="element clickable method private method__gzfileGetContents" data-toggle="collapse" data-target=".method__gzfileGetContents .collapse">
  483. <h2>_gzfileGetContents()
  484. </h2>
  485. <pre>_gzfileGetContents($filename) </pre>
  486. <div class="labels"></div>
  487. <div class="row collapse"><div class="detail-description">
  488. <div class="long_description"></div>
  489. <h3>Parameters</h3>
  490. <div class="subelement argument"><h4>$filename</h4></div>
  491. </div></div>
  492. </div>
  493. <a id="method__parseBorderAttributes"></a><div class="element clickable method private method__parseBorderAttributes" data-toggle="collapse" data-target=".method__parseBorderAttributes .collapse">
  494. <h2>_parseBorderAttributes()
  495. </h2>
  496. <pre>_parseBorderAttributes($borderAttributes) </pre>
  497. <div class="labels"><span class="label">Static</span></div>
  498. <div class="row collapse"><div class="detail-description">
  499. <div class="long_description"></div>
  500. <h3>Parameters</h3>
  501. <div class="subelement argument"><h4>$borderAttributes</h4></div>
  502. </div></div>
  503. </div>
  504. <a id="method__parseGnumericColour"></a><div class="element clickable method private method__parseGnumericColour" data-toggle="collapse" data-target=".method__parseGnumericColour .collapse">
  505. <h2>_parseGnumericColour()
  506. </h2>
  507. <pre>_parseGnumericColour($gnmColour) </pre>
  508. <div class="labels"><span class="label">Static</span></div>
  509. <div class="row collapse"><div class="detail-description">
  510. <div class="long_description"></div>
  511. <h3>Parameters</h3>
  512. <div class="subelement argument"><h4>$gnmColour</h4></div>
  513. </div></div>
  514. </div>
  515. <a id="method__parseRichText"></a><div class="element clickable method private method__parseRichText" data-toggle="collapse" data-target=".method__parseRichText .collapse">
  516. <h2>_parseRichText()
  517. </h2>
  518. <pre>_parseRichText($is) </pre>
  519. <div class="labels"></div>
  520. <div class="row collapse"><div class="detail-description">
  521. <div class="long_description"></div>
  522. <h3>Parameters</h3>
  523. <div class="subelement argument"><h4>$is</h4></div>
  524. </div></div>
  525. </div>
  526. <h3>
  527. <i class="icon-custom icon-property"></i> Properties</h3>
  528. <a id="property__fileHandle"> </a><div class="element clickable property protected property__fileHandle" data-toggle="collapse" data-target=".property__fileHandle .collapse">
  529. <h2></h2>
  530. <pre>$_fileHandle </pre>
  531. <div class="labels"><span class="label">Inherited</span></div>
  532. <div class="row collapse"><div class="detail-description">
  533. <div class="long_description"></div>
  534. <table class="table table-bordered"><tr>
  535. <th>inherited_from</th>
  536. <td>\PHPExcel_Reader_Abstract::$$_fileHandle</td>
  537. </tr></table>
  538. </div></div>
  539. </div>
  540. <a id="property__includeCharts"> </a><div class="element clickable property protected property__includeCharts" data-toggle="collapse" data-target=".property__includeCharts .collapse">
  541. <h2></h2>
  542. <pre>$_includeCharts : boolean</pre>
  543. <div class="labels"><span class="label">Inherited</span></div>
  544. <div class="row collapse"><div class="detail-description">
  545. <div class="long_description"></div>
  546. <table class="table table-bordered"><tr>
  547. <th>inherited_from</th>
  548. <td>\PHPExcel_Reader_Abstract::$$_includeCharts</td>
  549. </tr></table>
  550. </div></div>
  551. </div>
  552. <a id="property__loadSheetsOnly"> </a><div class="element clickable property protected property__loadSheetsOnly" data-toggle="collapse" data-target=".property__loadSheetsOnly .collapse">
  553. <h2></h2>
  554. <pre>$_loadSheetsOnly : array</pre>
  555. <div class="labels"><span class="label">Inherited</span></div>
  556. <div class="row collapse"><div class="detail-description">
  557. <div class="long_description"><p>If null, then all worksheets will be loaded.</p></div>
  558. <table class="table table-bordered"><tr>
  559. <th>inherited_from</th>
  560. <td>\PHPExcel_Reader_Abstract::$$_loadSheetsOnly</td>
  561. </tr></table>
  562. </div></div>
  563. </div>
  564. <a id="property__readDataOnly"> </a><div class="element clickable property protected property__readDataOnly" data-toggle="collapse" data-target=".property__readDataOnly .collapse">
  565. <h2></h2>
  566. <pre>$_readDataOnly : boolean</pre>
  567. <div class="labels"><span class="label">Inherited</span></div>
  568. <div class="row collapse"><div class="detail-description">
  569. <div class="long_description"></div>
  570. <table class="table table-bordered"><tr>
  571. <th>inherited_from</th>
  572. <td>\PHPExcel_Reader_Abstract::$$_readDataOnly</td>
  573. </tr></table>
  574. </div></div>
  575. </div>
  576. <a id="property__readFilter"> </a><div class="element clickable property protected property__readFilter" data-toggle="collapse" data-target=".property__readFilter .collapse">
  577. <h2></h2>
  578. <pre>$_readFilter : <a href="../classes/PHPExcel_Reader_IReadFilter.html">\PHPExcel_Reader_IReadFilter</a></pre>
  579. <div class="labels"><span class="label">Inherited</span></div>
  580. <div class="row collapse"><div class="detail-description">
  581. <div class="long_description"></div>
  582. <table class="table table-bordered"><tr>
  583. <th>inherited_from</th>
  584. <td>\PHPExcel_Reader_Abstract::$$_readFilter</td>
  585. </tr></table>
  586. </div></div>
  587. </div>
  588. <a id="property__expressions"> </a><div class="element clickable property private property__expressions" data-toggle="collapse" data-target=".property__expressions .collapse">
  589. <h2></h2>
  590. <pre>$_expressions : array</pre>
  591. <div class="labels"></div>
  592. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  593. </div>
  594. <a id="property__referenceHelper"> </a><div class="element clickable property private property__referenceHelper" data-toggle="collapse" data-target=".property__referenceHelper .collapse">
  595. <h2></h2>
  596. <pre>$_referenceHelper </pre>
  597. <div class="labels"></div>
  598. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  599. </div>
  600. <a id="property__styles"> </a><div class="element clickable property private property__styles" data-toggle="collapse" data-target=".property__styles .collapse">
  601. <h2></h2>
  602. <pre>$_styles : array</pre>
  603. <div class="labels"></div>
  604. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  605. </div>
  606. </div>
  607. </div>
  608. </div>
  609. </div>
  610. <div class="row"><footer class="span12">
  611. 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>
  612. Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a12</a> and<br>
  613. generated on 2014-03-02T15:27:35Z.<br></footer></div>
  614. </div>
  615. </body>
  616. </html>