Sophie: php-manual-en-4.3.0-2mdk noarch

php-manual-en-4.3.0-2mdk.noarch.rpm

<HTML
><HEAD
><TITLE
>gzencode</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK
REL="HOME"
TITLE="PHP Manual"
HREF="index.html"><LINK
REL="UP"
TITLE="Zlib Compression Functions"
HREF="ref.zlib.html"><LINK
REL="PREVIOUS"
TITLE="gzdeflate"
HREF="function.gzdeflate.html"><LINK
REL="NEXT"
TITLE="gzeof"
HREF="function.gzeof.html"><META
HTTP-EQUIV="Content-type"
CONTENT="text/html; charset=ISO-8859-1"></HEAD
><BODY
CLASS="refentry"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>PHP Manual</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="function.gzdeflate.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="function.gzeof.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="function.gzencode"
></A
>gzencode</H1
><DIV
CLASS="refnamediv"
><A
NAME="AEN99001"
></A
><P
>    (PHP 4 &#62;= 4.0.4)</P
>gzencode&nbsp;--&nbsp;Create a gzip compressed string</DIV
><DIV
CLASS="refsect1"
><A
NAME="AEN99004"
></A
><H2
>Description</H2
>string <B
CLASS="methodname"
>gzencode</B
> ( string data [, int level [, int encoding_mode]])<BR
></BR
><P
>   
     This function returns a compressed version of the input
     <TT
CLASS="parameter"
><I
>data</I
></TT
> compatible with the output of the
     <B
CLASS="command"
>gzip</B
> program, or <TT
CLASS="constant"
><B
>FALSE</B
></TT
> if an error is
     encountered. The optional parameter <TT
CLASS="parameter"
><I
>level</I
></TT
>
     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.
    </P
><P
>&#13;     You can also give <TT
CLASS="constant"
><B
>FORCE_GZIP</B
></TT
> (the default)
     or <TT
CLASS="constant"
><B
>FORCE_DEFLATE</B
></TT
> as optional third paramter
     <TT
CLASS="parameter"
><I
>encoding_mode</I
></TT
>. If you use
     <TT
CLASS="constant"
><B
>FORCE_DEFLATE</B
></TT
>, you get a standard zlib
     deflated string (inclusive zlib headers) after the gzip file
     header but without the trailing crc32 checksum.
     <DIV
CLASS="note"
><BLOCKQUOTE
CLASS="note"
><P
><B
>Note: </B
>
       <TT
CLASS="parameter"
><I
>level</I
></TT
> was added in PHP 4.2, before PHP
       4.2 <B
CLASS="function"
>gzencode()</B
> only had the
       <TT
CLASS="parameter"
><I
>data</I
></TT
> and (optional)
       <TT
CLASS="parameter"
><I
>encoding_mode</I
></TT
> parameters..
      </P
></BLOCKQUOTE
></DIV
>
    </P
><P
>&#13;     The resulting data contains the appropriate headers and data
     structure to make a standard .gz file, e.g.:
     <TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
CLASS="EXAMPLE"
><TR
><TD
><DIV
CLASS="example"
><A
NAME="AEN99035"
></A
><P
><B
>Example 1. Creating a gzip file</B
></P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
CELLPADDING="5"
><TR
><TD
><PRE
CLASS="php"
>&#60;?php
    $data = implode("", file("bigfile.txt"));
    $gzdata = gzencode($data, 9);
    $fp = fopen("bigfile.txt.gz", "w");
    fwrite($fp, $gzdata);
    fclose($fp);
?&#62;</PRE
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
>
    </P
><P
>&#13;     For more information on the GZIP file format, see the document:
     <A
HREF="http://www.ietf.org/rfc/rfc1952.txt"
TARGET="_top"
>GZIP file format specification
     version 4.3</A
> (RFC 1952).
    </P
><P
>&#13;     See also <A
HREF="function.gzcompress.html"
><B
CLASS="function"
>gzcompress()</B
></A
>.
     <A
HREF="function.gzuncompress.html"
><B
CLASS="function"
>gzuncompress()</B
></A
>,
     <A
HREF="function.gzdeflate.html"
><B
CLASS="function"
>gzdeflate()</B
></A
>,
     <A
HREF="function.gzinflate.html"
><B
CLASS="function"
>gzinflate()</B
></A
>.
    </P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="function.gzdeflate.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="function.gzeof.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>gzdeflate</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="ref.zlib.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>gzeof</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>