Source of: /manual/en/function.gzopen.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.zlib.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.gzopen.php',
1 => 'gzopen',
),
'up' =>
array (
0 => 'ref.zlib.php',
1 => 'Zlib Functions',
),
'prev' =>
array (
0 => 'function.gzinflate.php',
1 => 'gzinflate',
),
'next' =>
array (
0 => 'function.gzpassthru.php',
1 => 'gzpassthru',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.gzopen" class="refentry">
<div class="refnamediv">
<h1 class="refname">gzopen</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">gzopen</span> — <span class="dc-title">Open gz-file</span></p>
</div>
<a name="function.gzopen.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">resource</span> <span class="methodname"><b>gzopen</b></span>
( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$filename</tt></span>
, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$mode</tt></span>
[, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$use_include_path</tt><span class="initializer"> = 0</span></span>
] )</div>
<p class="para rdfs-comment">
Opens a gzip (.gz) file for reading or writing.
</p>
<p class="para">
<b>gzopen()</b> can be used to read a file which is
not in gzip format; in this case <a href="function.gzread.php" class="function">gzread()</a> will
directly read from the file without decompression.
</p>
</div>
<a name="function.gzopen.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">filename</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The file name.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">mode</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
As in <a href="function.fopen.php" class="function">fopen()</a> (<i>rb</i> or
<i>wb</i>) but can also include a compression level
(<i>wb9</i>) or a strategy: <i>f</i> for
filtered data as in <i>wb6f</i>, <i>h</i> for
<i>Huffman only compression</i> as in <i>wb1h</i>.
(See the description of <i>deflateInit2</i>
in <var class="filename">zlib.h</var> for
more information about the strategy parameter.)
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">use_include_path</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
You can set this optional parameter to <i>1</i>, if you
want to search for the file in the <a href="ini.core.php#ini.include-path" class="link">include_path</a> too.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.gzopen.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns a file pointer to the file opened, after that, everything you read
from this file descriptor will be transparently decompressed and what you
write gets compressed.
</p>
<p class="para">
If the open fails, the function returns <b><tt class="constant">FALSE</tt></b>.
</p>
</div>
<a name="function.gzopen.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 <b>gzopen()</b> Example</b></p>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$fp </span><span style="color: #007700">= </span><span style="color: #0000BB">gzopen</span><span style="color: #007700">(</span><span style="color: #DD0000">"/tmp/file.gz"</span><span style="color: #007700">, </span><span style="color: #DD0000">"r"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div><p>
</p>
</div>
<a name="function.gzopen.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.gzclose.php" class="function" rel="rdfs-seeAlso">gzclose()</a> - Close an open gz-file pointer</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
