/[suikacvs]/messaging/manakai/lib/Message/CGI/HTTP.html
Suika

Contents of /messaging/manakai/lib/Message/CGI/HTTP.html

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.1 - (hide annotations) (download) (as text)
Sat Aug 11 13:37:09 2007 UTC (17 years, 3 months ago) by wakaba
Branch: MAIN
File MIME type: text/html 
++ manakai/lib/Message/ChangeLog	11 Aug 2007 13:36:49 -0000
2007-08-11  Wakaba  <wakaba@suika.fam.cx>

	* Makefile: New directory |CGI| is added.

2007-08-11  Wakaba  <wakaba@suika.fam.cx>

	* CGI/: New directory.

++ manakai/lib/Message/CGI/ChangeLog	11 Aug 2007 13:33:26 -0000
	* Makefile: New file.

	* HTTP.pm: Reformed for manakai.

2007-08-11  Wakaba  <wakaba@suika.fam.cx>
1 wakaba 1.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-&gt;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>-&gt;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>-&gt;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>-&gt;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>-&gt;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>-&gt;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>-&gt;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></dl>
127     <p>
128     </p>
129     <hr />
130     <h1><a name="todo">TODO</a></h1>
131     <dl>
132     <dt><strong><a name="item_multipart_2fform_2ddata_support">multipart/form-data support</a></strong><br />
133     </dt>
134     </dl>
135     <p>
136     </p>
137     <hr />
138     <h1><a name="see_also">SEE ALSO</a></h1>
139     <p>A draft specification for DOM CGI Module
140     &lt;http://suika.fam.cx/gate/2005/sw/manakai/%E3%83%A1%E3%83%A2/2005-07-04&gt;
141     (This module does not implement the interface defined in this
142     specification, however.)</p>
143     <p>
144     </p>
145     <hr />
146     <h1><a name="author">AUTHOR</a></h1>
147     <p>Wakaba &lt;<a href="mailto:w@suika.fam.cx">w@suika.fam.cx</a>&gt;
148    
149     </p>
150     <p>
151     </p>
152     <hr />
153     <h1><a name="license">LICENSE</a></h1>
154     <p>Copyright 2003, 2007 Wakaba &lt;<a href="mailto:w@suika.fam.cx">w@suika.fam.cx</a>&gt;
155    
156     </p>
157     <p>This program is free software; you can redistribute it and/or
158     modify it under the same terms as Perl itself.
159    
160     </p>
161    
162     </body>
163    
164     </html>
admin@suikawiki.org
 ViewVC Help
Powered by ViewVC 1.1.24