mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-19 18:38:55 +00:00
009d44bfcf
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@179740 c90b9560-bf6c-de11-be94-00142212c4b1
150 lines
4.1 KiB
XML
150 lines
4.1 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.7 $ -->
|
|
<refentry id="function.gzencode">
|
|
<refnamediv>
|
|
<refname>gzencode</refname>
|
|
<refpurpose>Create a gzip compressed string</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>gzencode</methodname>
|
|
<methodparam><type>string</type><parameter>data</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>level</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>encoding_mode</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
This function returns a compressed version of the input
|
|
<parameter>data</parameter> compatible with the output of the
|
|
<command>gzip</command> program.
|
|
</para>
|
|
<para>
|
|
For more information on the GZIP file format, see the document:
|
|
<ulink url="&url.rfc;1952">GZIP file format specification
|
|
version 4.3</ulink> (RFC 1952).
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>data</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The data to encode.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>level</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The level of compression. Can be given as 0 for no compression up to 9
|
|
for maximum compression. If not given, the default compression level will
|
|
be the default compression level of the zlib library.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>encoding_mode</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The encoding mode. Can be <constant>FORCE_GZIP</constant> (the default)
|
|
or <constant>FORCE_DEFLATE</constant>.
|
|
</para>
|
|
<para>
|
|
If you use <constant>FORCE_DEFLATE</constant>, you get a standard zlib
|
|
deflated string (inclusive zlib headers) after the gzip file header but
|
|
without the trailing crc32 checksum.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
The encoded string, or &false; if an error occurred.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
The resulting data contains the appropriate headers and data
|
|
structure to make a standard .gz file, e.g.:
|
|
<example>
|
|
<title>Creating a gzip file</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$data = implode("", file("bigfile.txt"));
|
|
$gzdata = gzencode($data, 9);
|
|
$fp = fopen("bigfile.txt.gz", "w");
|
|
fwrite($fp, $gzdata);
|
|
fclose($fp);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="changelog">
|
|
&reftitle.changelog;
|
|
<para>
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>&Version;</entry>
|
|
<entry>&Description;</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>4.2</entry>
|
|
<entry>
|
|
<parameter>level</parameter> was added. <function>gzencode</function>
|
|
only had the <parameter>data</parameter> and the optional
|
|
<parameter>encoding_mode</parameter> parameters before.
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>gzdeflate</function></member>
|
|
<member><function>gzinflate</function></member>
|
|
<member><function>gzuncompress</function></member>
|
|
<member><function>gzcompress</function></member>
|
|
</simplelist>
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"../../../../manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|