mirror of
https://github.com/ditkrg/active_model_serializers.git
synced 2026-01-22 22:06:50 +00:00
399 lines
13 KiB
HTML
399 lines
13 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: ActiveModel::Serializer::Null
|
|
|
|
— Documentation by YARD 0.8.7.6
|
|
|
|
</title>
|
|
|
|
<link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
|
|
|
|
<link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
|
|
|
|
<script type="text/javascript" charset="utf-8">
|
|
hasFrames = window.top.frames.main ? true : false;
|
|
relpath = '../../';
|
|
framesUrl = "../../frames.html#!ActiveModel/Serializer/Null.html";
|
|
</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 (N)</a> »
|
|
<span class='title'><span class='object_link'><a href="../../ActiveModel.html" title="ActiveModel (module)">ActiveModel</a></span></span> » <span class='title'><span class='object_link'><a href="../Serializer.html" title="ActiveModel::Serializer (class)">Serializer</a></span></span>
|
|
»
|
|
<span class="title">Null</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: ActiveModel::Serializer::Null
|
|
|
|
|
|
|
|
</h1>
|
|
|
|
<dl class="box">
|
|
|
|
<dt class="r1">Inherits:</dt>
|
|
<dd class="r1">
|
|
<span class="inheritName"><span class='object_link'><a href="../Serializer.html" title="ActiveModel::Serializer (class)">ActiveModel::Serializer</a></span></span>
|
|
|
|
<ul class="fullTree">
|
|
<li>Object</li>
|
|
|
|
<li class="next"><span class='object_link'><a href="../Serializer.html" title="ActiveModel::Serializer (class)">ActiveModel::Serializer</a></span></li>
|
|
|
|
<li class="next">ActiveModel::Serializer::Null</li>
|
|
|
|
</ul>
|
|
<a href="#" class="inheritanceTree">show all</a>
|
|
|
|
</dd>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dt class="r2 last">Defined in:</dt>
|
|
<dd class="r2 last">lib/active_model/serializer/null.rb</dd>
|
|
|
|
</dl>
|
|
<div class="clear"></div>
|
|
|
|
|
|
<h2>Constant Summary</h2>
|
|
|
|
|
|
|
|
|
|
<h2>Constant Summary</h2>
|
|
|
|
<h3 class="inherited">Constants inherited
|
|
from <span class='object_link'><a href="../Serializer.html" title="ActiveModel::Serializer (class)">ActiveModel::Serializer</a></span></h3>
|
|
<p class="inherited"><span class='object_link'><a href="../Serializer.html#SERIALIZABLE_HASH_VALID_KEYS-constant" title="ActiveModel::Serializer::SERIALIZABLE_HASH_VALID_KEYS (constant)">SERIALIZABLE_HASH_VALID_KEYS</a></span>, <span class='object_link'><a href="../Serializer.html#UndefinedCacheKey-constant" title="ActiveModel::Serializer::UndefinedCacheKey (constant)">UndefinedCacheKey</a></span>, <span class='object_link'><a href="../Serializer.html#VERSION-constant" title="ActiveModel::Serializer::VERSION (constant)">VERSION</a></span></p>
|
|
|
|
|
|
|
|
<h3 class="inherited">Constants included
|
|
from <span class='object_link'><a href="Caching.html" title="ActiveModel::Serializer::Caching (module)">Caching</a></span></h3>
|
|
<p class="inherited"><span class='object_link'><a href="Caching.html#CALLER_FILE-constant" title="ActiveModel::Serializer::Caching::CALLER_FILE (constant)">Caching::CALLER_FILE</a></span></p>
|
|
|
|
|
|
|
|
|
|
<h2>Instance Attribute Summary</h2>
|
|
|
|
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="../Serializer.html" title="ActiveModel::Serializer (class)">ActiveModel::Serializer</a></span></h3>
|
|
<p class="inherited"><span class='object_link'><a href="../Serializer.html#object-instance_method" title="ActiveModel::Serializer#object (method)">#object</a></span>, <span class='object_link'><a href="../Serializer.html#root-instance_method" title="ActiveModel::Serializer#root (method)">#root</a></span>, <span class='object_link'><a href="../Serializer.html#scope-instance_method" title="ActiveModel::Serializer#scope (method)">#scope</a></span></p>
|
|
|
|
|
|
|
|
<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="#associations-instance_method" title="#associations (instance method)">- (Object) <strong>associations</strong> </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'></div></span>
|
|
|
|
</li>
|
|
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#attributes-instance_method" title="#attributes (instance method)">- (Object) <strong>attributes</strong> </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'></div></span>
|
|
|
|
</li>
|
|
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#serializable_hash-instance_method" title="#serializable_hash (instance method)">- (Object) <strong>serializable_hash</strong> </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'></div></span>
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Serializer.html" title="ActiveModel::Serializer (class)">ActiveModel::Serializer</a></span></h3>
|
|
<p class="inherited"><span class='object_link'><a href="../Serializer.html#adapter-class_method" title="ActiveModel::Serializer.adapter (method)">adapter</a></span>, <span class='object_link'><a href="../Serializer.html#as_json-instance_method" title="ActiveModel::Serializer#as_json (method)">#as_json</a></span>, <span class='object_link'><a href="../Serializer.html#get_serializer_for-class_method" title="ActiveModel::Serializer.get_serializer_for (method)">get_serializer_for</a></span>, <span class='object_link'><a href="../Serializer.html#include_directive_from_options-class_method" title="ActiveModel::Serializer.include_directive_from_options (method)">include_directive_from_options</a></span>, <span class='object_link'><a href="../Serializer.html#initialize-instance_method" title="ActiveModel::Serializer#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="../Serializer.html#json_key-instance_method" title="ActiveModel::Serializer#json_key (method)">#json_key</a></span>, <span class='object_link'><a href="../Serializer.html#read_attribute_for_serialization-instance_method" title="ActiveModel::Serializer#read_attribute_for_serialization (method)">#read_attribute_for_serialization</a></span>, <span class='object_link'><a href="../Serializer.html#relationship_value_for-instance_method" title="ActiveModel::Serializer#relationship_value_for (method)">#relationship_value_for</a></span>, <span class='object_link'><a href="../Serializer.html#resource_relationships-instance_method" title="ActiveModel::Serializer#resource_relationships (method)">#resource_relationships</a></span>, <span class='object_link'><a href="../Serializer.html#serialization_adapter_instance-class_method" title="ActiveModel::Serializer.serialization_adapter_instance (method)">serialization_adapter_instance</a></span>, <span class='object_link'><a href="../Serializer.html#serializer_for-class_method" title="ActiveModel::Serializer.serializer_for (method)">serializer_for</a></span>, <span class='object_link'><a href="../Serializer.html#serializer_lookup_chain_for-class_method" title="ActiveModel::Serializer.serializer_lookup_chain_for (method)">serializer_lookup_chain_for</a></span>, <span class='object_link'><a href="../Serializer.html#serializers_cache-class_method" title="ActiveModel::Serializer.serializers_cache (method)">serializers_cache</a></span>, <span class='object_link'><a href="../Serializer.html#success%3F-instance_method" title="ActiveModel::Serializer#success? (method)">#success?</a></span></p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="inherited">Methods included from <span class='object_link'><a href="../../ActiveModelSerializers/Deprecate.html" title="ActiveModelSerializers::Deprecate (module)">ActiveModelSerializers::Deprecate</a></span></h3>
|
|
<p class="inherited"><span class='object_link'><a href="../../ActiveModelSerializers/Deprecate.html#delegate_and_deprecate-class_method" title="ActiveModelSerializers::Deprecate.delegate_and_deprecate (method)">delegate_and_deprecate</a></span>, <span class='object_link'><a href="../../ActiveModelSerializers/Deprecate.html#deprecate-class_method" title="ActiveModelSerializers::Deprecate.deprecate (method)">deprecate</a></span></p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="inherited">Methods included from <span class='object_link'><a href="Caching.html" title="ActiveModel::Serializer::Caching (module)">Caching</a></span></h3>
|
|
<p class="inherited"><span class='object_link'><a href="Caching.html#cache_key-instance_method" title="ActiveModel::Serializer::Caching#cache_key (method)">#cache_key</a></span>, <span class='object_link'><a href="Caching.html#fetch-instance_method" title="ActiveModel::Serializer::Caching#fetch (method)">#fetch</a></span>, <span class='object_link'><a href="Caching.html#fetch_attributes-instance_method" title="ActiveModel::Serializer::Caching#fetch_attributes (method)">#fetch_attributes</a></span>, <span class='object_link'><a href="Caching.html#fetch_attributes_fragment-instance_method" title="ActiveModel::Serializer::Caching#fetch_attributes_fragment (method)">#fetch_attributes_fragment</a></span>, <span class='object_link'><a href="Caching.html#object_cache_key-instance_method" title="ActiveModel::Serializer::Caching#object_cache_key (method)">#object_cache_key</a></span>, <span class='object_link'><a href="Caching.html#serializer_class-instance_method" title="ActiveModel::Serializer::Caching#serializer_class (method)">#serializer_class</a></span></p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div id="constructor_details" class="method_details_list">
|
|
<h2>Constructor Details</h2>
|
|
|
|
<p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Serializer.html#initialize-instance_method" title="ActiveModel::Serializer#initialize (method)">ActiveModel::Serializer</a></span></p>
|
|
|
|
</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="associations-instance_method">
|
|
|
|
- (<tt>Object</tt>) <strong>associations</strong>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><table class="source_code">
|
|
<tr>
|
|
<td>
|
|
<pre class="lines">
|
|
|
|
|
|
8
|
|
9
|
|
10</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/null.rb', line 8</span>
|
|
|
|
<span class='kw'>def</span> <span class='id identifier rubyid_associations'>associations</span><span class='lparen'>(</span><span class='op'>*</span><span class='rparen'>)</span>
|
|
<span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
<span class='kw'>end</span></pre>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="method_details ">
|
|
<h3 class="signature " id="attributes-instance_method">
|
|
|
|
- (<tt>Object</tt>) <strong>attributes</strong>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><table class="source_code">
|
|
<tr>
|
|
<td>
|
|
<pre class="lines">
|
|
|
|
|
|
4
|
|
5
|
|
6</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/null.rb', line 4</span>
|
|
|
|
<span class='kw'>def</span> <span class='id identifier rubyid_attributes'>attributes</span><span class='lparen'>(</span><span class='op'>*</span><span class='rparen'>)</span>
|
|
<span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
<span class='kw'>end</span></pre>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="method_details ">
|
|
<h3 class="signature " id="serializable_hash-instance_method">
|
|
|
|
- (<tt>Object</tt>) <strong>serializable_hash</strong>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><table class="source_code">
|
|
<tr>
|
|
<td>
|
|
<pre class="lines">
|
|
|
|
|
|
12
|
|
13
|
|
14</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/null.rb', line 12</span>
|
|
|
|
<span class='kw'>def</span> <span class='id identifier rubyid_serializable_hash'>serializable_hash</span><span class='lparen'>(</span><span class='op'>*</span><span class='rparen'>)</span>
|
|
<span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
<span class='kw'>end</span></pre>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div id="footer">
|
|
Generated on Thu Jun 16 09:05:11 2016 by
|
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
0.8.7.6 (ruby-2.2.4).
|
|
</div>
|
|
|
|
</body>
|
|
</html> |