nizongfeng
/
ZZCS
1
0
Креирај огранак 0
Код Дискусије 0 Захтеви за спајање 0 Издања 0 Вики Activity
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.
2 Комити
1 Грана
14 MiB
 
 
 
 
Дрво: 0d86f80fa0
Гране Ознаке
${ item.name }
Create branch ${ searchTerm }
from '0d86f80fa0'
${ noResults }
ZZCS/coding/st-xm/ORG/Documentation/API/classes/PHPExcel_Shared_OLE.html

611 lines
32 KiB
Датотека Blame Историја 

  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_Shared_OLE</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_Asc2Ucs" title="Asc2Ucs :: Utility function to transform ASCII text to Unicode"><span class="description">Utility function to transform ASCII text to Unicode</span><pre>Asc2Ucs()</pre></a></li>

  96. <li class="method public "><a href="#method_LocalDate2OLE" title="LocalDate2OLE :: Utility function

  97. Returns a string for the OLE container with the date given"><span class="description">Utility function

  98. Returns a string for the OLE container with the date given</span><pre>LocalDate2OLE()</pre></a></li>

  99. <li class="method public "><a href="#method_OLE2LocalDate" title="OLE2LocalDate :: Returns a timestamp from an OLE container's date"><span class="description">Returns a timestamp from an OLE container's date</span><pre>OLE2LocalDate()</pre></a></li>

  100. <li class="method public "><a href="#method__getBlockOffset" title="_getBlockOffset :: "><span class="description">_getBlockOffset()

  101.         </span><pre>_getBlockOffset()</pre></a></li>

  102. <li class="method public "><a href="#method__ppsTreeComplete" title="_ppsTreeComplete :: It checks whether the PPS tree is complete (all PPS's read)

  103. starting with the given PPS (not necessarily root)"><span class="description">It checks whether the PPS tree is complete (all PPS's read)

  104. starting with the given PPS (not necessarily root)</span><pre>_ppsTreeComplete()</pre></a></li>

  105. <li class="method public "><a href="#method__readPpsWks" title="_readPpsWks :: Gets information about all PPS's on the OLE container from the PPS WK's

  106. creates an OLE_PPS object for each one."><span class="description">Gets information about all PPS's on the OLE container from the PPS WK's

  107. creates an OLE_PPS object for each one.</span><pre>_readPpsWks()</pre></a></li>

  108. <li class="method public "><a href="#method_getData" title="getData :: Gets data from a PPS

  109. If there is no PPS for the index given, it will return an empty string."><span class="description">Gets data from a PPS

  110. If there is no PPS for the index given, it will return an empty string.</span><pre>getData()</pre></a></li>

  111. <li class="method public "><a href="#method_getDataLength" title="getDataLength :: Gets the data length from a PPS

  112. If there is no PPS for the index given, it will return 0."><span class="description">Gets the data length from a PPS

  113. If there is no PPS for the index given, it will return 0.</span><pre>getDataLength()</pre></a></li>

  114. <li class="method public "><a href="#method_getStream" title="getStream :: Returns a stream for use with fread() etc."><span class="description">Returns a stream for use with fread() etc.</span><pre>getStream()</pre></a></li>

  115. <li class="method public "><a href="#method_isFile" title="isFile :: Checks whether a PPS is a File PPS or not."><span class="description">Checks whether a PPS is a File PPS or not.</span><pre>isFile()</pre></a></li>

  116. <li class="method public "><a href="#method_isRoot" title="isRoot :: Checks whether a PPS is a Root PPS or not."><span class="description">Checks whether a PPS is a Root PPS or not.</span><pre>isRoot()</pre></a></li>

  117. <li class="method public "><a href="#method_ppsTotal" title="ppsTotal :: Gives the total number of PPS's found in the OLE container."><span class="description">Gives the total number of PPS's found in the OLE container.</span><pre>ppsTotal()</pre></a></li>

  118. <li class="method public "><a href="#method_read" title="read :: Reads an OLE container from the contents of the file given."><span class="description">Reads an OLE container from the contents of the file given.</span><pre>read()</pre></a></li>

  119. </ul>

  120. </li>

  121. <li class="nav-header private">» Private

  122.                     <ul>

  123. <li class="method private "><a href="#method__readInt1" title="_readInt1 :: Reads a signed char."><span class="description">Reads a signed char.</span><pre>_readInt1()</pre></a></li>

  124. <li class="method private "><a href="#method__readInt2" title="_readInt2 :: Reads an unsigned short (2 octets)."><span class="description">Reads an unsigned short (2 octets).</span><pre>_readInt2()</pre></a></li>

  125. <li class="method private "><a href="#method__readInt4" title="_readInt4 :: Reads an unsigned long (4 octets)."><span class="description">Reads an unsigned long (4 octets).</span><pre>_readInt4()</pre></a></li>

  126. </ul>

  127. </li>

  128. <li class="nav-header">

  129. <i class="icon-custom icon-property"></i> Properties

  130.                     <ul>

  131. <li class="property public "><a href="#property__file_handle" title="$_file_handle :: The file handle for reading an OLE container"><span class="description"></span><pre>$_file_handle</pre></a></li>

  132. <li class="property public "><a href="#property__list" title="$_list :: Array of PPS's found on the OLE container"><span class="description"></span><pre>$_list</pre></a></li>

  133. <li class="property public "><a href="#property_bbat" title="$bbat :: Big Block Allocation Table"><span class="description"></span><pre>$bbat</pre></a></li>

  134. <li class="property public "><a href="#property_bigBlockSize" title="$bigBlockSize :: Size of big blocks."><span class="description"></span><pre>$bigBlockSize</pre></a></li>

  135. <li class="property public "><a href="#property_root" title="$root :: Root directory of OLE container"><span class="description"></span><pre>$root</pre></a></li>

  136. <li class="property public "><a href="#property_sbat" title="$sbat :: Short Block Allocation Table"><span class="description"></span><pre>$sbat</pre></a></li>

  137. <li class="property public "><a href="#property_smallBlockSize" title="$smallBlockSize :: Size of small blocks."><span class="description"></span><pre>$smallBlockSize</pre></a></li>

  138. </ul>

  139. </li>

  140. <li class="nav-header">

  141. <i class="icon-custom icon-constant"></i> Constants

  142.                     <ul>

  143. <li class="constant  "><a href="#constant_OLE_DATA_SIZE_SMALL" title="OLE_DATA_SIZE_SMALL :: "><span class="description">OLE_DATA_SIZE_SMALL</span><pre>OLE_DATA_SIZE_SMALL</pre></a></li>

  144. <li class="constant  "><a href="#constant_OLE_LONG_INT_SIZE" title="OLE_LONG_INT_SIZE :: "><span class="description">OLE_LONG_INT_SIZE</span><pre>OLE_LONG_INT_SIZE</pre></a></li>

  145. <li class="constant  "><a href="#constant_OLE_PPS_SIZE" title="OLE_PPS_SIZE :: "><span class="description">OLE_PPS_SIZE</span><pre>OLE_PPS_SIZE</pre></a></li>

  146. <li class="constant  "><a href="#constant_OLE_PPS_TYPE_DIR" title="OLE_PPS_TYPE_DIR :: "><span class="description">OLE_PPS_TYPE_DIR</span><pre>OLE_PPS_TYPE_DIR</pre></a></li>

  147. <li class="constant  "><a href="#constant_OLE_PPS_TYPE_FILE" title="OLE_PPS_TYPE_FILE :: "><span class="description">OLE_PPS_TYPE_FILE</span><pre>OLE_PPS_TYPE_FILE</pre></a></li>

  148. <li class="constant  "><a href="#constant_OLE_PPS_TYPE_ROOT" title="OLE_PPS_TYPE_ROOT :: "><span class="description">OLE_PPS_TYPE_ROOT</span><pre>OLE_PPS_TYPE_ROOT</pre></a></li>

  149. </ul>

  150. </li>

  151. </ul>

  152. </div>

  153. <div class="span8">

  154. <a id="\PHPExcel_Shared_OLE"></a><ul class="breadcrumb">

  155. <li>

  156. <a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>

  157. </li>

  158. <li><a href="../namespaces/global.html">global</a></li>

  159. <li class="active">

  160. <span class="divider">\</span><a href="../classes/PHPExcel_Shared_OLE.html">PHPExcel_Shared_OLE</a>

  161. </li>

  162. </ul>

  163. <div class="element class">

  164. <p class="short_description">OLE package base class.</p>

  165. <div class="details">

  166. <div class="long_description"></div>

  167. <table class="table table-bordered">

  168. <tr>

  169. <th>author</th>

  170. <td><a href="mailto:xnoguer@php.net">Xavier Noguer</a></td>

  171. </tr>

  172. <tr>

  173. <th>author</th>

  174. <td><a href="mailto:schmidt@php.net">Christian Schmidt</a></td>

  175. </tr>

  176. <tr>

  177. <th>category</th>

  178. <td>PHPExcel</td>

  179. </tr>

  180. <tr>

  181. <th>package</th>

  182. <td><a href="../packages/PHPExcel.Shared.OLE.html">PHPExcel_Shared_OLE</a></td>

  183. </tr>

  184. </table>

  185. <h3>

  186. <i class="icon-custom icon-method"></i> Methods</h3>

  187. <a id="method_Asc2Ucs"></a><div class="element clickable method public method_Asc2Ucs" data-toggle="collapse" data-target=".method_Asc2Ucs .collapse">

  188. <h2>Utility function to transform ASCII text to Unicode</h2>

  189. <pre>Asc2Ucs(string $ascii) : string</pre>

  190. <div class="labels"><span class="label">Static</span></div>

  191. <div class="row collapse"><div class="detail-description">

  192. <div class="long_description"></div>

  193. <table class="table table-bordered">

  194. <tr>

  195. <th>access</th>

  196. <td>public</td>

  197. </tr>

  198. <tr>

  199. <th>static</th>

  200. <td></td>

  201. </tr>

  202. </table>

  203. <h3>Parameters</h3>

  204. <div class="subelement argument">

  205. <h4>$ascii</h4>

  206. <code>string</code><p>The ASCII string to transform</p></div>

  207. <h3>Returns</h3>

  208. <div class="subelement response">

  209. <code>string</code>The string in Unicode</div>

  210. </div></div>

  211. </div>

  212. <a id="method_LocalDate2OLE"></a><div class="element clickable method public method_LocalDate2OLE" data-toggle="collapse" data-target=".method_LocalDate2OLE .collapse">

  213. <h2>Utility function

  214. Returns a string for the OLE container with the date given</h2>

  215. <pre>LocalDate2OLE(integer $date) : string</pre>

  216. <div class="labels"><span class="label">Static</span></div>

  217. <div class="row collapse"><div class="detail-description">

  218. <div class="long_description"></div>

  219. <table class="table table-bordered">

  220. <tr>

  221. <th>access</th>

  222. <td>public</td>

  223. </tr>

  224. <tr>

  225. <th>static</th>

  226. <td></td>

  227. </tr>

  228. </table>

  229. <h3>Parameters</h3>

  230. <div class="subelement argument">

  231. <h4>$date</h4>

  232. <code>integer</code><p>A timestamp</p></div>

  233. <h3>Returns</h3>

  234. <div class="subelement response">

  235. <code>string</code>The string for the OLE container</div>

  236. </div></div>

  237. </div>

  238. <a id="method_OLE2LocalDate"></a><div class="element clickable method public method_OLE2LocalDate" data-toggle="collapse" data-target=".method_OLE2LocalDate .collapse">

  239. <h2>Returns a timestamp from an OLE container's date</h2>

  240. <pre>OLE2LocalDate(integer $string) : string</pre>

  241. <div class="labels"><span class="label">Static</span></div>

  242. <div class="row collapse"><div class="detail-description">

  243. <div class="long_description"></div>

  244. <table class="table table-bordered">

  245. <tr>

  246. <th>access</th>

  247. <td>public</td>

  248. </tr>

  249. <tr>

  250. <th>static</th>

  251. <td></td>

  252. </tr>

  253. </table>

  254. <h3>Parameters</h3>

  255. <div class="subelement argument">

  256. <h4>$string</h4>

  257. <code>integer</code><p>A binary string with the encoded date</p></div>

  258. <h3>Returns</h3>

  259. <div class="subelement response">

  260. <code>string</code>The timestamp corresponding to the string</div>

  261. </div></div>

  262. </div>

  263. <a id="method__getBlockOffset"></a><div class="element clickable method public method__getBlockOffset" data-toggle="collapse" data-target=".method__getBlockOffset .collapse">

  264. <h2>_getBlockOffset()

  265.         </h2>

  266. <pre>_getBlockOffset(int $blockId) </pre>

  267. <div class="labels"></div>

  268. <div class="row collapse"><div class="detail-description">

  269. <div class="long_description"></div>

  270. <table class="table table-bordered"><tr>

  271. <th>access</th>

  272. <td>public</td>

  273. </tr></table>

  274. <h3>Parameters</h3>

  275. <div class="subelement argument">

  276. <h4>$blockId</h4>

  277. <code>int</code><p>block id</p></div>

  278. </div></div>

  279. </div>

  280. <a id="method__ppsTreeComplete"></a><div class="element clickable method public method__ppsTreeComplete" data-toggle="collapse" data-target=".method__ppsTreeComplete .collapse">

  281. <h2>It checks whether the PPS tree is complete (all PPS's read)

  282. starting with the given PPS (not necessarily root)</h2>

  283. <pre>_ppsTreeComplete(integer $index) : boolean</pre>

  284. <div class="labels"></div>

  285. <div class="row collapse"><div class="detail-description">

  286. <div class="long_description"></div>

  287. <table class="table table-bordered"><tr>

  288. <th>access</th>

  289. <td>public</td>

  290. </tr></table>

  291. <h3>Parameters</h3>

  292. <div class="subelement argument">

  293. <h4>$index</h4>

  294. <code>integer</code><p>The index of the PPS from which we are checking</p></div>

  295. <h3>Returns</h3>

  296. <div class="subelement response">

  297. <code>boolean</code>Whether the PPS tree for the given PPS is complete</div>

  298. </div></div>

  299. </div>

  300. <a id="method__readPpsWks"></a><div class="element clickable method public method__readPpsWks" data-toggle="collapse" data-target=".method__readPpsWks .collapse">

  301. <h2>Gets information about all PPS's on the OLE container from the PPS WK's

  302. creates an OLE_PPS object for each one.</h2>

  303. <pre>_readPpsWks(integer $blockId) : mixed</pre>

  304. <div class="labels"></div>

  305. <div class="row collapse"><div class="detail-description">

  306. <div class="long_description"></div>

  307. <table class="table table-bordered"><tr>

  308. <th>access</th>

  309. <td>public</td>

  310. </tr></table>

  311. <h3>Parameters</h3>

  312. <div class="subelement argument">

  313. <h4>$blockId</h4>

  314. <code>integer</code><p>the block id of the first block</p></div>

  315. <h3>Returns</h3>

  316. <div class="subelement response">

  317. <code>mixed</code>true on success, PEAR_Error on failure</div>

  318. </div></div>

  319. </div>

  320. <a id="method_getData"></a><div class="element clickable method public method_getData" data-toggle="collapse" data-target=".method_getData .collapse">

  321. <h2>Gets data from a PPS

  322. If there is no PPS for the index given, it will return an empty string.</h2>

  323. <pre>getData(integer $index, integer $position, integer $length) : string</pre>

  324. <div class="labels"></div>

  325. <div class="row collapse"><div class="detail-description">

  326. <div class="long_description"></div>

  327. <table class="table table-bordered">

  328. <tr>

  329. <th>access</th>

  330. <td>public</td>

  331. </tr>

  332. <tr>

  333. <th>see</th>

  334. <td><a href="">\OLE_PPS_File::getStream()</a></td>

  335. </tr>

  336. </table>

  337. <h3>Parameters</h3>

  338. <div class="subelement argument">

  339. <h4>$index</h4>

  340. <code>integer</code><p>The index for the PPS</p></div>

  341. <div class="subelement argument">

  342. <h4>$position</h4>

  343. <code>integer</code><p>The position from which to start reading

  344.                          (relative to the PPS)</p>

  345. </div>

  346. <div class="subelement argument">

  347. <h4>$length</h4>

  348. <code>integer</code><p>The amount of bytes to read (at most)</p>

  349. </div>

  350. <h3>Returns</h3>

  351. <div class="subelement response">

  352. <code>string</code>The binary string containing the data requested</div>

  353. </div></div>

  354. </div>

  355. <a id="method_getDataLength"></a><div class="element clickable method public method_getDataLength" data-toggle="collapse" data-target=".method_getDataLength .collapse">

  356. <h2>Gets the data length from a PPS

  357. If there is no PPS for the index given, it will return 0.</h2>

  358. <pre>getDataLength(integer $index) : integer</pre>

  359. <div class="labels"></div>

  360. <div class="row collapse"><div class="detail-description">

  361. <div class="long_description"></div>

  362. <table class="table table-bordered"><tr>

  363. <th>access</th>

  364. <td>public</td>

  365. </tr></table>

  366. <h3>Parameters</h3>

  367. <div class="subelement argument">

  368. <h4>$index</h4>

  369. <code>integer</code><p>The index for the PPS</p></div>

  370. <h3>Returns</h3>

  371. <div class="subelement response">

  372. <code>integer</code>The amount of bytes in data the PPS has</div>

  373. </div></div>

  374. </div>

  375. <a id="method_getStream"></a><div class="element clickable method public method_getStream" data-toggle="collapse" data-target=".method_getStream .collapse">

  376. <h2>Returns a stream for use with fread() etc.</h2>

  377. <pre>getStream(int | \PPS $blockIdOrPps) : resource</pre>

  378. <div class="labels"></div>

  379. <div class="row collapse"><div class="detail-description">

  380. <div class="long_description"><p>External callers should

  381. use PHPExcel_Shared_OLE_PPS_File::getStream().</p></div>

  382. <h3>Parameters</h3>

  383. <div class="subelement argument">

  384. <h4>$blockIdOrPps</h4>

  385. <code>int</code><code>\PPS</code><p>block id or PPS</p></div>

  386. <h3>Returns</h3>

  387. <div class="subelement response">

  388. <code>resource</code>read-only stream</div>

  389. </div></div>

  390. </div>

  391. <a id="method_isFile"></a><div class="element clickable method public method_isFile" data-toggle="collapse" data-target=".method_isFile .collapse">

  392. <h2>Checks whether a PPS is a File PPS or not.</h2>

  393. <pre>isFile(integer $index) : bool</pre>

  394. <div class="labels"></div>

  395. <div class="row collapse"><div class="detail-description">

  396. <div class="long_description"><p>If there is no PPS for the index given, it will return false.</p></div>

  397. <table class="table table-bordered"><tr>

  398. <th>access</th>

  399. <td>public</td>

  400. </tr></table>

  401. <h3>Parameters</h3>

  402. <div class="subelement argument">

  403. <h4>$index</h4>

  404. <code>integer</code><p>The index for the PPS</p></div>

  405. <h3>Returns</h3>

  406. <div class="subelement response">

  407. <code>bool</code>true if it's a File PPS, false otherwise</div>

  408. </div></div>

  409. </div>

  410. <a id="method_isRoot"></a><div class="element clickable method public method_isRoot" data-toggle="collapse" data-target=".method_isRoot .collapse">

  411. <h2>Checks whether a PPS is a Root PPS or not.</h2>

  412. <pre>isRoot(integer $index) : bool</pre>

  413. <div class="labels"></div>

  414. <div class="row collapse"><div class="detail-description">

  415. <div class="long_description"><p>If there is no PPS for the index given, it will return false.</p></div>

  416. <table class="table table-bordered"><tr>

  417. <th>access</th>

  418. <td>public</td>

  419. </tr></table>

  420. <h3>Parameters</h3>

  421. <div class="subelement argument">

  422. <h4>$index</h4>

  423. <code>integer</code><p>The index for the PPS.</p></div>

  424. <h3>Returns</h3>

  425. <div class="subelement response">

  426. <code>bool</code>true if it's a Root PPS, false otherwise</div>

  427. </div></div>

  428. </div>

  429. <a id="method_ppsTotal"></a><div class="element clickable method public method_ppsTotal" data-toggle="collapse" data-target=".method_ppsTotal .collapse">

  430. <h2>Gives the total number of PPS's found in the OLE container.</h2>

  431. <pre>ppsTotal() : integer</pre>

  432. <div class="labels"></div>

  433. <div class="row collapse"><div class="detail-description">

  434. <div class="long_description"></div>

  435. <table class="table table-bordered"><tr>

  436. <th>access</th>

  437. <td>public</td>

  438. </tr></table>

  439. <h3>Returns</h3>

  440. <div class="subelement response">

  441. <code>integer</code>The total number of PPS's found in the OLE container</div>

  442. </div></div>

  443. </div>

  444. <a id="method_read"></a><div class="element clickable method public method_read" data-toggle="collapse" data-target=".method_read .collapse">

  445. <h2>Reads an OLE container from the contents of the file given.</h2>

  446. <pre>read(string $file) : 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>acces</th>

  452. <td>public</td>

  453. </tr></table>

  454. <h3>Parameters</h3>

  455. <div class="subelement argument">

  456. <h4>$file</h4>

  457. <code>string</code>

  458. </div>

  459. <h3>Returns</h3>

  460. <div class="subelement response">

  461. <code>mixed</code>true on success, PEAR_Error on failure</div>

  462. </div></div>

  463. </div>

  464. <a id="method__readInt1"></a><div class="element clickable method private method__readInt1" data-toggle="collapse" data-target=".method__readInt1 .collapse">

  465. <h2>Reads a signed char.</h2>

  466. <pre>_readInt1(resource $fh) : int</pre>

  467. <div class="labels"><span class="label">Static</span></div>

  468. <div class="row collapse"><div class="detail-description">

  469. <div class="long_description"></div>

  470. <table class="table table-bordered"><tr>

  471. <th>access</th>

  472. <td>public</td>

  473. </tr></table>

  474. <h3>Parameters</h3>

  475. <div class="subelement argument">

  476. <h4>$fh</h4>

  477. <code>resource</code><p>file handle</p></div>

  478. <h3>Returns</h3>

  479. <div class="subelement response"><code>int</code></div>

  480. </div></div>

  481. </div>

  482. <a id="method__readInt2"></a><div class="element clickable method private method__readInt2" data-toggle="collapse" data-target=".method__readInt2 .collapse">

  483. <h2>Reads an unsigned short (2 octets).</h2>

  484. <pre>_readInt2(resource $fh) : int</pre>

  485. <div class="labels"><span class="label">Static</span></div>

  486. <div class="row collapse"><div class="detail-description">

  487. <div class="long_description"></div>

  488. <table class="table table-bordered"><tr>

  489. <th>access</th>

  490. <td>public</td>

  491. </tr></table>

  492. <h3>Parameters</h3>

  493. <div class="subelement argument">

  494. <h4>$fh</h4>

  495. <code>resource</code><p>file handle</p></div>

  496. <h3>Returns</h3>

  497. <div class="subelement response"><code>int</code></div>

  498. </div></div>

  499. </div>

  500. <a id="method__readInt4"></a><div class="element clickable method private method__readInt4" data-toggle="collapse" data-target=".method__readInt4 .collapse">

  501. <h2>Reads an unsigned long (4 octets).</h2>

  502. <pre>_readInt4(resource $fh) : int</pre>

  503. <div class="labels"><span class="label">Static</span></div>

  504. <div class="row collapse"><div class="detail-description">

  505. <div class="long_description"></div>

  506. <table class="table table-bordered"><tr>

  507. <th>access</th>

  508. <td>public</td>

  509. </tr></table>

  510. <h3>Parameters</h3>

  511. <div class="subelement argument">

  512. <h4>$fh</h4>

  513. <code>resource</code><p>file handle</p></div>

  514. <h3>Returns</h3>

  515. <div class="subelement response"><code>int</code></div>

  516. </div></div>

  517. </div>

  518. <h3>

  519. <i class="icon-custom icon-property"></i> Properties</h3>

  520. <a id="property__file_handle"> </a><div class="element clickable property public property__file_handle" data-toggle="collapse" data-target=".property__file_handle .collapse">

  521. <h2></h2>

  522. <pre>$_file_handle : resource</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="property__list"> </a><div class="element clickable property public property__list" data-toggle="collapse" data-target=".property__list .collapse">

  527. <h2></h2>

  528. <pre>$_list : array</pre>

  529. <div class="labels"></div>

  530. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>

  531. </div>

  532. <a id="property_bbat"> </a><div class="element clickable property public property_bbat" data-toggle="collapse" data-target=".property_bbat .collapse">

  533. <h2></h2>

  534. <pre>$bbat : array</pre>

  535. <div class="labels"></div>

  536. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>

  537. </div>

  538. <a id="property_bigBlockSize"> </a><div class="element clickable property public property_bigBlockSize" data-toggle="collapse" data-target=".property_bigBlockSize .collapse">

  539. <h2></h2>

  540. <pre>$bigBlockSize : int</pre>

  541. <div class="labels"></div>

  542. <div class="row collapse"><div class="detail-description"><div class="long_description"><p>This is usually 512.</p></div></div></div>

  543. </div>

  544. <a id="property_root"> </a><div class="element clickable property public property_root" data-toggle="collapse" data-target=".property_root .collapse">

  545. <h2></h2>

  546. <pre>$root : \OLE_PPS_Root</pre>

  547. <div class="labels"></div>

  548. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>

  549. </div>

  550. <a id="property_sbat"> </a><div class="element clickable property public property_sbat" data-toggle="collapse" data-target=".property_sbat .collapse">

  551. <h2></h2>

  552. <pre>$sbat : array</pre>

  553. <div class="labels"></div>

  554. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>

  555. </div>

  556. <a id="property_smallBlockSize"> </a><div class="element clickable property public property_smallBlockSize" data-toggle="collapse" data-target=".property_smallBlockSize .collapse">

  557. <h2></h2>

  558. <pre>$smallBlockSize : int</pre>

  559. <div class="labels"></div>

  560. <div class="row collapse"><div class="detail-description"><div class="long_description"><p>This is usually 64.</p></div></div></div>

  561. </div>

  562. <h3>

  563. <i class="icon-custom icon-constant"></i> Constants</h3>

  564. <a id="constant_OLE_DATA_SIZE_SMALL"> </a><div class="element clickable constant  constant_OLE_DATA_SIZE_SMALL" data-toggle="collapse" data-target=".constant_OLE_DATA_SIZE_SMALL .collapse">

  565. <h2>OLE_DATA_SIZE_SMALL</h2>

  566. <pre>OLE_DATA_SIZE_SMALL </pre>

  567. <div class="labels"></div>

  568. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>

  569. </div>

  570. <a id="constant_OLE_LONG_INT_SIZE"> </a><div class="element clickable constant  constant_OLE_LONG_INT_SIZE" data-toggle="collapse" data-target=".constant_OLE_LONG_INT_SIZE .collapse">

  571. <h2>OLE_LONG_INT_SIZE</h2>

  572. <pre>OLE_LONG_INT_SIZE </pre>

  573. <div class="labels"></div>

  574. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>

  575. </div>

  576. <a id="constant_OLE_PPS_SIZE"> </a><div class="element clickable constant  constant_OLE_PPS_SIZE" data-toggle="collapse" data-target=".constant_OLE_PPS_SIZE .collapse">

  577. <h2>OLE_PPS_SIZE</h2>

  578. <pre>OLE_PPS_SIZE </pre>

  579. <div class="labels"></div>

  580. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>

  581. </div>

  582. <a id="constant_OLE_PPS_TYPE_DIR"> </a><div class="element clickable constant  constant_OLE_PPS_TYPE_DIR" data-toggle="collapse" data-target=".constant_OLE_PPS_TYPE_DIR .collapse">

  583. <h2>OLE_PPS_TYPE_DIR</h2>

  584. <pre>OLE_PPS_TYPE_DIR </pre>

  585. <div class="labels"></div>

  586. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>

  587. </div>

  588. <a id="constant_OLE_PPS_TYPE_FILE"> </a><div class="element clickable constant  constant_OLE_PPS_TYPE_FILE" data-toggle="collapse" data-target=".constant_OLE_PPS_TYPE_FILE .collapse">

  589. <h2>OLE_PPS_TYPE_FILE</h2>

  590. <pre>OLE_PPS_TYPE_FILE </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="constant_OLE_PPS_TYPE_ROOT"> </a><div class="element clickable constant  constant_OLE_PPS_TYPE_ROOT" data-toggle="collapse" data-target=".constant_OLE_PPS_TYPE_ROOT .collapse">

  595. <h2>OLE_PPS_TYPE_ROOT</h2>

  596. <pre>OLE_PPS_TYPE_ROOT </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. </div>

  601. </div>

  602. </div>

  603. </div>

  604. <div class="row"><footer class="span12">

  605.             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>

  606.             Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a12</a> and<br>

  607.             generated on 2014-03-02T15:27:37Z.<br></footer></div>

  608. </div>

  609. </body>

  610. </html>