summaryrefslogtreecommitdiffhomepage
path: root/doc/Axlsx/RestrictionValidator.html
diff options
context:
space:
mode:
authorRandy Morgan <[email protected]>2011-11-20 23:44:58 +0900
committerRandy Morgan <[email protected]>2011-11-20 23:44:58 +0900
commit2d0ac967e94c5944ccccf9adad8da5a9d082df29 (patch)
tree194839f4ce3687bd51577bab7e75dddc21ad5c9c /doc/Axlsx/RestrictionValidator.html
parent9d210b319c43141120c42aa740fd4a8670e5029a (diff)
downloadcaxlsx-2d0ac967e94c5944ccccf9adad8da5a9d082df29.tar.gz
caxlsx-2d0ac967e94c5944ccccf9adad8da5a9d082df29.zip
pushing docs
Diffstat (limited to 'doc/Axlsx/RestrictionValidator.html')
-rw-r--r--doc/Axlsx/RestrictionValidator.html300
1 files changed, 300 insertions, 0 deletions
diff --git a/doc/Axlsx/RestrictionValidator.html b/doc/Axlsx/RestrictionValidator.html
new file mode 100644
index 00000000..a9020501
--- /dev/null
+++ b/doc/Axlsx/RestrictionValidator.html
@@ -0,0 +1,300 @@
+<!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: Axlsx::RestrictionValidator
+
+ &mdash; Documentation by YARD 0.7.3
+
+</title>
+
+ <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
+
+ <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+ relpath = '..';
+ if (relpath != '') relpath += '/';
+</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>
+ <script type="text/javascript" charset="utf-8">
+ if (window.top.frames.main) document.body.className = 'frames';
+ </script>
+
+ <div id="header">
+ <div id="menu">
+
+ <a href="../_index.html">Index (R)</a> &raquo;
+ <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span>
+ &raquo;
+ <span class="title">RestrictionValidator</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 id="class_list_link" href="#">Class List</a>
+
+ <a id="method_list_link" href="#">Method List</a>
+
+ <a id="file_list_link" href="#">File List</a>
+
+</div>
+ <div class="clear"></div>
+ </div>
+
+ <iframe id="search_frame"></iframe>
+
+ <div id="content"><h1>Class: Axlsx::RestrictionValidator
+
+
+
+</h1>
+
+<dl class="box">
+
+ <dt class="r1">Inherits:</dt>
+ <dd class="r1">
+ <span class="inheritName">Object</span>
+
+ <ul class="fullTree">
+ <li>Object</li>
+
+ <li class="next">Axlsx::RestrictionValidator</li>
+
+ </ul>
+ <a href="#" class="inheritanceTree">show all</a>
+
+ </dd>
+
+
+
+
+
+
+
+
+
+ <dt class="r2 last">Defined in:</dt>
+ <dd class="r2 last">lib/axlsx/util/validators.rb</dd>
+
+</dl>
+<div class="clear"></div>
+
+<h2>Overview</h2><div class="docstring">
+ <div class="discussion">
+ <p>
+Validate a value against a specific list of allowed values.
+</p>
+
+
+ </div>
+</div>
+<div class="tags">
+
+
+</div>
+
+
+
+
+
+ <h2>
+ Class 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-class_method" title="validate (class method)">+ (Boolean) <strong>validate</strong>(name, choices, v) </a>
+
+
+
+ </span>
+
+
+
+
+
+
+
+
+ <span class="summary_desc"><div class='inline'><p>
+Perform validation.
+</p>
+</div></span>
+
+</li>
+
+
+ </ul>
+
+
+
+
+ <div id="class_method_details" class="method_details_list">
+ <h2>Class Method Details</h2>
+
+
+ <div class="method_details first">
+ <p class="signature first" id="validate-class_method">
+
+ + (<tt>Boolean</tt>) <strong>validate</strong>(name, choices, v)
+
+
+
+</p><div class="docstring">
+ <div class="discussion">
+ <p>
+Perform validation
+</p>
+
+
+ </div>
+</div>
+<div class="tags">
+ <h3>Parameters:</h3>
+<ul class="param">
+
+ <li>
+
+ <span class='name'>name</span>
+
+
+ <span class='type'>(<tt>String</tt>)</span>
+
+
+
+ &mdash;
+ <div class='inline'><p>
+The name of what is being validatied. This is included in the error message
+</p>
+</div>
+
+ </li>
+
+ <li>
+
+ <span class='name'>choices</span>
+
+
+ <span class='type'>(<tt>Array</tt>)</span>
+
+
+
+ &mdash;
+ <div class='inline'><p>
+The list of choices to validate against
+</p>
+</div>
+
+ </li>
+
+ <li>
+
+ <span class='name'>v</span>
+
+
+ <span class='type'>(<tt>Any</tt>)</span>
+
+
+
+ &mdash;
+ <div class='inline'><p>
+The value to be validated
+</p>
+</div>
+
+ </li>
+
+</ul>
+
+<h3>Returns:</h3>
+<ul class="return">
+
+ <li>
+
+
+ <span class='type'>(<tt>Boolean</tt>)</span>
+
+
+
+ &mdash;
+ <div class='inline'><p>
+true if validation succeeds.
+</p>
+</div>
+
+ </li>
+
+</ul>
+<h3>Raises:</h3>
+<ul class="raise">
+
+ <li>
+
+
+ <span class='type'>(<tt>ArgumentError</tt>)</span>
+
+
+
+ &mdash;
+ <div class='inline'><p>
+Raised if the value provided is not in the list of choices.
+</p>
+</div>
+
+ </li>
+
+</ul>
+
+</div><table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
+10
+11
+12
+13</pre>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/axlsx/util/validators.rb', line 10</span>
+
+<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span><span class='lparen token'>(</span><span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='choices identifier id'>choices</span><span class='comma token'>,</span> <span class='v identifier id'>v</span><span class='rparen token'>)</span>
+ <span class='raise identifier id'>raise</span> <span class='ArgumentError constant id'>ArgumentError</span><span class='comma token'>,</span> <span class='lparen token'>(</span><span class='ERR_RESTRICTION constant id'>ERR_RESTRICTION</span> <span class='mod op'>%</span> <span class='lbrack token'>[</span><span class='v identifier id'>v</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span><span class='comma token'>,</span> <span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='choices identifier id'>choices</span><span class='dot token'>.</span><span class='inspect identifier id'>inspect</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='choices identifier id'>choices</span><span class='dot token'>.</span><span class='include? fid id'>include?</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span>
+ <span class='true true kw'>true</span>
+<span class='end end kw'>end</span>
+</pre>
+ </td>
+ </tr>
+</table>
+</div>
+
+ </div>
+
+</div>
+
+ <div id="footer">
+ Generated on Sun Nov 20 23:43:58 2011 by
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+ 0.7.3 (ruby-1.8.7).
+</div>
+
+ </body>
+</html> \ No newline at end of file
generated by cgit v1.2.3 (git 2.39.1) at 2026-05-04 03:25:26 +0000