sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 08:58:56 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

clear up some gzip/deflate confusion (of course, gzencode is undocumented, which leaves a bit of a hole)

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@40022 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
jim winstead 2001-01-23 02:29:41 +00:00
parent b6ec0edf52
commit b71e069eb1
1 changed files with 15 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
functions/zlib.xml
View file

@ -609,7 +609,7 @@ gzclose ($zd);
<refentry id="function.gzcompress">
<refnamediv>
<refname>gzcompress</refname>
<refpurpose>Gz-compress a string</refpurpose>
<refpurpose>Deflate a string</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@ -623,11 +623,19 @@ gzclose ($zd);
</funcprototype>
</funcsynopsis>
<para>
This function returns a gzip-compressed version of the input
<parameter>data</parameter> or false on errors. The optional
parameter <parameter>level</parameter> can be given as 0 for no
This function returns a compressed version of the input
<parameter>data</parameter> using the deflate algorithm,
or false if an error is encountered. The optional parameter
<parameter>level</parameter> can be given as 0 for no
compression up to 9 for maximum compression.
</para>
<note>
<para>
This is <emphasis>not</emphasis> the same as gzip compression,
which includes some header data. See <function>gzencode</function>
for gzip compression.
</para>
</note>
<para>
See also <function>gzuncompress</function>.
</para>
@ -637,7 +645,7 @@ gzclose ($zd);
<refentry id="function.gzuncompress">
<refnamediv>
<refname>gzuncompress</refname>
<refpurpose>Uncompress a gz-compressed string</refpurpose>
<refpurpose>Uncompress a deflated string</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@ -652,9 +660,9 @@ gzclose ($zd);
</funcsynopsis>
<para>
This function takes <parameter>data</parameter> compressed by
<function>gzcompress</function> and returns the orignial
<function>gzcompress</function> and returns the original
uncompressed data or false on error. The function will return an
error if the uncompressed data is more than 256 times the lenght
error if the uncompressed data is more than 256 times the length
of the compressed input <parameter>data</parameter> or more than
the optional parameter <parameter>length</parameter>.
</para>