0
0
zero/doc/Zero/Request/AcceptType.html
2012-11-26 21:40:21 +01:00

403 lines
8.9 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::AcceptType
&mdash; 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 (A)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Zero.html" title="Zero (module)">Zero</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Request.html" title="Zero::Request (class)">Request</a></span></span>
&raquo;
<span class="title">AcceptType</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::AcceptType
</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::AcceptType</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">lib/zero/request/accept_type.rb</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>This class provides an interface to access information of accept schemas.</p>
</div>
</div>
<div class="tags">
</div>
<h2>Constant Summary</h2>
<dl class="constants">
<dt id="MEDIA_TYPE_SEPERATOR-constant" class="">MEDIA_TYPE_SEPERATOR =
</dt>
<dd><pre class="code"><span class='string val'>','</span>
</pre></dd>
<dt id="MEDIA_PARAM_SEPERATOR-constant" class="">MEDIA_PARAM_SEPERATOR =
</dt>
<dd><pre class="code"><span class='string val'>';'</span>
</pre></dd>
<dt id="MEDIA_QUALITY_REGEX-constant" class="">MEDIA_QUALITY_REGEX =
</dt>
<dd><pre class="code"><span class='regexp val'>/q=[01]\./</span>
</pre></dd>
</dl>
<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="#each-instance_method" title="#each (instance method)">- (Object) <strong>each</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>iterate over all media types.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">- (AcceptType) <strong>initialize</strong>(string) </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>create a new instance of AcceptType.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#preferred-instance_method" title="#preferred (instance method)">- (Object) <strong>preferred</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>return the preferred type.</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::AcceptType (class)">AcceptType</a></span></tt>) <strong>initialize</strong>(string)
</h3><div class="docstring">
<div class="discussion">
<p>create a new instance of AcceptType</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
10
11
12
13
14
15
16</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zero/request/accept_type.rb', line 10</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_string identifier id'>string</span><span class='rparen token'>)</span>
<span class='rubyid_if if kw'>if</span> <span class='rubyid_string identifier id'>string</span><span class='dot token'>.</span><span class='rubyid_nil? fid id'>nil?</span>
<span class='rubyid_@elements ivar id'>@elements</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span>
<span class='rubyid_else else kw'>else</span>
<span class='rubyid_@elements ivar id'>@elements</span> <span class='assign token'>=</span> <span class='rubyid_parse_elements identifier id'>parse_elements</span><span class='lparen token'>(</span><span class='rubyid_string identifier id'>string</span><span class='rparen token'>)</span>
<span class='rubyid_end end kw'>end</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="each-instance_method">
- (<tt>Object</tt>) <strong>each</strong>
</h3><div class="docstring">
<div class="discussion">
<p>iterate over all media types</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
25
26
27</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zero/request/accept_type.rb', line 25</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_each identifier id'>each</span>
<span class='rubyid_@elements ivar id'>@elements</span><span class='dot token'>.</span><span class='rubyid_each identifier id'>each</span> <span class='lbrace token'>{</span><span class='bitor op'>|</span><span class='rubyid_element identifier id'>element</span><span class='bitor op'>|</span> <span class='rubyid_yield yield kw'>yield</span> <span class='rubyid_element identifier id'>element</span><span class='rbrace token'>}</span>
<span class='rubyid_end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="preferred-instance_method">
- (<tt>Object</tt>) <strong>preferred</strong>
</h3><div class="docstring">
<div class="discussion">
<p>return the preferred type</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'></span>
<div class='inline'>
<p>String the preferred media type</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
20
21
22</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zero/request/accept_type.rb', line 20</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_preferred identifier id'>preferred</span>
<span class='rubyid_@elements ivar id'>@elements</span><span class='dot token'>.</span><span class='rubyid_first identifier id'>first</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:02 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>