diff --git a/reference/net_gopher/configure.xml b/reference/net_gopher/configure.xml new file mode 100644 index 0000000000..af419e9afc --- /dev/null +++ b/reference/net_gopher/configure.xml @@ -0,0 +1,51 @@ + + +
+ &reftitle.install; + + Net_Gopher is installed through the usual PECL package installation process. + + + + + Prerequisite: PHP 4.3.0. + + + + + +$ pear install Net_Gopher + + + + + + Copy the resulting gopher.so to an appropriate location + and add extension=gopher.so to your &php.ini; + file or load it dynamically in your PHP script using + dl("gopher.so"); + + + +
+ + diff --git a/reference/net_gopher/functions/gopher-parsedir.xml b/reference/net_gopher/functions/gopher-parsedir.xml new file mode 100644 index 0000000000..d346aef699 --- /dev/null +++ b/reference/net_gopher/functions/gopher-parsedir.xml @@ -0,0 +1,215 @@ + + + + + + gopher_parsedir + Translate a gopher formatted directory entry into an associative array. + + + Description + + arraygopher_parsedir + stringdirent + + + While gopher returns text/plain 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. + + + Hypothetical output from <literal>gopher://gopher.example.com/</literal> + + + + + + In the example above, the root directory at gopher.example.com knows about + one DOCUMENT identified by 0 located at + gopher://gopher.example.com:70/allabout.txt. It also knows + about two other directory (which have their own listing files) at + gopher://gopher.exmaple.com:70/stories and at + gopher://gopher.ejemplo.co.es:70/. + In addition there is a binary file, a link to an HTTP url, and several + informative lines. + + + By passing each line of the directory listing into + gopher_parsedir, an associative array is formed containing + a parsed out version of the data. + + + Using <function>gopher_parsedir</function> + + 0 + [title] => All about my gopher site. + [path] => /allabout.txt + [host] => gopher.example.com + [port] => 70 +) +Array ( + [type] => 9 + [title] => A picture of my cat. + [path] => /pics/cat.png + [host] => gopher.example.com + [port] => 70 +) +Array ( + [type] => 1 + [title] => A collection of my writings. + [path] => /stories + [host] => gopher.example.com + [port] => 70 +) +Array ( + [type] => 254 + [title] => The HTTP version of this site. + [path] => URL:http://www.example.com + [host] => gopher.example.com + [port] => 70 +) +Array ( + [type] => 1 + [title] => Mirror of this site in Spain. + [path] => / + [host] => gopher.ejemplo.co.es + [port] => 70 +) +Array ( + [type] => 255 + [title] => Welcome to my gopher site. + [path] => + [host] => error.host + [port] => 1 +) +Array ( + [type] => 255 + [title] => Please select one of the options above. + [path] => + [host] => error.host + [port] => 1 +) +Array ( + [type] => 255 + [title] => Send complaints to /dev/null + [path] => + [host] => error.host + [port] => 1 +) +Array ( + [type] => 255 + [title] => Long live gopher! + [path] => + [host] => error.host + [port] => 1 +) +*/ +?> +]]> + + + + The values given by type are associated with + the following constants. + + + Gopher Constants + + + + Constant + Definition + + + + + GOPHER_DOCUMENT + Standard text/plain document. + + + GOPHER_DIRECTORY + A resource containing a gopher formatted directory listing. + + + GOPHER_BINHEX + A BinHex encoded binary file. + + + GOPHER_DOSBINARY + A DOS formatted binary archive. + + + GOPHER_UUENCODED + A UUEncoded file. + + + GOPHER_BINARY + A generic binary file. + + + GOPHER_INFO + An Informational entry + + + GOPHER_HTTP + A reference to an HTTP resource. + + + GOPHER_UNKNOWN + + An unrecognized entry, the line will be returned + in data. + + + + +
+
+
+ + + diff --git a/reference/net_gopher/reference.xml b/reference/net_gopher/reference.xml new file mode 100644 index 0000000000..8f4daf186b --- /dev/null +++ b/reference/net_gopher/reference.xml @@ -0,0 +1,83 @@ + + + + Net_Gopher + gopher + + +
+ &reftitle.intro; + + The gopher protocol, as defined by RFC 1436, + is generally considered the ancestor of the modern HTTP protocol. + However, gopher was also intended to provide references to non-gopher + resources including telnet, wais, nntp, and even http. This extension + adds gopher support to PHP's URL Wrappers, + and provides a helper function gopher_parsedir to + make sense of gopher formatted directory listings. + +
+ +
+ &reftitle.required; + + +
+ + &reference.net-gopher.configure; + +
+ &reftitle.runtime; + &no.config; +
+ +
+ &reftitle.resources; + &no.resource; +
+ +
+ &reftitle.constants; + &no.constants; +
+ +
+ &reftitle.examples; + + + +]]> + + +
+
+ +&reference.net-gopher.functions; + +
+ + +