489 lines
10 KiB
HTML
489 lines
10 KiB
HTML
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
||
|
<head>
|
||
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||
|
<title>
|
||
|
Class: Zero::Request::Parameter
|
||
|
|
||
|
— Documentation by YARD 0.8.3
|
||
|
|
||
|
</title>
|
||
|
|
||
|
<link rel="stylesheet" href="../../css/style.css" type="text/css" media="screen" charset="utf-8" />
|
||
|
|
||
|
<link rel="stylesheet" href="../../css/common.css" type="text/css" media="screen" charset="utf-8" />
|
||
|
|
||
|
<script type="text/javascript" charset="utf-8">
|
||
|
hasFrames = window.top.frames.main ? true : false;
|
||
|
relpath = '../../';
|
||
|
framesUrl = "../../frames.html#!" + escape(window.location.href);
|
||
|
</script>
|
||
|
|
||
|
|
||
|
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
|
||
|
|
||
|
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
|
||
|
|
||
|
|
||
|
</head>
|
||
|
<body>
|
||
|
<div id="header">
|
||
|
<div id="menu">
|
||
|
|
||
|
<a href="../../_index.html">Index (P)</a> »
|
||
|
<span class='title'><span class='object_link'><a href="../../Zero.html" title="Zero (module)">Zero</a></span></span> » <span class='title'><span class='object_link'><a href="../Request.html" title="Zero::Request (class)">Request</a></span></span>
|
||
|
»
|
||
|
<span class="title">Parameter</span>
|
||
|
|
||
|
|
||
|
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
||
|
</div>
|
||
|
|
||
|
<div id="search">
|
||
|
|
||
|
<a class="full_list_link" id="class_list_link"
|
||
|
href="../../class_list.html">
|
||
|
Class List
|
||
|
</a>
|
||
|
|
||
|
<a class="full_list_link" id="method_list_link"
|
||
|
href="../../method_list.html">
|
||
|
Method List
|
||
|
</a>
|
||
|
|
||
|
<a class="full_list_link" id="file_list_link"
|
||
|
href="../../file_list.html">
|
||
|
File List
|
||
|
</a>
|
||
|
|
||
|
</div>
|
||
|
<div class="clear"></div>
|
||
|
</div>
|
||
|
|
||
|
<iframe id="search_frame"></iframe>
|
||
|
|
||
|
<div id="content"><h1>Class: Zero::Request::Parameter
|
||
|
|
||
|
|
||
|
|
||
|
</h1>
|
||
|
|
||
|
<dl class="box">
|
||
|
|
||
|
<dt class="r1">Inherits:</dt>
|
||
|
<dd class="r1">
|
||
|
<span class="inheritName">Object</span>
|
||
|
|
||
|
<ul class="fullTree">
|
||
|
<li>Object</li>
|
||
|
|
||
|
<li class="next">Zero::Request::Parameter</li>
|
||
|
|
||
|
</ul>
|
||
|
<a href="#" class="inheritanceTree">show all</a>
|
||
|
|
||
|
</dd>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<dt class="r2 last">Defined in:</dt>
|
||
|
<dd class="r2 last">lib/zero/request/parameter.rb</dd>
|
||
|
|
||
|
</dl>
|
||
|
<div class="clear"></div>
|
||
|
|
||
|
<h2>Overview</h2><div class="docstring">
|
||
|
<div class="discussion">
|
||
|
|
||
|
<p>represents all parameter set in a session</p>
|
||
|
|
||
|
<p>This class holds all parameters available in the rack environment, split on
|
||
|
query and payload parameters.</p>
|
||
|
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<div class="tags">
|
||
|
|
||
|
|
||
|
</div>
|
||
|
<h2>Constant Summary</h2>
|
||
|
|
||
|
<dl class="constants">
|
||
|
|
||
|
<dt id="ENV_KEY_QUERY-constant" class="">ENV_KEY_QUERY =
|
||
|
<div class="docstring">
|
||
|
<div class="discussion">
|
||
|
|
||
|
<p>they key for the query string</p>
|
||
|
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<div class="tags">
|
||
|
|
||
|
|
||
|
</div>
|
||
|
</dt>
|
||
|
<dd><pre class="code"><span class='string val'>'QUERY_STRING'</span>
|
||
|
</pre></dd>
|
||
|
|
||
|
<dt id="ENV_KEY_PAYLOAD-constant" class="">ENV_KEY_PAYLOAD =
|
||
|
<div class="docstring">
|
||
|
<div class="discussion">
|
||
|
|
||
|
<p>the key for the payload</p>
|
||
|
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<div class="tags">
|
||
|
|
||
|
|
||
|
</div>
|
||
|
</dt>
|
||
|
<dd><pre class="code"><span class='string val'>'rack.input'</span>
|
||
|
</pre></dd>
|
||
|
|
||
|
<dt id="ENV_KEY_CONTENT_TYPE-constant" class="">ENV_KEY_CONTENT_TYPE =
|
||
|
<div class="docstring">
|
||
|
<div class="discussion">
|
||
|
|
||
|
<p>the key for the content type</p>
|
||
|
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<div class="tags">
|
||
|
|
||
|
|
||
|
</div>
|
||
|
</dt>
|
||
|
<dd><pre class="code"><span class='string val'>'CONTENT_TYPE'</span>
|
||
|
</pre></dd>
|
||
|
|
||
|
<dt id="PAYLOAD_CONTENT_TYPES-constant" class="">PAYLOAD_CONTENT_TYPES =
|
||
|
<div class="docstring">
|
||
|
<div class="discussion">
|
||
|
|
||
|
<p>all content types which used for using the body as a parameter input</p>
|
||
|
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<div class="tags">
|
||
|
|
||
|
|
||
|
</div>
|
||
|
</dt>
|
||
|
<dd><pre class="code"><span class='lbrack token'>[</span>
|
||
|
<span class='string val'>'application/x-www-form-urlencoded'</span><span class='comma token'>,</span>
|
||
|
<span class='string val'>'multipart/form-data'</span>
|
||
|
<span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_to_set identifier id'>to_set</span>
|
||
|
</pre></dd>
|
||
|
|
||
|
</dl>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
|
||
|
<ul class="summary">
|
||
|
|
||
|
<li class="public ">
|
||
|
<span class="summary_signature">
|
||
|
|
||
|
<a href="#payload-instance_method" title="#payload (instance method)">- (Object) <strong>payload</strong> </a>
|
||
|
|
||
|
|
||
|
|
||
|
(also: #post)
|
||
|
|
||
|
</span>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<span class="note title readonly">readonly</span>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<span class="summary_desc"><div class='inline'>
|
||
|
<p>get the payload or form data parameters.</p>
|
||
|
</div></span>
|
||
|
|
||
|
</li>
|
||
|
|
||
|
|
||
|
<li class="public ">
|
||
|
<span class="summary_signature">
|
||
|
|
||
|
<a href="#query-instance_method" title="#query (instance method)">- (Object) <strong>query</strong> </a>
|
||
|
|
||
|
|
||
|
|
||
|
(also: #get)
|
||
|
|
||
|
</span>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<span class="note title readonly">readonly</span>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<span class="summary_desc"><div class='inline'>
|
||
|
<p>get the query parameters.</p>
|
||
|
</div></span>
|
||
|
|
||
|
</li>
|
||
|
|
||
|
|
||
|
</ul>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<h2>
|
||
|
Instance Method Summary
|
||
|
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
||
|
</h2>
|
||
|
|
||
|
<ul class="summary">
|
||
|
|
||
|
<li class="public ">
|
||
|
<span class="summary_signature">
|
||
|
|
||
|
<a href="#initialize-instance_method" title="#initialize (instance method)">- (Parameter) <strong>initialize</strong>(environment) </a>
|
||
|
|
||
|
|
||
|
|
||
|
</span>
|
||
|
|
||
|
|
||
|
<span class="note title constructor">constructor</span>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<span class="summary_desc"><div class='inline'>
|
||
|
<p>creates a new parameter instance.</p>
|
||
|
</div></span>
|
||
|
|
||
|
</li>
|
||
|
|
||
|
|
||
|
</ul>
|
||
|
|
||
|
|
||
|
<div id="constructor_details" class="method_details_list">
|
||
|
<h2>Constructor Details</h2>
|
||
|
|
||
|
<div class="method_details first">
|
||
|
<h3 class="signature first" id="initialize-instance_method">
|
||
|
|
||
|
- (<tt><span class='object_link'><a href="" title="Zero::Request::Parameter (class)">Parameter</a></span></tt>) <strong>initialize</strong>(environment)
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
</h3><div class="docstring">
|
||
|
<div class="discussion">
|
||
|
|
||
|
<p>creates a new parameter instance</p>
|
||
|
|
||
|
<p>This should never be called directly, as it will be generated for you. This
|
||
|
instance gives you the options to get query parameters (mostly called GET
|
||
|
parameters) and payload parameters (or POST parameters).</p>
|
||
|
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<div class="tags">
|
||
|
<p class="tag_title">Parameters:</p>
|
||
|
<ul class="param">
|
||
|
|
||
|
<li>
|
||
|
|
||
|
<span class='name'>environment</span>
|
||
|
|
||
|
|
||
|
<span class='type'>(<tt>Hash</tt>)</span>
|
||
|
|
||
|
|
||
|
|
||
|
—
|
||
|
<div class='inline'>
|
||
|
<p>the rack environment</p>
|
||
|
</div>
|
||
|
|
||
|
</li>
|
||
|
|
||
|
</ul>
|
||
|
|
||
|
|
||
|
</div><table class="source_code">
|
||
|
<tr>
|
||
|
<td>
|
||
|
<pre class="lines">
|
||
|
|
||
|
|
||
|
37
|
||
|
38
|
||
|
39
|
||
|
40</pre>
|
||
|
</td>
|
||
|
<td>
|
||
|
<pre class="code"><span class="info file"># File 'lib/zero/request/parameter.rb', line 37</span>
|
||
|
|
||
|
<span class='rubyid_def def kw'>def</span> <span class='rubyid_initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='rubyid_environment identifier id'>environment</span><span class='rparen token'>)</span>
|
||
|
<span class='rubyid_@query ivar id'>@query</span> <span class='assign token'>=</span> <span class='rubyid_extract_query_params identifier id'>extract_query_params</span><span class='lparen token'>(</span><span class='rubyid_environment identifier id'>environment</span><span class='rparen token'>)</span>
|
||
|
<span class='rubyid_@payload ivar id'>@payload</span> <span class='assign token'>=</span> <span class='rubyid_extract_payload_params identifier id'>extract_payload_params</span><span class='lparen token'>(</span><span class='rubyid_environment identifier id'>environment</span><span class='rparen token'>)</span>
|
||
|
<span class='rubyid_end end kw'>end</span>
|
||
|
</pre>
|
||
|
</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
<div id="instance_attr_details" class="attr_details">
|
||
|
<h2>Instance Attribute Details</h2>
|
||
|
|
||
|
|
||
|
<span id=""></span>
|
||
|
<div class="method_details first">
|
||
|
<h3 class="signature first" id="payload-instance_method">
|
||
|
|
||
|
- (<tt>Object</tt>) <strong>payload</strong> <span class="extras">(readonly)</span>
|
||
|
|
||
|
|
||
|
|
||
|
<span class="aliases">Also known as:
|
||
|
<span class="names"><span id='post-instance_method'>post</span></span>
|
||
|
</span>
|
||
|
|
||
|
|
||
|
|
||
|
</h3><div class="docstring">
|
||
|
<div class="discussion">
|
||
|
|
||
|
<p>get the payload or form data parameters</p>
|
||
|
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<div class="tags">
|
||
|
|
||
|
|
||
|
</div><table class="source_code">
|
||
|
<tr>
|
||
|
<td>
|
||
|
<pre class="lines">
|
||
|
|
||
|
|
||
|
28
|
||
|
29
|
||
|
30</pre>
|
||
|
</td>
|
||
|
<td>
|
||
|
<pre class="code"><span class="info file"># File 'lib/zero/request/parameter.rb', line 28</span>
|
||
|
|
||
|
<span class='rubyid_def def kw'>def</span> <span class='rubyid_payload identifier id'>payload</span>
|
||
|
<span class='rubyid_@payload ivar id'>@payload</span>
|
||
|
<span class='rubyid_end end kw'>end</span>
|
||
|
</pre>
|
||
|
</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
<span id=""></span>
|
||
|
<div class="method_details ">
|
||
|
<h3 class="signature " id="query-instance_method">
|
||
|
|
||
|
- (<tt>Object</tt>) <strong>query</strong> <span class="extras">(readonly)</span>
|
||
|
|
||
|
|
||
|
|
||
|
<span class="aliases">Also known as:
|
||
|
<span class="names"><span id='get-instance_method'>get</span></span>
|
||
|
</span>
|
||
|
|
||
|
|
||
|
|
||
|
</h3><div class="docstring">
|
||
|
<div class="discussion">
|
||
|
|
||
|
<p>get the query parameters</p>
|
||
|
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<div class="tags">
|
||
|
|
||
|
|
||
|
</div><table class="source_code">
|
||
|
<tr>
|
||
|
<td>
|
||
|
<pre class="lines">
|
||
|
|
||
|
|
||
|
24
|
||
|
25
|
||
|
26</pre>
|
||
|
</td>
|
||
|
<td>
|
||
|
<pre class="code"><span class="info file"># File 'lib/zero/request/parameter.rb', line 24</span>
|
||
|
|
||
|
<span class='rubyid_def def kw'>def</span> <span class='rubyid_query identifier id'>query</span>
|
||
|
<span class='rubyid_@query ivar id'>@query</span>
|
||
|
<span class='rubyid_end end kw'>end</span>
|
||
|
</pre>
|
||
|
</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</div>
|
||
|
|
||
|
<div id="footer">
|
||
|
Generated on Mon Nov 26 21:40:01 2012 by
|
||
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||
|
0.8.3 (ruby-1.9.3).
|
||
|
</div>
|
||
|
|
||
|
</body>
|
||
|
</html>
|