<?xml version="1.0" encoding="iso-8859-1"?>
<!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>
<title>Class: Sinatra::Rabbit::Collection</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<meta http-equiv="Content-Script-Type" content="text/javascript" />
<link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
<script type="text/javascript">
// <![CDATA[
function popupCode( url ) {
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
}
function toggleCode( id ) {
if ( document.getElementById )
elem = document.getElementById( id );
else if ( document.all )
elem = eval( "document.all." + id );
else
return false;
elemStyle = elem.style;
if ( elemStyle.display != "block" ) {
elemStyle.display = "block"
} else {
elemStyle.display = "none"
}
return true;
}
// Make codeblocks hidden by default
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
// ]]>
</script>
</head>
<body>
<div id="classHeader">
<table class="header-table">
<tr class="top-aligned-row">
<td><strong>Class</strong></td>
<td class="class-name-in-header">Sinatra::Rabbit::Collection</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../../../files/lib/sinatra/rabbit_rb.html">
lib/sinatra/rabbit.rb
</a>
<br />
</td>
</tr>
<tr class="top-aligned-row">
<td><strong>Parent:</strong></td>
<td>
Object
</td>
</tr>
</table>
</div>
<!-- banner header -->
<div id="bodyContent">
<div id="contextContent">
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000240">check_supported</a>
<a href="#M000232">description</a>
<a href="#M000239">generate</a>
<a href="#M000237">generate_documentation</a>
<a href="#M000235">generate_head</a>
<a href="#M000236">generate_options</a>
<a href="#M000233">global!</a>
<a href="#M000234">global?</a>
<a href="#M000231">new</a>
<a href="#M000238">operation</a>
</div>
</div>
</div>
<!-- if includes -->
<div id="section">
<div id="attribute-list">
<h3 class="section-bar">Attributes</h3>
<div class="name-list">
<table>
<tr class="top-aligned-row context-row">
<td class="context-item-name">name</td>
<td class="context-item-value"> [R] </td>
<td class="context-item-desc"></td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">operations</td>
<td class="context-item-value"> [R] </td>
<td class="context-item-desc"></td>
</tr>
</table>
</div>
</div>
<!-- if method_list -->
<div id="methods">
<h3 class="section-bar">Public Class methods</h3>
<div id="method-M000231" class="method-detail">
<a name="M000231"></a>
<div class="method-heading">
<a href="Collection.src/M000231.html" target="Code" class="method-signature"
onclick="popupCode('Collection.src/M000231.html');return false;">
<span class="method-name">new</span><span class="method-args">(name, &block)</span>
</a>
</div>
<div class="method-description">
</div>
</div>
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000240" class="method-detail">
<a name="M000240"></a>
<div class="method-heading">
<a href="Collection.src/M000240.html" target="Code" class="method-signature"
onclick="popupCode('Collection.src/M000240.html');return false;">
<span class="method-name">check_supported</span><span class="method-args">(driver)</span>
</a>
</div>
<div class="method-description">
</div>
</div>
<div id="method-M000232" class="method-detail">
<a name="M000232"></a>
<div class="method-heading">
<a href="Collection.src/M000232.html" target="Code" class="method-signature"
onclick="popupCode('Collection.src/M000232.html');return false;">
<span class="method-name">description</span><span class="method-args">(text='')</span>
</a>
</div>
<div class="method-description">
<p>
Set/Return <a href="Collection.html#M000232">description</a> for collection
If first parameter is not present, full <a
href="Collection.html#M000232">description</a> will be returned.
</p>
</div>
</div>
<div id="method-M000239" class="method-detail">
<a name="M000239"></a>
<div class="method-heading">
<a href="Collection.src/M000239.html" target="Code" class="method-signature"
onclick="popupCode('Collection.src/M000239.html');return false;">
<span class="method-name">generate</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
</div>
</div>
<div id="method-M000237" class="method-detail">
<a name="M000237"></a>
<div class="method-heading">
<a href="Collection.src/M000237.html" target="Code" class="method-signature"
onclick="popupCode('Collection.src/M000237.html');return false;">
<span class="method-name">generate_documentation</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
</div>
</div>
<div id="method-M000235" class="method-detail">
<a name="M000235"></a>
<div class="method-heading">
<a href="Collection.src/M000235.html" target="Code" class="method-signature"
onclick="popupCode('Collection.src/M000235.html');return false;">
<span class="method-name">generate_head</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
</div>
</div>
<div id="method-M000236" class="method-detail">
<a name="M000236"></a>
<div class="method-heading">
<a href="Collection.src/M000236.html" target="Code" class="method-signature"
onclick="popupCode('Collection.src/M000236.html');return false;">
<span class="method-name">generate_options</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
</div>
</div>
<div id="method-M000233" class="method-detail">
<a name="M000233"></a>
<div class="method-heading">
<a href="Collection.src/M000233.html" target="Code" class="method-signature"
onclick="popupCode('Collection.src/M000233.html');return false;">
<span class="method-name">global!</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Mark this collection as global, i.e. independent of any specific driver
</p>
</div>
</div>
<div id="method-M000234" class="method-detail">
<a name="M000234"></a>
<div class="method-heading">
<a href="Collection.src/M000234.html" target="Code" class="method-signature"
onclick="popupCode('Collection.src/M000234.html');return false;">
<span class="method-name">global?</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Return <tt>true</tt> if this collection is global, i.e. independent of any
specific driver
</p>
</div>
</div>
<div id="method-M000238" class="method-detail">
<a name="M000238"></a>
<div class="method-heading">
<a href="Collection.src/M000238.html" target="Code" class="method-signature"
onclick="popupCode('Collection.src/M000238.html');return false;">
<span class="method-name">operation</span><span class="method-args">(name, opts = {}, &block)</span>
</a>
</div>
<div class="method-description">
<p>
Add a <a href="Collection.html#M000231">new</a> <a
href="Collection.html#M000238">operation</a> for this collection. For the
standard REST operations :index, :show, :update, and :destroy, we already
know what method to use and whether this is an <a
href="Collection.html#M000238">operation</a> on the URL for individual
elements or for the whole collection.
</p>
<p>
For non-standard operations, options must be passed:
</p>
<pre>
:method : one of the HTTP methods
:member : whether this is an operation on the collection or an
individual element (FIXME: custom operations on the
collection will use a nonsensical URL) The URL for the
operation is the element URL with the name of the operation
appended
</pre>
<p>
This also defines a helper method like show_instance_url that returns the
URL to this <a href="Collection.html#M000238">operation</a> (in request
context)
</p>
</div>
</div>
</div>
</div>
<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>
</body>
</html>
