diff options
| author | Gibheer <gibheer@gmail.com> | 2012-11-26 21:40:21 +0100 |
|---|---|---|
| committer | Gibheer <gibheer@gmail.com> | 2012-11-26 21:40:21 +0100 |
| commit | 37a4a28deec224f7cd9a5a124e22258e868913e4 (patch) | |
| tree | 23f8ce9b940ff1a357336344388cbcd46aa57ee7 /doc/Zero/Request.html | |
| parent | 77a2cbe6d4e8752a9450e945724522d10cfb5f09 (diff) | |
added the first set of documentation
Diffstat (limited to 'doc/Zero/Request.html')
| -rw-r--r-- | doc/Zero/Request.html | 1476 |
1 files changed, 1476 insertions, 0 deletions
diff --git a/doc/Zero/Request.html b/doc/Zero/Request.html new file mode 100644 index 0000000..03e5591 --- /dev/null +++ b/doc/Zero/Request.html @@ -0,0 +1,1476 @@ +<!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 + + — 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 (R)</a> » + <span class='title'><span class='object_link'><a href="../Zero.html" title="Zero (module)">Zero</a></span></span> + » + <span class="title">Request</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 + + + +</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</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/zero/request.rb<span class="defines">,<br /> + lib/zero/request/server.rb,<br /> lib/zero/request/client.rb,<br /> lib/zero/request/accept.rb,<br /> lib/zero/request/parameter.rb,<br /> lib/zero/request/accept_type.rb</span> +</dd> + +</dl> +<div class="clear"></div> + +<h2>Overview</h2><div class="docstring"> + <div class="discussion"> + +<p>This class wraps around a rack environment for easier access to all data.</p> + + + </div> +</div> +<div class="tags"> + + +</div><h2>Defined Under Namespace</h2> +<p class="children"> + + + + + <strong class="classes">Classes:</strong> <span class='object_link'><a href="Request/Accept.html" title="Zero::Request::Accept (class)">Accept</a></span>, <span class='object_link'><a href="Request/AcceptType.html" title="Zero::Request::AcceptType (class)">AcceptType</a></span>, <span class='object_link'><a href="Request/Client.html" title="Zero::Request::Client (class)">Client</a></span>, <span class='object_link'><a href="Request/Parameter.html" title="Zero::Request::Parameter (class)">Parameter</a></span>, <span class='object_link'><a href="Request/Server.html" title="Zero::Request::Server (class)">Server</a></span> + + +</p> + + <h2>Constant Summary</h2> + + + + + + <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="#env-instance_method" title="#env (instance method)">- (Hash) <strong>env</strong> </a> + + + + </span> + + + + + <span class="note title readonly">readonly</span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>get the environment.</p> +</div></span> + +</li> + + + </ul> + + + + + + <h2> + Class Method Summary + <small>(<a href="#" class="summary_toggle">collapse</a>)</small> + </h2> + + <ul class="summary"> + + <li class="public "> + <span class="summary_signature"> + + <a href="#create-class_method" title="create (class method)">+ (Object) <strong>create</strong>(environment) </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'></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="#accept-instance_method" title="#accept (instance method)">- (Accept) <strong>accept</strong> </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>get the media types.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#client-instance_method" title="#client (instance method)">- (Client) <strong>client</strong> </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>return all information about the client.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#content_type-instance_method" title="#content_type (instance method)">- (String) <strong>content_type</strong> </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>return the content type of the request TODO change into its own object?.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#delete%3F-instance_method" title="#delete? (instance method)">- (Boolean) <strong>delete?</strong> </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>is the method 'DELETE'?.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#get%3F-instance_method" title="#get? (instance method)">- (Boolean) <strong>get?</strong> </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>is the method 'GET'?.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#head%3F-instance_method" title="#head? (instance method)">- (Boolean) <strong>head?</strong> </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>is the method 'HEAD'?.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#initialize-instance_method" title="#initialize (instance method)">- (Request) <strong>initialize</strong>(env) </a> + + + + </span> + + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>create a new request object.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#method-instance_method" title="#method (instance method)">- (Symbol) <strong>method</strong> </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>get the method of the request.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#params-instance_method" title="#params (instance method)">- (Parameter) <strong>params</strong> </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>get an object representing the parameters of the request.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#patch%3F-instance_method" title="#patch? (instance method)">- (Boolean) <strong>patch?</strong> </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>is the method 'PATCH'?.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#path-instance_method" title="#path (instance method)">- (String) <strong>path</strong> </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>get the requested path.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#post%3F-instance_method" title="#post? (instance method)">- (Boolean) <strong>post?</strong> </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>is the method 'POST'?.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#put%3F-instance_method" title="#put? (instance method)">- (Boolean) <strong>put?</strong> </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>is the method 'PUT'?.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#server-instance_method" title="#server (instance method)">- (Server) <strong>server</strong> </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>get the information on the server.</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 (class)">Request</a></span></tt>) <strong>initialize</strong>(env) + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>create a new request object</p> + + + </div> +</div> +<div class="tags"> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +15 +16 +17 +18</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/zero/request.rb', line 15</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_env identifier id'>env</span><span class='rparen token'>)</span> + <span class='rubyid_@env ivar id'>@env</span> <span class='assign token'>=</span> <span class='rubyid_env identifier id'>env</span> + <span class='rubyid_@env ivar id'>@env</span><span class='lbrack token'>[</span><span class='string val'>'zero.request'</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='rubyid_self self kw'>self</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="env-instance_method"> + + - (<tt>Hash</tt>) <strong>env</strong> <span class="extras">(readonly)</span> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>get the environment</p> + + + </div> +</div> +<div class="tags"> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Hash</tt>)</span> + + + + — + <div class='inline'> +<p>the environment hash</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +22 +23 +24</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/zero/request.rb', line 22</span> + +<span class='rubyid_def def kw'>def</span> <span class='rubyid_env identifier id'>env</span> + <span class='rubyid_@env ivar id'>@env</span> +<span class='rubyid_end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + + + <div id="class_method_details" class="method_details_list"> + <h2>Class Method Details</h2> + + + <div class="method_details first"> + <h3 class="signature first" id="create-class_method"> + + + (<tt>Object</tt>) <strong>create</strong>(environment) + + + + + +</h3><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +9 +10 +11 +12</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/zero/request.rb', line 9</span> + +<span class='rubyid_def def kw'>def</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_create identifier id'>create</span><span class='lparen token'>(</span><span class='rubyid_environment identifier id'>environment</span><span class='rparen token'>)</span> + <span class='rubyid_return return kw'>return</span> <span class='rubyid_environment identifier id'>environment</span><span class='lbrack token'>[</span><span class='string val'>'zero.request'</span><span class='rbrack token'>]</span> <span class='rubyid_if if_mod kw'>if</span> <span class='rubyid_environment identifier id'>environment</span><span class='dot token'>.</span><span class='rubyid_has_key? fid id'>has_key?</span><span class='lparen token'>(</span><span class='string val'>'zero.request'</span><span class='rparen token'>)</span> + <span class='rubyid_new identifier id'>new</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_method_details" class="method_details_list"> + <h2>Instance Method Details</h2> + + + <div class="method_details first"> + <h3 class="signature first" id="accept-instance_method"> + + - (<tt><span class='object_link'><a href="Request/Accept.html" title="Zero::Request::Accept (class)">Accept</a></span></tt>) <strong>accept</strong> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>get the media types</p> + + + </div> +</div> +<div class="tags"> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="Request/Accept.html" title="Zero::Request::Accept (class)">Accept</a></span></tt>)</span> + + + + — + <div class='inline'> +<p>on Accept object managing all types and their order</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +57 +58 +59</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/zero/request.rb', line 57</span> + +<span class='rubyid_def def kw'>def</span> <span class='rubyid_accept identifier id'>accept</span> + <span class='rubyid_@accept ivar id'>@accept</span> <span class='opasgn op'>||=</span> <span class='rubyid_Request constant id'>Request</span><span class='colon2 op'>::</span><span class='rubyid_Accept constant id'>Accept</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_@env ivar id'>@env</span><span class='rparen token'>)</span> +<span class='rubyid_end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <h3 class="signature " id="client-instance_method"> + + - (<tt><span class='object_link'><a href="Request/Client.html" title="Zero::Request::Client (class)">Client</a></span></tt>) <strong>client</strong> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>return all information about the client</p> + + + </div> +</div> +<div class="tags"> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="Request/Client.html" title="Zero::Request::Client (class)">Client</a></span></tt>)</span> + + + + — + <div class='inline'> +<p>an information object about the client</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +32 +33 +34</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/zero/request.rb', line 32</span> + +<span class='rubyid_def def kw'>def</span> <span class='rubyid_client identifier id'>client</span> + <span class='rubyid_@client ivar id'>@client</span> <span class='opasgn op'>||=</span> <span class='rubyid_Request constant id'>Request</span><span class='colon2 op'>::</span><span class='rubyid_Client constant id'>Client</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_@env ivar id'>@env</span><span class='rparen token'>)</span> +<span class='rubyid_end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <h3 class="signature " id="content_type-instance_method"> + + - (<tt>String</tt>) <strong>content_type</strong> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>return the content type of the request TODO change into its own object?</p> + + + </div> +</div> +<div class="tags"> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>String</tt>)</span> + + + + — + <div class='inline'> +<p>returns the content type of the request</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +51 +52 +53</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/zero/request.rb', line 51</span> + +<span class='rubyid_def def kw'>def</span> <span class='rubyid_content_type identifier id'>content_type</span> + <span class='rubyid_@env ivar id'>@env</span><span class='lbrack token'>[</span><span class='rubyid_CONST_CONTENT_TYPE constant id'>CONST_CONTENT_TYPE</span><span class='rbrack token'>]</span> <span class='rubyid_if if_mod kw'>if</span> <span class='rubyid_@env ivar id'>@env</span><span class='dot token'>.</span><span class='rubyid_has_key? fid id'>has_key?</span><span class='lparen token'>(</span><span class='rubyid_CONST_CONTENT_TYPE constant id'>CONST_CONTENT_TYPE</span><span class='rparen token'>)</span> +<span class='rubyid_end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <h3 class="signature " id="delete?-instance_method"> + + - (<tt>Boolean</tt>) <strong>delete?</strong> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>is the method 'DELETE'?</p> + + + </div> +</div> +<div class="tags"> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + — + <div class='inline'> +<p>true if this is a delete request</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +77</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/zero/request.rb', line 77</span> + +<span class='rubyid_def def kw'>def</span> <span class='rubyid_delete? fid id'>delete?</span><span class='semicolon token'>;</span> <span class='rubyid_method identifier id'>method</span> <span class='eq op'>==</span> <span class='symbol val'>:delete</span> <span class='rubyid_end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <h3 class="signature " id="get?-instance_method"> + + - (<tt>Boolean</tt>) <strong>get?</strong> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>is the method 'GET'?</p> + + + </div> +</div> +<div class="tags"> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + — + <div class='inline'> +<p>true if this is a get request</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +68</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/zero/request.rb', line 68</span> + +<span class='rubyid_def def kw'>def</span> <span class='rubyid_get? fid id'>get?</span><span class='semicolon token'>;</span> <span class='rubyid_method identifier id'>method</span> <span class='eq op'>==</span> <span class='symbol val'>:get</span> <span class='rubyid_end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <h3 class="signature " id="head?-instance_method"> + + - (<tt>Boolean</tt>) <strong>head?</strong> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>is the method 'HEAD'?</p> + + + </div> +</div> +<div class="tags"> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + — + <div class='inline'> +<p>true if this is a head request</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +80</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/zero/request.rb', line 80</span> + +<span class='rubyid_def def kw'>def</span> <span class='rubyid_head? fid id'>head?</span><span class='semicolon token'>;</span> <span class='rubyid_method identifier id'>method</span> <span class='eq op'>==</span> <span class='symbol val'>:head</span> <span class='rubyid_end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <h3 class="signature " id="method-instance_method"> + + - (<tt>Symbol</tt>) <strong>method</strong> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>get the method of the request</p> + + + </div> +</div> +<div class="tags"> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Symbol</tt>)</span> + + + + — + <div class='inline'> +<p>the symbol representation of the method</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +63 +64 +65</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/zero/request.rb', line 63</span> + +<span class='rubyid_def def kw'>def</span> <span class='rubyid_method identifier id'>method</span> + <span class='rubyid_@method ivar id'>@method</span> <span class='opasgn op'>||=</span> <span class='rubyid_@env ivar id'>@env</span><span class='lbrack token'>[</span><span class='rubyid_CONST_REQUEST_METHOD constant id'>CONST_REQUEST_METHOD</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_downcase identifier id'>downcase</span><span class='dot token'>.</span><span class='rubyid_to_sym identifier id'>to_sym</span> +<span class='rubyid_end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <h3 class="signature " id="params-instance_method"> + + - (<tt><span class='object_link'><a href="Request/Parameter.html" title="Zero::Request::Parameter (class)">Parameter</a></span></tt>) <strong>params</strong> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>get an object representing the parameters of the request</p> + + + </div> +</div> +<div class="tags"> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="Request/Parameter.html" title="Zero::Request::Parameter (class)">Parameter</a></span></tt>)</span> + + + + — + <div class='inline'> +<p>object having all parameters</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +44 +45 +46</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/zero/request.rb', line 44</span> + +<span class='rubyid_def def kw'>def</span> <span class='rubyid_params identifier id'>params</span> + <span class='rubyid_@params ivar id'>@params</span> <span class='opasgn op'>||=</span> <span class='rubyid_Request constant id'>Request</span><span class='colon2 op'>::</span><span class='rubyid_Parameter constant id'>Parameter</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_@env ivar id'>@env</span><span class='rparen token'>)</span> +<span class='rubyid_end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <h3 class="signature " id="patch?-instance_method"> + + - (<tt>Boolean</tt>) <strong>patch?</strong> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>is the method 'PATCH'?</p> + + + </div> +</div> +<div class="tags"> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + — + <div class='inline'> +<p>true if this is a patch request</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +83</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/zero/request.rb', line 83</span> + +<span class='rubyid_def def kw'>def</span> <span class='rubyid_patch? fid id'>patch?</span><span class='semicolon token'>;</span> <span class='rubyid_method identifier id'>method</span> <span class='eq op'>==</span> <span class='symbol val'>:patch</span> <span class='rubyid_end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <h3 class="signature " id="path-instance_method"> + + - (<tt>String</tt>) <strong>path</strong> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>get the requested path</p> + + + </div> +</div> +<div class="tags"> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>String</tt>)</span> + + + + — + <div class='inline'> +<p>returns the requested path</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +26 +27 +28</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/zero/request.rb', line 26</span> + +<span class='rubyid_def def kw'>def</span> <span class='rubyid_path identifier id'>path</span> + <span class='rubyid_@path ivar id'>@path</span> <span class='opasgn op'>||=</span> <span class='rubyid_@env ivar id'>@env</span><span class='lbrack token'>[</span><span class='rubyid_CONST_PATH_INFO constant id'>CONST_PATH_INFO</span><span class='rbrack token'>]</span> +<span class='rubyid_end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <h3 class="signature " id="post?-instance_method"> + + - (<tt>Boolean</tt>) <strong>post?</strong> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>is the method 'POST'?</p> + + + </div> +</div> +<div class="tags"> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + — + <div class='inline'> +<p>true if this is a post request</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +71</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/zero/request.rb', line 71</span> + +<span class='rubyid_def def kw'>def</span> <span class='rubyid_post? fid id'>post?</span><span class='semicolon token'>;</span> <span class='rubyid_method identifier id'>method</span> <span class='eq op'>==</span> <span class='symbol val'>:post</span> <span class='rubyid_end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <h3 class="signature " id="put?-instance_method"> + + - (<tt>Boolean</tt>) <strong>put?</strong> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>is the method 'PUT'?</p> + + + </div> +</div> +<div class="tags"> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + — + <div class='inline'> +<p>true if this is a put request</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +74</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/zero/request.rb', line 74</span> + +<span class='rubyid_def def kw'>def</span> <span class='rubyid_put? fid id'>put?</span><span class='semicolon token'>;</span> <span class='rubyid_method identifier id'>method</span> <span class='eq op'>==</span> <span class='symbol val'>:put</span> <span class='rubyid_end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <h3 class="signature " id="server-instance_method"> + + - (<tt><span class='object_link'><a href="Request/Server.html" title="Zero::Request::Server (class)">Server</a></span></tt>) <strong>server</strong> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>get the information on the server</p> + + + </div> +</div> +<div class="tags"> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="Request/Server.html" title="Zero::Request::Server (class)">Server</a></span></tt>)</span> + + + + — + <div class='inline'> +<p>information on the running server</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +38 +39 +40</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/zero/request.rb', line 38</span> + +<span class='rubyid_def def kw'>def</span> <span class='rubyid_server identifier id'>server</span> + <span class='rubyid_@server ivar id'>@server</span> <span class='opasgn op'>||=</span> <span class='rubyid_Request constant id'>Request</span><span class='colon2 op'>::</span><span class='rubyid_Server constant id'>Server</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_@env ivar id'>@env</span><span class='rparen token'>)</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:00 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>
\ No newline at end of file |