332 lines
15 KiB
HTML
332 lines
15 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<title>ValidationRule Class Reference</title>
|
|
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
|
|
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
|
|
<meta charset='utf-8'>
|
|
<script src="../js/jquery.min.js" defer></script>
|
|
<script src="../js/jazzy.js" defer></script>
|
|
|
|
</head>
|
|
<body>
|
|
<a name="//apple_ref/swift/Class/ValidationRule" class="dashAnchor"></a>
|
|
<a title="ValidationRule Class Reference"></a>
|
|
<header>
|
|
<div class="content-wrapper">
|
|
<p><a href="../index.html">SwiftValidator Docs</a> (100% documented)</p>
|
|
</div>
|
|
</header>
|
|
<div class="content-wrapper">
|
|
<p id="breadcrumbs">
|
|
<a href="../index.html">SwiftValidator Reference</a>
|
|
<img id="carat" src="../img/carat.png" />
|
|
ValidationRule Class Reference
|
|
</p>
|
|
</div>
|
|
<div class="content-wrapper">
|
|
<nav class="sidebar">
|
|
<ul class="nav-groups">
|
|
<li class="nav-group-name">
|
|
<a href="../Classes.html">Classes</a>
|
|
<ul class="nav-group-tasks">
|
|
<li class="nav-group-task">
|
|
<a href="../Classes/AlphaNumericRule.html">AlphaNumericRule</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Classes/AlphaRule.html">AlphaRule</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Classes/CharacterSetRule.html">CharacterSetRule</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Classes/ConfirmationRule.html">ConfirmationRule</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Classes/EmailRule.html">EmailRule</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Classes/ExactLengthRule.html">ExactLengthRule</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Classes/FloatRule.html">FloatRule</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Classes/FullNameRule.html">FullNameRule</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Classes/HexColorRule.html">HexColorRule</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Classes/IPV4Rule.html">IPV4Rule</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Classes/ISBNRule.html">ISBNRule</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Classes/MaxLengthRule.html">MaxLengthRule</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Classes/MinLengthRule.html">MinLengthRule</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Classes/PasswordRule.html">PasswordRule</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Classes/PhoneNumberRule.html">PhoneNumberRule</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Classes/RegexRule.html">RegexRule</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Classes/RequiredRule.html">RequiredRule</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Classes/ValidationError.html">ValidationError</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Classes/ValidationRule.html">ValidationRule</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Classes/Validator.html">Validator</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Classes/ZipCodeRule.html">ZipCodeRule</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="nav-group-name">
|
|
<a href="../Protocols.html">Protocols</a>
|
|
<ul class="nav-group-tasks">
|
|
<li class="nav-group-task">
|
|
<a href="../Protocols/Rule.html">Rule</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Protocols/ValidationDelegate.html">ValidationDelegate</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<article class="main-content">
|
|
<section>
|
|
<section class="section">
|
|
<h1>ValidationRule</h1>
|
|
<div class="declaration">
|
|
<div class="language">
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">ValidationRule</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<p><code>ValidationRule</code> is a class that creates an object which holds validation info of a text field.</p>
|
|
|
|
</section>
|
|
<section class="section task-group-section">
|
|
<div class="task-group">
|
|
<ul>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:vC14SwiftValidator14ValidationRule9textFieldCSo11UITextField"></a>
|
|
<a name="//apple_ref/swift/Property/textField" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:vC14SwiftValidator14ValidationRule9textFieldCSo11UITextField">textField</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>the text field of the field</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">textField</span><span class="p">:</span><span class="kt">UITextField</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:vC14SwiftValidator14ValidationRule10errorLabelGSqCSo7UILabel_"></a>
|
|
<a name="//apple_ref/swift/Property/errorLabel" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:vC14SwiftValidator14ValidationRule10errorLabelGSqCSo7UILabel_">errorLabel</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>the errorLabel of the field</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">errorLabel</span><span class="p">:</span><span class="kt">UILabel</span><span class="p">?</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:vC14SwiftValidator14ValidationRule5rulesGSaPS_4Rule__"></a>
|
|
<a name="//apple_ref/swift/Property/rules" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:vC14SwiftValidator14ValidationRule5rulesGSaPS_4Rule__">rules</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>the rules of the field</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">rules</span><span class="p">:[</span><span class="kt">Rule</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:FC14SwiftValidator14ValidationRulecFMS0_FT9textFieldCSo11UITextField5rulesGSaPS_4Rule__10errorLabelGSqCSo7UILabel__S0_"></a>
|
|
<a name="//apple_ref/swift/Method/init(textField:rules:errorLabel:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:FC14SwiftValidator14ValidationRulecFMS0_FT9textFieldCSo11UITextField5rulesGSaPS_4Rule__10errorLabelGSqCSo7UILabel__S0_">init(textField:rules:errorLabel:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Initializes <code><a href="../Classes/ValidationRule.html">ValidationRule</a></code> instance with text field, rules, and errorLabel.</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">textField</span><span class="p">:</span> <span class="kt">UITextField</span><span class="p">,</span> <span class="nv">rules</span><span class="p">:[</span><span class="kt">Rule</span><span class="p">],</span> <span class="nv">errorLabel</span><span class="p">:</span><span class="kt">UILabel</span><span class="p">?)</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h4>Parameters</h4>
|
|
<table class="graybox">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>textField</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>text field that holds actual text in text field.</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>errorLabel</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>label that holds error label of text field.</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>rules</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>array of Rule objects, which text field will be validated against.</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h4>Return Value</h4>
|
|
<p>An initialized <code><a href="../Classes/ValidationRule.html">ValidationRule</a></code> object, or nil if an object could not be created for some reason that would not result in an exception.</p>
|
|
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:FC14SwiftValidator14ValidationRule13validateFieldFS0_FT_GSqCS_15ValidationError_"></a>
|
|
<a name="//apple_ref/swift/Method/validateField()" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:FC14SwiftValidator14ValidationRule13validateFieldFS0_FT_GSqCS_15ValidationError_">validateField()</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Used to validate text field against its validation rules.
|
|
- returns: <code><a href="../Classes/ValidationError.html">ValidationError</a></code> object if at least one error is found. Nil is returned if there are no validation errors.</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">validateField</span><span class="p">()</span> <span class="o">-></span> <span class="kt">ValidationError</span><span class="p">?</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h4>Return Value</h4>
|
|
<p><code><a href="../Classes/ValidationError.html">ValidationError</a></code> object if at least one error is found. Nil is returned if there are no validation errors.</p>
|
|
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section id="footer">
|
|
<p>© 2016 <a class="link" href="https://github.com/jpotts18/SwiftValidator" target="_blank" rel="external">Jeff Potter</a>. All rights reserved. (Last updated: 2016-04-15)</p>
|
|
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.5.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
|
</section>
|
|
</article>
|
|
</div>
|
|
</body>
|
|
</div>
|
|
</html>
|