cvs: phpdoc /en/reference/zlib/functions gzclose.xml gzcompress.xml gzdeflate.xml gzencode.xml gzeof.xml gzfile.xml gzgetc.xml gzgets.xml gzgetss.xml
gzinflate.xml gzopen.xml gzpassthru.xml gzputs.xml gzread.xml gzrewind.xml gzseek.xml gztell.xml gzuncompress.xml gzwrite.xml readgzfile.xml
zlib-get-coding-type.xml

From:	Mehdi Achour	Date:	Fri, 14 Jan 2005 01:15:53 +0000
Subject:	cvs: phpdoc /en/reference/zlib/functions gzclose.xml gzcompress.xml gzdeflate.xml gzencode.xml gzeof.xml gzfile.xml gzgetc.xml gzgets.xml gzgetss.xml gzinflate.xml gzopen.xml gzpassthru.xml gzputs.xml gzread.xml gzrewind.xml gzseek.xml gztell.xml gzuncompress.xml gzwrite.xml readgzfile.xml zlib-get-coding-type.xml
Groups:	php.doc
Request:	Send a blank email to phpdoc+get-969365960@lists.php.net to get a copy of this message

didou Thu Jan 13 20:15:53 2005 EDT Modified files: /phpdoc/en/reference/zlib/functions gzclose.xml gzcompress.xml gzdeflate.xml gzencode.xml gzeof.xml gzfile.xml gzgetc.xml gzgets.xml gzgetss.xml gzinflate.xml gzopen.xml gzpassthru.xml gzputs.xml gzread.xml gzrewind.xml gzseek.xml gztell.xml gzuncompress.xml gzwrite.xml readgzfile.xml zlib-get-coding-type.xml Log: Switch ref.zlib to the new structure

http://cvs.php.net/diff.php/phpdoc/en/reference/zlib/functions/gzclose.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/zlib/functions/gzclose.xml diff -u phpdoc/en/reference/zlib/functions/gzclose.xml:1.4 phpdoc/en/reference/zlib/functions/gzclose.xml:1.5 --- phpdoc/en/reference/zlib/functions/gzclose.xml:1.4 Fri Feb 27 13:06:01 2004 +++ phpdoc/en/reference/zlib/functions/gzclose.xml Thu Jan 13 20:15:52 2005 @@ -1,32 +1,51 @@ <?xml version="1.0" encoding="iso-8859-1"?> - - - <refentry id="function.gzclose"> - <refnamediv> - <refname>gzclose</refname> - <refpurpose>Close an open gz-file pointer</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>gzclose</methodname> - <methodparam><type>resource</type><parameter>zp</parameter></methodparam> - </methodsynopsis> - <para> - The gz-file pointed to by <parameter>zp</parameter> is closed. - </para> - <para> - &return.success; - </para> - <para> - The gz-file pointer must be valid, and must point to a file - successfully opened by <function>gzopen</function>. - </para> - <para> - See also <function>gzopen</function>. - </para> - </refsect1> - </refentry> + +<refentry id="function.gzclose"> + <refnamediv> + <refname>gzclose</refname> + <refpurpose>Close an open gz-file pointer</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>bool</type><methodname>gzclose</methodname> + <methodparam><type>resource</type><parameter>zp</parameter></methodparam> + </methodsynopsis> + <para> + Closes the given gz-file pointer. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>zp</parameter></term> + <listitem> + <para> + The gz-file pointer. It must be valid, and must point to a file + successfully opened by <function>gzopen</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>gzopen</function></member> + </simplelist> + </para> + </refsect1> +</refentry>  - - <refentry id="function.gzcompress"> - <refnamediv> - <refname>gzcompress</refname> - <refpurpose>Compress a string</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>gzcompress</methodname> - <methodparam><type>string</type><parameter>data</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>level</parameter></methodparam> - </methodsynopsis> - <para> - This function returns a compressed version of the input - <parameter>data</parameter> using the ZLIB data format, - 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> - <para> - For details on the ZLIB compression algorithm see the document - "<ulink url="&url.rfc;1950">ZLIB Compressed Data Format - Specification version 3.3</ulink>" (RFC 1950). - </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>gzdeflate</function>, - <function>gzinflate</function>, - <function>gzuncompress</function>, - <function>gzencode</function>. - </para> - </refsect1> - </refentry> + +<refentry id="function.gzcompress"> + <refnamediv> + <refname>gzcompress</refname> + <refpurpose>Compress a string</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>string</type><methodname>gzcompress</methodname> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>level</parameter></methodparam> + </methodsynopsis> + <para> + This function compress the given string using the <literal>ZLIB</literal> + data format. + </para> + <para> + For details on the ZLIB compression algorithm see the document + "<ulink url="&url.rfc;1950">ZLIB Compressed Data Format + Specification version 3.3</ulink>" (RFC 1950). + </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> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>data</parameter></term> + <listitem> + <para> + The data to compress. + </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. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + The compressed string or &false; if an error occured. + </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>gzencode</function></member> + </simplelist> + </para> + </refsect1> +</refentry>  - - <refentry id="function.gzdeflate"> - <refnamediv> - <refname>gzdeflate</refname> - <refpurpose>Deflate a string</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>gzdeflate</methodname> - <methodparam><type>string</type><parameter>data</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>level</parameter></methodparam> - </methodsynopsis> - <para> - This function returns a compressed version of the input - <parameter>data</parameter> using the DEFLATE data format, - 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. If - <parameter>level</parameter> is not given the default - compression level will be the default compression level of the - zlib library. - </para> - <para> - For details on the DEFLATE compression algorithm see the document - "<ulink url="&url.rfc;1951">DEFLATE Compressed Data Format - Specification version 1.3</ulink>" (RFC 1951). - </para> - <para> - See also - <function>gzinflate</function>, - <function>gzcompress</function>, - <function>gzuncompress</function>, - <function>gzencode</function>. - </para> - </refsect1> - </refentry> + +<refentry id="function.gzdeflate"> + <refnamediv> + <refname>gzdeflate</refname> + <refpurpose>Deflate a string</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>string</type><methodname>gzdeflate</methodname> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>level</parameter></methodparam> + </methodsynopsis> + <para> + This function compress the given string using the <literal>DEFLATE</literal> + data format. + </para> + <para> + For details on the DEFLATE compression algorithm see the document + "<ulink url="&url.rfc;1951">DEFLATE Compressed Data Format + Specification version 1.3</ulink>" (RFC 1951). + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>data</parameter></term> + <listitem> + <para> + The data to deflate. + </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> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + The deflated string or &false; if an error occured. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>gzinflate</function></member> + <member><function>gzcompress</function></member> + <member><function>gzuncompress</function></member> + <member><function>gzencode</function></member> + </simplelist> + </para> + </refsect1> +</refentry>  - - <refentry id="function.gzencode"> - <refnamediv> - <refname>gzencode</refname> - <refpurpose>Create a gzip compressed string</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <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, 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, if not given the default compression level will be - the default compression level of the zlib library. - </para> - <para> - You can also give <constant>FORCE_GZIP</constant> (the default) - or <constant>FORCE_DEFLATE</constant> as optional third parameter - <parameter>encoding_mode</parameter>. 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. - <note> + +<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> - <parameter>level</parameter> was added in PHP 4.2, before PHP - 4.2 <function>gzencode</function> only had the - <parameter>data</parameter> and (optional) - <parameter>encoding_mode</parameter> parameters.. - </para> - </note> - </para> - <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"> + 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 occured. + </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); +$data = implode("", file("bigfile.txt")); +$gzdata = gzencode($data, 9); +$fp = fopen("bigfile.txt.gz", "w"); +fwrite($fp, $gzdata); +fclose($fp); ?> ]]> - </programlisting> - </example> - </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> - <para> - See also <function>gzcompress</function>, - <function>gzuncompress</function>, - <function>gzdeflate</function>, and - <function>gzinflate</function>. - </para> - </refsect1> - </refentry> + </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>  - - <refentry id="function.gzeof"> - <refnamediv> - <refname>gzeof</refname> - <refpurpose>Test for end-of-file on a gz-file pointer</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>gzeof</methodname> - <methodparam><type>resource</type><parameter>zp</parameter></methodparam> - </methodsynopsis> - <para> - Returns &true; if the gz-file pointer is at EOF or an error occurs; - otherwise returns &false;. - </para> - <para> - The gz-file pointer must be valid, and must point to a file - successfully opened by <function>gzopen</function>. - </para> - </refsect1> - </refentry> + +<refentry id="function.gzeof"> + <refnamediv> + <refname>gzeof</refname> + <refpurpose>Test for end-of-file on a gz-file pointer</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>int</type><methodname>gzeof</methodname> + <methodparam><type>resource</type><parameter>zp</parameter></methodparam> + </methodsynopsis> + <para> + Tests the given GZ file pointer for EOF (end-of-file). + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>zp</parameter></term> + <listitem> + <para> + The gz-file pointer. It must be valid, and must point to a file + successfully opened by <function>gzopen</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns &true; if the gz-file pointer is at EOF or an error occurs; + otherwise returns &false;. + </para> + </refsect1> +</refentry>  - - <refentry id="function.gzfile"> - <refnamediv> - <refname>gzfile</refname> - <refpurpose>Read entire gz-file into an array</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>array</type><methodname>gzfile</methodname> - <methodparam><type>string</type><parameter>filename</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>use_include_path</parameter></methodparam> - </methodsynopsis> - <para> - Identical to <function>readgzfile</function>, except that - <function>gzfile</function> returns the file in an array. - </para> - <para> - You can use the optional second parameter and set it to "1", if - you want to search for the file in the <link - linkend="ini.include-path">include_path</link>, too. - </para> - <para> - See also <function>readgzfile</function>, and - <function>gzopen</function>. - </para> - </refsect1> - </refentry> + +<refentry id="function.gzfile"> + <refnamediv> + <refname>gzfile</refname> + <refpurpose>Read entire gz-file into an array</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>array</type><methodname>gzfile</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>use_include_path</parameter></methodparam> + </methodsynopsis> + <para> + This function is identical to <function>readgzfile</function>, except that + it returns the file in an array. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>filename</parameter></term> + <listitem> + <para> + The file name. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>use_include_path</parameter></term> + <listitem> + <para> + You can set this optional parameter to <literal>1</literal>, if you + want to search for the file in the <link + linkend="ini.include-path">include_path</link> too. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + An array containing the file, one line per cell. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>readgzfile</function></member> + <member><function>gzopen</function></member> + </simplelist> + </para> + </refsect1> +</refentry>  - - <refentry id="function.gzgetc"> - <refnamediv> - <refname>gzgetc</refname> - <refpurpose>Get character from gz-file pointer</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>gzgetc</methodname> - <methodparam><type>resource</type><parameter>zp</parameter></methodparam> - </methodsynopsis> - <para> - Returns a string containing a single (uncompressed) character - read from the file pointed to by zp. Returns &false; on EOF - (unlike <function>gzeof</function>). - </para> - <para> - The gz-file pointer must be valid, and must point to a file - successfully opened by <function>gzopen</function>. - </para> - <para> - See also <function>gzopen</function>, and - <function>gzgets</function>. - </para> - </refsect1> - </refentry> + +<refentry id="function.gzgetc"> + <refnamediv> + <refname>gzgetc</refname> + <refpurpose>Get character from gz-file pointer</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>string</type><methodname>gzgetc</methodname> + <methodparam><type>resource</type><parameter>zp</parameter></methodparam> + </methodsynopsis> + <para> + Returns a string containing a single (uncompressed) character + read from the given gz-file pointer. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>zp</parameter></term> + <listitem> + <para> + The gz-file pointer. It must be valid, and must point to a file + successfully opened by <function>gzopen</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + The uncompressed character or &false; on EOF (unlike <function>gzeof</function>). + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>gzopen</function></member> + <member><function>gzgets</function></member> + </simplelist> + </para> + </refsect1> +</refentry>  - - <refentry id="function.gzgets"> - <refnamediv> - <refname>gzgets</refname> - <refpurpose>Get line from file pointer</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>gzgets</methodname> - <methodparam><type>resource</type><parameter>zp</parameter></methodparam> - <methodparam><type>int</type><parameter>length</parameter></methodparam> - </methodsynopsis> - <para> - Returns a (uncompressed) string of up to length - 1 bytes read - from the file pointed to by fp. Reading ends when length - 1 - bytes have been read, on a newline, or on EOF (whichever comes - first). - </para> - <para> - If an error occurs, returns &false;. - </para> - <para> - The file pointer must be valid, and must point to a file - successfully opened by <function>gzopen</function>. - </para> - <para> - See also <function>gzopen</function>, - <function>gzgetc</function>, and <function>fgets</function>. - </para> - </refsect1> - </refentry> + +<refentry id="function.gzgets"> + <refnamediv> + <refname>gzgets</refname> + <refpurpose>Get line from file pointer</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>string</type><methodname>gzgets</methodname> + <methodparam><type>resource</type><parameter>zp</parameter></methodparam> + <methodparam><type>int</type><parameter>length</parameter></methodparam> + </methodsynopsis> + <para> + Gets a (uncompressed) string of up to length - 1 bytes read from the given + file pointer. Reading ends when length - 1 bytes have been read, on a + newline, or on EOF (whichever comes first). + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>zp</parameter></term> + <listitem> + <para> + The gz-file pointer. It must be valid, and must point to a file + successfully opened by <function>gzopen</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>length</parameter></term> + <listitem> + <para> + The length of data to get. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + The uncompressed string, or &false; on error. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>gzopen</function></member> + <member><function>gzgetc</function></member> + <member><function>gzgets</function></member> + </simplelist> + </para> + </refsect1> +</refentry>  - - <refentry id="function.gzgetss"> - <refnamediv> - <refname>gzgetss</refname> - <refpurpose> - Get line from gz-file pointer and strip HTML tags - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>gzgetss</methodname> - <methodparam><type>resource</type><parameter>zp</parameter></methodparam> - <methodparam><type>int</type><parameter>length</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>allowable_tags</parameter></methodparam> - </methodsynopsis> - <para> - Identical to <function>gzgets</function>, except that - <function>gzgetss</function> attempts to strip any HTML and PHP - tags from the text it reads. - </para> - <para> - You can use the optional third parameter to specify tags which - should not be stripped. - <note> + +<refentry id="function.gzgetss"> + <refnamediv> + <refname>gzgetss</refname> + <refpurpose> + Get line from gz-file pointer and strip HTML tags + </refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>string</type><methodname>gzgetss</methodname> + <methodparam><type>resource</type><parameter>zp</parameter></methodparam> + <methodparam><type>int</type><parameter>length</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>allowable_tags</parameter></methodparam> + </methodsynopsis> + <para> + Identical to <function>gzgets</function>, except that + <function>gzgetss</function> attempts to strip any HTML and PHP + tags from the text it reads. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>zp</parameter></term> + <listitem> <para> - <parameter>Allowable_tags</parameter> was added in PHP 3.0.13, - PHP 4.0b3. - </para> - </note> - </para> - <para> - See also <function>gzgets</function>, - <function>gzopen</function>, and <function>strip_tags</function>. - </para> - </refsect1> - </refentry> + The gz-file pointer. It must be valid, and must point to a file + successfully opened by <function>gzopen</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>length</parameter></term> + <listitem> + <para> + The length of data to get. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>allowable_tags</parameter></term> + <listitem> + <para> + You can use this optional parameter to specify tags which should not + be stripped. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + The uncompressed and striped string, or &false; on error. + </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>3.0.13 and 4.0b3</entry> + <entry> + <parameter>allowable_tags</parameter> was added. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>gzopen</function></member> + <member><function>gzgets</function></member> + <member><function>strip_tags</function></member> + </simplelist> + </para> + </refsect1> +</refentry>  - - <refentry id="function.gzinflate"> - <refnamediv> - <refname>gzinflate</refname> - <refpurpose>Inflate a deflated string</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>gzinflate</methodname> - <methodparam><type>string</type><parameter>data</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam> - </methodsynopsis> - <para> - This function takes <parameter>data</parameter> compressed by - <function>gzdeflate</function> and returns the original - uncompressed data or &false; on error. The function will return an - error if the uncompressed data is more than 32768 times the length - of the compressed input <parameter>data</parameter> or more than - the optional parameter <parameter>length</parameter>. - </para> - <para> - See also <function>gzcompress</function>, - <function>gzuncompress</function>, - <function>gzdeflate</function>, and - <function>gzencode</function>. - </para> - </refsect1> - </refentry> + +<refentry id="function.gzinflate"> + <refnamediv> + <refname>gzinflate</refname> + <refpurpose>Inflate a deflated string</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>string</type><methodname>gzinflate</methodname> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam> + </methodsynopsis> + <para> + This function inflate a deflated string. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>data</parameter></term> + <listitem> + <para> + The data compressed by <function>gzdeflate</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>length</parameter></term> + <listitem> + <para> + The maximum length of data to decode. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + The original uncompressed data or &false; on error. + </para> + <para> + The function will return an error if the uncompressed data is more than + 32768 times the length of the compressed input <parameter>data</parameter> + or more than the optional parameter <parameter>length</parameter>. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>gzdeflate</function></member> + <member><function>gzcompress</function></member> + <member><function>gzuncompress</function></member> + <member><function>gzencode</function></member> + </simplelist> + </para> + </refsect1> +</refentry>  - - <refentry id="function.gzopen"> - <refnamediv> - <refname>gzopen</refname> - <refpurpose>Open gz-file</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>resource</type><methodname>gzopen</methodname> - <methodparam><type>string</type><parameter>filename</parameter></methodparam> - <methodparam><type>string</type><parameter>mode</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>use_include_path</parameter></methodparam> - </methodsynopsis> - <para> - Opens a gzip (.gz) file for reading or writing. The mode - parameter is as in <function>fopen</function> ("rb" or "wb") but - can also include a compression level ("wb9") or a strategy: 'f' - for filtered data as in "wb6f", 'h' for Huffman only compression - as in "wb1h". (See the description of deflateInit2 in zlib.h for - more information about the strategy parameter.) - </para> - <para> - <function>gzopen</function> can be used to read a file which is - not in gzip format; in this case <function>gzread</function> will - directly read from the file without decompression. - </para> - <para> - <function>gzopen</function> 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. - </para> - <para> - If the open fails, the function returns &false;. - </para> - <para> - You can use the optional third parameter and set it to "1", if - you want to search for the file in the <link - linkend="ini.include-path">include_path</link>, too. - </para> - <para> - <example> - <title><function>gzopen</function> Example</title> - <programlisting role="php"> + +<refentry id="function.gzopen"> + <refnamediv> + <refname>gzopen</refname> + <refpurpose>Open gz-file</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>resource</type><methodname>gzopen</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + <methodparam><type>string</type><parameter>mode</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>use_include_path</parameter></methodparam> + </methodsynopsis> + <para> + Opens a gzip (.gz) file for reading or writing. + </para> + <para> + <function>gzopen</function> can be used to read a file which is + not in gzip format; in this case <function>gzread</function> will + directly read from the file without decompression. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>filename</parameter></term> + <listitem> + <para> + The file name. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>mode</parameter></term> + <listitem> + <para> + As in <function>fopen</function> (<literal>rb</literal> or + <literal>wb</literal>) but can also include a compression level + (<literal>wb9</literal>) or a strategy: <literal>f</literal> for + filtered data as in <literal>wb6f</literal>, <literal>h</literal> for + <literal>Huffman only compression</literal> as in <literal>wb1h</literal>. + (See the description of deflateInit2 in <filename>zlib.h</filename> for + more information about the strategy parameter.) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>use_include_path</parameter></term> + <listitem> + <para> + You can set this optional parameter to <literal>1</literal>, if you + want to search for the file in the <link + linkend="ini.include-path">include_path</link> too. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <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. + </para> + <para> + If the open fails, the function returns &false;. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>gzopen</function> Example</title> + <programlisting role="php"> <![CDATA[ <?php $fp = gzopen("/tmp/file.gz", "r"); ?> ]]> - </programlisting> - </example> - </para> - <para> - See also <function>gzclose</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>gzclose</function></member> + </simplelist> + </para> + </refsect1> +</refentry>  - - <refentry id="function.gzpassthru"> - <refnamediv> - <refname>gzpassthru</refname> - <refpurpose> - Output all remaining data on a gz-file pointer - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>gzpassthru</methodname> - <methodparam><type>resource</type><parameter>zp</parameter></methodparam> - </methodsynopsis> - <para> - Reads to EOF on the given gz-file pointer and writes the - (uncompressed) results to standard output. - </para> - <para> - If an error occurs, returns &false;. - </para> - <para> - The file pointer must be valid, and must point to a file - successfully opened by <function>gzopen</function>. - </para> - </refsect1> - </refentry> + +<refentry id="function.gzpassthru"> + <refnamediv> + <refname>gzpassthru</refname> + <refpurpose> + Output all remaining data on a gz-file pointer + </refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>int</type><methodname>gzpassthru</methodname> + <methodparam><type>resource</type><parameter>zp</parameter></methodparam> + </methodsynopsis> + <para> + Reads to EOF on the given gz-file pointer from the current position and + writes the (uncompressed) results to standard output. + </para> + <note> + <para> + You may need to call <function>gzrewind</function> to reset the file + pointer to the beginning of the file if you have already written data + to it. + </para> + </note> + <tip> + <para> + If you just want to dump the contents of a file to the output buffer, + without first modifying it or seeking to a particular offset, you may + want to use the <function>readgzfile</function> function, which saves + you the <function>gzopen</function> call. + </para> + </tip> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>zp</parameter></term> + <listitem> + <para> + The gz-file pointer. It must be valid, and must point to a file + successfully opened by <function>gzopen</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + The number of uncompressed characters read from <parameter>gz</parameter> + and passed through to the input, or &false; on error. + </para> + </refsect1> +</refentry>  - - <refentry id="function.gzputs"> - <refnamediv> - <refname>gzputs</refname> - <refpurpose>Alias of <function>gzwrite</function></refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <para> - This function is an alias of <function>gzwrite</function>. - </para> - </refsect1> - </refentry> + +<refentry id="function.gzputs"> + <refnamediv> + <refname>gzputs</refname> + <refpurpose>Alias of <function>gzwrite</function></refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <para> + This function is an alias of <function>gzwrite</function>. + </para> + </refsect1> +</refentry>  - - <refentry id="function.gzread"> - <refnamediv> - <refname>gzread</refname> - <refpurpose>Binary-safe gz-file read</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>gzread</methodname> - <methodparam><type>resource</type><parameter>zp</parameter></methodparam> - <methodparam><type>int</type><parameter>length</parameter></methodparam> - </methodsynopsis> - <simpara> - <function>gzread</function> reads up to - <parameter>length</parameter> bytes from the gz-file pointer - referenced by <parameter>zp</parameter>. Reading stops when - <parameter>length</parameter> (uncompressed) bytes have been read - or EOF is reached, whichever comes first. - </simpara> - <para> - <example> - <title><function>gzread</function> example</title> - <programlisting role="php"> + +<refentry id="function.gzread"> + <refnamediv> + <refname>gzread</refname> + <refpurpose>Binary-safe gz-file read</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>string</type><methodname>gzread</methodname> + <methodparam><type>resource</type><parameter>zp</parameter></methodparam> + <methodparam><type>int</type><parameter>length</parameter></methodparam> + </methodsynopsis> + <para> + <function>gzread</function> reads up to <parameter>length</parameter> bytes + from the given gz-file pointer. Reading stops when + <parameter>length</parameter> (uncompressed) bytes have been read + or EOF is reached, whichever comes first. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>zp</parameter></term> + <listitem> + <para> + The gz-file pointer. It must be valid, and must point to a file + successfully opened by <function>gzopen</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>length</parameter></term> + <listitem> + <para> + The number of bytes to read. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + The data that have been read. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>gzread</function> example</title> + <programlisting role="php"> <![CDATA[ <?php // get contents of a gz-file into a string @@ -33,16 +64,24 @@ gzclose($zd); ?> ]]> - </programlisting> - </example> - </para> - <simpara> - See also <function>gzwrite</function>, <function>gzopen</function>, - <function>gzgets</function>, <function>gzgetss</function>, - <function>gzfile</function>, and <function>gzpassthru</function>. - </simpara> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>gzwrite</function></member> + <member><function>gzopen</function></member> + <member><function>gzgets</function></member> + <member><function>gzgetss</function></member> + <member><function>gzfile</function></member> + <member><function>gzpassthru</function></member> + </simplelist> + </para> + </refsect1> +</refentry>  - - <refentry id="function.gzrewind"> - <refnamediv> - <refname>gzrewind</refname> - <refpurpose>Rewind the position of a gz-file pointer</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>gzrewind</methodname> - <methodparam><type>resource</type><parameter>zp</parameter></methodparam> - </methodsynopsis> - <para> - Sets the file position indicator for zp to the beginning of the - file stream. - </para> - <para> - If an error occurs, returns 0. - </para> - <para> - The file pointer must be valid, and must point to a file - successfully opened by <function>gzopen</function>. - </para> - <para> - See also <function>gzseek</function> and - <function>gztell</function>. - </para> - </refsect1> - </refentry> + +<refentry id="function.gzrewind"> + <refnamediv> + <refname>gzrewind</refname> + <refpurpose>Rewind the position of a gz-file pointer</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>bool</type><methodname>gzrewind</methodname> + <methodparam><type>resource</type><parameter>zp</parameter></methodparam> + </methodsynopsis> + <para> + Sets the file position indicator of the given gz-file pointer to the + beginning of the file stream. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>zp</parameter></term> + <listitem> + <para> + The gz-file pointer. It must be valid, and must point to a file + successfully opened by <function>gzopen</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>gzseek</function></member> + <member><function>gztell</function></member> + </simplelist> + </para> + </refsect1> +</refentry>  - - <refentry id="function.gzseek"> - <refnamediv> - <refname>gzseek</refname> - <refpurpose>Seek on a gz-file pointer</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>gzseek</methodname> - <methodparam><type>resource</type><parameter>zp</parameter></methodparam> - <methodparam><type>int</type><parameter>offset</parameter></methodparam> - </methodsynopsis> - <para> - Sets the file position indicator for the file referenced by zp to - offset bytes into the file stream. Equivalent to calling (in C) - <literal>gzseek(zp, offset, SEEK_SET)</literal>. - </para> - <para> - If the file is opened for reading, this function is emulated but - can be extremely slow. If the file is opened for writing, only - forward seeks are supported; gzseek then compresses a sequence of - zeroes up to the new starting position. - </para> - <para> - Upon success, returns 0; otherwise, returns -1. Note that seeking - past EOF is not considered an error. - </para> - <para> - See also <function>gztell</function> and - <function>gzrewind</function>. - </para> - </refsect1> - </refentry> + +<refentry id="function.gzseek"> + <refnamediv> + <refname>gzseek</refname> + <refpurpose>Seek on a gz-file pointer</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>int</type><methodname>gzseek</methodname> + <methodparam><type>resource</type><parameter>zp</parameter></methodparam> + <methodparam><type>int</type><parameter>offset</parameter></methodparam> + </methodsynopsis> + <para> + Sets the file position indicator for the given file pointer to the + given offset byte into the file stream. Equivalent to calling (in C) + <literal>gzseek(zp, offset, SEEK_SET)</literal>. + </para> + <para> + If the file is opened for reading, this function is emulated but + can be extremely slow. If the file is opened for writing, only + forward seeks are supported; <function>gzseek</function> then compresses + a sequence of zeroes up to the new starting position. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>zp</parameter></term> + <listitem> + <para> + The gz-file pointer. It must be valid, and must point to a file + successfully opened by <function>gzopen</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>offset</parameter></term> + <listitem> + <para> + The seeked offset. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Upon success, returns 0; otherwise, returns -1. Note that seeking + past EOF is not considered an error. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>gztell</function></member> + <member><function>gzrewind</function></member> + </simplelist> + </para> + </refsect1> +</refentry>  - - <refentry id="function.gztell"> - <refnamediv> - <refname>gztell</refname> - <refpurpose>Tell gz-file pointer read/write position</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>gztell</methodname> - <methodparam><type>resource</type><parameter>zp</parameter></methodparam> - </methodsynopsis> - <para> - Returns the position of the file pointer referenced by - <parameter>zp</parameter>; i.e., its offset into the file - stream. - </para> - <para> - If an error occurs, returns &false;. - </para> - <para> - The file pointer must be valid, and must point to a file - successfully opened by <function>gzopen</function>. - </para> - <para> - See also <function>gzopen</function>, <function>gzseek</function> - and <function>gzrewind</function>. - </para> - </refsect1> - </refentry> + +<refentry id="function.gztell"> + <refnamediv> + <refname>gztell</refname> + <refpurpose>Tell gz-file pointer read/write position</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>int</type><methodname>gztell</methodname> + <methodparam><type>resource</type><parameter>zp</parameter></methodparam> + </methodsynopsis> + <para> + Gets the position of the given file pointer; i.e., its offset into the + file stream. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>zp</parameter></term> + <listitem> + <para> + The gz-file pointer. It must be valid, and must point to a file + successfully opened by <function>gzopen</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + The position of the file pointer or &false; if an error occurs. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>gzopen</function></member> + <member><function>gzseek</function></member> + <member><function>gzrewind</function></member> + </simplelist> + </para> + </refsect1> +</refentry>  - - <refentry id="function.gzuncompress"> - <refnamediv> - <refname>gzuncompress</refname> - <refpurpose>Uncompress a compressed string</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>gzuncompress</methodname> - <methodparam><type>string</type><parameter>data</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam> - </methodsynopsis> - <para> - This function takes <parameter>data</parameter> compressed by - <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 32768 times the length - of the compressed input <parameter>data</parameter> or more than - the optional parameter <parameter>length</parameter>. - </para> - <para> - See also <function>gzdeflate</function>, - <function>gzinflate</function>, - <function>gzcompress</function>, - <function>gzencode</function>. - </para> - </refsect1> - </refentry> + +<refentry id="function.gzuncompress"> + <refnamediv> + <refname>gzuncompress</refname> + <refpurpose>Uncompress a compressed string</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>string</type><methodname>gzuncompress</methodname> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam> + </methodsynopsis> + <para> + This function uncompress a compressed string. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>data</parameter></term> + <listitem> + <para> + The data compressed by <function>gzcompress</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>length</parameter></term> + <listitem> + <para> + The maximum length of data to decode. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + The original uncompressed data or &false; on error. + </para> + <para> + The function will return an error if the uncompressed data is more than + 32768 times the length of the compressed input <parameter>data</parameter> + or more than the optional parameter <parameter>length</parameter>. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>gzcompress</function></member> + <member><function>gzinflate</function></member> + <member><function>gzdeflate</function></member> + <member><function>gzencode</function></member> + </simplelist> + </para> + </refsect1> +</refentry>  - - <refentry id="function.gzwrite"> - <refnamediv> - <refname>gzwrite</refname> - <refpurpose>Binary-safe gz-file write</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>gzwrite</methodname> - <methodparam><type>resource</type><parameter>zp</parameter></methodparam> - <methodparam><type>string</type><parameter>string</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam> - </methodsynopsis> - <simpara> - <function>gzwrite</function> writes the contents of - <parameter>string</parameter> to the gz-file stream pointed to by - <parameter>zp</parameter>. If the <parameter>length</parameter> - argument is given, writing will stop after - <parameter>length</parameter> (uncompressed) bytes have been - written or the end of <parameter>string</parameter> is reached, - whichever comes first. - </simpara> - <simpara> - <function>gzwrite</function> returns the number of (uncompressed) bytes - written to the gz-file stream pointed to by <parameter>zp</parameter>. - </simpara> - <simpara> - Note that if the <parameter>length</parameter> argument is given, - then the <link - linkend="ini.magic-quotes-runtime">magic_quotes_runtime</link> - configuration option will be ignored and no slashes will be - stripped from <parameter>string</parameter>. - </simpara> - <simpara> - See also <function>gzread</function>, <function>gzopen</function>, - and <function>gzputs</function>. - </simpara> - </refsect1> - </refentry> + +<refentry id="function.gzwrite"> + <refnamediv> + <refname>gzwrite</refname> + <refpurpose>Binary-safe gz-file write</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>int</type><methodname>gzwrite</methodname> + <methodparam><type>resource</type><parameter>zp</parameter></methodparam> + <methodparam><type>string</type><parameter>string</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam> + </methodsynopsis> + <para> + <function>gzwrite</function> writes the contents of + <parameter>string</parameter> to the given gz-file. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>zp</parameter></term> + <listitem> + <para> + The gz-file pointer. It must be valid, and must point to a file + successfully opened by <function>gzopen</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>string</parameter></term> + <listitem> + <para> + The string to write. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>length</parameter></term> + <listitem> + <para> + The number of uncompressed bytes to write. If supplied, writing will + stop after <parameter>length</parameter> (uncompressed) bytes have been + written or the end of <parameter>string</parameter> is reached, + whichever comes first. + </para> + <note> + <para> + Note that if the <parameter>length</parameter> argument is given, + then the <link + linkend="ini.magic-quotes-runtime">magic_quotes_runtime</link> + configuration option will be ignored and no slashes will be + stripped from <parameter>string</parameter>. + </para> + </note> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the number of (uncompressed) bytes written to the given gz-file + stream. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>gzread</function></member> + <member><function>gzopen</function></member> + <member><function>gzputs</function></member> + </simplelist> + </para> + </refsect1> +</refentry>  - - <refentry id="function.readgzfile"> - <refnamediv> - <refname>readgzfile</refname> - <refpurpose>Output a gz-file</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>readgzfile</methodname> - <methodparam><type>string</type><parameter>filename</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>use_include_path</parameter></methodparam> - </methodsynopsis> - <para> - Reads a file, decompresses it and writes it to standard - output. - </para> - <para> - <function>readgzfile</function> can be used to read a file which - is not in gzip format; in this case - <function>readgzfile</function> will directly read from the file - without decompression. - </para> - <para> - Returns the number of (uncompressed) bytes read from the file. If - an error occurs, &false; is returned and unless the function was - called as <literal>@readgzfile</literal>, an error message is - printed. - </para> - <para> - The file <parameter>filename</parameter> will be opened from the - filesystem and its contents written to standard output. - </para> - <para> - You can use the optional second parameter and set it to "1", if - you want to search for the file in the <link - linkend="ini.include-path">include_path</link>, too. - </para> - <para> - See also <function>gzpassthru</function>, - <function>gzfile</function>, and <function>gzopen</function>. - </para> - </refsect1> - </refentry> + +<refentry id="function.readgzfile"> + <refnamediv> + <refname>readgzfile</refname> + <refpurpose>Output a gz-file</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>int</type><methodname>readgzfile</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>use_include_path</parameter></methodparam> + </methodsynopsis> + <para> + Reads a file, decompresses it and writes it to standard output. + </para> + <para> + <function>readgzfile</function> can be used to read a file which is not in + gzip format; in this case <function>readgzfile</function> will directly + read from the file without decompression. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>filename</parameter></term> + <listitem> + <para> + The file name. This file will be opened from the filesystem and its + contents written to standard output. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>use_include_path</parameter></term> + <listitem> + <para> + You can set this optional parameter to <literal>1</literal>, if you + want to search for the file in the <link + linkend="ini.include-path">include_path</link> too. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the number of (uncompressed) bytes read from the file. If + an error occurs, &false; is returned and unless the function was + called as <literal>@readgzfile</literal>, an error message is + printed. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>gzpassthru</function></member> + <member><function>gzfile</function></member> + <member><function>gzopen</function></member> + </simplelist> + </para> + </refsect1> +</refentry>  - <refentry id="function.zlib-get-coding-type"> - <refnamediv> - <refname>zlib_get_coding_type</refname> - <refpurpose>Returns the coding type used for output compression</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>zlib_get_coding_type</methodname> - <void /> - </methodsynopsis> - <para> - Returns the coding type used for output compression. Possible return - values are <literal>gzip</literal>, <literal>deflate</literal>, or - &false; - </para> - <para> - See also the - <link linkend="ini.zlib.output-compression"> - zlib.output_compression</link> directive. - </para> - </refsect1> - </refentry> + +<refentry id="function.zlib-get-coding-type"> + <refnamediv> + <refname>zlib_get_coding_type</refname> + <refpurpose>Returns the coding type used for output compression</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>string</type><methodname>zlib_get_coding_type</methodname> + <void /> + </methodsynopsis> + <para> + Returns the coding type used for output compression. + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Possible return values are <literal>gzip</literal>, <literal>deflate</literal>, + or &false;. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member> + The <link + linkend="ini.zlib.output-compression">zlib.output_compression</link> + directive + </member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: