PageRenderTime 45ms CodeModel.GetById 15ms RepoModel.GetById 1ms app.codeStats 0ms

/php-manual-en-20100611/php-chunked-xhtml/rarentry.getstream.html

#
HTML | 112 lines | 91 code | 21 blank | 0 comment | 0 complexity | 5c5c61d87cec34c4d2ba5d31562ff5f2 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 file handler for entry.</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="rarentry.getpackedsize.html">RarEntry::getPackedSize</a></div>
    10. 

  10.  <div class="next" style="text-align: right; float: right;"><a href="rarentry.getunpackedsize.html">RarEntry::getUnpackedSize</a></div>
    11. 

  11.  <div class="up"><a href="class.rarentry.html">RarEntry</a></div>
    12. 

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

  13. </div><hr /><div id="rarentry.getstream" class="refentry">
    14. 

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

  15.   <h1 class="refname">RarEntry::getStream</h1>
    16. 

  16.   <p class="verinfo">(PECL rar &gt;= 2.0.0)</p><p class="refpurpose"><span class="refname">RarEntry::getStream</span> &mdash; <span class="dc-title">Get file handler for entry.</span></p>
    17. 

  17. 

  18.  </div>
    19. 

  19.  
    20. 

  20.  <div class="refsect1 description">
    21. 

  21.   <h3 class="title">Description</h3>
    22. 

  22.   <div class="methodsynopsis dc-description">
    23. 

  23.    <span class="modifier">public</span>  <span class="type">resource</span>  <span class="methodname"><b>RarEntry::RarEntry::getStream</b></span>
    24. 

  24.     ([ <span class="methodparam"> <span class="type">string</span>  <tt class="parameter">$password</tt></span>
    25. 

  25.   ] )</div>
    26. 

  26. 

  27.   <p class="para rdfs-comment">
    28. 

  28.    Returns a file handler that
    29. 

  29.    supports read operations. This handler provides on-the-fly decompression
    30. 

  30.    for this entry.
    31. 

  31.   </p>
    32. 

  32.   <p class="para">
    33. 

  33.     The handler is not invalidated by calling
    34. 

  34.     <span class="function"><a href="rararchive.close.html" class="function">rar_close()</a></span>.
    35. 

  35.   </p>
    36. 

  36.   <div class="warning"><b class="warning">Warning</b>
    37. 

  37.    <p class="para">The resulting stream has no integrity verification. In particular, file corruption and
    38. 

  38.    decryption with a wrong a key will not be detected. It is the programmer&#039;s responsability to use the entry&#039;s CRC
    39. 

  39.    to check for integrity, if he so wishes.</p>
    40. 

  40.   </div>
    41. 

  41.  </div>
    42. 

  42. 

  43.  
    44. 

  44.  <div class="refsect1 parameters">
    45. 

  45.   <h3 class="title">Parameters</h3>
    46. 

  46.   <p class="para">
    47. 

  47.    <dl>
    48. 

  48. 

  49.     <dt>
    50. 

  50. 

  51.      <span class="term"><i><tt class="parameter">password</tt></i></span>
    52. 

  52.      <dd>
    53. 

  53. 

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

  55.        The password used to encrypt this entry. If the entry is not encrypted, this value will not be used and can
    56. 

  56.        be omitted. If this parameter is omitted and the entry is encrypted, the password given to
    57. 

  57.        <span class="function"><a href="rararchive.open.html" class="function">rar_open()</a></span>, if any, will be used. If a wrong password is given, either explicitly
    58. 

  58.        or implicitly via <span class="function"><a href="rararchive.open.html" class="function">rar_open()</a></span>, this method&#039;s resulting stream will produce wrong
    59. 

  59.        output. If no password is given and one is required, this method will fail and return <b><tt>FALSE</tt></b>.
    60. 

  60.        You can check whether an entry is encrypted with  <span class="methodname"><a href="rarentry.isencrypted.html" class="function">RarEntry::isEncrypted</a></span>.
    61. 

  61.       </p>
    62. 

  62.      </dd>
    63. 

  63. 

  64.     </dt>
    65. 

  65. 

  66.    </dl>
    67. 

  67. 

  68.   </p>
    69. 

  69.  </div>
    70. 

  70. 

  71. 

  72.  <div class="refsect1 returnvalues">
    73. 

  73.   <h3 class="title">Return Values</h3>
    74. 

  74.   <p class="para">
    75. 

  75.    The file handler  or <b><tt>FALSE</tt></b> on failure.
    76. 

  76.   </p>
    77. 

  77.  </div>
    78. 

  78. 

  79.  
    80. 

  80.  <div class="refsect1 examples">
    81. 

  81.   <h3 class="title">Examples</h3>
    82. 

  82.   <p class="para">
    83. 

  83.    <div class="example">
    84. 

  84.     <p><b>Example #1  <span class="methodname"><b>RarEntry::getStream</b></span> example</b></p>
    85. 

  85.     <div class="example-contents">
    86. 

  86. <div class="phpcode"><code><span style="color: #000000">
    87. 

  87. <span style="color: #0000BB">&lt;?php<br /><br />$rar_file&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">rar_open</span><span style="color: #007700">(</span><span style="color: #DD0000">'example.rar'</span><span style="color: #007700">);<br />if&nbsp;(</span><span style="color: #0000BB">$rar_file&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">"Failed&nbsp;to&nbsp;open&nbsp;Rar&nbsp;archive"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$entry&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">rar_entry_get</span><span style="color: #007700">(</span><span style="color: #0000BB">$rar_file</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">'Dir/file.txt'</span><span style="color: #007700">);<br />if&nbsp;(</span><span style="color: #0000BB">$entry&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">"Failed&nbsp;to&nbsp;find&nbsp;such&nbsp;entry"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$stream&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">$entry</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getStream</span><span style="color: #007700">();<br />if&nbsp;(</span><span style="color: #0000BB">$stream&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">"Failed&nbsp;to&nbsp;obtain&nbsp;stream."</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_file</span><span style="color: #007700">);&nbsp;</span><span style="color: #FF8000">//stream&nbsp;is&nbsp;independent&nbsp;from&nbsp;file<br /><br /></span><span style="color: #007700">while&nbsp;(!</span><span style="color: #0000BB">feof</span><span style="color: #007700">(</span><span style="color: #0000BB">$stream</span><span style="color: #007700">))&nbsp;{<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$buff&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">fread</span><span style="color: #007700">(</span><span style="color: #0000BB">$stream</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">8192</span><span style="color: #007700">);<br />&nbsp;&nbsp;&nbsp;&nbsp;if&nbsp;(</span><span style="color: #0000BB">$buff&nbsp;</span><span style="color: #007700">!==&nbsp;</span><span style="color: #0000BB">false</span><span style="color: #007700">)<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;echo&nbsp;</span><span style="color: #0000BB">$buff</span><span style="color: #007700">;<br />&nbsp;&nbsp;&nbsp;&nbsp;else<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;break;&nbsp;</span><span style="color: #FF8000">//fread&nbsp;error<br /></span><span style="color: #007700">}<br /><br /></span><span style="color: #0000BB">fclose</span><span style="color: #007700">(</span><span style="color: #0000BB">$stream</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?&gt;</span>
    88. 

  88. </span>
    89. 

  89. </code></div>
    90. 

  90.     </div>
    91. 

  91. 

  92.    </div>
    93. 

  93.   </p>
    94. 

  94.  </div>
    95. 

  95. 

  96.  
    97. 

  97.  <div class="refsect1 seealso">
    98. 

  98.   <h3 class="title">See Also</h3>
    99. 

  99.   <p class="para">
    100. 

  100.    <ul class="simplelist">
    101. 

  101.     <li class="member"> <span class="methodname"><a href="rarentry.extract.html" class="function" rel="rdfs-seeAlso">RarEntry::extract</a> - Extract entry from the archive.</span></li>
    102. 

  102.    </ul>
    103. 

  103.   </p>
    104. 

  104.  </div>
    105. 

  105. 

  106. 

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

  108.  <div class="prev" style="text-align: left; float: left;"><a href="rarentry.getpackedsize.html">RarEntry::getPackedSize</a></div>
    109. 

  109.  <div class="next" style="text-align: right; float: right;"><a href="rarentry.getunpackedsize.html">RarEntry::getUnpackedSize</a></div>
    110. 

  110.  <div class="up"><a href="class.rarentry.html">RarEntry</a></div>
    111. 

  111.  <div class="home"><a href="index.html">PHP Manual</a></div>
    112. 

  112. </div></body></html>
    113. 

  113.