| 1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> |
| 2 |
<html xmlns="http://www.w3.org/1999/xhtml"> |
| 3 |
<head> |
| 4 |
<title>Message::CGI::HTTP - An Object-Oriented HTTP CGI Interface</title> |
| 5 |
<link rel="stylesheet" href="http://suika.fam.cx/www/style/html/pod.css" type="text/css" /> |
| 6 |
<link rev="made" href="mailto:admin@suika.fam.cx" /> |
| 7 |
</head> |
| 8 |
|
| 9 |
<body> |
| 10 |
|
| 11 |
<p><a name="__index__"></a></p> |
| 12 |
<!-- INDEX BEGIN --> |
| 13 |
|
| 14 |
<ul> |
| 15 |
|
| 16 |
<li><a href="#name">NAME</a></li> |
| 17 |
<li><a href="#description">DESCRIPTION</a></li> |
| 18 |
<li><a href="#methods">METHODS</a></li> |
| 19 |
<li><a href="#todo">TODO</a></li> |
| 20 |
<li><a href="#see_also">SEE ALSO</a></li> |
| 21 |
<li><a href="#author">AUTHOR</a></li> |
| 22 |
<li><a href="#license">LICENSE</a></li> |
| 23 |
</ul> |
| 24 |
<!-- INDEX END --> |
| 25 |
|
| 26 |
<hr /> |
| 27 |
<p> |
| 28 |
</p> |
| 29 |
<h1><a name="name">NAME</a></h1> |
| 30 |
<p>Message::CGI::HTTP - An Object-Oriented HTTP CGI Interface</p> |
| 31 |
<p> |
| 32 |
</p> |
| 33 |
<hr /> |
| 34 |
<h1><a name="description">DESCRIPTION</a></h1> |
| 35 |
<p>The <code>Message::CGI::HTTP</code> module provides an object-oriented |
| 36 |
interface for inputs and outputs as defined by CGI specification.</p> |
| 37 |
<p>This module is part of manakai.</p> |
| 38 |
<p> |
| 39 |
</p> |
| 40 |
<hr /> |
| 41 |
<h1><a name="methods">METHODS</a></h1> |
| 42 |
<dl> |
| 43 |
<dt><strong><a name="item_new"><em>$cgi</em> = Message::CGI::HTTP->new;</a></strong><br /> |
| 44 |
</dt> |
| 45 |
<dd> |
| 46 |
Creates and returns a new instance of HTTP CGI interface object. |
| 47 |
</dd> |
| 48 |
<p></p> |
| 49 |
<dt><strong><a name="item_get_meta_variable"><em>$value</em> = <em>$cgi</em>->get_meta_variable (<em>$name</em>)</a></strong><br /> |
| 50 |
</dt> |
| 51 |
<dd> |
| 52 |
Returns the value of the meta-variable <em>$name</em>. The name |
| 53 |
specified by the <em>$name</em> SHOULD be a meta-variable name |
| 54 |
defined by a CGI specification, e.g. <code>CONTENT_TYPE</code> or |
| 55 |
<code>HTTP_USER_AGENT</code>. Otherwise, the result is implementation |
| 56 |
dependent. In an environment where meta-variables are supplied |
| 57 |
as envirnoment variables, specifying an environment variable |
| 58 |
that is not a meta-variable, such as <code>PATH</code>, results in the |
| 59 |
value of that environment variable. However, CGI scripts |
| 60 |
SHOULD NOT depend on such behavior. |
| 61 |
</dd> |
| 62 |
<dd> |
| 63 |
<p>This method might return <code>undef</code> when the meta-variable |
| 64 |
is not defined or is defined but its value is <code>undef</code>.</p> |
| 65 |
</dd> |
| 66 |
<p></p> |
| 67 |
<dt><strong><a name="item_meta_variable_names"><em>$list</em> = <em>$cgi</em>->meta_variable_names;</a></strong><br /> |
| 68 |
</dt> |
| 69 |
<dd> |
| 70 |
Returns list of meta variables. Note that this list might contain |
| 71 |
other environmental variables than CGI meta variables, since |
| 72 |
they cannot distinglish unless we know what is CGI meta variable |
| 73 |
and what is not. Unfortunately, there is no complete list of CGI |
| 74 |
meta variables, whilst list of standarized meta variables is available. |
| 75 |
</dd> |
| 76 |
<dd> |
| 77 |
<p>NOTE: Some application might use an environmental variable named |
| 78 |
'HTTP_HOME', which might make some confusion with CGI meta variable |
| 79 |
for HTTP 'Home:' header field. Fortunately, such name of HTTP |
| 80 |
header field is not intoroduced as far as I know.</p> |
| 81 |
</dd> |
| 82 |
<dd> |
| 83 |
<p>This method returns a <code>Message::DOM::DOMStringList</code>.</p> |
| 84 |
</dd> |
| 85 |
<p></p> |
| 86 |
<dt><strong><a name="item_get_parameter"><em>$value</em> = <code>$cgi</code>->get_parameter ($name);</a></strong><br /> |
| 87 |
</dt> |
| 88 |
<dd> |
| 89 |
Returns parameter value if any. |
| 90 |
Parameter value is set by query-string of Request-URI |
| 91 |
and/or entity-body value. |
| 92 |
</dd> |
| 93 |
<dd> |
| 94 |
<p>When multiple values with same parameter name is specified, |
| 95 |
the first one is returned in scalar context or |
| 96 |
an array reference of all values is returned in array context. |
| 97 |
(Note that query-string is ``earlier'' than entity-body.)</p> |
| 98 |
</dd> |
| 99 |
<p></p> |
| 100 |
<dt><strong><a name="item_parameter_names"><em>$keys</em> = <em>$cgi</em>->parameter_names;</a></strong><br /> |
| 101 |
</dt> |
| 102 |
<dd> |
| 103 |
Returnes a list of parameter names provided. |
| 104 |
</dd> |
| 105 |
<dd> |
| 106 |
<p>This method returns a <code>Message::DOM::DOMStringList</code>.</p> |
| 107 |
</dd> |
| 108 |
<p></p> |
| 109 |
<dt><strong><a name="item_entity_body"><em>$body</em> = <em>$cgi</em>->entity_body;</a></strong><br /> |
| 110 |
</dt> |
| 111 |
<dd> |
| 112 |
Returns entity-body content if any. |
| 113 |
</dd> |
| 114 |
<p></p> |
| 115 |
<dt><strong><a name="item_request_uri"><em>$uri</em> = <em>$cgi</em>->request_uri;</a></strong><br /> |
| 116 |
</dt> |
| 117 |
<dd> |
| 118 |
Returns Request-URI as a <code>Message::URI::URIReference</code> object. |
| 119 |
</dd> |
| 120 |
<dd> |
| 121 |
<p>Note that stringified value of returned value might not be same as the |
| 122 |
URI specified as the Request-URI of HTTP request or (possibly pseudo-) |
| 123 |
URI entered by the user, since no standarized way to get it is |
| 124 |
defined by HTTP and CGI/1.1 specifications.</p> |
| 125 |
</dd> |
| 126 |
<p></p> |
| 127 |
<dt><strong><a name="item_path_info"><em>$value</em> = <em>$cgi</em>->path_info ([<em>$new_value</em>]);</a></strong><br /> |
| 128 |
</dt> |
| 129 |
<dd> |
| 130 |
This method reflects the meta-variable with the same name (in uppercase). |
| 131 |
</dd> |
| 132 |
<p></p></dl> |
| 133 |
<p> |
| 134 |
</p> |
| 135 |
<hr /> |
| 136 |
<h1><a name="todo">TODO</a></h1> |
| 137 |
<dl> |
| 138 |
<dt><strong><a name="item_multipart_2fform_2ddata_support">multipart/form-data support</a></strong><br /> |
| 139 |
</dt> |
| 140 |
</dl> |
| 141 |
<p> |
| 142 |
</p> |
| 143 |
<hr /> |
| 144 |
<h1><a name="see_also">SEE ALSO</a></h1> |
| 145 |
<p>A draft specification for DOM CGI Module |
| 146 |
<http://suika.fam.cx/gate/2005/sw/manakai/%E3%83%A1%E3%83%A2/2005-07-04> |
| 147 |
(This module does not implement the interface defined in this |
| 148 |
specification, however.)</p> |
| 149 |
<p> |
| 150 |
</p> |
| 151 |
<hr /> |
| 152 |
<h1><a name="author">AUTHOR</a></h1> |
| 153 |
<p>Wakaba <<a href="mailto:w@suika.fam.cx">w@suika.fam.cx</a>></p> |
| 154 |
<p>This module was originally developed as part of SuikaWiki. |
| 155 |
|
| 156 |
</p> |
| 157 |
<p> |
| 158 |
</p> |
| 159 |
<hr /> |
| 160 |
<h1><a name="license">LICENSE</a></h1> |
| 161 |
<p>Copyright 2003, 2007 Wakaba <<a href="mailto:w@suika.fam.cx">w@suika.fam.cx</a>> |
| 162 |
|
| 163 |
</p> |
| 164 |
<p>This program is free software; you can redistribute it and/or |
| 165 |
modify it under the same terms as Perl itself. |
| 166 |
|
| 167 |
</p> |
| 168 |
|
| 169 |
</body> |
| 170 |
|
| 171 |
</html> |
Parent Directory
| 
Revision Log