uTools-Manuals/docs/php/gzcompress.html
2019-04-08 23:22:26 +08:00

156 lines
5.3 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Compress a string</title>
</head>
<body class="docs"><div id="layout">
<div id="layout-content"><div id="function.gzcompress" class="refentry">
<div class="refnamediv">
<h1 class="refname">gzcompress</h1>
<p class="verinfo">(PHP 4 &gt;= 4.0.1, PHP 5, PHP 7)</p><p class="refpurpose"><span class="refname">gzcompress</span> &mdash; <span class="dc-title">Compress a string</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.gzcompress-description">
<h3 class="title">说明</h3>
<div class="methodsynopsis dc-description">
<span class="methodname"><strong>gzcompress</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$data</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$level</code><span class="initializer"> = -1</span></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$encoding</code><span class="initializer"> = ZLIB_ENCODING_DEFLATE</span></span>
]] ) : <span class="type">string</span></div>
<p class="para rdfs-comment">
This function compresses the given string using the <em>ZLIB</em>
data format.
</p>
<p class="para">
For details on the ZLIB compression algorithm see the document
&quot;<a href="http://www.faqs.org/rfcs/rfc1950" class="link external">&raquo;&nbsp;ZLIB Compressed Data Format
Specification version 3.3</a>&quot; (RFC 1950).
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
This is <em class="emphasis">not</em> the same as gzip compression,
which includes some header data. See <span class="function"><a href="gzencode.html" class="function">gzencode()</a></span>
for gzip compression.
</p>
</p></blockquote>
</div>
<div class="refsect1 parameters" id="refsect1-function.gzcompress-parameters">
<h3 class="title">参数</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">data</code></dt>
<dd>
<p class="para">
The data to compress.
</p>
</dd>
<dt>
<code class="parameter">level</code></dt>
<dd>
<p class="para">
The level of compression. Can be given as 0 for no compression up to 9
for maximum compression.
</p>
<p class="para">
If -1 is used, the default compression of the zlib library is used which is 6.
</p>
</dd>
<dt>
<code class="parameter">encoding</code></dt>
<dd>
<p class="para">
One of <strong><code>ZLIB_ENCODING_*</code></strong> constants.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.gzcompress-returnvalues">
<h3 class="title">返回值</h3>
<p class="para">
The compressed string or <strong><code>FALSE</code></strong> if an error occurred.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.gzcompress-examples">
<h3 class="title">范例</h3>
<p class="para">
<div class="example" id="example-869">
<p><strong>Example #1 <span class="function"><strong>gzcompress()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><pre><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br />$compressed&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">gzcompress</span><span style="color: #007700">(</span><span style="color: #DD0000">'Compress&nbsp;me'</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">9</span><span style="color: #007700">);<br />echo&nbsp;</span><span style="color: #0000BB">$compressed</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">?&gt;</span>
</span>
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 changelog" id="refsect1-function.gzcompress-changelog">
<h3 class="title">更新日志</h3>
<p class="para">
<table class="doctable informaltable">
<thead>
<tr>
<th>版本</th>
<th>说明</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>5.4.0</td>
<td>
Added <code class="parameter">encoding</code> parameter.
</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.gzcompress-seealso">
<h3 class="title">参见</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="function"><a href="gzdeflate.html" class="function" rel="rdfs-seeAlso">gzdeflate()</a> - Deflate a string</span></li>
<li class="member"><span class="function"><a href="gzinflate.html" class="function" rel="rdfs-seeAlso">gzinflate()</a> - Inflate a deflated string</span></li>
<li class="member"><span class="function"><a href="gzuncompress.html" class="function" rel="rdfs-seeAlso">gzuncompress()</a> - Uncompress a compressed string</span></li>
<li class="member"><span class="function"><a href="gzencode.html" class="function" rel="rdfs-seeAlso">gzencode()</a> - Create a gzip compressed string</span></li>
</ul>
</p>
</div>
</div></div></div></body></html>