<!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: Apes::Validators::BaseValidator — 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#!Apes/Validators/BaseValidator.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 (B)</a> » <span class='title'><span class='object_link'><a href="../../Apes.html" title="Apes (module)">Apes</a></span></span> » <span class='title'><span class='object_link'><a href="../Validators.html" title="Apes::Validators (module)">Validators</a></span></span> » <span class="title">BaseValidator</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: Apes::Validators::BaseValidator </h1> <dl class="box"> <dt class="r1">Inherits:</dt> <dd class="r1"> <span class="inheritName">ActiveModel::EachValidator</span> <ul class="fullTree"> <li>Object</li> <li class="next">ActiveModel::EachValidator</li> <li class="next">Apes::Validators::BaseValidator</li> </ul> <a href="#" class="inheritanceTree">show all</a> </dd> <dt class="r2 last">Defined in:</dt> <dd class="r2 last">lib/apes/validators.rb</dd> </dl> <div class="clear"></div> <h2>Overview</h2><div class="docstring"> <div class="discussion"> <p>The base validator.</p> </div> </div> <div class="tags"> </div><div id="subclasses"> <h2>Direct Known Subclasses</h2> <p class="children"><span class='object_link'><a href="BooleanValidator.html" title="Apes::Validators::BooleanValidator (class)">BooleanValidator</a></span>, <span class='object_link'><a href="EmailValidator.html" title="Apes::Validators::EmailValidator (class)">EmailValidator</a></span>, <span class='object_link'><a href="PhoneValidator.html" title="Apes::Validators::PhoneValidator (class)">PhoneValidator</a></span>, <span class='object_link'><a href="ReferenceValidator.html" title="Apes::Validators::ReferenceValidator (class)">ReferenceValidator</a></span>, <span class='object_link'><a href="TimestampValidator.html" title="Apes::Validators::TimestampValidator (class)">TimestampValidator</a></span>, <span class='object_link'><a href="UuidValidator.html" title="Apes::Validators::UuidValidator (class)">UuidValidator</a></span>, <span class='object_link'><a href="ZipCodeValidator.html" title="Apes::Validators::ZipCodeValidator (class)">ZipCodeValidator</a></span></p> </div> <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="#validate_each-instance_method" title="#validate_each (instance method)">- (Object) <strong>validate_each</strong>(model, attribute, value) </a> </span> <span class="summary_desc"><div class='inline'><p>Perform validation on a attribute of a model.</p> </div></span> </li> </ul> <div id="instance_method_details" class="method_details_list"> <h2>Instance Method Details</h2> <div class="method_details first"> <h3 class="signature first" id="validate_each-instance_method"> - (<tt>Object</tt>) <strong>validate_each</strong>(model, attribute, value) </h3><div class="docstring"> <div class="discussion"> <p>Perform validation on a attribute of a model.</p> </div> </div> <div class="tags"> <p class="tag_title">Parameters:</p> <ul class="param"> <li> <span class='name'>model</span> <span class='type'>(<tt>Object</tt>)</span> — <div class='inline'><p>The object to validate.</p> </div> </li> <li> <span class='name'>attribute</span> <span class='type'>(<tt>String|Symbol</tt>)</span> — <div class='inline'><p>The attribute to validate.</p> </div> </li> <li> <span class='name'>value</span> <span class='type'>(<tt>Object</tt>)</span> — <div class='inline'><p>The value of the attribute.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 16 17 18 19 20 21 22 23 24</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/apes/validators.rb', line 16</span> <span class='kw'>def</span> <span class='id identifier rubyid_validate_each'>validate_each</span><span class='lparen'>(</span><span class='id identifier rubyid_model'>model</span><span class='comma'>,</span> <span class='id identifier rubyid_attribute'>attribute</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span> <span class='id identifier rubyid_checked'>checked</span> <span class='op'>=</span> <span class='id identifier rubyid_check_valid?'>check_valid?</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span> <span class='kw'>return</span> <span class='id identifier rubyid_checked'>checked</span> <span class='kw'>if</span> <span class='id identifier rubyid_checked'>checked</span> <span class='id identifier rubyid_message'>message</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:message</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:default_message</span><span class='rbracket'>]</span> <span class='id identifier rubyid_destination'>destination</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:additional</span><span class='rbracket'>]</span> <span class='op'>?</span> <span class='id identifier rubyid_model'>model</span><span class='period'>.</span><span class='id identifier rubyid_additional_errors'>additional_errors</span> <span class='op'>:</span> <span class='id identifier rubyid_model'>model</span><span class='period'>.</span><span class='id identifier rubyid_errors'>errors</span> <span class='id identifier rubyid_destination'>destination</span><span class='lbracket'>[</span><span class='id identifier rubyid_attribute'>attribute</span><span class='rbracket'>]</span> <span class='op'><<</span> <span class='id identifier rubyid_message'>message</span> <span class='kw'>nil</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> </div> </div> <div id="footer"> Generated on Thu Aug 18 15:49:46 2016 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.8.7.6 (ruby-2.3.0). </div> </body> </html>