<?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: ActiveRecord::AttributeMethods::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">ActiveRecord::AttributeMethods::ClassMethods</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../../../files/lib/active_record/attribute_methods_rb.html">
lib/active_record/attribute_methods.rb
</a>
<br />
</td>
</tr>
</table>
</div>
<!-- banner header -->
<div id="bodyContent">
<div id="contextContent">
<div id="description">
<p>
Declare and check for suffixed attribute methods.
</p>
</div>
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000044">attribute_method_suffix</a>
<a href="#M000052">cache_attribute?</a>
<a href="#M000050">cache_attributes</a>
<a href="#M000051">cached_attributes</a>
<a href="#M000047">define_attribute_methods</a>
<a href="#M000049">define_read_methods</a>
<a href="#M000046">generated_methods?</a>
<a href="#M000048">instance_method_already_implemented?</a>
<a href="#M000045">match_attribute_method?</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-M000044" class="method-detail">
<a name="M000044"></a>
<div class="method-heading">
<a href="ClassMethods.src/M000044.html" target="Code" class="method-signature"
onclick="popupCode('ClassMethods.src/M000044.html');return false;">
<span class="method-name">attribute_method_suffix</span><span class="method-args">(*suffixes)</span>
</a>
</div>
<div class="method-description">
<p>
Declares a method available for all attributes with the given suffix. Uses
<tt>method_missing</tt> and <tt>respond_to?</tt> to rewrite the method
</p>
<pre>
#{attr}#{suffix}(*args, &block)
</pre>
<p>
to
</p>
<pre>
attribute#{suffix}(#{attr}, *args, &block)
</pre>
<p>
An <tt>attribute#{suffix}</tt> instance method must exist and accept at
least the <tt>attr</tt> argument.
</p>
<p>
For example:
</p>
<pre>
class Person < ActiveRecord::Base
attribute_method_suffix '_changed?'
private
def attribute_changed?(attr)
...
end
end
person = Person.find(1)
person.name_changed? # => false
person.name = 'Hubert'
person.name_changed? # => true
</pre>
</div>
</div>
<div id="method-M000052" class="method-detail">
<a name="M000052"></a>
<div class="method-heading">
<a href="ClassMethods.src/M000052.html" target="Code" class="method-signature"
onclick="popupCode('ClassMethods.src/M000052.html');return false;">
<span class="method-name">cache_attribute?</span><span class="method-args">(attr_name)</span>
</a>
</div>
<div class="method-description">
<p>
Returns <tt>true</tt> if the provided attribute is being cached.
</p>
</div>
</div>
<div id="method-M000050" class="method-detail">
<a name="M000050"></a>
<div class="method-heading">
<a href="ClassMethods.src/M000050.html" target="Code" class="method-signature"
onclick="popupCode('ClassMethods.src/M000050.html');return false;">
<span class="method-name">cache_attributes</span><span class="method-args">(*attribute_names)</span>
</a>
</div>
<div class="method-description">
<p>
<tt><a href="ClassMethods.html#M000050">cache_attributes</a></tt> allows
you to declare which converted attribute values should be cached. Usually
caching only pays off for attributes with expensive conversion methods,
like time related columns (e.g. <tt>created_at</tt>, <tt>updated_at</tt>).
</p>
</div>
</div>
<div id="method-M000051" class="method-detail">
<a name="M000051"></a>
<div class="method-heading">
<a href="ClassMethods.src/M000051.html" target="Code" class="method-signature"
onclick="popupCode('ClassMethods.src/M000051.html');return false;">
<span class="method-name">cached_attributes</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Returns the attributes which are cached. By default time related columns
with datatype <tt>:datetime, :timestamp, :time, :date</tt> are cached.
</p>
</div>
</div>
<div id="method-M000047" class="method-detail">
<a name="M000047"></a>
<div class="method-heading">
<a href="ClassMethods.src/M000047.html" target="Code" class="method-signature"
onclick="popupCode('ClassMethods.src/M000047.html');return false;">
<span class="method-name">define_attribute_methods</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Generates all the attribute related methods for columns in the database
accessors, mutators and query methods.
</p>
</div>
</div>
<div id="method-M000049" class="method-detail">
<a name="M000049"></a>
<div class="method-heading">
<span class="method-name">define_read_methods</span><span class="method-args">()</span>
</div>
<div class="method-description">
<p>
Alias for <a href="ClassMethods.html#M000047">define_attribute_methods</a>
</p>
</div>
</div>
<div id="method-M000046" class="method-detail">
<a name="M000046"></a>
<div class="method-heading">
<a href="ClassMethods.src/M000046.html" target="Code" class="method-signature"
onclick="popupCode('ClassMethods.src/M000046.html');return false;">
<span class="method-name">generated_methods?</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
</div>
</div>
<div id="method-M000048" class="method-detail">
<a name="M000048"></a>
<div class="method-heading">
<a href="ClassMethods.src/M000048.html" target="Code" class="method-signature"
onclick="popupCode('ClassMethods.src/M000048.html');return false;">
<span class="method-name">instance_method_already_implemented?</span><span class="method-args">(method_name)</span>
</a>
</div>
<div class="method-description">
<p>
Checks whether the method is defined in the model or any of its subclasses
that also derive from Active Record. Raises <a
href="../DangerousAttributeError.html">DangerousAttributeError</a> if the
method is defined by Active Record though.
</p>
</div>
</div>
<div id="method-M000045" class="method-detail">
<a name="M000045"></a>
<div class="method-heading">
<a href="ClassMethods.src/M000045.html" target="Code" class="method-signature"
onclick="popupCode('ClassMethods.src/M000045.html');return false;">
<span class="method-name">match_attribute_method?</span><span class="method-args">(method_name)</span>
</a>
</div>
<div class="method-description">
<p>
Returns MatchData if method_name is an attribute method.
</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>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
d51872cc0e1fdee944d71993f94ac764
>
files
>
102
