philip Fri Feb 25 20:34:29 2005 EDT
Modified files:
/phpdoc/en/reference/zlib/functions gzclose.xml gzcompress.xml
gzdeflate.xml gzeof.xml
gzfile.xml gzgetc.xml
gzgets.xml gzgetss.xml
gzinflate.xml gzseek.xml
gzuncompress.xml gzwrite.xml
Log:
Added an example.
http://cvs.php.net/diff.php/phpdoc/en/reference/zlib/functions/gzclose.xml?r1=1.5&r2=1.6&ty=u
Index: phpdoc/en/reference/zlib/functions/gzclose.xml
diff -u phpdoc/en/reference/zlib/functions/gzclose.xml:1.5
phpdoc/en/reference/zlib/functions/gzclose.xml:1.6
--- phpdoc/en/reference/zlib/functions/gzclose.xml:1.5 Thu Jan 13 20:15:52 2005
+++ phpdoc/en/reference/zlib/functions/gzclose.xml Fri Feb 25 20:34:28 2005
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
<refentry id="function.gzclose">
<refnamediv>
<refname>gzclose</refname>
@@ -37,6 +37,23 @@
&return.success;
</para>
</refsect1>
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title><function>gzclose</function> example</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+$gz = gzopen('somefile.gz','w9');
+gzputs ($gz, 'I was added to somefile.gz');
+gzclose($gz);
+?>
+]]>
+ </programlisting>
+ </example>
+ </para>
+ </refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
http://cvs.php.net/diff.php/phpdoc/en/reference/zlib/functions/gzcompress.xml?r1=1.5&r2=1.6&ty=u
Index: phpdoc/en/reference/zlib/functions/gzcompress.xml
diff -u phpdoc/en/reference/zlib/functions/gzcompress.xml:1.5
phpdoc/en/reference/zlib/functions/gzcompress.xml:1.6
--- phpdoc/en/reference/zlib/functions/gzcompress.xml:1.5 Sun Feb 13
23:13:17 2005
+++ phpdoc/en/reference/zlib/functions/gzcompress.xml Fri Feb 25 20:34:29 2005
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
<refentry id="function.gzcompress">
<refnamediv>
<refname>gzcompress</refname>
@@ -59,6 +59,22 @@
The compressed string or &false; if an error occurred.
</para>
</refsect1>
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title><function>gzcompress</function> example</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+$compressed = gzcompress('Compress me', 9);
+echo $compressed;
+?>
+]]>
+ </programlisting>
+ </example>
+ </para>
+ </refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
http://cvs.php.net/diff.php/phpdoc/en/reference/zlib/functions/gzdeflate.xml?r1=1.6&r2=1.7&ty=u
Index: phpdoc/en/reference/zlib/functions/gzdeflate.xml
diff -u phpdoc/en/reference/zlib/functions/gzdeflate.xml:1.6
phpdoc/en/reference/zlib/functions/gzdeflate.xml:1.7
--- phpdoc/en/reference/zlib/functions/gzdeflate.xml:1.6 Sun Feb 13
23:13:17 2005
+++ phpdoc/en/reference/zlib/functions/gzdeflate.xml Fri Feb 25 20:34:29 2005
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.6 $ -->
+<!-- $Revision: 1.7 $ -->
<refentry id="function.gzdeflate">
<refnamediv>
<refname>gzdeflate</refname>
@@ -53,6 +53,22 @@
The deflated string or &false; if an error occurred.
</para>
</refsect1>
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title><function>gzdeflate</function> example</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+$compressed = gzdeflate('Compress me', 9);
+echo $compressed;
+?>
+]]>
+ </programlisting>
+ </example>
+ </para>
+ </refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
http://cvs.php.net/diff.php/phpdoc/en/reference/zlib/functions/gzeof.xml?r1=1.4&r2=1.5&ty=u
Index: phpdoc/en/reference/zlib/functions/gzeof.xml
diff -u phpdoc/en/reference/zlib/functions/gzeof.xml:1.4
phpdoc/en/reference/zlib/functions/gzeof.xml:1.5
--- phpdoc/en/reference/zlib/functions/gzeof.xml:1.4 Thu Jan 13 20:15:52 2005
+++ phpdoc/en/reference/zlib/functions/gzeof.xml Fri Feb 25 20:34:29 2005
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
<refentry id="function.gzeof">
<refnamediv>
<refname>gzeof</refname>
@@ -38,6 +38,25 @@
otherwise returns &false;.
</para>
</refsect1>
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title><function>gzeof</function> example</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+$gz = gzopen('somefile.gz', 'r');
+while (!gzeof($gz)) {
+ echo gzgetc($gz);
+}
+gzclose($gz);
+?>
+]]>
+ </programlisting>
+ </example>
+ </para>
+ </refsect1>
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/diff.php/phpdoc/en/reference/zlib/functions/gzfile.xml?r1=1.3&r2=1.4&ty=u
Index: phpdoc/en/reference/zlib/functions/gzfile.xml
diff -u phpdoc/en/reference/zlib/functions/gzfile.xml:1.3
phpdoc/en/reference/zlib/functions/gzfile.xml:1.4
--- phpdoc/en/reference/zlib/functions/gzfile.xml:1.3 Thu Jan 13 20:15:52 2005
+++ phpdoc/en/reference/zlib/functions/gzfile.xml Fri Feb 25 20:34:29 2005
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<refentry id="function.gzfile">
<refnamediv>
<refname>gzfile</refname>
@@ -48,6 +48,24 @@
An array containing the file, one line per cell.
</para>
</refsect1>
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title><function>gzfile</function> example</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+$lines = gzfile('somefile.gz');
+foreach ($lines as $line) {
+ echo $line;
+}
+?>
+]]>
+ </programlisting>
+ </example>
+ </para>
+ </refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
http://cvs.php.net/diff.php/phpdoc/en/reference/zlib/functions/gzgetc.xml?r1=1.5&r2=1.6&ty=u
Index: phpdoc/en/reference/zlib/functions/gzgetc.xml
diff -u phpdoc/en/reference/zlib/functions/gzgetc.xml:1.5
phpdoc/en/reference/zlib/functions/gzgetc.xml:1.6
--- phpdoc/en/reference/zlib/functions/gzgetc.xml:1.5 Thu Jan 13 20:15:52 2005
+++ phpdoc/en/reference/zlib/functions/gzgetc.xml Fri Feb 25 20:34:29 2005
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
<refentry id="function.gzgetc">
<refnamediv>
<refname>gzgetc</refname>
@@ -38,6 +38,25 @@
The uncompressed character or &false; on EOF (unlike
<function>gzeof</function>).
</para>
</refsect1>
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title><function>gzgetc</function> example</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+$gz = gzopen('somefile.gz', 'r');
+while (!gzeof($gz)) {
+ echo gzgetc($gz);
+}
+gzclose($gz);
+?>
+]]>
+ </programlisting>
+ </example>
+ </para>
+ </refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
http://cvs.php.net/diff.php/phpdoc/en/reference/zlib/functions/gzgets.xml?r1=1.4&r2=1.5&ty=u
Index: phpdoc/en/reference/zlib/functions/gzgets.xml
diff -u phpdoc/en/reference/zlib/functions/gzgets.xml:1.4
phpdoc/en/reference/zlib/functions/gzgets.xml:1.5
--- phpdoc/en/reference/zlib/functions/gzgets.xml:1.4 Thu Jan 13 20:15:52 2005
+++ phpdoc/en/reference/zlib/functions/gzgets.xml Fri Feb 25 20:34:29 2005
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
<refentry id="function.gzgets">
<refnamediv>
<refname>gzgets</refname>
@@ -48,6 +48,26 @@
The uncompressed string, or &false; on error.
</para>
</refsect1>
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title><function>gzgets</function> example</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+$handle = gzopen('somefile.gz', 'r');
+while (!gzeof($handle)) {
+ $buffer = gzgets($handle, 4096);
+ echo $buffer;
+}
+gzlose($handle);
+?>
+]]>
+ </programlisting>
+ </example>
+ </para>
+ </refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
http://cvs.php.net/diff.php/phpdoc/en/reference/zlib/functions/gzgetss.xml?r1=1.5&r2=1.6&ty=u
Index: phpdoc/en/reference/zlib/functions/gzgetss.xml
diff -u phpdoc/en/reference/zlib/functions/gzgetss.xml:1.5
phpdoc/en/reference/zlib/functions/gzgetss.xml:1.6
--- phpdoc/en/reference/zlib/functions/gzgetss.xml:1.5 Thu Jan 13 20:15:52 2005
+++ phpdoc/en/reference/zlib/functions/gzgetss.xml Fri Feb 25 20:34:29 2005
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
<refentry id="function.gzgetss">
<refnamediv>
<refname>gzgetss</refname>
@@ -83,6 +83,26 @@
</informaltable>
</para>
</refsect1>
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title><function>gzgetss</function> example</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+$handle = gzopen('somefile.gz', 'r');
+while (!gzeof($handle)) {
+ $buffer = gzgetss($handle, 4096);
+ echo $buffer;
+}
+gzlose($handle);
+?>
+]]>
+ </programlisting>
+ </example>
+ </para>
+ </refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
http://cvs.php.net/diff.php/phpdoc/en/reference/zlib/functions/gzinflate.xml?r1=1.6&r2=1.7&ty=u
Index: phpdoc/en/reference/zlib/functions/gzinflate.xml
diff -u phpdoc/en/reference/zlib/functions/gzinflate.xml:1.6
phpdoc/en/reference/zlib/functions/gzinflate.xml:1.7
--- phpdoc/en/reference/zlib/functions/gzinflate.xml:1.6 Thu Jan 13
20:15:52 2005
+++ phpdoc/en/reference/zlib/functions/gzinflate.xml Fri Feb 25 20:34:29 2005
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.6 $ -->
+<!-- $Revision: 1.7 $ -->
<refentry id="function.gzinflate">
<refnamediv>
<refname>gzinflate</refname>
@@ -50,6 +50,23 @@
or more than the optional parameter <parameter>length</parameter>.
</para>
</refsect1>
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title><function>gzinflate</function> example</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+$compressed = gzdeflate('Compress me', 9);
+$uncompressed = gzinflate($compressed);
+echo $uncompressed;
+?>
+]]>
+ </programlisting>
+ </example>
+ </para>
+ </refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
http://cvs.php.net/diff.php/phpdoc/en/reference/zlib/functions/gzseek.xml?r1=1.5&r2=1.6&ty=u
Index: phpdoc/en/reference/zlib/functions/gzseek.xml
diff -u phpdoc/en/reference/zlib/functions/gzseek.xml:1.5
phpdoc/en/reference/zlib/functions/gzseek.xml:1.6
--- phpdoc/en/reference/zlib/functions/gzseek.xml:1.5 Thu Jan 13 20:15:52 2005
+++ phpdoc/en/reference/zlib/functions/gzseek.xml Fri Feb 25 20:34:29 2005
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
<refentry id="function.gzseek">
<refnamediv>
<refname>gzseek</refname>
@@ -55,6 +55,24 @@
past EOF is not considered an error.
</para>
</refsect1>
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title><function>gzseek</function> example</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+$gz = gzopen('somefile.gz', 'r');
+gzseek($gz,2);
+echo gzgetc($gz);
+gzclose($gz);
+?>
+]]>
+ </programlisting>
+ </example>
+ </para>
+ </refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
http://cvs.php.net/diff.php/phpdoc/en/reference/zlib/functions/gzuncompress.xml?r1=1.5&r2=1.6&ty=u
Index: phpdoc/en/reference/zlib/functions/gzuncompress.xml
diff -u phpdoc/en/reference/zlib/functions/gzuncompress.xml:1.5
phpdoc/en/reference/zlib/functions/gzuncompress.xml:1.6
--- phpdoc/en/reference/zlib/functions/gzuncompress.xml:1.5 Thu Jan 13
20:15:52 2005
+++ phpdoc/en/reference/zlib/functions/gzuncompress.xml Fri Feb 25 20:34:29 2005
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
<refentry id="function.gzuncompress">
<refnamediv>
<refname>gzuncompress</refname>
@@ -50,6 +50,23 @@
or more than the optional parameter <parameter>length</parameter>.
</para>
</refsect1>
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title><function>gzuncompress</function> example</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+$compressed = gzcompress('Compress me', 9);
+$uncompressed = gzuncompress($compressed);
+echo $uncompressed;
+?>
+]]>
+ </programlisting>
+ </example>
+ </para>
+ </refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
http://cvs.php.net/diff.php/phpdoc/en/reference/zlib/functions/gzwrite.xml?r1=1.5&r2=1.6&ty=u
Index: phpdoc/en/reference/zlib/functions/gzwrite.xml
diff -u phpdoc/en/reference/zlib/functions/gzwrite.xml:1.5
phpdoc/en/reference/zlib/functions/gzwrite.xml:1.6
--- phpdoc/en/reference/zlib/functions/gzwrite.xml:1.5 Thu Jan 13 20:33:25 2005
+++ phpdoc/en/reference/zlib/functions/gzwrite.xml Fri Feb 25 20:34:29 2005
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
<refentry id="function.gzwrite">
<refnamediv>
<refname>gzwrite</refname>
@@ -69,6 +69,24 @@
stream.
</para>
</refsect1>
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title><function>gzwrite</function> example</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+$string = 'Some information to compress';
+$gz = gzopen('somefile.gz','w9');
+gzwrite($gz, $string);
+gzclose($gz);
+?>
+]]>
+ </programlisting>
+ </example>
+ </para>
+ </refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
