phpfunc

phpfunc is a command line perl script that returns documentation on a builtin php function, works like perldoc -f function.

Requirements:

perl
LWP perl module
connection to a web local server with php documentation or connection to the internet.

Download:

phpfunc.tar.gz - distributed under the GNU license.

How phpfunc works:

phpfunc takes a php function name and returns the definition, synopsis any relevant functions.

example:
   $ phpfunc strstr
   FUNCTION:
              strstr -- Find first occurrence of a string.

   SYNOPSIS:
              string strstr(string haystack, string needle);

   SEE ALSO:
              stristr(), strrchr(), substr(), and ereg()

   $


phpfunc currently requires a connection to a web server that is serving the plain html version of php online documentation. This may be placed on a local web server to improve performance. phpfunc goes to the online manual to reference the function given. In future releases phpfunc may come with its own local copies of the documentation but currently only supports the online version.

Configuring phpfunc:

At the top of the perl script is a section called CONFIG. Below that there are 5 variables.

my $url - point this to the PLAIN HTML version of php's documentation. A copy placed on a local web server will descrease the time it takes to return the results. The default will use the copy sitting on php's server

my $timeout- this is the time in seconds to keep trying to fetch the results. Since pages from the documentation are being pulled from a web server, connections my be slow or down.

The other three variables deal with proxy information. Skip if not needed

my $use_proxy - 0 (zero) = no. 1 = yes

my $proxy_server - the address of your proxy server.

my $proxy_port - the port of your proxy server.

Contact:

eryx@users.sourceforge.net.com

This site hosted by Sourceforge