Package: CGI

CGI

public class CGI

Return to package list

Version: 1.0
Date: 2001-05-29 11:05:37

Author: John Luxford <lux@simian.ca> <http://www.simian.ca/>

Summary
CGI is a class that is used to give GET and POST auto-generated
variables their own distinct namespace, so as not to conflict with other
auto-generated variables, such as Cookie data.  The CGI class gets its data
from the $HTTP_POST_VARS and $HTTP_GET_VARS hashes.

Example
$cgi = new CGI;

// if a variable called 'query' was passed to this script, it can
// be accessed this way:
echo $cgi->query;

// or you can use the 'param' property to retrieve all of the names
// of the variables passed to this script:
foreach ($cgi->param as $p) {
	echo $cgi->{$p};
}

Properties

public array $param

Summary
Contains a list of the names of all the variables passed to the
current script through either the GET or POST methods.

Methods

public CGI () -> void

Summary
Constructor method.

public parseUri () -> array

Summary
Takes the global $REQUEST_URI variable and parses it as if
each subdirectory listing is a key/value pair, separated by periods (.),
and adds these pairs as properties of this object, and the keys to the
param array.  Any subdirectories that do not contain a period are returned
as extras.

public translateUri (string $uri, string $lose) -> string

Summary
Takes an ordinary URI with GET parameters in it, and returns
a URI compatible with the parseUri method.  The optional lose parameter
is a comma-separated list of key/value pairs in the URI to lose, but
not from the parameter list (the stuff that follows the ?), but from
the first part of the URI.

Return to Top


This file was created by DocReader, an Open Source class documentation system.
Visit Simian Systems to learn more.