git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@188666 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Friedhelm Betz 2005-06-17 17:54:45 +00:00
parent c621b879bc
commit de60569a9e

View file

@ -1,26 +1,27 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<!-- splitted from ./en/functions/net-gopher.xml, last change in rev -->
<refentry id="function.gopher-parsedir">
<refnamediv>
<refname>gopher_parsedir</refname>
<refpurpose>Translate a gopher formatted directory entry into an associative array.</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>gopher_parsedir</methodname>
<methodparam><type>string</type><parameter>dirent</parameter></methodparam>
</methodsynopsis>
<simpara>
While gopher returns <literal>text/plain</literal> documents for
actual document requests. A request to a directory (such as /) will
return specially encoded series of lines with each line being one
directory entry or information line.
</simpara>
<example>
<title>Hypothetical output from <literal>gopher://gopher.example.com/</literal></title>
<screen>
<refentry id="function.gopher-parsedir">
<refnamediv>
<refname>gopher_parsedir</refname>
<refpurpose>Translate a gopher formatted directory entry into an associative array.</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>gopher_parsedir</methodname>
<methodparam><type>string</type><parameter>dirent</parameter></methodparam>
</methodsynopsis>
<simpara>
While gopher returns <literal>text/plain</literal> documents for
actual document requests. A request to a directory (such as /) will
return specially encoded series of lines with each line being one
directory entry or information line.
</simpara>
<example>
<title>Hypothetical output from <literal>gopher://gopher.example.com/</literal></title>
<screen>
<![CDATA[
0All about my gopher site. /allabout.txt gopher.example.com 70
9A picture of my cat. /pics/cat.png gopher.example.com 70
@ -32,26 +33,26 @@ iPlease select one of the options above error.host 1
iSend complaints to /dev/null error.host 1
iLong live gopher! error.host 1
]]>
</screen>
</example>
<simpara>
In the example above, the root directory at gopher.example.com knows about
one <literal>DOCUMENT</literal> identified by <literal>0</literal> located at
<literal>gopher://gopher.example.com:70/allabout.txt</literal>. It also knows
about two other directory (which have their own listing files) at
<literal>gopher://gopher.exmaple.com:70/stories</literal> and at
<literal>gopher://gopher.ejemplo.co.es:70/</literal>.
In addition there is a binary file, a link to an HTTP url, and several
informative lines.
</simpara>
<simpara>
By passing each line of the directory listing into
<function>gopher_parsedir</function>, an associative array is formed containing
a parsed out version of the data.
</simpara>
<example>
<title>Using <function>gopher_parsedir</function></title>
<programlisting role="php">
</screen>
</example>
<simpara>
In the example above, the root directory at gopher.example.com knows about
one <literal>DOCUMENT</literal> identified by <literal>0</literal> located at
<literal>gopher://gopher.example.com:70/allabout.txt</literal>. It also knows
about two other directory (which have their own listing files) at
<literal>gopher://gopher.exmaple.com:70/stories</literal> and at
<literal>gopher://gopher.ejemplo.co.es:70/</literal>.
In addition there is a binary file, a link to an HTTP url, and several
informative lines.
</simpara>
<simpara>
By passing each line of the directory listing into
<function>gopher_parsedir</function>, an associative array is formed containing
a parsed out version of the data.
</simpara>
<example>
<title>Using <function>gopher_parsedir</function></title>
<programlisting role="php">
<![CDATA[
<?php
dl("gopher.so");
@ -131,66 +132,66 @@ Array (
*/
?>
]]>
</programlisting>
</example>
<simpara>
The values given by <parameter>type</parameter> are associated with
the following constants.
</simpara>
<table>
<title>Gopher Constants</title>
<tgroup cols="2">
<thead>
<row>
<entry>Constant</entry>
<entry>Definition</entry>
</row>
</thead>
<tbody>
<row>
<entry><constant>GOPHER_DOCUMENT</constant></entry>
<entry>Standard <literal>text/plain</literal> document.</entry>
</row>
<row>
<entry><constant>GOPHER_DIRECTORY</constant></entry>
<entry>A resource containing a gopher formatted directory listing.</entry>
</row>
<row>
<entry><constant>GOPHER_BINHEX</constant></entry>
<entry>A BinHex encoded binary file.</entry>
</row>
<row>
<entry><constant>GOPHER_DOSBINARY</constant></entry>
<entry>A DOS formatted binary archive.</entry>
</row>
<row>
<entry><constant>GOPHER_UUENCODED</constant></entry>
<entry>A UUEncoded file.</entry>
</row>
<row>
<entry><constant>GOPHER_BINARY</constant></entry>
<entry>A generic binary file.</entry>
</row>
<row>
<entry><constant>GOPHER_INFO</constant></entry>
<entry>An Informational entry</entry>
</row>
<row>
<entry><constant>GOPHER_HTTP</constant></entry>
<entry>A reference to an HTTP resource.</entry>
</row>
<row>
<entry><constant>GOPHER_UNKNOWN</constant></entry>
<entry>
An unrecognized entry, the line will be returned
in <parameter>data</parameter>.
</entry>
</row>
</tbody>
</tgroup>
</table>
</refsect1>
</refentry>
</programlisting>
</example>
<simpara>
The values given by <parameter>type</parameter> are associated with
the following constants.
</simpara>
<table>
<title>Gopher Constants</title>
<tgroup cols="2">
<thead>
<row>
<entry>Constant</entry>
<entry>Definition</entry>
</row>
</thead>
<tbody>
<row>
<entry><constant>GOPHER_DOCUMENT</constant></entry>
<entry>Standard <literal>text/plain</literal> document.</entry>
</row>
<row>
<entry><constant>GOPHER_DIRECTORY</constant></entry>
<entry>A resource containing a gopher formatted directory listing.</entry>
</row>
<row>
<entry><constant>GOPHER_BINHEX</constant></entry>
<entry>A BinHex encoded binary file.</entry>
</row>
<row>
<entry><constant>GOPHER_DOSBINARY</constant></entry>
<entry>A DOS formatted binary archive.</entry>
</row>
<row>
<entry><constant>GOPHER_UUENCODED</constant></entry>
<entry>A UUEncoded file.</entry>
</row>
<row>
<entry><constant>GOPHER_BINARY</constant></entry>
<entry>A generic binary file.</entry>
</row>
<row>
<entry><constant>GOPHER_INFO</constant></entry>
<entry>An Informational entry</entry>
</row>
<row>
<entry><constant>GOPHER_HTTP</constant></entry>
<entry>A reference to an HTTP resource.</entry>
</row>
<row>
<entry><constant>GOPHER_UNKNOWN</constant></entry>
<entry>
An unrecognized entry, the line will be returned
in <parameter>data</parameter>.
</entry>
</row>
</tbody>
</tgroup>
</table>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables: