PageRenderTime 47ms CodeModel.GetById 20ms RepoModel.GetById 0ms app.codeStats 0ms

/php/rararchive.getentries.html

https://bitbucket.org/thncr/manuals
HTML | 165 lines | 134 code | 31 blank | 0 comment | 0 complexity | 087d606da338b0bea1d0b5cf008b9a6c MD5 | raw file
    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
    2. 

  2. <html>
    3. 

  3.  <head>
    4. 

  4.   <meta http-equiv="content-type" content="text/html; charset=UTF-8">
    5. 

  5.   <title>Get full list of entries from the RAR archive</title>
    6. 

  6. 

  7.  </head>
    8. 

  8.  <body><div class="manualnavbar" style="text-align: center;">
    9. 

  9.  <div class="prev" style="text-align: left; float: left;"><a href="rararchive.getcomment.html">RarArchive::getComment</a></div>
    10. 

  10.  <div class="next" style="text-align: right; float: right;"><a href="rararchive.getentry.html">RarArchive::getEntry</a></div>
    11. 

  11.  <div class="up"><a href="class.rararchive.html">RarArchive</a></div>
    12. 

  12.  <div class="home"><a href="index.html">PHP Manual</a></div>
    13. 

  13. </div><hr /><div id="rararchive.getentries" class="refentry">
    14. 

  14.  <div class="refnamediv">
    15. 

  15.   <h1 class="refname">RarArchive::getEntries</h1>
    16. 

  16.   <h1 class="refname">rar_list</h1>
    17. 

  17.   <p class="verinfo">(PECL rar &gt;= 2.0.0)</p><p class="refpurpose"><span class="refname">RarArchive::getEntries</span> -- <span class="refname">rar_list</span> &mdash; <span class="dc-title">Get full list of entries from the RAR archive</span></p>
    18. 

  18. 

  19.  </div>
    20. 

  20. 

  21.  <div class="refsect1 description" id="refsect1-rararchive.getentries-description">
    22. 

  22.   <h3 class="title">说明</h3>
    23. 

  23.   <p class="para">面向对象风格 (method):</p>
    24. 

  24.    <div class="methodsynopsis dc-description">
    25. 

  25.    <span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><strong>RarArchive::getEntries</strong></span>
    26. 

  26.     ( <span class="methodparam">void</span>
    27. 

  27.     )</div>
    28. 

  28. 

  29.   <p class="para rdfs-comment">过程化风格:</p>
    30. 

  30.   <div class="methodsynopsis dc-description">
    31. 

  31.    <span class="type">array</span> <span class="methodname"><strong>rar_list</strong></span>
    32. 

  32.     ( <span class="methodparam"><span class="type"><a href="class.rararchive.html" class="type RarArchive">RarArchive</a></span> <code class="parameter">$rarfile</code></span>
    33. 

  33.    )</div>
    34. 

  34. 

  35.   <p class="para rdfs-comment">
    36. 

  36.    Get entries list (files and directories) from the RAR archive.
    37. 

  37.   </p>
    38. 

  38.   <blockquote class="note"><p><strong class="note">Note</strong>: 
    39. 

  39.    <p class="para">
    40. 

  40.     If the archive has
    41. 

  41.     entries with the same name, this method, together with <span class="type"><a href="class.rararchive.html" class="type RarArchive">RarArchive</a></span>
    42. 

  42.     <em>foreach</em> iteration and array-like access with numeric indexes,
    43. 

  43.     are the only ones to access all the entries (i.e.,
    44. 

  44.      <span class="methodname"><a href="rararchive.getentry.html" class="methodname">RarArchive::getEntry()</a></span> and the <a href="wrappers.rar.html" class="link">
    45. 

  45.     <em>rar://</em> wrapper</a> are insufficient).
    46. 

  46.    </p>
    47. 

  47.   </p></blockquote>
    48. 

  48.  </div>
    49. 

  49. 

  50. 

  51.  <div class="refsect1 parameters" id="refsect1-rararchive.getentries-parameters">
    52. 

  52.   <h3 class="title">参数</h3>
    53. 

  53.   <p class="para">
    54. 

  54.    <dl>
    55. 

  55. 

  56.     <dt>
    57. 

  57. 

  58.      <span class="term"><em><code class="parameter">rarfile</code></em></span>
    59. 

  59.      <dd>
    60. 

  60. 

  61.       <p class="para">
    62. 

  62.        A <span class="type"><a href="class.rararchive.html" class="type RarArchive">RarArchive</a></span> object, opened with  <span class="function"><a href="rararchive.open.html" class="function">rar_open()</a></span>.
    63. 

  63.       </p>
    64. 

  64.      </dd>
    65. 

  65. 

  66.     </dt>
    67. 

  67. 

  68.    </dl>
    69. 

  69. 

  70.   </p>
    71. 

  71.  </div>
    72. 

  72. 

  73. 

  74.  <div class="refsect1 returnvalues" id="refsect1-rararchive.getentries-returnvalues">
    75. 

  75.   <h3 class="title">返回值</h3>
    76. 

  76.   <p class="para">
    77. 

  77.     <span class="function"><strong>rar_list()</strong></span> returns array of <span class="type"><a href="class.rarentry.html" class="type RarEntry">RarEntry</a></span> objects
    78. 

  78.     或者在失败时返回 <strong><code>FALSE</code></strong>.
    79. 

  79.   </p>
    80. 

  80.  </div>
    81. 

  81. 

  82.  
    83. 

  83.  <div class="refsect1 changelog" id="refsect1-rararchive.getentries-changelog">
    84. 

  84.   <h3 class="title">更新日志</h3>
    85. 

  85.   <p class="para">
    86. 

  86.    <table class="doctable informaltable">
    87. 

  87.     
    88. 

  88.      <thead>
    89. 

  89.       <tr>
    90. 

  90.        <th>版本</th>
    91. 

  91.        <th>说明</th>
    92. 

  92.       </tr>
    93. 

  93. 

  94.      </thead>
    95. 

  95. 

  96.      <tbody class="tbody">
    97. 

  97.       <tr>
    98. 

  98.        <td>3.0.0</td>
    99. 

  99.        <td>
    100. 

  100.         Support for RAR archives with repeated entry names is no longer defective.
    101. 

  101.        </td>
    102. 

  102.       </tr>
    103. 

  103. 

  104.      </tbody>
    105. 

  105.     
    106. 

  106.    </table>
    107. 

  107. 

  108.   </p>
    109. 

  109.  </div>
    110. 

  110. 

  111. 

  112.  <div class="refsect1 examples" id="refsect1-rararchive.getentries-examples">
    113. 

  113.   <h3 class="title">范例</h3>
    114. 

  114.   <p class="para">
    115. 

  115.    <div class="example" id="example-784">
    116. 

  116.     <p><strong>Example #1 面向对象风格</strong></p>
    117. 

  117.     <div class="example-contents">
    118. 

  118. <div class="phpcode"><code><span style="color: #000000">
    119. 

  119. <span style="color: #0000BB">&lt;?php<br />$rar_arch&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">RarArchive</span><span style="color: #007700">::</span><span style="color: #0000BB">open</span><span style="color: #007700">(</span><span style="color: #DD0000">'solid.rar'</span><span style="color: #007700">);<br />if&nbsp;(</span><span style="color: #0000BB">$rar_arch&nbsp;</span><span style="color: #007700">===&nbsp;</span><span style="color: #0000BB">FALSE</span><span style="color: #007700">)<br />&nbsp;&nbsp;&nbsp;&nbsp;die(</span><span style="color: #DD0000">"Could&nbsp;not&nbsp;open&nbsp;RAR&nbsp;archive."</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$rar_entries&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">$rar_arch</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getEntries</span><span style="color: #007700">();<br />if&nbsp;(</span><span style="color: #0000BB">$rar_entries&nbsp;</span><span style="color: #007700">===&nbsp;</span><span style="color: #0000BB">FALSE</span><span style="color: #007700">)<br />&nbsp;&nbsp;&nbsp;&nbsp;die(</span><span style="color: #DD0000">"Could&nbsp;retrieve&nbsp;entries."</span><span style="color: #007700">);<br /><br />echo&nbsp;</span><span style="color: #DD0000">"Found&nbsp;"&nbsp;</span><span style="color: #007700">.&nbsp;</span><span style="color: #0000BB">count</span><span style="color: #007700">(</span><span style="color: #0000BB">$rar_entries</span><span style="color: #007700">)&nbsp;.&nbsp;</span><span style="color: #DD0000">"&nbsp;entries.\n"</span><span style="color: #007700">;<br /><br />foreach&nbsp;(</span><span style="color: #0000BB">$rar_entries&nbsp;</span><span style="color: #007700">as&nbsp;</span><span style="color: #0000BB">$e</span><span style="color: #007700">)&nbsp;{<br />&nbsp;&nbsp;&nbsp;&nbsp;echo&nbsp;</span><span style="color: #0000BB">$e</span><span style="color: #007700">;<br />&nbsp;&nbsp;&nbsp;&nbsp;echo&nbsp;</span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">$rar_arch</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">close</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">?&gt;</span>
    120. 

  120. </span>
    121. 

  121. </code></div>
    122. 

  122.      </div>
    123. 

  123. 

  124.      <div class="example-contents"><p>以上例程的输出类似于：</p></div>
    125. 

  125.      <div class="example-contents screen">
    126. 

  126. <div class="cdata"><pre>
    127. 

  127. Found 2 entries.
    128. 

  128. RarEntry for file &quot;tese.txt&quot; (23b93a7a)
    129. 

  129. RarEntry for file &quot;unrardll.txt&quot; (2ed64b6e)
    130. 

  130. </pre></div>
    131. 

  131.     </div>
    132. 

  132.    </div>
    133. 

  133.   </p>
    134. 

  134.   <p class="para">
    135. 

  135.    <div class="example" id="example-785">
    136. 

  136.     <p><strong>Example #2 过程化风格</strong></p>
    137. 

  137.     <div class="example-contents">
    138. 

  138. <div class="phpcode"><code><span style="color: #000000">
    139. 

  139. <span style="color: #0000BB">&lt;?php<br />$rar_arch&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">rar_open</span><span style="color: #007700">(</span><span style="color: #DD0000">'solid.rar'</span><span style="color: #007700">);<br />if&nbsp;(</span><span style="color: #0000BB">$rar_arch&nbsp;</span><span style="color: #007700">===&nbsp;</span><span style="color: #0000BB">FALSE</span><span style="color: #007700">)<br />&nbsp;&nbsp;&nbsp;&nbsp;die(</span><span style="color: #DD0000">"Could&nbsp;not&nbsp;open&nbsp;RAR&nbsp;archive."</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$rar_entries&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">rar_list</span><span style="color: #007700">(</span><span style="color: #0000BB">$rar_arch</span><span style="color: #007700">);<br />if&nbsp;(</span><span style="color: #0000BB">$rar_entries&nbsp;</span><span style="color: #007700">===&nbsp;</span><span style="color: #0000BB">FALSE</span><span style="color: #007700">)<br />&nbsp;&nbsp;&nbsp;&nbsp;die(</span><span style="color: #DD0000">"Could&nbsp;retrieve&nbsp;entries."</span><span style="color: #007700">);<br /><br />echo&nbsp;</span><span style="color: #DD0000">"Found&nbsp;"&nbsp;</span><span style="color: #007700">.&nbsp;</span><span style="color: #0000BB">count</span><span style="color: #007700">(</span><span style="color: #0000BB">$rar_entries</span><span style="color: #007700">)&nbsp;.&nbsp;</span><span style="color: #DD0000">"&nbsp;entries.\n"</span><span style="color: #007700">;<br /><br />foreach&nbsp;(</span><span style="color: #0000BB">$rar_entries&nbsp;</span><span style="color: #007700">as&nbsp;</span><span style="color: #0000BB">$e</span><span style="color: #007700">)&nbsp;{<br />&nbsp;&nbsp;&nbsp;&nbsp;echo&nbsp;</span><span style="color: #0000BB">$e</span><span style="color: #007700">;<br />&nbsp;&nbsp;&nbsp;&nbsp;echo&nbsp;</span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">rar_close</span><span style="color: #007700">(</span><span style="color: #0000BB">$rar_arch</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span>
    140. 

  140. </span>
    141. 

  141. </code></div>
    142. 

  142.      </div>
    143. 

  143. 

  144.    </div>
    145. 

  145.   </p>
    146. 

  146.  </div>
    147. 

  147. 

  148. 

  149.  <div class="refsect1 seealso" id="refsect1-rararchive.getentries-seealso">
    150. 

  150.   <h3 class="title">参见</h3>
    151. 

  151.   <p class="para">
    152. 

  152.    <ul class="simplelist">
    153. 

  153.     <li class="member"> <span class="methodname"><a href="rararchive.getentry.html" class="methodname" rel="rdfs-seeAlso">RarArchive::getEntry()</a> - Get entry object from the RAR archive</span></li>
    154. 

  154.     <li class="member"><a href="wrappers.rar.html" class="link"><em>rar://</em> wrapper</a></li>
    155. 

  155.    </ul>
    156. 

  156.   </p>
    157. 

  157.  </div>
    158. 

  158. 

  159. 

  160. </div><hr /><div class="manualnavbar" style="text-align: center;">
    161. 

  161.  <div class="prev" style="text-align: left; float: left;"><a href="rararchive.getcomment.html">RarArchive::getComment</a></div>
    162. 

  162.  <div class="next" style="text-align: right; float: right;"><a href="rararchive.getentry.html">RarArchive::getEntry</a></div>
    163. 

  163.  <div class="up"><a href="class.rararchive.html">RarArchive</a></div>
    164. 

  164.  <div class="home"><a href="index.html">PHP Manual</a></div>
    165. 

  165. </div></body></html>
    166. 

  166.