doc/api/classes/ActionController/Pagination/ClassMethods.html
<?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>Module: ActionController::Pagination::ClassMethods</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>Module</strong></td>
<td class="class-name-in-header">ActionController::Pagination::ClassMethods</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../../../files/vendor/rails/actionpack/lib/action_controller/pagination_rb.html">
vendor/rails/actionpack/lib/action_controller/pagination.rb
</a>
<br />
</td>
</tr>
</table>
</div>
<!-- banner header -->
<div id="bodyContent">
<div id="contextContent">
<div id="description">
<p>
These methods become class methods on any controller
</p>
</div>
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000135">paginate</a>
</div>
</div>
</div>
<!-- if includes -->
<div id="section">
<!-- if method_list -->
<div id="methods">
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000135" class="method-detail">
<a name="M000135"></a>
<div class="method-heading">
<a href="#M000135" class="method-signature">
<span class="method-name">paginate</span><span class="method-args">(collection_id, options={})</span>
</a>
</div>
<div class="method-description">
<p>
Creates a <tt>before_filter</tt> which automatically paginates an Active
Record model for all actions in a controller (or certain actions if
specified with the <tt>:actions</tt> option).
</p>
<p>
<tt>options</tt> are the same as PaginationHelper#paginate, with the
addition of:
</p>
<table>
<tr><td valign="top"><tt>:actions</tt>:</td><td>an array of actions for which the pagination is active. Defaults to
<tt>nil</tt> (i.e., every action)
</td></tr>
</table>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000135-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000135-source">
<pre>
<span class="ruby-comment cmt"># File vendor/rails/actionpack/lib/action_controller/pagination.rb, line 147</span>
147: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">paginate</span>(<span class="ruby-identifier">collection_id</span>, <span class="ruby-identifier">options</span>={})
148: <span class="ruby-constant">Pagination</span>.<span class="ruby-identifier">validate_options!</span>(<span class="ruby-identifier">collection_id</span>, <span class="ruby-identifier">options</span>, <span class="ruby-keyword kw">false</span>)
149: <span class="ruby-identifier">module_eval</span> <span class="ruby-keyword kw">do</span>
150: <span class="ruby-identifier">before_filter</span> <span class="ruby-identifier">:create_paginators_and_retrieve_collections</span>
151: <span class="ruby-constant">OPTIONS</span>[<span class="ruby-keyword kw">self</span>] <span class="ruby-operator">||=</span> <span class="ruby-constant">Hash</span>.<span class="ruby-identifier">new</span>
152: <span class="ruby-constant">OPTIONS</span>[<span class="ruby-keyword kw">self</span>][<span class="ruby-identifier">collection_id</span>] = <span class="ruby-identifier">options</span>
153: <span class="ruby-keyword kw">end</span>
154: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</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>