Merge pull request #99 from jpotts18/gh-pages-develop
docs generated via jazzy
This commit is contained in:
David Patterson
commit
92bf121f87
|
|
@ -0,0 +1,592 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<title>Classes 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 title="Classes 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" />
|
||||
Classes 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/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/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>Classes</h1>
|
||||
<p>The following classes are available globally.</p>
|
||||
|
||||
</section>
|
||||
<section class="section task-group-section">
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:C14SwiftValidator9EmailRule"></a>
|
||||
<a name="//apple_ref/swift/Class/EmailRule" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:C14SwiftValidator9EmailRule">EmailRule</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p><code>EmailRule</code> is a subclass of RegexRule that defines how a email is validated.</p>
|
||||
|
||||
<a href="Classes/EmailRule.html" class="slightly-smaller">See more</a>
|
||||
</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">class</span> <span class="kt">EmailRule</span><span class="p">:</span> <span class="kt">RegexRule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:C14SwiftValidator12FullNameRule"></a>
|
||||
<a name="//apple_ref/swift/Class/FullNameRule" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:C14SwiftValidator12FullNameRule">FullNameRule</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p><code>FullNameRule</code> is a subclass of Rule that defines how a full name is validated.</p>
|
||||
|
||||
<a href="Classes/FullNameRule.html" class="slightly-smaller">See more</a>
|
||||
</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">class</span> <span class="kt">FullNameRule</span> <span class="p">:</span> <span class="kt">Rule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:C14SwiftValidator11ZipCodeRule"></a>
|
||||
<a name="//apple_ref/swift/Class/ZipCodeRule" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:C14SwiftValidator11ZipCodeRule">ZipCodeRule</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p><code>ZipCodeRule</code> is a subclass of <code><a href="Classes/RegexRule.html">RegexRule</a></code> that represents how zip codes are to be validated.</p>
|
||||
|
||||
<a href="Classes/ZipCodeRule.html" class="slightly-smaller">See more</a>
|
||||
</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">class</span> <span class="kt">ZipCodeRule</span><span class="p">:</span> <span class="kt">RegexRule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:C14SwiftValidator12PasswordRule"></a>
|
||||
<a name="//apple_ref/swift/Class/PasswordRule" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:C14SwiftValidator12PasswordRule">PasswordRule</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p><code>PasswordRule</code> is a subclass of RegexRule that defines how a password is validated.</p>
|
||||
|
||||
<a href="Classes/PasswordRule.html" class="slightly-smaller">See more</a>
|
||||
</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">class</span> <span class="kt">PasswordRule</span> <span class="p">:</span> <span class="kt">RegexRule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:C14SwiftValidator15PhoneNumberRule"></a>
|
||||
<a name="//apple_ref/swift/Class/PhoneNumberRule" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:C14SwiftValidator15PhoneNumberRule">PhoneNumberRule</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p><code>PhoneNumberRule</code> is a subclass of Rule that defines how a phone number is validated.</p>
|
||||
|
||||
<a href="Classes/PhoneNumberRule.html" class="slightly-smaller">See more</a>
|
||||
</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">class</span> <span class="kt">PhoneNumberRule</span><span class="p">:</span> <span class="kt">RegexRule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:C14SwiftValidator9FloatRule"></a>
|
||||
<a name="//apple_ref/swift/Class/FloatRule" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:C14SwiftValidator9FloatRule">FloatRule</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p><code>FloatRule</code> is a subclass of Rule that defines how check if a value is a floating point value.</p>
|
||||
|
||||
<a href="Classes/FloatRule.html" class="slightly-smaller">See more</a>
|
||||
</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">class</span> <span class="kt">FloatRule</span><span class="p">:</span><span class="kt">Rule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:C14SwiftValidator9Validator"></a>
|
||||
<a name="//apple_ref/swift/Class/Validator" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:C14SwiftValidator9Validator">Validator</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Class that makes <code>Validator</code> objects. Should be added as a parameter to ViewController that will display
|
||||
validation fields.</p>
|
||||
|
||||
<a href="Classes/Validator.html" class="slightly-smaller">See more</a>
|
||||
</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">class</span> <span class="kt">Validator</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:C14SwiftValidator14ValidationRule"></a>
|
||||
<a name="//apple_ref/swift/Class/ValidationRule" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:C14SwiftValidator14ValidationRule">ValidationRule</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p><code>ValidationRule</code> is a class that creates an object which holds validation info of a text field.</p>
|
||||
|
||||
<a href="Classes/ValidationRule.html" class="slightly-smaller">See more</a>
|
||||
</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">class</span> <span class="kt">ValidationRule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:C14SwiftValidator16ConfirmationRule"></a>
|
||||
<a name="//apple_ref/swift/Class/ConfirmationRule" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:C14SwiftValidator16ConfirmationRule">ConfirmationRule</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p><code>ConfirmationRule</code> is a subclass of Rule that defines how a text field that has to be equal
|
||||
to another text field is validated.</p>
|
||||
|
||||
<a href="Classes/ConfirmationRule.html" class="slightly-smaller">See more</a>
|
||||
</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">class</span> <span class="kt">ConfirmationRule</span><span class="p">:</span> <span class="kt">Rule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:C14SwiftValidator15ValidationError"></a>
|
||||
<a name="//apple_ref/swift/Class/ValidationError" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:C14SwiftValidator15ValidationError">ValidationError</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>The <code>ValidationError</code> class is used for representing errors of a failed validation. It contains the text field, error label, and error message of a failed validation.</p>
|
||||
|
||||
<a href="Classes/ValidationError.html" class="slightly-smaller">See more</a>
|
||||
</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">class</span> <span class="kt">ValidationError</span><span class="p">:</span> <span class="kt">NSObject</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:C14SwiftValidator12RequiredRule"></a>
|
||||
<a name="//apple_ref/swift/Class/RequiredRule" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:C14SwiftValidator12RequiredRule">RequiredRule</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p><code>RequiredRule</code> is a subclass of Rule that defines how a required text field is validated.</p>
|
||||
|
||||
<a href="Classes/RequiredRule.html" class="slightly-smaller">See more</a>
|
||||
</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">class</span> <span class="kt">RequiredRule</span><span class="p">:</span> <span class="kt">Rule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:C14SwiftValidator9RegexRule"></a>
|
||||
<a name="//apple_ref/swift/Class/RegexRule" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:C14SwiftValidator9RegexRule">RegexRule</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p><code>RegexRule</code> is a subclass of Rule that defines how a regular expression is validated.</p>
|
||||
|
||||
<a href="Classes/RegexRule.html" class="slightly-smaller">See more</a>
|
||||
</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">class</span> <span class="kt">RegexRule</span> <span class="p">:</span> <span class="kt">Rule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:C14SwiftValidator13MinLengthRule"></a>
|
||||
<a name="//apple_ref/swift/Class/MinLengthRule" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:C14SwiftValidator13MinLengthRule">MinLengthRule</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p><code>MinLengthRule</code> is a subclass of Rule that defines how minimum character length is validated.</p>
|
||||
|
||||
<a href="Classes/MinLengthRule.html" class="slightly-smaller">See more</a>
|
||||
</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">class</span> <span class="kt">MinLengthRule</span><span class="p">:</span> <span class="kt">Rule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:C14SwiftValidator13MaxLengthRule"></a>
|
||||
<a name="//apple_ref/swift/Class/MaxLengthRule" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:C14SwiftValidator13MaxLengthRule">MaxLengthRule</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p><code>MaxLengthRule</code> is a subclass of <code><a href="Protocols/Rule.html">Rule</a></code> that defines how maximum character length is validated.</p>
|
||||
|
||||
<a href="Classes/MaxLengthRule.html" class="slightly-smaller">See more</a>
|
||||
</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">class</span> <span class="kt">MaxLengthRule</span><span class="p">:</span> <span class="kt">Rule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:C14SwiftValidator15ExactLengthRule"></a>
|
||||
<a name="//apple_ref/swift/Class/ExactLengthRule" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:C14SwiftValidator15ExactLengthRule">ExactLengthRule</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p><code>ExactLengthRule</code> is a subclass of Rule that is used to make sure a the text of a text field is an exact length.</p>
|
||||
|
||||
<a href="Classes/ExactLengthRule.html" class="slightly-smaller">See more</a>
|
||||
</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">class</span> <span class="kt">ExactLengthRule</span> <span class="p">:</span> <span class="kt">Rule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</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-02-14)</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>
|
||||
|
|
@ -0,0 +1,271 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<title>ConfirmationRule 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/ConfirmationRule" class="dashAnchor"></a>
|
||||
<a title="ConfirmationRule 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" />
|
||||
ConfirmationRule 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/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/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>ConfirmationRule</h1>
|
||||
<div class="declaration">
|
||||
<div class="language">
|
||||
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">ConfirmationRule</span><span class="p">:</span> <span class="kt">Rule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<p><code>ConfirmationRule</code> is a subclass of Rule that defines how a text field that has to be equal
|
||||
to another text field is validated.</p>
|
||||
|
||||
</section>
|
||||
<section class="section task-group-section">
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator16ConfirmationRulecFMS0_FT12confirmFieldCSo11UITextField7messageSS_S0_"></a>
|
||||
<a name="//apple_ref/swift/Method/init(confirmField:message:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator16ConfirmationRulecFMS0_FT12confirmFieldCSo11UITextField7messageSS_S0_">init(confirmField:message:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Initializes a <code><a href="../Classes/ConfirmationRule.html">ConfirmationRule</a></code> object to validate the text of a text field that should equal the text of another text 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="nf">init</span><span class="p">(</span><span class="nv">confirmField</span><span class="p">:</span> <span class="kt">UITextField</span><span class="p">,</span> <span class="nv">message</span> <span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="s">"This field does not match"</span><span class="p">)</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>confirmField</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>text field to which original text field will be compared to.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>message</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>String of error message.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>An initialized 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:FC14SwiftValidator16ConfirmationRule8validateFS0_FSSSb"></a>
|
||||
<a name="//apple_ref/swift/Method/validate(_:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator16ConfirmationRule8validateFS0_FSSSb">validate(_:)</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 a text 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="kd">func</span> <span class="nf">validate</span><span class="p">(</span><span class="nv">value</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Bool</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>value</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>String to checked for validation.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>A boolean value. True if validation is successful; False if validation fails.</p>
|
||||
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator16ConfirmationRule12errorMessageFS0_FT_SS"></a>
|
||||
<a name="//apple_ref/swift/Method/errorMessage()" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator16ConfirmationRule12errorMessageFS0_FT_SS">errorMessage()</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Displays an error message when text field fails validation.</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">errorMessage</span><span class="p">()</span> <span class="o">-></span> <span class="kt">String</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>String of error message.</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-02-14)</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>
|
||||
|
|
@ -0,0 +1,173 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<title>EmailRule 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/EmailRule" class="dashAnchor"></a>
|
||||
<a title="EmailRule 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" />
|
||||
EmailRule 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/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/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>EmailRule</h1>
|
||||
<div class="declaration">
|
||||
<div class="language">
|
||||
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">EmailRule</span><span class="p">:</span> <span class="kt">RegexRule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<p><code>EmailRule</code> is a subclass of RegexRule that defines how a email is validated.</p>
|
||||
|
||||
</section>
|
||||
<section class="section task-group-section">
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator9EmailRulecFMS0_FT7messageSS_S0_"></a>
|
||||
<a name="//apple_ref/swift/Method/init(message:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator9EmailRulecFMS0_FT7messageSS_S0_">init(message:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Initializes an <code><a href="../Classes/EmailRule.html">EmailRule</a></code> object to validate an email text 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="n">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">message</span> <span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="s">"Must be a valid email address"</span><span class="p">)</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>message</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>String of error message.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>An initialized 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>
|
||||
</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-02-14)</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>
|
||||
|
|
@ -0,0 +1,270 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<title>ExactLengthRule 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/ExactLengthRule" class="dashAnchor"></a>
|
||||
<a title="ExactLengthRule 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" />
|
||||
ExactLengthRule 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/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/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>ExactLengthRule</h1>
|
||||
<div class="declaration">
|
||||
<div class="language">
|
||||
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">ExactLengthRule</span> <span class="p">:</span> <span class="kt">Rule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<p><code>ExactLengthRule</code> is a subclass of Rule that is used to make sure a the text of a text field is an exact length.</p>
|
||||
|
||||
</section>
|
||||
<section class="section task-group-section">
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator15ExactLengthRulecFMS0_FT6lengthSi7messageSS_S0_"></a>
|
||||
<a name="//apple_ref/swift/Method/init(length:message:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator15ExactLengthRulecFMS0_FT6lengthSi7messageSS_S0_">init(length:message:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Initializes an <code><a href="../Classes/ExactLengthRule.html">ExactLengthRule</a></code> object to validate the text of a text field against an exact length.</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">length</span><span class="p">:</span> <span class="kt">Int</span><span class="p">,</span> <span class="nv">message</span> <span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="s">"Must be exactly %ld characters long"</span><span class="p">)</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>length</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>Integer value of exact string length being specified.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>message</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>String of error message.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>An initialized <code><a href="../Classes/ExactLengthRule.html">ExactLengthRule</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:FC14SwiftValidator15ExactLengthRule8validateFS0_FSSSb"></a>
|
||||
<a name="//apple_ref/swift/Method/validate(_:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator15ExactLengthRule8validateFS0_FSSSb">validate(_:)</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 a text 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="kd">func</span> <span class="nf">validate</span><span class="p">(</span><span class="nv">value</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Bool</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>value</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>String to checked for validation.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>A boolean value. True if validation is successful; False if validation fails.</p>
|
||||
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator15ExactLengthRule12errorMessageFS0_FT_SS"></a>
|
||||
<a name="//apple_ref/swift/Method/errorMessage()" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator15ExactLengthRule12errorMessageFS0_FT_SS">errorMessage()</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Displays error message if a text field fails validation.</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">errorMessage</span><span class="p">()</span> <span class="o">-></span> <span class="kt">String</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>String of error message.</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-02-14)</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>
|
||||
|
|
@ -0,0 +1,257 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<title>FloatRule 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/FloatRule" class="dashAnchor"></a>
|
||||
<a title="FloatRule 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" />
|
||||
FloatRule 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/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/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>FloatRule</h1>
|
||||
<div class="declaration">
|
||||
<div class="language">
|
||||
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">FloatRule</span><span class="p">:</span><span class="kt">Rule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<p><code>FloatRule</code> is a subclass of Rule that defines how check if a value is a floating point value.</p>
|
||||
|
||||
</section>
|
||||
<section class="section task-group-section">
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator9FloatRulecFMS0_FT7messageSS_S0_"></a>
|
||||
<a name="//apple_ref/swift/Method/init(message:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator9FloatRulecFMS0_FT7messageSS_S0_">init(message:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Initializes a <code><a href="../Classes/FloatRule.html">FloatRule</a></code> object to validate that the text of a text field is a floating point number.</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">message</span> <span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="s">"This must be a number with or without a decimal"</span><span class="p">)</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>message</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>String of error message.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>An initialized 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:FC14SwiftValidator9FloatRule8validateFS0_FSSSb"></a>
|
||||
<a name="//apple_ref/swift/Method/validate(_:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator9FloatRule8validateFS0_FSSSb">validate(_:)</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.</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">validate</span><span class="p">(</span><span class="nv">value</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Bool</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>value</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>String to checked for validation.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>Boolean value. True if validation is successful; False if validation fails.</p>
|
||||
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator9FloatRule12errorMessageFS0_FT_SS"></a>
|
||||
<a name="//apple_ref/swift/Method/errorMessage()" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator9FloatRule12errorMessageFS0_FT_SS">errorMessage()</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Displays error message when text field fails validation.</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">errorMessage</span><span class="p">()</span> <span class="o">-></span> <span class="kt">String</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>String of error message.</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-02-14)</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>
|
||||
|
|
@ -0,0 +1,257 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<title>FullNameRule 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/FullNameRule" class="dashAnchor"></a>
|
||||
<a title="FullNameRule 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" />
|
||||
FullNameRule 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/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/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>FullNameRule</h1>
|
||||
<div class="declaration">
|
||||
<div class="language">
|
||||
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">FullNameRule</span> <span class="p">:</span> <span class="kt">Rule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<p><code>FullNameRule</code> is a subclass of Rule that defines how a full name is validated.</p>
|
||||
|
||||
</section>
|
||||
<section class="section task-group-section">
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator12FullNameRulecFMS0_FT7messageSS_S0_"></a>
|
||||
<a name="//apple_ref/swift/Method/init(message:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator12FullNameRulecFMS0_FT7messageSS_S0_">init(message:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Initializes a <code><a href="../Classes/FullNameRule.html">FullNameRule</a></code> object that is used to verify that text in text field is a full name.</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">message</span> <span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="s">"Please provide a first & last name"</span><span class="p">)</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>message</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>String of error message.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>An initialized <code><a href="../Classes/FullNameRule.html">FullNameRule</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:FC14SwiftValidator12FullNameRule8validateFS0_FSSSb"></a>
|
||||
<a name="//apple_ref/swift/Method/validate(_:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator12FullNameRule8validateFS0_FSSSb">validate(_:)</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 a text 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="kd">func</span> <span class="nf">validate</span><span class="p">(</span><span class="nv">value</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Bool</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>value</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>String to checked for validation.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>A boolean value. True if validation is successful; False if validation fails.</p>
|
||||
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator12FullNameRule12errorMessageFS0_FT_SS"></a>
|
||||
<a name="//apple_ref/swift/Method/errorMessage()" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator12FullNameRule12errorMessageFS0_FT_SS">errorMessage()</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 display error message of a text field that has failed validation.</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">errorMessage</span><span class="p">()</span> <span class="o">-></span> <span class="kt">String</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>String of error message.</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-02-14)</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>
|
||||
|
|
@ -0,0 +1,304 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<title>MaxLengthRule 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/MaxLengthRule" class="dashAnchor"></a>
|
||||
<a title="MaxLengthRule 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" />
|
||||
MaxLengthRule 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/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/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>MaxLengthRule</h1>
|
||||
<div class="declaration">
|
||||
<div class="language">
|
||||
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">MaxLengthRule</span><span class="p">:</span> <span class="kt">Rule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<p><code>MaxLengthRule</code> is a subclass of <code><a href="../Protocols/Rule.html">Rule</a></code> that defines how maximum character length is validated.</p>
|
||||
|
||||
</section>
|
||||
<section class="section task-group-section">
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator13MaxLengthRulecFMS0_FT_S0_"></a>
|
||||
<a name="//apple_ref/swift/Method/init()" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator13MaxLengthRulecFMS0_FT_S0_">init()</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
|
||||
</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></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>An initialized <code><a href="../Classes/MaxLengthRule.html">MaxLengthRule</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:FC14SwiftValidator13MaxLengthRulecFMS0_FT6lengthSi7messageSS_S0_"></a>
|
||||
<a name="//apple_ref/swift/Method/init(length:message:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator13MaxLengthRulecFMS0_FT6lengthSi7messageSS_S0_">init(length:message:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Initializes a <code><a href="../Classes/MaxLengthRule.html">MaxLengthRule</a></code> object that is to validate the length of the text of a text field
|
||||
- parameter length: Maximum character length.
|
||||
- parameter message: String of error message.
|
||||
- returns: An initialized object, or nil if an object could not be created for some reason that would not result in an exception.</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">length</span><span class="p">:</span> <span class="kt">Int</span><span class="p">,</span> <span class="nv">message</span> <span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="s">"Must be at most %ld characters long"</span><span class="p">)</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>length</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>Maximum character length.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>message</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>String of error message.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>An initialized 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:FC14SwiftValidator13MaxLengthRule8validateFS0_FSSSb"></a>
|
||||
<a name="//apple_ref/swift/Method/validate(_:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator13MaxLengthRule8validateFS0_FSSSb">validate(_:)</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 a text 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="kd">func</span> <span class="nf">validate</span><span class="p">(</span><span class="nv">value</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Bool</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>value</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>String to checked for validation.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>A boolean value. True if validation is successful; False if validation fails.</p>
|
||||
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator13MaxLengthRule12errorMessageFS0_FT_SS"></a>
|
||||
<a name="//apple_ref/swift/Method/errorMessage()" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator13MaxLengthRule12errorMessageFS0_FT_SS">errorMessage()</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Displays an error message if a text field fails validation.</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">errorMessage</span><span class="p">()</span> <span class="o">-></span> <span class="kt">String</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>String of error message.</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-02-14)</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>
|
||||
|
|
@ -0,0 +1,306 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<title>MinLengthRule 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/MinLengthRule" class="dashAnchor"></a>
|
||||
<a title="MinLengthRule 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" />
|
||||
MinLengthRule 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/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/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>MinLengthRule</h1>
|
||||
<div class="declaration">
|
||||
<div class="language">
|
||||
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">MinLengthRule</span><span class="p">:</span> <span class="kt">Rule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<p><code>MinLengthRule</code> is a subclass of Rule that defines how minimum character length is validated.</p>
|
||||
|
||||
</section>
|
||||
<section class="section task-group-section">
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator13MinLengthRulecFMS0_FT_S0_"></a>
|
||||
<a name="//apple_ref/swift/Method/init()" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator13MinLengthRulecFMS0_FT_S0_">init()</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
|
||||
</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></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>An initialized <code><a href="../Classes/MinLengthRule.html">MinLengthRule</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:FC14SwiftValidator13MinLengthRulecFMS0_FT6lengthSi7messageSS_S0_"></a>
|
||||
<a name="//apple_ref/swift/Method/init(length:message:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator13MinLengthRulecFMS0_FT6lengthSi7messageSS_S0_">init(length:message:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Initializes a <code><a href="../Classes/MaxLengthRule.html">MaxLengthRule</a></code> object that is to validate the length of the text of a text field
|
||||
- parameter length: Minimum character length.
|
||||
- parameter message: String of error message.
|
||||
- returns: An initialized <code><a href="../Classes/MinLengthRule.html">MinLengthRule</a></code> object, or nil if an object could not be created for some reason that would not result in an exception.</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">length</span><span class="p">:</span> <span class="kt">Int</span><span class="p">,</span> <span class="nv">message</span> <span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="s">"Must be at least %ld characters long"</span><span class="p">)</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>length</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>Minimum character length.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>message</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>String of error message.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>An initialized <code><a href="../Classes/MinLengthRule.html">MinLengthRule</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:FC14SwiftValidator13MinLengthRule8validateFS0_FSSSb"></a>
|
||||
<a name="//apple_ref/swift/Method/validate(_:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator13MinLengthRule8validateFS0_FSSSb">validate(_:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Validates a text field.
|
||||
- parameter value: String to checked for validation.
|
||||
- returns: A boolean value. True if validation is successful; False if validation fails.</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">validate</span><span class="p">(</span><span class="nv">value</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Bool</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>value</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>String to checked for validation.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>A boolean value. True if validation is successful; False if validation fails.</p>
|
||||
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator13MinLengthRule12errorMessageFS0_FT_SS"></a>
|
||||
<a name="//apple_ref/swift/Method/errorMessage()" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator13MinLengthRule12errorMessageFS0_FT_SS">errorMessage()</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Displays error message when text field has failed validation.</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">errorMessage</span><span class="p">()</span> <span class="o">-></span> <span class="kt">String</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>String of error message.</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-02-14)</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>
|
||||
|
|
@ -0,0 +1,173 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<title>PasswordRule 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/PasswordRule" class="dashAnchor"></a>
|
||||
<a title="PasswordRule 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" />
|
||||
PasswordRule 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/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/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>PasswordRule</h1>
|
||||
<div class="declaration">
|
||||
<div class="language">
|
||||
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">PasswordRule</span> <span class="p">:</span> <span class="kt">RegexRule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<p><code>PasswordRule</code> is a subclass of RegexRule that defines how a password is validated.</p>
|
||||
|
||||
</section>
|
||||
<section class="section task-group-section">
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator12PasswordRulecFMS0_FT7messageSS_S0_"></a>
|
||||
<a name="//apple_ref/swift/Method/init(message:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator12PasswordRulecFMS0_FT7messageSS_S0_">init(message:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Initializes a <code><a href="../Classes/PasswordRule.html">PasswordRule</a></code> object that will validate a text field is a valid password.</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="n">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">message</span> <span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="s">"Must be 8 characters with 1 uppercase"</span><span class="p">)</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>message</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>String of error message.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>An initialized <code><a href="../Classes/PasswordRule.html">PasswordRule</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>
|
||||
</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-02-14)</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>
|
||||
|
|
@ -0,0 +1,175 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<title>PhoneNumberRule 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/PhoneNumberRule" class="dashAnchor"></a>
|
||||
<a title="PhoneNumberRule 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" />
|
||||
PhoneNumberRule 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/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/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>PhoneNumberRule</h1>
|
||||
<div class="declaration">
|
||||
<div class="language">
|
||||
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">PhoneNumberRule</span><span class="p">:</span> <span class="kt">RegexRule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<p><code>PhoneNumberRule</code> is a subclass of Rule that defines how a phone number is validated.</p>
|
||||
|
||||
</section>
|
||||
<section class="section task-group-section">
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator15PhoneNumberRulecFMS0_FT7messageSS_S0_"></a>
|
||||
<a name="//apple_ref/swift/Method/init(message:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator15PhoneNumberRulecFMS0_FT7messageSS_S0_">init(message:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Method used to initialize <code><a href="../Classes/PhoneNumberRule.html">PhoneNumberRule</a></code> object.
|
||||
- parameter message: Error message that is displayed if validation fails.
|
||||
- returns: An initialized <code><a href="../Classes/PasswordRule.html">PasswordRule</a></code> object, or nil if an object could not be created for some reason that would not result in an exception.</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="n">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">message</span> <span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="s">"Enter a valid 10 digit phone number"</span><span class="p">)</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>message</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>Error message that is displayed if validation fails.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>An initialized <code><a href="../Classes/PasswordRule.html">PasswordRule</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>
|
||||
</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-02-14)</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>
|
||||
|
|
@ -0,0 +1,270 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<title>RegexRule 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/RegexRule" class="dashAnchor"></a>
|
||||
<a title="RegexRule 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" />
|
||||
RegexRule 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/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/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>RegexRule</h1>
|
||||
<div class="declaration">
|
||||
<div class="language">
|
||||
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">RegexRule</span> <span class="p">:</span> <span class="kt">Rule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<p><code>RegexRule</code> is a subclass of Rule that defines how a regular expression is validated.</p>
|
||||
|
||||
</section>
|
||||
<section class="section task-group-section">
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator9RegexRulecFMS0_FT5regexSS7messageSS_S0_"></a>
|
||||
<a name="//apple_ref/swift/Method/init(regex:message:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator9RegexRulecFMS0_FT5regexSS7messageSS_S0_">init(regex:message:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Method used to initialize <code><a href="../Classes/RegexRule.html">RegexRule</a></code> object.</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">regex</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">message</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="s">"Invalid Regular Expression"</span><span class="p">)</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>regex</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>Regular expression string to be used in validation.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>message</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>String of error message.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>An initialized <code><a href="../Classes/RegexRule.html">RegexRule</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:FC14SwiftValidator9RegexRule8validateFS0_FSSSb"></a>
|
||||
<a name="//apple_ref/swift/Method/validate(_:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator9RegexRule8validateFS0_FSSSb">validate(_:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Method used to validate text 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="kd">func</span> <span class="nf">validate</span><span class="p">(</span><span class="nv">value</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Bool</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>value</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>String to checked for validation.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>Boolean value. True if validation is successful; False if validation fails.</p>
|
||||
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator9RegexRule12errorMessageFS0_FT_SS"></a>
|
||||
<a name="//apple_ref/swift/Method/errorMessage()" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator9RegexRule12errorMessageFS0_FT_SS">errorMessage()</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Method used to dispaly error message when text field fails validation.</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">errorMessage</span><span class="p">()</span> <span class="o">-></span> <span class="kt">String</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>String of error message.</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-02-14)</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>
|
||||
|
|
@ -0,0 +1,256 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<title>RequiredRule 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/RequiredRule" class="dashAnchor"></a>
|
||||
<a title="RequiredRule 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" />
|
||||
RequiredRule 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/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/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>RequiredRule</h1>
|
||||
<div class="declaration">
|
||||
<div class="language">
|
||||
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">RequiredRule</span><span class="p">:</span> <span class="kt">Rule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<p><code>RequiredRule</code> is a subclass of Rule that defines how a required text field is validated.</p>
|
||||
|
||||
</section>
|
||||
<section class="section task-group-section">
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator12RequiredRulecFMS0_FT7messageSS_S0_"></a>
|
||||
<a name="//apple_ref/swift/Method/init(message:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator12RequiredRulecFMS0_FT7messageSS_S0_">init(message:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
|
||||
</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">message</span> <span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="s">"This field is required"</span><span class="p">)</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>message</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>String of error message.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>An initialized <code><a href="../Classes/RequiredRule.html">RequiredRule</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:FC14SwiftValidator12RequiredRule8validateFS0_FSSSb"></a>
|
||||
<a name="//apple_ref/swift/Method/validate(_:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator12RequiredRule8validateFS0_FSSSb">validate(_:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Validates a text 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="kd">func</span> <span class="nf">validate</span><span class="p">(</span><span class="nv">value</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Bool</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>value</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>String to checked for validation.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>Boolean value. True if validation is successful; False if validation fails.</p>
|
||||
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator12RequiredRule12errorMessageFS0_FT_SS"></a>
|
||||
<a name="//apple_ref/swift/Method/errorMessage()" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator12RequiredRule12errorMessageFS0_FT_SS">errorMessage()</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 display error message when validation fails.</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">errorMessage</span><span class="p">()</span> <span class="o">-></span> <span class="kt">String</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>String of error message.</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-02-14)</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>
|
||||
|
|
@ -0,0 +1,352 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<title>ValidationError 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/ValidationError" class="dashAnchor"></a>
|
||||
<a title="ValidationError 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" />
|
||||
ValidationError 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/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/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>ValidationError</h1>
|
||||
<div class="declaration">
|
||||
<div class="language">
|
||||
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">ValidationError</span><span class="p">:</span> <span class="kt">NSObject</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<p>The <code>ValidationError</code> class is used for representing errors of a failed validation. It contains the text field, error label, and error message of a failed validation.</p>
|
||||
|
||||
</section>
|
||||
<section class="section task-group-section">
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:vC14SwiftValidator15ValidationError9textFieldCSo11UITextField"></a>
|
||||
<a name="//apple_ref/swift/Property/textField" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:vC14SwiftValidator15ValidationError9textFieldCSo11UITextField">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 textField 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">let</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:vC14SwiftValidator15ValidationError10errorLabelGSqCSo7UILabel_"></a>
|
||||
<a name="//apple_ref/swift/Property/errorLabel" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:vC14SwiftValidator15ValidationError10errorLabelGSqCSo7UILabel_">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 error label 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:vC14SwiftValidator15ValidationError12errorMessageSS"></a>
|
||||
<a name="//apple_ref/swift/Property/errorMessage" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:vC14SwiftValidator15ValidationError12errorMessageSS">errorMessage</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>the error message 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">let</span> <span class="nv">errorMessage</span><span class="p">:</span><span class="kt">String</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator15ValidationErrorcFMS0_FT9textFieldCSo11UITextField5errorSS_S0_"></a>
|
||||
<a name="//apple_ref/swift/Method/init(textField:error:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator15ValidationErrorcFMS0_FT9textFieldCSo11UITextField5errorSS_S0_">init(textField:error:)</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/ValidationError.html">ValidationError</a></code> object with a textField and error.
|
||||
- parameter textField: UITextField that holds textField.
|
||||
- parameter errorMessage: String that holds error message.
|
||||
- returns: An initialized object, or nil if an object could not be created for some reason that would not result in an exception.</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">error</span><span class="p">:</span><span class="kt">String</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>UITextField that holds textField.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>errorMessage</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>String that holds error message.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>An initialized 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:FC14SwiftValidator15ValidationErrorcFMS0_FT9textFieldCSo11UITextField10errorLabelGSqCSo7UILabel_5errorSS_S0_"></a>
|
||||
<a name="//apple_ref/swift/Method/init(textField:errorLabel:error:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator15ValidationErrorcFMS0_FT9textFieldCSo11UITextField10errorLabelGSqCSo7UILabel_5errorSS_S0_">init(textField:errorLabel:error:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Initializes ValidationError object with a textField, errorLabel, and errorMessage.
|
||||
- parameter textField: UITextField that holds textField.
|
||||
- parameter errorLabel: UILabel that holds error label.
|
||||
- parameter errorMessage: String that holds error message.
|
||||
- returns: An initialized object, or nil if an object could not be created for some reason that would not result in an exception.</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">errorLabel</span><span class="p">:</span><span class="kt">UILabel</span><span class="p">?,</span> <span class="nv">error</span><span class="p">:</span><span class="kt">String</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>UITextField that holds textField.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>errorLabel</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>UILabel that holds error label.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>errorMessage</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>String that holds error message.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>An initialized 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>
|
||||
</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-02-14)</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>
|
||||
|
|
@ -0,0 +1,313 @@
|
|||
<!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/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/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-02-14)</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>
|
||||
|
|
@ -0,0 +1,628 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<title>Validator 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/Validator" class="dashAnchor"></a>
|
||||
<a title="Validator 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" />
|
||||
Validator 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/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/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>Validator</h1>
|
||||
<div class="declaration">
|
||||
<div class="language">
|
||||
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">Validator</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<p>Class that makes <code>Validator</code> objects. Should be added as a parameter to ViewController that will display
|
||||
validation fields.</p>
|
||||
|
||||
</section>
|
||||
<section class="section task-group-section">
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:vC14SwiftValidator9Validator11validationsGVSs10DictionaryCSo11UITextFieldCS_14ValidationRule_"></a>
|
||||
<a name="//apple_ref/swift/Property/validations" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:vC14SwiftValidator9Validator11validationsGVSs10DictionaryCSo11UITextFieldCS_14ValidationRule_">validations</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Dictionary to hold all fields (and accompanying rules) that will undergo validation.</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">validations</span> <span class="o">=</span> <span class="p">[</span><span class="kt">UITextField</span><span class="p">:</span><span class="kt">ValidationRule</span><span class="p">]()</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:vC14SwiftValidator9Validator6errorsGVSs10DictionaryCSo11UITextFieldCS_15ValidationError_"></a>
|
||||
<a name="//apple_ref/swift/Property/errors" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:vC14SwiftValidator9Validator6errorsGVSs10DictionaryCSo11UITextFieldCS_15ValidationError_">errors</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Dictionary to hold fields (and accompanying errors) that were unsuccessfully validated.</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">errors</span> <span class="o">=</span> <span class="p">[</span><span class="kt">UITextField</span><span class="p">:</span><span class="kt">ValidationError</span><span class="p">]()</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator9ValidatorcFMS0_FT_S0_"></a>
|
||||
<a name="//apple_ref/swift/Method/init()" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator9ValidatorcFMS0_FT_S0_">init()</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
|
||||
</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></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>An initialized 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>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="task-group">
|
||||
<div class="task-name-container">
|
||||
<a name="/Public%20functions"></a>
|
||||
<a name="//apple_ref/swift/Section/Public functions" class="dashAnchor"></a>
|
||||
<a href="#/Public%20functions">
|
||||
<h3 class="section-name">Public functions</h3>
|
||||
</a>
|
||||
</div>
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator9Validator13validateFieldFS0_FTCSo11UITextField8callbackFT5errorGSqCS_15ValidationError__T__T_"></a>
|
||||
<a name="//apple_ref/swift/Method/validateField(_:callback:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator9Validator13validateFieldFS0_FTCSo11UITextField8callbackFT5errorGSqCS_15ValidationError__T__T_">validateField(_:callback:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>This method is used to validate a single field registered to Validator. If validation is unsuccessful,
|
||||
field gets added to errors dictionary.
|
||||
- parameter textField: Holds validator field data.
|
||||
- returns: No return value.</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="nv">textField</span><span class="p">:</span> <span class="kt">UITextField</span><span class="p">,</span> <span class="nv">callback</span><span class="p">:</span> <span class="p">(</span><span class="nv">error</span><span class="p">:</span><span class="kt">ValidationError</span><span class="p">?)</span> <span class="o">-></span> <span class="kt">Void</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>Holds validator field data.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>No return value.</p>
|
||||
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="task-group">
|
||||
<div class="task-name-container">
|
||||
<a name="/Using%20Keys"></a>
|
||||
<a name="//apple_ref/swift/Section/Using Keys" class="dashAnchor"></a>
|
||||
<a href="#/Using%20Keys">
|
||||
<h3 class="section-name">Using Keys</h3>
|
||||
</a>
|
||||
</div>
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator9Validator17styleTransformersFS0_FT7successGSqFT14validationRuleCS_14ValidationRule_T__5errorGSqFT15validationErrorCS_15ValidationError_T___T_"></a>
|
||||
<a name="//apple_ref/swift/Method/styleTransformers(success:error:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator9Validator17styleTransformersFS0_FT7successGSqFT14validationRuleCS_14ValidationRule_T__5errorGSqFT15validationErrorCS_15ValidationError_T___T_">styleTransformers(success:error:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>This method is used to style fields that have undergone validation checks. Success callback should be used to show common success styling and error callback should be used to show common error styling.</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">styleTransformers</span><span class="p">(</span><span class="n">success</span> <span class="nv">success</span><span class="p">:((</span><span class="nv">validationRule</span><span class="p">:</span><span class="kt">ValidationRule</span><span class="p">)</span><span class="o">-></span><span class="kt">Void</span><span class="p">)?,</span> <span class="nv">error</span><span class="p">:((</span><span class="nv">validationError</span><span class="p">:</span><span class="kt">ValidationError</span><span class="p">)</span><span class="o">-></span><span class="kt">Void</span><span class="p">)?)</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>success</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>A closure which is called with validationRule, an object that holds validation data</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>error</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>A closure which is called with validationError, an object that holds validation error data</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>No return value</p>
|
||||
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator9Validator13registerFieldFS0_FTCSo11UITextField5rulesGSaPS_4Rule___T_"></a>
|
||||
<a name="//apple_ref/swift/Method/registerField(_:rules:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator9Validator13registerFieldFS0_FTCSo11UITextField5rulesGSaPS_4Rule___T_">registerField(_:rules:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>This method is used to add a field to validator.</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">registerField</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></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>textField</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>field that is to be validated.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>Rule</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>An array which holds different rules to validate against textField.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>No return value</p>
|
||||
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator9Validator13registerFieldFS0_FTCSo11UITextField10errorLabelCSo7UILabel5rulesGSaPS_4Rule___T_"></a>
|
||||
<a name="//apple_ref/swift/Method/registerField(_:errorLabel:rules:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator9Validator13registerFieldFS0_FTCSo11UITextField10errorLabelCSo7UILabel5rulesGSaPS_4Rule___T_">registerField(_:errorLabel:rules:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>This method is used to add a field to validator.</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">registerField</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">errorLabel</span><span class="p">:</span><span class="kt">UILabel</span><span class="p">,</span> <span class="nv">rules</span><span class="p">:[</span><span class="kt">Rule</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>field that is to be validated.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>errorLabel</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>A UILabel that holds error label data</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>rules</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>A Rule array that holds different rules that apply to said textField.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>No return value</p>
|
||||
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator9Validator15unregisterFieldFS0_FCSo11UITextFieldT_"></a>
|
||||
<a name="//apple_ref/swift/Method/unregisterField(_:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator9Validator15unregisterFieldFS0_FCSo11UITextFieldT_">unregisterField(_:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>This method is for removing a field validator.</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">unregisterField</span><span class="p">(</span><span class="nv">textField</span><span class="p">:</span><span class="kt">UITextField</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>field used to locate and remove textField from validator.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>No return value</p>
|
||||
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator9Validator8validateFS0_FPS_18ValidationDelegate_T_"></a>
|
||||
<a name="//apple_ref/swift/Method/validate(_:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator9Validator8validateFS0_FPS_18ValidationDelegate_T_">validate(_:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>This method checks to see if all fields in validator are valid.</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">validate</span><span class="p">(</span><span class="nv">delegate</span><span class="p">:</span><span class="kt">ValidationDelegate</span><span class="p">)</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>No return value.</p>
|
||||
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator9Validator8validateFS0_FFT6errorsGVSs10DictionaryCSo11UITextFieldCS_15ValidationError__T_T_"></a>
|
||||
<a name="//apple_ref/swift/Method/validate(_:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator9Validator8validateFS0_FFT6errorsGVSs10DictionaryCSo11UITextFieldCS_15ValidationError__T_T_">validate(_:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>This method validates all fields in validator and sets any errors to errors parameter of callback.</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">validate</span><span class="p">(</span><span class="nv">callback</span><span class="p">:(</span><span class="nv">errors</span><span class="p">:[</span><span class="kt">UITextField</span><span class="p">:</span><span class="kt">ValidationError</span><span class="p">])</span><span class="o">-></span><span class="kt">Void</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>callback</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>A closure which is called with errors, a dictionary of type UITextField:ValidationError.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>No return value.</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-02-14)</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>
|
||||
|
|
@ -0,0 +1,173 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<title>ZipCodeRule 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/ZipCodeRule" class="dashAnchor"></a>
|
||||
<a title="ZipCodeRule 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" />
|
||||
ZipCodeRule 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/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/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>ZipCodeRule</h1>
|
||||
<div class="declaration">
|
||||
<div class="language">
|
||||
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">ZipCodeRule</span><span class="p">:</span> <span class="kt">RegexRule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<p><code>ZipCodeRule</code> is a subclass of <code><a href="../Classes/RegexRule.html">RegexRule</a></code> that represents how zip codes are to be validated.</p>
|
||||
|
||||
</section>
|
||||
<section class="section task-group-section">
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator11ZipCodeRulecFMS0_FT7messageSS_S0_"></a>
|
||||
<a name="//apple_ref/swift/Method/init(message:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator11ZipCodeRulecFMS0_FT7messageSS_S0_">init(message:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Initializes a <code><a href="../Classes/ZipCodeRule.html">ZipCodeRule</a></code> object.</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="n">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">message</span> <span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="s">"Enter a valid 5 digit zipcode"</span><span class="p">)</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>message</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>String that holds error message.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>An initialized 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>
|
||||
</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-02-14)</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>
|
||||
|
|
@ -0,0 +1,174 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<title>Protocols 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 title="Protocols 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" />
|
||||
Protocols 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/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/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>Protocols</h1>
|
||||
<p>The following protocols are available globally.</p>
|
||||
|
||||
</section>
|
||||
<section class="section task-group-section">
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:P14SwiftValidator4Rule"></a>
|
||||
<a name="//apple_ref/swift/Protocol/Rule" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:P14SwiftValidator4Rule">Rule</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>The <code>Rule</code> protocol declares the required methods for all objects that subscribe to it.</p>
|
||||
|
||||
<a href="Protocols/Rule.html" class="slightly-smaller">See more</a>
|
||||
</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">protocol</span> <span class="kt">Rule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:P14SwiftValidator18ValidationDelegate"></a>
|
||||
<a name="//apple_ref/swift/Protocol/ValidationDelegate" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:P14SwiftValidator18ValidationDelegate">ValidationDelegate</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Protocol for <code>ValidationDelegate</code> adherents, which comes with two required methods that are called depending on whether validation succeeded or failed.</p>
|
||||
|
||||
<a href="Protocols/ValidationDelegate.html" class="slightly-smaller">See more</a>
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">ValidationDelegate</span></code></pre>
|
||||
|
||||
</div>
|
||||
</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-02-14)</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>
|
||||
|
|
@ -0,0 +1,205 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<title>Rule Protocol 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/Protocol/Rule" class="dashAnchor"></a>
|
||||
<a title="Rule Protocol 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" />
|
||||
Rule Protocol 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/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/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>Rule</h1>
|
||||
<div class="declaration">
|
||||
<div class="language">
|
||||
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">Rule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<p>The <code>Rule</code> protocol declares the required methods for all objects that subscribe to it.</p>
|
||||
|
||||
</section>
|
||||
<section class="section task-group-section">
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FP14SwiftValidator4Rule8validateuRq_S0__Fq_FSSSb"></a>
|
||||
<a name="//apple_ref/swift/Method/validate(_:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FP14SwiftValidator4Rule8validateuRq_S0__Fq_FSSSb">validate(_:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Validates text of a text 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">func</span> <span class="nf">validate</span><span class="p">(</span><span class="nv">value</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Bool</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>value</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>String of text to be validated.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>Boolean value. True if validation is successful; False if validation fails.</p>
|
||||
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FP14SwiftValidator4Rule12errorMessageuRq_S0__Fq_FT_SS"></a>
|
||||
<a name="//apple_ref/swift/Method/errorMessage()" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FP14SwiftValidator4Rule12errorMessageuRq_S0__Fq_FT_SS">errorMessage()</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Displays error message of a text field that has failed validation.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight"><code><span class="kd">func</span> <span class="nf">errorMessage</span><span class="p">()</span> <span class="o">-></span> <span class="kt">String</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>String of error message.</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-02-14)</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>
|
||||
|
|
@ -0,0 +1,187 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<title>ValidationDelegate Protocol 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/Protocol/ValidationDelegate" class="dashAnchor"></a>
|
||||
<a title="ValidationDelegate Protocol 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" />
|
||||
ValidationDelegate Protocol 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/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/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>ValidationDelegate</h1>
|
||||
<div class="declaration">
|
||||
<div class="language">
|
||||
<pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">ValidationDelegate</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<p>Protocol for <code>ValidationDelegate</code> adherents, which comes with two required methods that are called depending on whether validation succeeded or failed.</p>
|
||||
|
||||
</section>
|
||||
<section class="section task-group-section">
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FP14SwiftValidator18ValidationDelegate20validationSuccessfuluRq_S0__Fq_FT_T_"></a>
|
||||
<a name="//apple_ref/swift/Method/validationSuccessful()" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FP14SwiftValidator18ValidationDelegate20validationSuccessfuluRq_S0__Fq_FT_T_">validationSuccessful()</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>This method will be called on delegate object when validation is successful.
|
||||
- returns: No return value.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight"><code><span class="kd">func</span> <span class="nf">validationSuccessful</span><span class="p">()</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>No return value.</p>
|
||||
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FP14SwiftValidator18ValidationDelegate16validationFaileduRq_S0__Fq_FGVSs10DictionaryCSo11UITextFieldCS_15ValidationError_T_"></a>
|
||||
<a name="//apple_ref/swift/Method/validationFailed(_:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FP14SwiftValidator18ValidationDelegate16validationFaileduRq_S0__Fq_FGVSs10DictionaryCSo11UITextFieldCS_15ValidationError_T_">validationFailed(_:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>This method will be called on delegate object when validation fails.
|
||||
- returns: No return value.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight"><code><span class="kd">func</span> <span class="nf">validationFailed</span><span class="p">(</span><span class="nv">errors</span><span class="p">:</span> <span class="p">[</span><span class="kt">UITextField</span><span class="p">:</span><span class="kt">ValidationError</span><span class="p">])</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>No return value.</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-02-14)</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>
|
||||
|
|
@ -0,0 +1,200 @@
|
|||
/* Credit to https://gist.github.com/wataru420/2048287 */
|
||||
.highlight {
|
||||
/* Comment */
|
||||
/* Error */
|
||||
/* Keyword */
|
||||
/* Operator */
|
||||
/* Comment.Multiline */
|
||||
/* Comment.Preproc */
|
||||
/* Comment.Single */
|
||||
/* Comment.Special */
|
||||
/* Generic.Deleted */
|
||||
/* Generic.Deleted.Specific */
|
||||
/* Generic.Emph */
|
||||
/* Generic.Error */
|
||||
/* Generic.Heading */
|
||||
/* Generic.Inserted */
|
||||
/* Generic.Inserted.Specific */
|
||||
/* Generic.Output */
|
||||
/* Generic.Prompt */
|
||||
/* Generic.Strong */
|
||||
/* Generic.Subheading */
|
||||
/* Generic.Traceback */
|
||||
/* Keyword.Constant */
|
||||
/* Keyword.Declaration */
|
||||
/* Keyword.Pseudo */
|
||||
/* Keyword.Reserved */
|
||||
/* Keyword.Type */
|
||||
/* Literal.Number */
|
||||
/* Literal.String */
|
||||
/* Name.Attribute */
|
||||
/* Name.Builtin */
|
||||
/* Name.Class */
|
||||
/* Name.Constant */
|
||||
/* Name.Entity */
|
||||
/* Name.Exception */
|
||||
/* Name.Function */
|
||||
/* Name.Namespace */
|
||||
/* Name.Tag */
|
||||
/* Name.Variable */
|
||||
/* Operator.Word */
|
||||
/* Text.Whitespace */
|
||||
/* Literal.Number.Float */
|
||||
/* Literal.Number.Hex */
|
||||
/* Literal.Number.Integer */
|
||||
/* Literal.Number.Oct */
|
||||
/* Literal.String.Backtick */
|
||||
/* Literal.String.Char */
|
||||
/* Literal.String.Doc */
|
||||
/* Literal.String.Double */
|
||||
/* Literal.String.Escape */
|
||||
/* Literal.String.Heredoc */
|
||||
/* Literal.String.Interpol */
|
||||
/* Literal.String.Other */
|
||||
/* Literal.String.Regex */
|
||||
/* Literal.String.Single */
|
||||
/* Literal.String.Symbol */
|
||||
/* Name.Builtin.Pseudo */
|
||||
/* Name.Variable.Class */
|
||||
/* Name.Variable.Global */
|
||||
/* Name.Variable.Instance */
|
||||
/* Literal.Number.Integer.Long */ }
|
||||
.highlight .c {
|
||||
color: #999988;
|
||||
font-style: italic; }
|
||||
.highlight .err {
|
||||
color: #a61717;
|
||||
background-color: #e3d2d2; }
|
||||
.highlight .k {
|
||||
color: #000000;
|
||||
font-weight: bold; }
|
||||
.highlight .o {
|
||||
color: #000000;
|
||||
font-weight: bold; }
|
||||
.highlight .cm {
|
||||
color: #999988;
|
||||
font-style: italic; }
|
||||
.highlight .cp {
|
||||
color: #999999;
|
||||
font-weight: bold; }
|
||||
.highlight .c1 {
|
||||
color: #999988;
|
||||
font-style: italic; }
|
||||
.highlight .cs {
|
||||
color: #999999;
|
||||
font-weight: bold;
|
||||
font-style: italic; }
|
||||
.highlight .gd {
|
||||
color: #000000;
|
||||
background-color: #ffdddd; }
|
||||
.highlight .gd .x {
|
||||
color: #000000;
|
||||
background-color: #ffaaaa; }
|
||||
.highlight .ge {
|
||||
color: #000000;
|
||||
font-style: italic; }
|
||||
.highlight .gr {
|
||||
color: #aa0000; }
|
||||
.highlight .gh {
|
||||
color: #999999; }
|
||||
.highlight .gi {
|
||||
color: #000000;
|
||||
background-color: #ddffdd; }
|
||||
.highlight .gi .x {
|
||||
color: #000000;
|
||||
background-color: #aaffaa; }
|
||||
.highlight .go {
|
||||
color: #888888; }
|
||||
.highlight .gp {
|
||||
color: #555555; }
|
||||
.highlight .gs {
|
||||
font-weight: bold; }
|
||||
.highlight .gu {
|
||||
color: #aaaaaa; }
|
||||
.highlight .gt {
|
||||
color: #aa0000; }
|
||||
.highlight .kc {
|
||||
color: #000000;
|
||||
font-weight: bold; }
|
||||
.highlight .kd {
|
||||
color: #000000;
|
||||
font-weight: bold; }
|
||||
.highlight .kp {
|
||||
color: #000000;
|
||||
font-weight: bold; }
|
||||
.highlight .kr {
|
||||
color: #000000;
|
||||
font-weight: bold; }
|
||||
.highlight .kt {
|
||||
color: #445588; }
|
||||
.highlight .m {
|
||||
color: #009999; }
|
||||
.highlight .s {
|
||||
color: #d14; }
|
||||
.highlight .na {
|
||||
color: #008080; }
|
||||
.highlight .nb {
|
||||
color: #0086B3; }
|
||||
.highlight .nc {
|
||||
color: #445588;
|
||||
font-weight: bold; }
|
||||
.highlight .no {
|
||||
color: #008080; }
|
||||
.highlight .ni {
|
||||
color: #800080; }
|
||||
.highlight .ne {
|
||||
color: #990000;
|
||||
font-weight: bold; }
|
||||
.highlight .nf {
|
||||
color: #990000; }
|
||||
.highlight .nn {
|
||||
color: #555555; }
|
||||
.highlight .nt {
|
||||
color: #000080; }
|
||||
.highlight .nv {
|
||||
color: #008080; }
|
||||
.highlight .ow {
|
||||
color: #000000;
|
||||
font-weight: bold; }
|
||||
.highlight .w {
|
||||
color: #bbbbbb; }
|
||||
.highlight .mf {
|
||||
color: #009999; }
|
||||
.highlight .mh {
|
||||
color: #009999; }
|
||||
.highlight .mi {
|
||||
color: #009999; }
|
||||
.highlight .mo {
|
||||
color: #009999; }
|
||||
.highlight .sb {
|
||||
color: #d14; }
|
||||
.highlight .sc {
|
||||
color: #d14; }
|
||||
.highlight .sd {
|
||||
color: #d14; }
|
||||
.highlight .s2 {
|
||||
color: #d14; }
|
||||
.highlight .se {
|
||||
color: #d14; }
|
||||
.highlight .sh {
|
||||
color: #d14; }
|
||||
.highlight .si {
|
||||
color: #d14; }
|
||||
.highlight .sx {
|
||||
color: #d14; }
|
||||
.highlight .sr {
|
||||
color: #009926; }
|
||||
.highlight .s1 {
|
||||
color: #d14; }
|
||||
.highlight .ss {
|
||||
color: #990073; }
|
||||
.highlight .bp {
|
||||
color: #999999; }
|
||||
.highlight .vc {
|
||||
color: #008080; }
|
||||
.highlight .vg {
|
||||
color: #008080; }
|
||||
.highlight .vi {
|
||||
color: #008080; }
|
||||
.highlight .il {
|
||||
color: #009999; }
|
||||
|
|
@ -0,0 +1,331 @@
|
|||
html, body, div, span, h1, h3, h4, p, a, code, em, img, ul, li, table, tbody, tr, td {
|
||||
background: transparent;
|
||||
border: 0;
|
||||
margin: 0;
|
||||
outline: 0;
|
||||
padding: 0;
|
||||
vertical-align: baseline; }
|
||||
|
||||
body {
|
||||
background-color: #f2f2f2;
|
||||
font-family: Helvetica, freesans, Arial, sans-serif;
|
||||
font-size: 14px;
|
||||
-webkit-font-smoothing: subpixel-antialiased;
|
||||
word-wrap: break-word; }
|
||||
|
||||
h1, h2, h3 {
|
||||
margin-top: 0.8em;
|
||||
margin-bottom: 0.3em;
|
||||
font-weight: 100;
|
||||
color: black; }
|
||||
|
||||
h1 {
|
||||
font-size: 2.5em; }
|
||||
|
||||
h2 {
|
||||
font-size: 2em;
|
||||
border-bottom: 1px solid #e2e2e2; }
|
||||
|
||||
h4 {
|
||||
font-size: 13px;
|
||||
line-height: 1.5;
|
||||
margin-top: 21px; }
|
||||
|
||||
h5 {
|
||||
font-size: 1.1em; }
|
||||
|
||||
h6 {
|
||||
font-size: 1.1em;
|
||||
color: #777; }
|
||||
|
||||
.section-name {
|
||||
color: gray;
|
||||
display: block;
|
||||
font-family: Helvetica;
|
||||
font-size: 22px;
|
||||
font-weight: 100;
|
||||
margin-bottom: 15px; }
|
||||
|
||||
pre, code {
|
||||
font: 0.95em Menlo, monospace;
|
||||
color: #777;
|
||||
word-wrap: normal; }
|
||||
|
||||
p code, li code {
|
||||
background-color: #eee;
|
||||
padding: 2px 4px;
|
||||
border-radius: 4px; }
|
||||
|
||||
a {
|
||||
color: #0088cc;
|
||||
text-decoration: none; }
|
||||
|
||||
ul {
|
||||
padding-left: 15px; }
|
||||
|
||||
li {
|
||||
line-height: 1.8em; }
|
||||
|
||||
img {
|
||||
max-width: 100%; }
|
||||
|
||||
blockquote {
|
||||
margin-left: 0;
|
||||
padding: 0 10px;
|
||||
border-left: 4px solid #ccc; }
|
||||
|
||||
.content-wrapper {
|
||||
margin: 0 auto;
|
||||
width: 980px; }
|
||||
|
||||
header {
|
||||
font-size: 0.85em;
|
||||
line-height: 26px;
|
||||
background-color: #414141;
|
||||
position: fixed;
|
||||
width: 100%;
|
||||
z-index: 1; }
|
||||
header img {
|
||||
padding-right: 6px;
|
||||
vertical-align: -4px;
|
||||
height: 16px; }
|
||||
header a {
|
||||
color: #fff; }
|
||||
header p {
|
||||
float: left;
|
||||
color: #999; }
|
||||
header .header-right {
|
||||
float: right;
|
||||
margin-left: 16px; }
|
||||
|
||||
#breadcrumbs {
|
||||
background-color: #f2f2f2;
|
||||
height: 27px;
|
||||
padding-top: 17px;
|
||||
position: fixed;
|
||||
width: 100%;
|
||||
z-index: 1;
|
||||
margin-top: 26px; }
|
||||
#breadcrumbs #carat {
|
||||
height: 10px;
|
||||
margin: 0 5px; }
|
||||
|
||||
.sidebar {
|
||||
background-color: #f9f9f9;
|
||||
border: 1px solid #e2e2e2;
|
||||
overflow-y: auto;
|
||||
overflow-x: hidden;
|
||||
position: fixed;
|
||||
top: 70px;
|
||||
bottom: 0;
|
||||
width: 230px;
|
||||
word-wrap: normal; }
|
||||
|
||||
.nav-groups {
|
||||
list-style-type: none;
|
||||
background: #fff;
|
||||
padding-left: 0; }
|
||||
|
||||
.nav-group-name {
|
||||
border-bottom: 1px solid #e2e2e2;
|
||||
font-size: 1.1em;
|
||||
font-weight: 100;
|
||||
padding: 15px 0 15px 20px; }
|
||||
.nav-group-name > a {
|
||||
color: #333; }
|
||||
|
||||
.nav-group-tasks {
|
||||
margin-top: 5px; }
|
||||
|
||||
.nav-group-task {
|
||||
font-size: 0.9em;
|
||||
list-style-type: none; }
|
||||
.nav-group-task a {
|
||||
color: #888; }
|
||||
|
||||
.main-content {
|
||||
background-color: #fff;
|
||||
border: 1px solid #e2e2e2;
|
||||
margin-left: 246px;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
padding-bottom: 60px;
|
||||
top: 70px;
|
||||
width: 734px; }
|
||||
.main-content p, .main-content a, .main-content code, .main-content em, .main-content ul, .main-content table, .main-content blockquote {
|
||||
margin-bottom: 1em; }
|
||||
.main-content p {
|
||||
line-height: 1.8em; }
|
||||
.main-content section .section:first-child {
|
||||
margin-top: 0;
|
||||
padding-top: 0; }
|
||||
.main-content section .task-group-section .task-group:first-of-type {
|
||||
padding-top: 10px; }
|
||||
.main-content section .task-group-section .task-group:first-of-type .section-name {
|
||||
padding-top: 15px; }
|
||||
|
||||
.section {
|
||||
padding: 0 25px; }
|
||||
|
||||
.highlight {
|
||||
background-color: #eee;
|
||||
padding: 10px 12px;
|
||||
border: 1px solid #e2e2e2;
|
||||
border-radius: 4px;
|
||||
overflow-x: auto; }
|
||||
|
||||
.declaration .highlight {
|
||||
overflow-x: initial;
|
||||
padding: 0 40px 40px 0;
|
||||
margin-bottom: -25px;
|
||||
background-color: transparent;
|
||||
border: none; }
|
||||
|
||||
.section-name {
|
||||
margin: 0;
|
||||
margin-left: 18px; }
|
||||
|
||||
.task-group-section {
|
||||
padding-left: 6px;
|
||||
border-top: 1px solid #e2e2e2; }
|
||||
|
||||
.task-group {
|
||||
padding-top: 0px; }
|
||||
|
||||
.task-name-container a[name]:before {
|
||||
content: "";
|
||||
display: block;
|
||||
padding-top: 70px;
|
||||
margin: -70px 0 0; }
|
||||
|
||||
.item {
|
||||
padding-top: 8px;
|
||||
width: 100%;
|
||||
list-style-type: none; }
|
||||
.item a[name]:before {
|
||||
content: "";
|
||||
display: block;
|
||||
padding-top: 70px;
|
||||
margin: -70px 0 0; }
|
||||
.item code {
|
||||
background-color: transparent;
|
||||
padding: 0; }
|
||||
.item .token {
|
||||
padding-left: 3px;
|
||||
margin-left: 15px;
|
||||
font-size: 11.9px; }
|
||||
.item .declaration-note {
|
||||
font-size: .85em;
|
||||
color: gray;
|
||||
font-style: italic; }
|
||||
|
||||
.pointer-container {
|
||||
border-bottom: 1px solid #e2e2e2;
|
||||
left: -23px;
|
||||
padding-bottom: 13px;
|
||||
position: relative;
|
||||
width: 110%; }
|
||||
|
||||
.pointer {
|
||||
background: #f9f9f9;
|
||||
border-left: 1px solid #e2e2e2;
|
||||
border-top: 1px solid #e2e2e2;
|
||||
height: 12px;
|
||||
left: 21px;
|
||||
top: -7px;
|
||||
-webkit-transform: rotate(45deg);
|
||||
-moz-transform: rotate(45deg);
|
||||
-o-transform: rotate(45deg);
|
||||
transform: rotate(45deg);
|
||||
position: absolute;
|
||||
width: 12px; }
|
||||
|
||||
.height-container {
|
||||
display: none;
|
||||
left: -25px;
|
||||
padding: 0 25px;
|
||||
position: relative;
|
||||
width: 100%;
|
||||
overflow: hidden; }
|
||||
.height-container .section {
|
||||
background: #f9f9f9;
|
||||
border-bottom: 1px solid #e2e2e2;
|
||||
left: -25px;
|
||||
position: relative;
|
||||
width: 100%;
|
||||
padding-top: 10px;
|
||||
padding-bottom: 5px; }
|
||||
|
||||
.aside, .language {
|
||||
padding: 6px 12px;
|
||||
margin: 12px 0;
|
||||
border-left: 5px solid #dddddd;
|
||||
overflow-y: hidden; }
|
||||
.aside .aside-title, .language .aside-title {
|
||||
font-size: 9px;
|
||||
letter-spacing: 2px;
|
||||
text-transform: uppercase;
|
||||
padding-bottom: 0;
|
||||
margin: 0;
|
||||
color: #aaa;
|
||||
-webkit-user-select: none; }
|
||||
.aside p:last-child, .language p:last-child {
|
||||
margin-bottom: 0; }
|
||||
|
||||
.language {
|
||||
border-left: 5px solid #cde9f4; }
|
||||
.language .aside-title {
|
||||
color: #4b8afb; }
|
||||
|
||||
.aside-warning {
|
||||
border-left: 5px solid #ff6666; }
|
||||
.aside-warning .aside-title {
|
||||
color: #ff0000; }
|
||||
|
||||
.graybox {
|
||||
border-collapse: collapse;
|
||||
width: 100%; }
|
||||
.graybox p {
|
||||
margin: 0;
|
||||
word-break: break-word;
|
||||
min-width: 50px; }
|
||||
.graybox td {
|
||||
border: 1px solid #e2e2e2;
|
||||
padding: 5px 25px 5px 10px;
|
||||
vertical-align: middle; }
|
||||
.graybox tr td:first-of-type {
|
||||
text-align: right;
|
||||
padding: 7px;
|
||||
vertical-align: top;
|
||||
word-break: normal;
|
||||
width: 40px; }
|
||||
|
||||
.slightly-smaller {
|
||||
font-size: 0.9em; }
|
||||
|
||||
#footer {
|
||||
position: absolute;
|
||||
bottom: 10px;
|
||||
margin-left: 25px; }
|
||||
#footer p {
|
||||
margin: 0;
|
||||
color: #aaa;
|
||||
font-size: 0.8em; }
|
||||
|
||||
html.dash header, html.dash #breadcrumbs, html.dash .sidebar {
|
||||
display: none; }
|
||||
html.dash .main-content {
|
||||
width: 980px;
|
||||
margin-left: 0;
|
||||
border: none;
|
||||
width: 100%;
|
||||
top: 0;
|
||||
padding-bottom: 0; }
|
||||
html.dash .height-container {
|
||||
display: block; }
|
||||
html.dash .item .token {
|
||||
margin-left: 0; }
|
||||
html.dash .content-wrapper {
|
||||
width: auto; }
|
||||
html.dash #footer {
|
||||
position: static; }
|
||||
Binary file not shown.
|
|
@ -0,0 +1,20 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
||||
<plist version="1.0">
|
||||
<dict>
|
||||
<key>CFBundleIdentifier</key>
|
||||
<string>com.jazzy.swiftvalidator</string>
|
||||
<key>CFBundleName</key>
|
||||
<string>SwiftValidator</string>
|
||||
<key>DocSetPlatformFamily</key>
|
||||
<string>jazzy</string>
|
||||
<key>isDashDocset</key>
|
||||
<true/>
|
||||
<key>dashIndexFilePath</key>
|
||||
<string>index.html</string>
|
||||
<key>isJavaScriptEnabled</key>
|
||||
<true/>
|
||||
<key>DashDocSetFamily</key>
|
||||
<string>dashtoc</string>
|
||||
</dict>
|
||||
</plist>
|
||||
|
|
@ -0,0 +1,592 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<title>Classes 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 title="Classes 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" />
|
||||
Classes 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/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/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>Classes</h1>
|
||||
<p>The following classes are available globally.</p>
|
||||
|
||||
</section>
|
||||
<section class="section task-group-section">
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:C14SwiftValidator9EmailRule"></a>
|
||||
<a name="//apple_ref/swift/Class/EmailRule" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:C14SwiftValidator9EmailRule">EmailRule</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p><code>EmailRule</code> is a subclass of RegexRule that defines how a email is validated.</p>
|
||||
|
||||
<a href="Classes/EmailRule.html" class="slightly-smaller">See more</a>
|
||||
</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">class</span> <span class="kt">EmailRule</span><span class="p">:</span> <span class="kt">RegexRule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:C14SwiftValidator12FullNameRule"></a>
|
||||
<a name="//apple_ref/swift/Class/FullNameRule" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:C14SwiftValidator12FullNameRule">FullNameRule</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p><code>FullNameRule</code> is a subclass of Rule that defines how a full name is validated.</p>
|
||||
|
||||
<a href="Classes/FullNameRule.html" class="slightly-smaller">See more</a>
|
||||
</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">class</span> <span class="kt">FullNameRule</span> <span class="p">:</span> <span class="kt">Rule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:C14SwiftValidator11ZipCodeRule"></a>
|
||||
<a name="//apple_ref/swift/Class/ZipCodeRule" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:C14SwiftValidator11ZipCodeRule">ZipCodeRule</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p><code>ZipCodeRule</code> is a subclass of <code><a href="Classes/RegexRule.html">RegexRule</a></code> that represents how zip codes are to be validated.</p>
|
||||
|
||||
<a href="Classes/ZipCodeRule.html" class="slightly-smaller">See more</a>
|
||||
</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">class</span> <span class="kt">ZipCodeRule</span><span class="p">:</span> <span class="kt">RegexRule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:C14SwiftValidator12PasswordRule"></a>
|
||||
<a name="//apple_ref/swift/Class/PasswordRule" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:C14SwiftValidator12PasswordRule">PasswordRule</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p><code>PasswordRule</code> is a subclass of RegexRule that defines how a password is validated.</p>
|
||||
|
||||
<a href="Classes/PasswordRule.html" class="slightly-smaller">See more</a>
|
||||
</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">class</span> <span class="kt">PasswordRule</span> <span class="p">:</span> <span class="kt">RegexRule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:C14SwiftValidator15PhoneNumberRule"></a>
|
||||
<a name="//apple_ref/swift/Class/PhoneNumberRule" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:C14SwiftValidator15PhoneNumberRule">PhoneNumberRule</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p><code>PhoneNumberRule</code> is a subclass of Rule that defines how a phone number is validated.</p>
|
||||
|
||||
<a href="Classes/PhoneNumberRule.html" class="slightly-smaller">See more</a>
|
||||
</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">class</span> <span class="kt">PhoneNumberRule</span><span class="p">:</span> <span class="kt">RegexRule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:C14SwiftValidator9FloatRule"></a>
|
||||
<a name="//apple_ref/swift/Class/FloatRule" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:C14SwiftValidator9FloatRule">FloatRule</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p><code>FloatRule</code> is a subclass of Rule that defines how check if a value is a floating point value.</p>
|
||||
|
||||
<a href="Classes/FloatRule.html" class="slightly-smaller">See more</a>
|
||||
</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">class</span> <span class="kt">FloatRule</span><span class="p">:</span><span class="kt">Rule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:C14SwiftValidator9Validator"></a>
|
||||
<a name="//apple_ref/swift/Class/Validator" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:C14SwiftValidator9Validator">Validator</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Class that makes <code>Validator</code> objects. Should be added as a parameter to ViewController that will display
|
||||
validation fields.</p>
|
||||
|
||||
<a href="Classes/Validator.html" class="slightly-smaller">See more</a>
|
||||
</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">class</span> <span class="kt">Validator</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:C14SwiftValidator14ValidationRule"></a>
|
||||
<a name="//apple_ref/swift/Class/ValidationRule" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:C14SwiftValidator14ValidationRule">ValidationRule</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p><code>ValidationRule</code> is a class that creates an object which holds validation info of a text field.</p>
|
||||
|
||||
<a href="Classes/ValidationRule.html" class="slightly-smaller">See more</a>
|
||||
</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">class</span> <span class="kt">ValidationRule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:C14SwiftValidator16ConfirmationRule"></a>
|
||||
<a name="//apple_ref/swift/Class/ConfirmationRule" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:C14SwiftValidator16ConfirmationRule">ConfirmationRule</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p><code>ConfirmationRule</code> is a subclass of Rule that defines how a text field that has to be equal
|
||||
to another text field is validated.</p>
|
||||
|
||||
<a href="Classes/ConfirmationRule.html" class="slightly-smaller">See more</a>
|
||||
</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">class</span> <span class="kt">ConfirmationRule</span><span class="p">:</span> <span class="kt">Rule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:C14SwiftValidator15ValidationError"></a>
|
||||
<a name="//apple_ref/swift/Class/ValidationError" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:C14SwiftValidator15ValidationError">ValidationError</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>The <code>ValidationError</code> class is used for representing errors of a failed validation. It contains the text field, error label, and error message of a failed validation.</p>
|
||||
|
||||
<a href="Classes/ValidationError.html" class="slightly-smaller">See more</a>
|
||||
</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">class</span> <span class="kt">ValidationError</span><span class="p">:</span> <span class="kt">NSObject</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:C14SwiftValidator12RequiredRule"></a>
|
||||
<a name="//apple_ref/swift/Class/RequiredRule" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:C14SwiftValidator12RequiredRule">RequiredRule</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p><code>RequiredRule</code> is a subclass of Rule that defines how a required text field is validated.</p>
|
||||
|
||||
<a href="Classes/RequiredRule.html" class="slightly-smaller">See more</a>
|
||||
</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">class</span> <span class="kt">RequiredRule</span><span class="p">:</span> <span class="kt">Rule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:C14SwiftValidator9RegexRule"></a>
|
||||
<a name="//apple_ref/swift/Class/RegexRule" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:C14SwiftValidator9RegexRule">RegexRule</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p><code>RegexRule</code> is a subclass of Rule that defines how a regular expression is validated.</p>
|
||||
|
||||
<a href="Classes/RegexRule.html" class="slightly-smaller">See more</a>
|
||||
</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">class</span> <span class="kt">RegexRule</span> <span class="p">:</span> <span class="kt">Rule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:C14SwiftValidator13MinLengthRule"></a>
|
||||
<a name="//apple_ref/swift/Class/MinLengthRule" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:C14SwiftValidator13MinLengthRule">MinLengthRule</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p><code>MinLengthRule</code> is a subclass of Rule that defines how minimum character length is validated.</p>
|
||||
|
||||
<a href="Classes/MinLengthRule.html" class="slightly-smaller">See more</a>
|
||||
</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">class</span> <span class="kt">MinLengthRule</span><span class="p">:</span> <span class="kt">Rule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:C14SwiftValidator13MaxLengthRule"></a>
|
||||
<a name="//apple_ref/swift/Class/MaxLengthRule" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:C14SwiftValidator13MaxLengthRule">MaxLengthRule</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p><code>MaxLengthRule</code> is a subclass of <code><a href="Protocols/Rule.html">Rule</a></code> that defines how maximum character length is validated.</p>
|
||||
|
||||
<a href="Classes/MaxLengthRule.html" class="slightly-smaller">See more</a>
|
||||
</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">class</span> <span class="kt">MaxLengthRule</span><span class="p">:</span> <span class="kt">Rule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:C14SwiftValidator15ExactLengthRule"></a>
|
||||
<a name="//apple_ref/swift/Class/ExactLengthRule" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:C14SwiftValidator15ExactLengthRule">ExactLengthRule</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p><code>ExactLengthRule</code> is a subclass of Rule that is used to make sure a the text of a text field is an exact length.</p>
|
||||
|
||||
<a href="Classes/ExactLengthRule.html" class="slightly-smaller">See more</a>
|
||||
</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">class</span> <span class="kt">ExactLengthRule</span> <span class="p">:</span> <span class="kt">Rule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</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-02-14)</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>
|
||||
|
|
@ -0,0 +1,271 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<title>ConfirmationRule 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/ConfirmationRule" class="dashAnchor"></a>
|
||||
<a title="ConfirmationRule 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" />
|
||||
ConfirmationRule 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/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/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>ConfirmationRule</h1>
|
||||
<div class="declaration">
|
||||
<div class="language">
|
||||
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">ConfirmationRule</span><span class="p">:</span> <span class="kt">Rule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<p><code>ConfirmationRule</code> is a subclass of Rule that defines how a text field that has to be equal
|
||||
to another text field is validated.</p>
|
||||
|
||||
</section>
|
||||
<section class="section task-group-section">
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator16ConfirmationRulecFMS0_FT12confirmFieldCSo11UITextField7messageSS_S0_"></a>
|
||||
<a name="//apple_ref/swift/Method/init(confirmField:message:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator16ConfirmationRulecFMS0_FT12confirmFieldCSo11UITextField7messageSS_S0_">init(confirmField:message:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Initializes a <code><a href="../Classes/ConfirmationRule.html">ConfirmationRule</a></code> object to validate the text of a text field that should equal the text of another text 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="nf">init</span><span class="p">(</span><span class="nv">confirmField</span><span class="p">:</span> <span class="kt">UITextField</span><span class="p">,</span> <span class="nv">message</span> <span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="s">"This field does not match"</span><span class="p">)</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>confirmField</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>text field to which original text field will be compared to.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>message</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>String of error message.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>An initialized 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:FC14SwiftValidator16ConfirmationRule8validateFS0_FSSSb"></a>
|
||||
<a name="//apple_ref/swift/Method/validate(_:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator16ConfirmationRule8validateFS0_FSSSb">validate(_:)</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 a text 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="kd">func</span> <span class="nf">validate</span><span class="p">(</span><span class="nv">value</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Bool</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>value</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>String to checked for validation.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>A boolean value. True if validation is successful; False if validation fails.</p>
|
||||
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator16ConfirmationRule12errorMessageFS0_FT_SS"></a>
|
||||
<a name="//apple_ref/swift/Method/errorMessage()" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator16ConfirmationRule12errorMessageFS0_FT_SS">errorMessage()</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Displays an error message when text field fails validation.</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">errorMessage</span><span class="p">()</span> <span class="o">-></span> <span class="kt">String</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>String of error message.</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-02-14)</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>
|
||||
|
|
@ -0,0 +1,173 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<title>EmailRule 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/EmailRule" class="dashAnchor"></a>
|
||||
<a title="EmailRule 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" />
|
||||
EmailRule 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/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/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>EmailRule</h1>
|
||||
<div class="declaration">
|
||||
<div class="language">
|
||||
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">EmailRule</span><span class="p">:</span> <span class="kt">RegexRule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<p><code>EmailRule</code> is a subclass of RegexRule that defines how a email is validated.</p>
|
||||
|
||||
</section>
|
||||
<section class="section task-group-section">
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator9EmailRulecFMS0_FT7messageSS_S0_"></a>
|
||||
<a name="//apple_ref/swift/Method/init(message:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator9EmailRulecFMS0_FT7messageSS_S0_">init(message:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Initializes an <code><a href="../Classes/EmailRule.html">EmailRule</a></code> object to validate an email text 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="n">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">message</span> <span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="s">"Must be a valid email address"</span><span class="p">)</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>message</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>String of error message.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>An initialized 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>
|
||||
</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-02-14)</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>
|
||||
|
|
@ -0,0 +1,270 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<title>ExactLengthRule 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/ExactLengthRule" class="dashAnchor"></a>
|
||||
<a title="ExactLengthRule 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" />
|
||||
ExactLengthRule 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/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/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>ExactLengthRule</h1>
|
||||
<div class="declaration">
|
||||
<div class="language">
|
||||
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">ExactLengthRule</span> <span class="p">:</span> <span class="kt">Rule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<p><code>ExactLengthRule</code> is a subclass of Rule that is used to make sure a the text of a text field is an exact length.</p>
|
||||
|
||||
</section>
|
||||
<section class="section task-group-section">
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator15ExactLengthRulecFMS0_FT6lengthSi7messageSS_S0_"></a>
|
||||
<a name="//apple_ref/swift/Method/init(length:message:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator15ExactLengthRulecFMS0_FT6lengthSi7messageSS_S0_">init(length:message:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Initializes an <code><a href="../Classes/ExactLengthRule.html">ExactLengthRule</a></code> object to validate the text of a text field against an exact length.</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">length</span><span class="p">:</span> <span class="kt">Int</span><span class="p">,</span> <span class="nv">message</span> <span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="s">"Must be exactly %ld characters long"</span><span class="p">)</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>length</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>Integer value of exact string length being specified.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>message</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>String of error message.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>An initialized <code><a href="../Classes/ExactLengthRule.html">ExactLengthRule</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:FC14SwiftValidator15ExactLengthRule8validateFS0_FSSSb"></a>
|
||||
<a name="//apple_ref/swift/Method/validate(_:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator15ExactLengthRule8validateFS0_FSSSb">validate(_:)</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 a text 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="kd">func</span> <span class="nf">validate</span><span class="p">(</span><span class="nv">value</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Bool</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>value</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>String to checked for validation.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>A boolean value. True if validation is successful; False if validation fails.</p>
|
||||
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator15ExactLengthRule12errorMessageFS0_FT_SS"></a>
|
||||
<a name="//apple_ref/swift/Method/errorMessage()" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator15ExactLengthRule12errorMessageFS0_FT_SS">errorMessage()</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Displays error message if a text field fails validation.</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">errorMessage</span><span class="p">()</span> <span class="o">-></span> <span class="kt">String</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>String of error message.</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-02-14)</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>
|
||||
|
|
@ -0,0 +1,257 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<title>FloatRule 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/FloatRule" class="dashAnchor"></a>
|
||||
<a title="FloatRule 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" />
|
||||
FloatRule 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/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/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>FloatRule</h1>
|
||||
<div class="declaration">
|
||||
<div class="language">
|
||||
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">FloatRule</span><span class="p">:</span><span class="kt">Rule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<p><code>FloatRule</code> is a subclass of Rule that defines how check if a value is a floating point value.</p>
|
||||
|
||||
</section>
|
||||
<section class="section task-group-section">
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator9FloatRulecFMS0_FT7messageSS_S0_"></a>
|
||||
<a name="//apple_ref/swift/Method/init(message:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator9FloatRulecFMS0_FT7messageSS_S0_">init(message:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Initializes a <code><a href="../Classes/FloatRule.html">FloatRule</a></code> object to validate that the text of a text field is a floating point number.</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">message</span> <span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="s">"This must be a number with or without a decimal"</span><span class="p">)</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>message</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>String of error message.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>An initialized 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:FC14SwiftValidator9FloatRule8validateFS0_FSSSb"></a>
|
||||
<a name="//apple_ref/swift/Method/validate(_:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator9FloatRule8validateFS0_FSSSb">validate(_:)</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.</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">validate</span><span class="p">(</span><span class="nv">value</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Bool</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>value</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>String to checked for validation.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>Boolean value. True if validation is successful; False if validation fails.</p>
|
||||
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator9FloatRule12errorMessageFS0_FT_SS"></a>
|
||||
<a name="//apple_ref/swift/Method/errorMessage()" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator9FloatRule12errorMessageFS0_FT_SS">errorMessage()</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Displays error message when text field fails validation.</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">errorMessage</span><span class="p">()</span> <span class="o">-></span> <span class="kt">String</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>String of error message.</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-02-14)</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>
|
||||
|
|
@ -0,0 +1,257 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<title>FullNameRule 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/FullNameRule" class="dashAnchor"></a>
|
||||
<a title="FullNameRule 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" />
|
||||
FullNameRule 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/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/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>FullNameRule</h1>
|
||||
<div class="declaration">
|
||||
<div class="language">
|
||||
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">FullNameRule</span> <span class="p">:</span> <span class="kt">Rule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<p><code>FullNameRule</code> is a subclass of Rule that defines how a full name is validated.</p>
|
||||
|
||||
</section>
|
||||
<section class="section task-group-section">
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator12FullNameRulecFMS0_FT7messageSS_S0_"></a>
|
||||
<a name="//apple_ref/swift/Method/init(message:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator12FullNameRulecFMS0_FT7messageSS_S0_">init(message:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Initializes a <code><a href="../Classes/FullNameRule.html">FullNameRule</a></code> object that is used to verify that text in text field is a full name.</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">message</span> <span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="s">"Please provide a first & last name"</span><span class="p">)</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>message</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>String of error message.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>An initialized <code><a href="../Classes/FullNameRule.html">FullNameRule</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:FC14SwiftValidator12FullNameRule8validateFS0_FSSSb"></a>
|
||||
<a name="//apple_ref/swift/Method/validate(_:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator12FullNameRule8validateFS0_FSSSb">validate(_:)</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 a text 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="kd">func</span> <span class="nf">validate</span><span class="p">(</span><span class="nv">value</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Bool</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>value</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>String to checked for validation.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>A boolean value. True if validation is successful; False if validation fails.</p>
|
||||
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator12FullNameRule12errorMessageFS0_FT_SS"></a>
|
||||
<a name="//apple_ref/swift/Method/errorMessage()" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator12FullNameRule12errorMessageFS0_FT_SS">errorMessage()</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 display error message of a text field that has failed validation.</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">errorMessage</span><span class="p">()</span> <span class="o">-></span> <span class="kt">String</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>String of error message.</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-02-14)</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>
|
||||
|
|
@ -0,0 +1,304 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<title>MaxLengthRule 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/MaxLengthRule" class="dashAnchor"></a>
|
||||
<a title="MaxLengthRule 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" />
|
||||
MaxLengthRule 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/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/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>MaxLengthRule</h1>
|
||||
<div class="declaration">
|
||||
<div class="language">
|
||||
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">MaxLengthRule</span><span class="p">:</span> <span class="kt">Rule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<p><code>MaxLengthRule</code> is a subclass of <code><a href="../Protocols/Rule.html">Rule</a></code> that defines how maximum character length is validated.</p>
|
||||
|
||||
</section>
|
||||
<section class="section task-group-section">
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator13MaxLengthRulecFMS0_FT_S0_"></a>
|
||||
<a name="//apple_ref/swift/Method/init()" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator13MaxLengthRulecFMS0_FT_S0_">init()</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
|
||||
</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></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>An initialized <code><a href="../Classes/MaxLengthRule.html">MaxLengthRule</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:FC14SwiftValidator13MaxLengthRulecFMS0_FT6lengthSi7messageSS_S0_"></a>
|
||||
<a name="//apple_ref/swift/Method/init(length:message:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator13MaxLengthRulecFMS0_FT6lengthSi7messageSS_S0_">init(length:message:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Initializes a <code><a href="../Classes/MaxLengthRule.html">MaxLengthRule</a></code> object that is to validate the length of the text of a text field
|
||||
- parameter length: Maximum character length.
|
||||
- parameter message: String of error message.
|
||||
- returns: An initialized object, or nil if an object could not be created for some reason that would not result in an exception.</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">length</span><span class="p">:</span> <span class="kt">Int</span><span class="p">,</span> <span class="nv">message</span> <span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="s">"Must be at most %ld characters long"</span><span class="p">)</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>length</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>Maximum character length.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>message</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>String of error message.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>An initialized 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:FC14SwiftValidator13MaxLengthRule8validateFS0_FSSSb"></a>
|
||||
<a name="//apple_ref/swift/Method/validate(_:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator13MaxLengthRule8validateFS0_FSSSb">validate(_:)</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 a text 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="kd">func</span> <span class="nf">validate</span><span class="p">(</span><span class="nv">value</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Bool</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>value</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>String to checked for validation.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>A boolean value. True if validation is successful; False if validation fails.</p>
|
||||
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator13MaxLengthRule12errorMessageFS0_FT_SS"></a>
|
||||
<a name="//apple_ref/swift/Method/errorMessage()" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator13MaxLengthRule12errorMessageFS0_FT_SS">errorMessage()</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Displays an error message if a text field fails validation.</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">errorMessage</span><span class="p">()</span> <span class="o">-></span> <span class="kt">String</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>String of error message.</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-02-14)</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>
|
||||
|
|
@ -0,0 +1,306 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<title>MinLengthRule 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/MinLengthRule" class="dashAnchor"></a>
|
||||
<a title="MinLengthRule 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" />
|
||||
MinLengthRule 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/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/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>MinLengthRule</h1>
|
||||
<div class="declaration">
|
||||
<div class="language">
|
||||
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">MinLengthRule</span><span class="p">:</span> <span class="kt">Rule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<p><code>MinLengthRule</code> is a subclass of Rule that defines how minimum character length is validated.</p>
|
||||
|
||||
</section>
|
||||
<section class="section task-group-section">
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator13MinLengthRulecFMS0_FT_S0_"></a>
|
||||
<a name="//apple_ref/swift/Method/init()" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator13MinLengthRulecFMS0_FT_S0_">init()</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
|
||||
</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></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>An initialized <code><a href="../Classes/MinLengthRule.html">MinLengthRule</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:FC14SwiftValidator13MinLengthRulecFMS0_FT6lengthSi7messageSS_S0_"></a>
|
||||
<a name="//apple_ref/swift/Method/init(length:message:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator13MinLengthRulecFMS0_FT6lengthSi7messageSS_S0_">init(length:message:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Initializes a <code><a href="../Classes/MaxLengthRule.html">MaxLengthRule</a></code> object that is to validate the length of the text of a text field
|
||||
- parameter length: Minimum character length.
|
||||
- parameter message: String of error message.
|
||||
- returns: An initialized <code><a href="../Classes/MinLengthRule.html">MinLengthRule</a></code> object, or nil if an object could not be created for some reason that would not result in an exception.</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">length</span><span class="p">:</span> <span class="kt">Int</span><span class="p">,</span> <span class="nv">message</span> <span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="s">"Must be at least %ld characters long"</span><span class="p">)</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>length</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>Minimum character length.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>message</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>String of error message.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>An initialized <code><a href="../Classes/MinLengthRule.html">MinLengthRule</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:FC14SwiftValidator13MinLengthRule8validateFS0_FSSSb"></a>
|
||||
<a name="//apple_ref/swift/Method/validate(_:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator13MinLengthRule8validateFS0_FSSSb">validate(_:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Validates a text field.
|
||||
- parameter value: String to checked for validation.
|
||||
- returns: A boolean value. True if validation is successful; False if validation fails.</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">validate</span><span class="p">(</span><span class="nv">value</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Bool</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>value</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>String to checked for validation.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>A boolean value. True if validation is successful; False if validation fails.</p>
|
||||
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator13MinLengthRule12errorMessageFS0_FT_SS"></a>
|
||||
<a name="//apple_ref/swift/Method/errorMessage()" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator13MinLengthRule12errorMessageFS0_FT_SS">errorMessage()</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Displays error message when text field has failed validation.</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">errorMessage</span><span class="p">()</span> <span class="o">-></span> <span class="kt">String</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>String of error message.</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-02-14)</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>
|
||||
|
|
@ -0,0 +1,173 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<title>PasswordRule 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/PasswordRule" class="dashAnchor"></a>
|
||||
<a title="PasswordRule 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" />
|
||||
PasswordRule 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/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/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>PasswordRule</h1>
|
||||
<div class="declaration">
|
||||
<div class="language">
|
||||
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">PasswordRule</span> <span class="p">:</span> <span class="kt">RegexRule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<p><code>PasswordRule</code> is a subclass of RegexRule that defines how a password is validated.</p>
|
||||
|
||||
</section>
|
||||
<section class="section task-group-section">
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator12PasswordRulecFMS0_FT7messageSS_S0_"></a>
|
||||
<a name="//apple_ref/swift/Method/init(message:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator12PasswordRulecFMS0_FT7messageSS_S0_">init(message:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Initializes a <code><a href="../Classes/PasswordRule.html">PasswordRule</a></code> object that will validate a text field is a valid password.</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="n">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">message</span> <span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="s">"Must be 8 characters with 1 uppercase"</span><span class="p">)</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>message</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>String of error message.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>An initialized <code><a href="../Classes/PasswordRule.html">PasswordRule</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>
|
||||
</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-02-14)</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>
|
||||
|
|
@ -0,0 +1,175 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<title>PhoneNumberRule 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/PhoneNumberRule" class="dashAnchor"></a>
|
||||
<a title="PhoneNumberRule 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" />
|
||||
PhoneNumberRule 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/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/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>PhoneNumberRule</h1>
|
||||
<div class="declaration">
|
||||
<div class="language">
|
||||
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">PhoneNumberRule</span><span class="p">:</span> <span class="kt">RegexRule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<p><code>PhoneNumberRule</code> is a subclass of Rule that defines how a phone number is validated.</p>
|
||||
|
||||
</section>
|
||||
<section class="section task-group-section">
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator15PhoneNumberRulecFMS0_FT7messageSS_S0_"></a>
|
||||
<a name="//apple_ref/swift/Method/init(message:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator15PhoneNumberRulecFMS0_FT7messageSS_S0_">init(message:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Method used to initialize <code><a href="../Classes/PhoneNumberRule.html">PhoneNumberRule</a></code> object.
|
||||
- parameter message: Error message that is displayed if validation fails.
|
||||
- returns: An initialized <code><a href="../Classes/PasswordRule.html">PasswordRule</a></code> object, or nil if an object could not be created for some reason that would not result in an exception.</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="n">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">message</span> <span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="s">"Enter a valid 10 digit phone number"</span><span class="p">)</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>message</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>Error message that is displayed if validation fails.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>An initialized <code><a href="../Classes/PasswordRule.html">PasswordRule</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>
|
||||
</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-02-14)</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>
|
||||
|
|
@ -0,0 +1,270 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<title>RegexRule 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/RegexRule" class="dashAnchor"></a>
|
||||
<a title="RegexRule 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" />
|
||||
RegexRule 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/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/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>RegexRule</h1>
|
||||
<div class="declaration">
|
||||
<div class="language">
|
||||
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">RegexRule</span> <span class="p">:</span> <span class="kt">Rule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<p><code>RegexRule</code> is a subclass of Rule that defines how a regular expression is validated.</p>
|
||||
|
||||
</section>
|
||||
<section class="section task-group-section">
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator9RegexRulecFMS0_FT5regexSS7messageSS_S0_"></a>
|
||||
<a name="//apple_ref/swift/Method/init(regex:message:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator9RegexRulecFMS0_FT5regexSS7messageSS_S0_">init(regex:message:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Method used to initialize <code><a href="../Classes/RegexRule.html">RegexRule</a></code> object.</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">regex</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">message</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="s">"Invalid Regular Expression"</span><span class="p">)</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>regex</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>Regular expression string to be used in validation.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>message</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>String of error message.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>An initialized <code><a href="../Classes/RegexRule.html">RegexRule</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:FC14SwiftValidator9RegexRule8validateFS0_FSSSb"></a>
|
||||
<a name="//apple_ref/swift/Method/validate(_:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator9RegexRule8validateFS0_FSSSb">validate(_:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Method used to validate text 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="kd">func</span> <span class="nf">validate</span><span class="p">(</span><span class="nv">value</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Bool</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>value</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>String to checked for validation.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>Boolean value. True if validation is successful; False if validation fails.</p>
|
||||
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator9RegexRule12errorMessageFS0_FT_SS"></a>
|
||||
<a name="//apple_ref/swift/Method/errorMessage()" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator9RegexRule12errorMessageFS0_FT_SS">errorMessage()</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Method used to dispaly error message when text field fails validation.</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">errorMessage</span><span class="p">()</span> <span class="o">-></span> <span class="kt">String</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>String of error message.</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-02-14)</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>
|
||||
|
|
@ -0,0 +1,256 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<title>RequiredRule 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/RequiredRule" class="dashAnchor"></a>
|
||||
<a title="RequiredRule 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" />
|
||||
RequiredRule 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/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/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>RequiredRule</h1>
|
||||
<div class="declaration">
|
||||
<div class="language">
|
||||
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">RequiredRule</span><span class="p">:</span> <span class="kt">Rule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<p><code>RequiredRule</code> is a subclass of Rule that defines how a required text field is validated.</p>
|
||||
|
||||
</section>
|
||||
<section class="section task-group-section">
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator12RequiredRulecFMS0_FT7messageSS_S0_"></a>
|
||||
<a name="//apple_ref/swift/Method/init(message:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator12RequiredRulecFMS0_FT7messageSS_S0_">init(message:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
|
||||
</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">message</span> <span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="s">"This field is required"</span><span class="p">)</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>message</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>String of error message.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>An initialized <code><a href="../Classes/RequiredRule.html">RequiredRule</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:FC14SwiftValidator12RequiredRule8validateFS0_FSSSb"></a>
|
||||
<a name="//apple_ref/swift/Method/validate(_:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator12RequiredRule8validateFS0_FSSSb">validate(_:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Validates a text 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="kd">func</span> <span class="nf">validate</span><span class="p">(</span><span class="nv">value</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Bool</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>value</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>String to checked for validation.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>Boolean value. True if validation is successful; False if validation fails.</p>
|
||||
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator12RequiredRule12errorMessageFS0_FT_SS"></a>
|
||||
<a name="//apple_ref/swift/Method/errorMessage()" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator12RequiredRule12errorMessageFS0_FT_SS">errorMessage()</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 display error message when validation fails.</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">errorMessage</span><span class="p">()</span> <span class="o">-></span> <span class="kt">String</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>String of error message.</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-02-14)</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>
|
||||
|
|
@ -0,0 +1,352 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<title>ValidationError 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/ValidationError" class="dashAnchor"></a>
|
||||
<a title="ValidationError 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" />
|
||||
ValidationError 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/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/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>ValidationError</h1>
|
||||
<div class="declaration">
|
||||
<div class="language">
|
||||
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">ValidationError</span><span class="p">:</span> <span class="kt">NSObject</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<p>The <code>ValidationError</code> class is used for representing errors of a failed validation. It contains the text field, error label, and error message of a failed validation.</p>
|
||||
|
||||
</section>
|
||||
<section class="section task-group-section">
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:vC14SwiftValidator15ValidationError9textFieldCSo11UITextField"></a>
|
||||
<a name="//apple_ref/swift/Property/textField" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:vC14SwiftValidator15ValidationError9textFieldCSo11UITextField">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 textField 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">let</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:vC14SwiftValidator15ValidationError10errorLabelGSqCSo7UILabel_"></a>
|
||||
<a name="//apple_ref/swift/Property/errorLabel" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:vC14SwiftValidator15ValidationError10errorLabelGSqCSo7UILabel_">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 error label 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:vC14SwiftValidator15ValidationError12errorMessageSS"></a>
|
||||
<a name="//apple_ref/swift/Property/errorMessage" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:vC14SwiftValidator15ValidationError12errorMessageSS">errorMessage</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>the error message 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">let</span> <span class="nv">errorMessage</span><span class="p">:</span><span class="kt">String</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator15ValidationErrorcFMS0_FT9textFieldCSo11UITextField5errorSS_S0_"></a>
|
||||
<a name="//apple_ref/swift/Method/init(textField:error:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator15ValidationErrorcFMS0_FT9textFieldCSo11UITextField5errorSS_S0_">init(textField:error:)</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/ValidationError.html">ValidationError</a></code> object with a textField and error.
|
||||
- parameter textField: UITextField that holds textField.
|
||||
- parameter errorMessage: String that holds error message.
|
||||
- returns: An initialized object, or nil if an object could not be created for some reason that would not result in an exception.</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">error</span><span class="p">:</span><span class="kt">String</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>UITextField that holds textField.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>errorMessage</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>String that holds error message.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>An initialized 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:FC14SwiftValidator15ValidationErrorcFMS0_FT9textFieldCSo11UITextField10errorLabelGSqCSo7UILabel_5errorSS_S0_"></a>
|
||||
<a name="//apple_ref/swift/Method/init(textField:errorLabel:error:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator15ValidationErrorcFMS0_FT9textFieldCSo11UITextField10errorLabelGSqCSo7UILabel_5errorSS_S0_">init(textField:errorLabel:error:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Initializes ValidationError object with a textField, errorLabel, and errorMessage.
|
||||
- parameter textField: UITextField that holds textField.
|
||||
- parameter errorLabel: UILabel that holds error label.
|
||||
- parameter errorMessage: String that holds error message.
|
||||
- returns: An initialized object, or nil if an object could not be created for some reason that would not result in an exception.</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">errorLabel</span><span class="p">:</span><span class="kt">UILabel</span><span class="p">?,</span> <span class="nv">error</span><span class="p">:</span><span class="kt">String</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>UITextField that holds textField.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>errorLabel</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>UILabel that holds error label.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>errorMessage</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>String that holds error message.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>An initialized 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>
|
||||
</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-02-14)</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>
|
||||
|
|
@ -0,0 +1,313 @@
|
|||
<!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/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/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-02-14)</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>
|
||||
|
|
@ -0,0 +1,628 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<title>Validator 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/Validator" class="dashAnchor"></a>
|
||||
<a title="Validator 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" />
|
||||
Validator 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/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/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>Validator</h1>
|
||||
<div class="declaration">
|
||||
<div class="language">
|
||||
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">Validator</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<p>Class that makes <code>Validator</code> objects. Should be added as a parameter to ViewController that will display
|
||||
validation fields.</p>
|
||||
|
||||
</section>
|
||||
<section class="section task-group-section">
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:vC14SwiftValidator9Validator11validationsGVSs10DictionaryCSo11UITextFieldCS_14ValidationRule_"></a>
|
||||
<a name="//apple_ref/swift/Property/validations" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:vC14SwiftValidator9Validator11validationsGVSs10DictionaryCSo11UITextFieldCS_14ValidationRule_">validations</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Dictionary to hold all fields (and accompanying rules) that will undergo validation.</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">validations</span> <span class="o">=</span> <span class="p">[</span><span class="kt">UITextField</span><span class="p">:</span><span class="kt">ValidationRule</span><span class="p">]()</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:vC14SwiftValidator9Validator6errorsGVSs10DictionaryCSo11UITextFieldCS_15ValidationError_"></a>
|
||||
<a name="//apple_ref/swift/Property/errors" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:vC14SwiftValidator9Validator6errorsGVSs10DictionaryCSo11UITextFieldCS_15ValidationError_">errors</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Dictionary to hold fields (and accompanying errors) that were unsuccessfully validated.</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">errors</span> <span class="o">=</span> <span class="p">[</span><span class="kt">UITextField</span><span class="p">:</span><span class="kt">ValidationError</span><span class="p">]()</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator9ValidatorcFMS0_FT_S0_"></a>
|
||||
<a name="//apple_ref/swift/Method/init()" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator9ValidatorcFMS0_FT_S0_">init()</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
|
||||
</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></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>An initialized 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>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="task-group">
|
||||
<div class="task-name-container">
|
||||
<a name="/Public%20functions"></a>
|
||||
<a name="//apple_ref/swift/Section/Public functions" class="dashAnchor"></a>
|
||||
<a href="#/Public%20functions">
|
||||
<h3 class="section-name">Public functions</h3>
|
||||
</a>
|
||||
</div>
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator9Validator13validateFieldFS0_FTCSo11UITextField8callbackFT5errorGSqCS_15ValidationError__T__T_"></a>
|
||||
<a name="//apple_ref/swift/Method/validateField(_:callback:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator9Validator13validateFieldFS0_FTCSo11UITextField8callbackFT5errorGSqCS_15ValidationError__T__T_">validateField(_:callback:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>This method is used to validate a single field registered to Validator. If validation is unsuccessful,
|
||||
field gets added to errors dictionary.
|
||||
- parameter textField: Holds validator field data.
|
||||
- returns: No return value.</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="nv">textField</span><span class="p">:</span> <span class="kt">UITextField</span><span class="p">,</span> <span class="nv">callback</span><span class="p">:</span> <span class="p">(</span><span class="nv">error</span><span class="p">:</span><span class="kt">ValidationError</span><span class="p">?)</span> <span class="o">-></span> <span class="kt">Void</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>Holds validator field data.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>No return value.</p>
|
||||
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="task-group">
|
||||
<div class="task-name-container">
|
||||
<a name="/Using%20Keys"></a>
|
||||
<a name="//apple_ref/swift/Section/Using Keys" class="dashAnchor"></a>
|
||||
<a href="#/Using%20Keys">
|
||||
<h3 class="section-name">Using Keys</h3>
|
||||
</a>
|
||||
</div>
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator9Validator17styleTransformersFS0_FT7successGSqFT14validationRuleCS_14ValidationRule_T__5errorGSqFT15validationErrorCS_15ValidationError_T___T_"></a>
|
||||
<a name="//apple_ref/swift/Method/styleTransformers(success:error:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator9Validator17styleTransformersFS0_FT7successGSqFT14validationRuleCS_14ValidationRule_T__5errorGSqFT15validationErrorCS_15ValidationError_T___T_">styleTransformers(success:error:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>This method is used to style fields that have undergone validation checks. Success callback should be used to show common success styling and error callback should be used to show common error styling.</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">styleTransformers</span><span class="p">(</span><span class="n">success</span> <span class="nv">success</span><span class="p">:((</span><span class="nv">validationRule</span><span class="p">:</span><span class="kt">ValidationRule</span><span class="p">)</span><span class="o">-></span><span class="kt">Void</span><span class="p">)?,</span> <span class="nv">error</span><span class="p">:((</span><span class="nv">validationError</span><span class="p">:</span><span class="kt">ValidationError</span><span class="p">)</span><span class="o">-></span><span class="kt">Void</span><span class="p">)?)</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>success</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>A closure which is called with validationRule, an object that holds validation data</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>error</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>A closure which is called with validationError, an object that holds validation error data</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>No return value</p>
|
||||
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator9Validator13registerFieldFS0_FTCSo11UITextField5rulesGSaPS_4Rule___T_"></a>
|
||||
<a name="//apple_ref/swift/Method/registerField(_:rules:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator9Validator13registerFieldFS0_FTCSo11UITextField5rulesGSaPS_4Rule___T_">registerField(_:rules:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>This method is used to add a field to validator.</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">registerField</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></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>textField</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>field that is to be validated.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>Rule</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>An array which holds different rules to validate against textField.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>No return value</p>
|
||||
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator9Validator13registerFieldFS0_FTCSo11UITextField10errorLabelCSo7UILabel5rulesGSaPS_4Rule___T_"></a>
|
||||
<a name="//apple_ref/swift/Method/registerField(_:errorLabel:rules:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator9Validator13registerFieldFS0_FTCSo11UITextField10errorLabelCSo7UILabel5rulesGSaPS_4Rule___T_">registerField(_:errorLabel:rules:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>This method is used to add a field to validator.</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">registerField</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">errorLabel</span><span class="p">:</span><span class="kt">UILabel</span><span class="p">,</span> <span class="nv">rules</span><span class="p">:[</span><span class="kt">Rule</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>field that is to be validated.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>errorLabel</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>A UILabel that holds error label data</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>rules</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>A Rule array that holds different rules that apply to said textField.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>No return value</p>
|
||||
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator9Validator15unregisterFieldFS0_FCSo11UITextFieldT_"></a>
|
||||
<a name="//apple_ref/swift/Method/unregisterField(_:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator9Validator15unregisterFieldFS0_FCSo11UITextFieldT_">unregisterField(_:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>This method is for removing a field validator.</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">unregisterField</span><span class="p">(</span><span class="nv">textField</span><span class="p">:</span><span class="kt">UITextField</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>field used to locate and remove textField from validator.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>No return value</p>
|
||||
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator9Validator8validateFS0_FPS_18ValidationDelegate_T_"></a>
|
||||
<a name="//apple_ref/swift/Method/validate(_:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator9Validator8validateFS0_FPS_18ValidationDelegate_T_">validate(_:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>This method checks to see if all fields in validator are valid.</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">validate</span><span class="p">(</span><span class="nv">delegate</span><span class="p">:</span><span class="kt">ValidationDelegate</span><span class="p">)</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>No return value.</p>
|
||||
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator9Validator8validateFS0_FFT6errorsGVSs10DictionaryCSo11UITextFieldCS_15ValidationError__T_T_"></a>
|
||||
<a name="//apple_ref/swift/Method/validate(_:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator9Validator8validateFS0_FFT6errorsGVSs10DictionaryCSo11UITextFieldCS_15ValidationError__T_T_">validate(_:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>This method validates all fields in validator and sets any errors to errors parameter of callback.</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">validate</span><span class="p">(</span><span class="nv">callback</span><span class="p">:(</span><span class="nv">errors</span><span class="p">:[</span><span class="kt">UITextField</span><span class="p">:</span><span class="kt">ValidationError</span><span class="p">])</span><span class="o">-></span><span class="kt">Void</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>callback</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>A closure which is called with errors, a dictionary of type UITextField:ValidationError.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>No return value.</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-02-14)</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>
|
||||
|
|
@ -0,0 +1,173 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<title>ZipCodeRule 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/ZipCodeRule" class="dashAnchor"></a>
|
||||
<a title="ZipCodeRule 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" />
|
||||
ZipCodeRule 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/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/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>ZipCodeRule</h1>
|
||||
<div class="declaration">
|
||||
<div class="language">
|
||||
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">ZipCodeRule</span><span class="p">:</span> <span class="kt">RegexRule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<p><code>ZipCodeRule</code> is a subclass of <code><a href="../Classes/RegexRule.html">RegexRule</a></code> that represents how zip codes are to be validated.</p>
|
||||
|
||||
</section>
|
||||
<section class="section task-group-section">
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FC14SwiftValidator11ZipCodeRulecFMS0_FT7messageSS_S0_"></a>
|
||||
<a name="//apple_ref/swift/Method/init(message:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FC14SwiftValidator11ZipCodeRulecFMS0_FT7messageSS_S0_">init(message:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Initializes a <code><a href="../Classes/ZipCodeRule.html">ZipCodeRule</a></code> object.</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="n">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">message</span> <span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="s">"Enter a valid 5 digit zipcode"</span><span class="p">)</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>message</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>String that holds error message.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>An initialized 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>
|
||||
</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-02-14)</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>
|
||||
|
|
@ -0,0 +1,174 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<title>Protocols 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 title="Protocols 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" />
|
||||
Protocols 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/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/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>Protocols</h1>
|
||||
<p>The following protocols are available globally.</p>
|
||||
|
||||
</section>
|
||||
<section class="section task-group-section">
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:P14SwiftValidator4Rule"></a>
|
||||
<a name="//apple_ref/swift/Protocol/Rule" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:P14SwiftValidator4Rule">Rule</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>The <code>Rule</code> protocol declares the required methods for all objects that subscribe to it.</p>
|
||||
|
||||
<a href="Protocols/Rule.html" class="slightly-smaller">See more</a>
|
||||
</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">protocol</span> <span class="kt">Rule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:P14SwiftValidator18ValidationDelegate"></a>
|
||||
<a name="//apple_ref/swift/Protocol/ValidationDelegate" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:P14SwiftValidator18ValidationDelegate">ValidationDelegate</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Protocol for <code>ValidationDelegate</code> adherents, which comes with two required methods that are called depending on whether validation succeeded or failed.</p>
|
||||
|
||||
<a href="Protocols/ValidationDelegate.html" class="slightly-smaller">See more</a>
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">ValidationDelegate</span></code></pre>
|
||||
|
||||
</div>
|
||||
</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-02-14)</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>
|
||||
|
|
@ -0,0 +1,205 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<title>Rule Protocol 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/Protocol/Rule" class="dashAnchor"></a>
|
||||
<a title="Rule Protocol 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" />
|
||||
Rule Protocol 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/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/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>Rule</h1>
|
||||
<div class="declaration">
|
||||
<div class="language">
|
||||
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">Rule</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<p>The <code>Rule</code> protocol declares the required methods for all objects that subscribe to it.</p>
|
||||
|
||||
</section>
|
||||
<section class="section task-group-section">
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FP14SwiftValidator4Rule8validateuRq_S0__Fq_FSSSb"></a>
|
||||
<a name="//apple_ref/swift/Method/validate(_:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FP14SwiftValidator4Rule8validateuRq_S0__Fq_FSSSb">validate(_:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Validates text of a text 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">func</span> <span class="nf">validate</span><span class="p">(</span><span class="nv">value</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Bool</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>value</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>String of text to be validated.</p>
|
||||
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>Boolean value. True if validation is successful; False if validation fails.</p>
|
||||
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FP14SwiftValidator4Rule12errorMessageuRq_S0__Fq_FT_SS"></a>
|
||||
<a name="//apple_ref/swift/Method/errorMessage()" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FP14SwiftValidator4Rule12errorMessageuRq_S0__Fq_FT_SS">errorMessage()</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Displays error message of a text field that has failed validation.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight"><code><span class="kd">func</span> <span class="nf">errorMessage</span><span class="p">()</span> <span class="o">-></span> <span class="kt">String</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>String of error message.</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-02-14)</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>
|
||||
|
|
@ -0,0 +1,187 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<title>ValidationDelegate Protocol 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/Protocol/ValidationDelegate" class="dashAnchor"></a>
|
||||
<a title="ValidationDelegate Protocol 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" />
|
||||
ValidationDelegate Protocol 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/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/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>ValidationDelegate</h1>
|
||||
<div class="declaration">
|
||||
<div class="language">
|
||||
<pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">ValidationDelegate</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<p>Protocol for <code>ValidationDelegate</code> adherents, which comes with two required methods that are called depending on whether validation succeeded or failed.</p>
|
||||
|
||||
</section>
|
||||
<section class="section task-group-section">
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FP14SwiftValidator18ValidationDelegate20validationSuccessfuluRq_S0__Fq_FT_T_"></a>
|
||||
<a name="//apple_ref/swift/Method/validationSuccessful()" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FP14SwiftValidator18ValidationDelegate20validationSuccessfuluRq_S0__Fq_FT_T_">validationSuccessful()</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>This method will be called on delegate object when validation is successful.
|
||||
- returns: No return value.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight"><code><span class="kd">func</span> <span class="nf">validationSuccessful</span><span class="p">()</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>No return value.</p>
|
||||
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:FP14SwiftValidator18ValidationDelegate16validationFaileduRq_S0__Fq_FGVSs10DictionaryCSo11UITextFieldCS_15ValidationError_T_"></a>
|
||||
<a name="//apple_ref/swift/Method/validationFailed(_:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:FP14SwiftValidator18ValidationDelegate16validationFaileduRq_S0__Fq_FGVSs10DictionaryCSo11UITextFieldCS_15ValidationError_T_">validationFailed(_:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>This method will be called on delegate object when validation fails.
|
||||
- returns: No return value.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight"><code><span class="kd">func</span> <span class="nf">validationFailed</span><span class="p">(</span><span class="nv">errors</span><span class="p">:</span> <span class="p">[</span><span class="kt">UITextField</span><span class="p">:</span><span class="kt">ValidationError</span><span class="p">])</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>No return value.</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-02-14)</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>
|
||||
|
|
@ -0,0 +1,200 @@
|
|||
/* Credit to https://gist.github.com/wataru420/2048287 */
|
||||
.highlight {
|
||||
/* Comment */
|
||||
/* Error */
|
||||
/* Keyword */
|
||||
/* Operator */
|
||||
/* Comment.Multiline */
|
||||
/* Comment.Preproc */
|
||||
/* Comment.Single */
|
||||
/* Comment.Special */
|
||||
/* Generic.Deleted */
|
||||
/* Generic.Deleted.Specific */
|
||||
/* Generic.Emph */
|
||||
/* Generic.Error */
|
||||
/* Generic.Heading */
|
||||
/* Generic.Inserted */
|
||||
/* Generic.Inserted.Specific */
|
||||
/* Generic.Output */
|
||||
/* Generic.Prompt */
|
||||
/* Generic.Strong */
|
||||
/* Generic.Subheading */
|
||||
/* Generic.Traceback */
|
||||
/* Keyword.Constant */
|
||||
/* Keyword.Declaration */
|
||||
/* Keyword.Pseudo */
|
||||
/* Keyword.Reserved */
|
||||
/* Keyword.Type */
|
||||
/* Literal.Number */
|
||||
/* Literal.String */
|
||||
/* Name.Attribute */
|
||||
/* Name.Builtin */
|
||||
/* Name.Class */
|
||||
/* Name.Constant */
|
||||
/* Name.Entity */
|
||||
/* Name.Exception */
|
||||
/* Name.Function */
|
||||
/* Name.Namespace */
|
||||
/* Name.Tag */
|
||||
/* Name.Variable */
|
||||
/* Operator.Word */
|
||||
/* Text.Whitespace */
|
||||
/* Literal.Number.Float */
|
||||
/* Literal.Number.Hex */
|
||||
/* Literal.Number.Integer */
|
||||
/* Literal.Number.Oct */
|
||||
/* Literal.String.Backtick */
|
||||
/* Literal.String.Char */
|
||||
/* Literal.String.Doc */
|
||||
/* Literal.String.Double */
|
||||
/* Literal.String.Escape */
|
||||
/* Literal.String.Heredoc */
|
||||
/* Literal.String.Interpol */
|
||||
/* Literal.String.Other */
|
||||
/* Literal.String.Regex */
|
||||
/* Literal.String.Single */
|
||||
/* Literal.String.Symbol */
|
||||
/* Name.Builtin.Pseudo */
|
||||
/* Name.Variable.Class */
|
||||
/* Name.Variable.Global */
|
||||
/* Name.Variable.Instance */
|
||||
/* Literal.Number.Integer.Long */ }
|
||||
.highlight .c {
|
||||
color: #999988;
|
||||
font-style: italic; }
|
||||
.highlight .err {
|
||||
color: #a61717;
|
||||
background-color: #e3d2d2; }
|
||||
.highlight .k {
|
||||
color: #000000;
|
||||
font-weight: bold; }
|
||||
.highlight .o {
|
||||
color: #000000;
|
||||
font-weight: bold; }
|
||||
.highlight .cm {
|
||||
color: #999988;
|
||||
font-style: italic; }
|
||||
.highlight .cp {
|
||||
color: #999999;
|
||||
font-weight: bold; }
|
||||
.highlight .c1 {
|
||||
color: #999988;
|
||||
font-style: italic; }
|
||||
.highlight .cs {
|
||||
color: #999999;
|
||||
font-weight: bold;
|
||||
font-style: italic; }
|
||||
.highlight .gd {
|
||||
color: #000000;
|
||||
background-color: #ffdddd; }
|
||||
.highlight .gd .x {
|
||||
color: #000000;
|
||||
background-color: #ffaaaa; }
|
||||
.highlight .ge {
|
||||
color: #000000;
|
||||
font-style: italic; }
|
||||
.highlight .gr {
|
||||
color: #aa0000; }
|
||||
.highlight .gh {
|
||||
color: #999999; }
|
||||
.highlight .gi {
|
||||
color: #000000;
|
||||
background-color: #ddffdd; }
|
||||
.highlight .gi .x {
|
||||
color: #000000;
|
||||
background-color: #aaffaa; }
|
||||
.highlight .go {
|
||||
color: #888888; }
|
||||
.highlight .gp {
|
||||
color: #555555; }
|
||||
.highlight .gs {
|
||||
font-weight: bold; }
|
||||
.highlight .gu {
|
||||
color: #aaaaaa; }
|
||||
.highlight .gt {
|
||||
color: #aa0000; }
|
||||
.highlight .kc {
|
||||
color: #000000;
|
||||
font-weight: bold; }
|
||||
.highlight .kd {
|
||||
color: #000000;
|
||||
font-weight: bold; }
|
||||
.highlight .kp {
|
||||
color: #000000;
|
||||
font-weight: bold; }
|
||||
.highlight .kr {
|
||||
color: #000000;
|
||||
font-weight: bold; }
|
||||
.highlight .kt {
|
||||
color: #445588; }
|
||||
.highlight .m {
|
||||
color: #009999; }
|
||||
.highlight .s {
|
||||
color: #d14; }
|
||||
.highlight .na {
|
||||
color: #008080; }
|
||||
.highlight .nb {
|
||||
color: #0086B3; }
|
||||
.highlight .nc {
|
||||
color: #445588;
|
||||
font-weight: bold; }
|
||||
.highlight .no {
|
||||
color: #008080; }
|
||||
.highlight .ni {
|
||||
color: #800080; }
|
||||
.highlight .ne {
|
||||
color: #990000;
|
||||
font-weight: bold; }
|
||||
.highlight .nf {
|
||||
color: #990000; }
|
||||
.highlight .nn {
|
||||
color: #555555; }
|
||||
.highlight .nt {
|
||||
color: #000080; }
|
||||
.highlight .nv {
|
||||
color: #008080; }
|
||||
.highlight .ow {
|
||||
color: #000000;
|
||||
font-weight: bold; }
|
||||
.highlight .w {
|
||||
color: #bbbbbb; }
|
||||
.highlight .mf {
|
||||
color: #009999; }
|
||||
.highlight .mh {
|
||||
color: #009999; }
|
||||
.highlight .mi {
|
||||
color: #009999; }
|
||||
.highlight .mo {
|
||||
color: #009999; }
|
||||
.highlight .sb {
|
||||
color: #d14; }
|
||||
.highlight .sc {
|
||||
color: #d14; }
|
||||
.highlight .sd {
|
||||
color: #d14; }
|
||||
.highlight .s2 {
|
||||
color: #d14; }
|
||||
.highlight .se {
|
||||
color: #d14; }
|
||||
.highlight .sh {
|
||||
color: #d14; }
|
||||
.highlight .si {
|
||||
color: #d14; }
|
||||
.highlight .sx {
|
||||
color: #d14; }
|
||||
.highlight .sr {
|
||||
color: #009926; }
|
||||
.highlight .s1 {
|
||||
color: #d14; }
|
||||
.highlight .ss {
|
||||
color: #990073; }
|
||||
.highlight .bp {
|
||||
color: #999999; }
|
||||
.highlight .vc {
|
||||
color: #008080; }
|
||||
.highlight .vg {
|
||||
color: #008080; }
|
||||
.highlight .vi {
|
||||
color: #008080; }
|
||||
.highlight .il {
|
||||
color: #009999; }
|
||||
|
|
@ -0,0 +1,331 @@
|
|||
html, body, div, span, h1, h3, h4, p, a, code, em, img, ul, li, table, tbody, tr, td {
|
||||
background: transparent;
|
||||
border: 0;
|
||||
margin: 0;
|
||||
outline: 0;
|
||||
padding: 0;
|
||||
vertical-align: baseline; }
|
||||
|
||||
body {
|
||||
background-color: #f2f2f2;
|
||||
font-family: Helvetica, freesans, Arial, sans-serif;
|
||||
font-size: 14px;
|
||||
-webkit-font-smoothing: subpixel-antialiased;
|
||||
word-wrap: break-word; }
|
||||
|
||||
h1, h2, h3 {
|
||||
margin-top: 0.8em;
|
||||
margin-bottom: 0.3em;
|
||||
font-weight: 100;
|
||||
color: black; }
|
||||
|
||||
h1 {
|
||||
font-size: 2.5em; }
|
||||
|
||||
h2 {
|
||||
font-size: 2em;
|
||||
border-bottom: 1px solid #e2e2e2; }
|
||||
|
||||
h4 {
|
||||
font-size: 13px;
|
||||
line-height: 1.5;
|
||||
margin-top: 21px; }
|
||||
|
||||
h5 {
|
||||
font-size: 1.1em; }
|
||||
|
||||
h6 {
|
||||
font-size: 1.1em;
|
||||
color: #777; }
|
||||
|
||||
.section-name {
|
||||
color: gray;
|
||||
display: block;
|
||||
font-family: Helvetica;
|
||||
font-size: 22px;
|
||||
font-weight: 100;
|
||||
margin-bottom: 15px; }
|
||||
|
||||
pre, code {
|
||||
font: 0.95em Menlo, monospace;
|
||||
color: #777;
|
||||
word-wrap: normal; }
|
||||
|
||||
p code, li code {
|
||||
background-color: #eee;
|
||||
padding: 2px 4px;
|
||||
border-radius: 4px; }
|
||||
|
||||
a {
|
||||
color: #0088cc;
|
||||
text-decoration: none; }
|
||||
|
||||
ul {
|
||||
padding-left: 15px; }
|
||||
|
||||
li {
|
||||
line-height: 1.8em; }
|
||||
|
||||
img {
|
||||
max-width: 100%; }
|
||||
|
||||
blockquote {
|
||||
margin-left: 0;
|
||||
padding: 0 10px;
|
||||
border-left: 4px solid #ccc; }
|
||||
|
||||
.content-wrapper {
|
||||
margin: 0 auto;
|
||||
width: 980px; }
|
||||
|
||||
header {
|
||||
font-size: 0.85em;
|
||||
line-height: 26px;
|
||||
background-color: #414141;
|
||||
position: fixed;
|
||||
width: 100%;
|
||||
z-index: 1; }
|
||||
header img {
|
||||
padding-right: 6px;
|
||||
vertical-align: -4px;
|
||||
height: 16px; }
|
||||
header a {
|
||||
color: #fff; }
|
||||
header p {
|
||||
float: left;
|
||||
color: #999; }
|
||||
header .header-right {
|
||||
float: right;
|
||||
margin-left: 16px; }
|
||||
|
||||
#breadcrumbs {
|
||||
background-color: #f2f2f2;
|
||||
height: 27px;
|
||||
padding-top: 17px;
|
||||
position: fixed;
|
||||
width: 100%;
|
||||
z-index: 1;
|
||||
margin-top: 26px; }
|
||||
#breadcrumbs #carat {
|
||||
height: 10px;
|
||||
margin: 0 5px; }
|
||||
|
||||
.sidebar {
|
||||
background-color: #f9f9f9;
|
||||
border: 1px solid #e2e2e2;
|
||||
overflow-y: auto;
|
||||
overflow-x: hidden;
|
||||
position: fixed;
|
||||
top: 70px;
|
||||
bottom: 0;
|
||||
width: 230px;
|
||||
word-wrap: normal; }
|
||||
|
||||
.nav-groups {
|
||||
list-style-type: none;
|
||||
background: #fff;
|
||||
padding-left: 0; }
|
||||
|
||||
.nav-group-name {
|
||||
border-bottom: 1px solid #e2e2e2;
|
||||
font-size: 1.1em;
|
||||
font-weight: 100;
|
||||
padding: 15px 0 15px 20px; }
|
||||
.nav-group-name > a {
|
||||
color: #333; }
|
||||
|
||||
.nav-group-tasks {
|
||||
margin-top: 5px; }
|
||||
|
||||
.nav-group-task {
|
||||
font-size: 0.9em;
|
||||
list-style-type: none; }
|
||||
.nav-group-task a {
|
||||
color: #888; }
|
||||
|
||||
.main-content {
|
||||
background-color: #fff;
|
||||
border: 1px solid #e2e2e2;
|
||||
margin-left: 246px;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
padding-bottom: 60px;
|
||||
top: 70px;
|
||||
width: 734px; }
|
||||
.main-content p, .main-content a, .main-content code, .main-content em, .main-content ul, .main-content table, .main-content blockquote {
|
||||
margin-bottom: 1em; }
|
||||
.main-content p {
|
||||
line-height: 1.8em; }
|
||||
.main-content section .section:first-child {
|
||||
margin-top: 0;
|
||||
padding-top: 0; }
|
||||
.main-content section .task-group-section .task-group:first-of-type {
|
||||
padding-top: 10px; }
|
||||
.main-content section .task-group-section .task-group:first-of-type .section-name {
|
||||
padding-top: 15px; }
|
||||
|
||||
.section {
|
||||
padding: 0 25px; }
|
||||
|
||||
.highlight {
|
||||
background-color: #eee;
|
||||
padding: 10px 12px;
|
||||
border: 1px solid #e2e2e2;
|
||||
border-radius: 4px;
|
||||
overflow-x: auto; }
|
||||
|
||||
.declaration .highlight {
|
||||
overflow-x: initial;
|
||||
padding: 0 40px 40px 0;
|
||||
margin-bottom: -25px;
|
||||
background-color: transparent;
|
||||
border: none; }
|
||||
|
||||
.section-name {
|
||||
margin: 0;
|
||||
margin-left: 18px; }
|
||||
|
||||
.task-group-section {
|
||||
padding-left: 6px;
|
||||
border-top: 1px solid #e2e2e2; }
|
||||
|
||||
.task-group {
|
||||
padding-top: 0px; }
|
||||
|
||||
.task-name-container a[name]:before {
|
||||
content: "";
|
||||
display: block;
|
||||
padding-top: 70px;
|
||||
margin: -70px 0 0; }
|
||||
|
||||
.item {
|
||||
padding-top: 8px;
|
||||
width: 100%;
|
||||
list-style-type: none; }
|
||||
.item a[name]:before {
|
||||
content: "";
|
||||
display: block;
|
||||
padding-top: 70px;
|
||||
margin: -70px 0 0; }
|
||||
.item code {
|
||||
background-color: transparent;
|
||||
padding: 0; }
|
||||
.item .token {
|
||||
padding-left: 3px;
|
||||
margin-left: 15px;
|
||||
font-size: 11.9px; }
|
||||
.item .declaration-note {
|
||||
font-size: .85em;
|
||||
color: gray;
|
||||
font-style: italic; }
|
||||
|
||||
.pointer-container {
|
||||
border-bottom: 1px solid #e2e2e2;
|
||||
left: -23px;
|
||||
padding-bottom: 13px;
|
||||
position: relative;
|
||||
width: 110%; }
|
||||
|
||||
.pointer {
|
||||
background: #f9f9f9;
|
||||
border-left: 1px solid #e2e2e2;
|
||||
border-top: 1px solid #e2e2e2;
|
||||
height: 12px;
|
||||
left: 21px;
|
||||
top: -7px;
|
||||
-webkit-transform: rotate(45deg);
|
||||
-moz-transform: rotate(45deg);
|
||||
-o-transform: rotate(45deg);
|
||||
transform: rotate(45deg);
|
||||
position: absolute;
|
||||
width: 12px; }
|
||||
|
||||
.height-container {
|
||||
display: none;
|
||||
left: -25px;
|
||||
padding: 0 25px;
|
||||
position: relative;
|
||||
width: 100%;
|
||||
overflow: hidden; }
|
||||
.height-container .section {
|
||||
background: #f9f9f9;
|
||||
border-bottom: 1px solid #e2e2e2;
|
||||
left: -25px;
|
||||
position: relative;
|
||||
width: 100%;
|
||||
padding-top: 10px;
|
||||
padding-bottom: 5px; }
|
||||
|
||||
.aside, .language {
|
||||
padding: 6px 12px;
|
||||
margin: 12px 0;
|
||||
border-left: 5px solid #dddddd;
|
||||
overflow-y: hidden; }
|
||||
.aside .aside-title, .language .aside-title {
|
||||
font-size: 9px;
|
||||
letter-spacing: 2px;
|
||||
text-transform: uppercase;
|
||||
padding-bottom: 0;
|
||||
margin: 0;
|
||||
color: #aaa;
|
||||
-webkit-user-select: none; }
|
||||
.aside p:last-child, .language p:last-child {
|
||||
margin-bottom: 0; }
|
||||
|
||||
.language {
|
||||
border-left: 5px solid #cde9f4; }
|
||||
.language .aside-title {
|
||||
color: #4b8afb; }
|
||||
|
||||
.aside-warning {
|
||||
border-left: 5px solid #ff6666; }
|
||||
.aside-warning .aside-title {
|
||||
color: #ff0000; }
|
||||
|
||||
.graybox {
|
||||
border-collapse: collapse;
|
||||
width: 100%; }
|
||||
.graybox p {
|
||||
margin: 0;
|
||||
word-break: break-word;
|
||||
min-width: 50px; }
|
||||
.graybox td {
|
||||
border: 1px solid #e2e2e2;
|
||||
padding: 5px 25px 5px 10px;
|
||||
vertical-align: middle; }
|
||||
.graybox tr td:first-of-type {
|
||||
text-align: right;
|
||||
padding: 7px;
|
||||
vertical-align: top;
|
||||
word-break: normal;
|
||||
width: 40px; }
|
||||
|
||||
.slightly-smaller {
|
||||
font-size: 0.9em; }
|
||||
|
||||
#footer {
|
||||
position: absolute;
|
||||
bottom: 10px;
|
||||
margin-left: 25px; }
|
||||
#footer p {
|
||||
margin: 0;
|
||||
color: #aaa;
|
||||
font-size: 0.8em; }
|
||||
|
||||
html.dash header, html.dash #breadcrumbs, html.dash .sidebar {
|
||||
display: none; }
|
||||
html.dash .main-content {
|
||||
width: 980px;
|
||||
margin-left: 0;
|
||||
border: none;
|
||||
width: 100%;
|
||||
top: 0;
|
||||
padding-bottom: 0; }
|
||||
html.dash .height-container {
|
||||
display: block; }
|
||||
html.dash .item .token {
|
||||
margin-left: 0; }
|
||||
html.dash .content-wrapper {
|
||||
width: auto; }
|
||||
html.dash #footer {
|
||||
position: static; }
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 274 B |
Binary file not shown.
|
After Width: | Height: | Size: 1.3 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 1.5 KiB |
|
|
@ -0,0 +1,240 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<title>SwiftValidator 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 title="SwiftValidator 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" />
|
||||
SwiftValidator 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/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/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">
|
||||
|
||||
<a href='#swiftvalidator' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h1 id='swiftvalidator'>SwiftValidator</h1>
|
||||
|
||||
<p><a href="https://travis-ci.org/jpotts18/SwiftValidator"><img src="https://travis-ci.org/jpotts18/SwiftValidator.svg?branch=travis-ci" alt="Build Status"></a> <a href="https://github.com/Carthage/Carthage"><img src="https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat" alt="Carthage compatible"></a></p>
|
||||
|
||||
<p>Swift Validator is a rule-based validation library for Swift.</p>
|
||||
|
||||
<p><img src="/swift-validator-v2.gif" alt="Swift Validator"></p>
|
||||
<a href='#core_concepts' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h2 id='core_concepts'>Core Concepts</h2>
|
||||
|
||||
<ul>
|
||||
<li><code>UITextField</code> + <code>[Rule]</code> + (and optional error <code>UILabel</code>) go into <code>Validator</code></li>
|
||||
<li><code>UITextField</code> + <code>ValidationError</code> come out of <code>Validator</code></li>
|
||||
<li><code>Validator</code> evaluates <code>[Rule]</code> sequentially and stops evaluating when a <code>Rule</code> fails.</li>
|
||||
</ul>
|
||||
<a href='#installation' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h2 id='installation'>Installation</h2>
|
||||
<pre class="highlight ruby"><code><span class="c1"># Podfile</span>
|
||||
<span class="n">source</span> <span class="s1">'https://github.com/CocoaPods/Specs.git'</span>
|
||||
<span class="n">platform</span> <span class="ss">:ios</span><span class="p">,</span> <span class="s2">"8.1"</span>
|
||||
|
||||
<span class="n">use_frameworks!</span>
|
||||
<span class="n">pod</span> <span class="s1">'SwiftValidator'</span><span class="p">,</span> <span class="s1">'3.0.3'</span>
|
||||
</code></pre>
|
||||
|
||||
<p>Install into your project:</p>
|
||||
<pre class="highlight shell"><code><span class="gp">$ </span>pod install
|
||||
</code></pre>
|
||||
|
||||
<p>Open your project in Xcode from the .xcworkspace file (not the usual project file):</p>
|
||||
<pre class="highlight shell"><code><span class="gp">$ </span>open MyProject.xcworkspace
|
||||
</code></pre>
|
||||
|
||||
<p>If you are using Carthage you will need to add this to your <code>Cartfile</code></p>
|
||||
<pre class="highlight shell"><code>github <span class="s2">"jpotts18/SwiftValidator"</span>
|
||||
</code></pre>
|
||||
<a href='#usage' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h2 id='usage'>Usage</h2>
|
||||
|
||||
<p>You can now import SwiftValidator framework into your files.</p>
|
||||
|
||||
<p>Initialize the <code>Validator</code> by setting a delegate to a View Controller or other object.</p>
|
||||
<pre class="highlight swift"><code><span class="c1">// ViewController.swift</span>
|
||||
<span class="k">let</span> <span class="nv">validator</span> <span class="o">=</span> <span class="kt">Validator</span><span class="p">()</span>
|
||||
</code></pre>
|
||||
|
||||
<p>Register the fields that you want to validate</p>
|
||||
<pre class="highlight swift"><code><span class="k">override</span> <span class="kd">func</span> <span class="nf">viewDidLoad</span><span class="p">()</span> <span class="p">{</span>
|
||||
<span class="k">super</span><span class="o">.</span><span class="nf">viewDidLoad</span><span class="p">()</span>
|
||||
|
||||
<span class="c1">// Validation Rules are evaluated from left to right.</span>
|
||||
<span class="n">validator</span><span class="o">.</span><span class="nf">registerField</span><span class="p">(</span><span class="n">fullNameTextField</span><span class="p">,</span> <span class="nv">rules</span><span class="p">:</span> <span class="p">[</span><span class="kt">RequiredRule</span><span class="p">(),</span> <span class="kt">FullNameRule</span><span class="p">()])</span>
|
||||
|
||||
<span class="c1">// You can pass in error labels with your rules</span>
|
||||
<span class="c1">// You can pass in custom error messages to regex rules (such as ZipCodeRule and EmailRule)</span>
|
||||
<span class="n">validator</span><span class="o">.</span><span class="nf">registerField</span><span class="p">(</span><span class="n">emailTextField</span><span class="p">,</span> <span class="nv">errorLabel</span><span class="p">:</span> <span class="n">emailErrorLabel</span><span class="p">,</span> <span class="nv">rules</span><span class="p">:</span> <span class="p">[</span><span class="kt">RequiredRule</span><span class="p">(),</span> <span class="kt">EmailRule</span><span class="p">(</span><span class="nv">message</span><span class="p">:</span> <span class="s">"Invalid email"</span><span class="p">)])</span>
|
||||
|
||||
<span class="c1">// You can validate against other fields using ConfirmRule</span>
|
||||
<span class="n">validator</span><span class="o">.</span><span class="nf">registerField</span><span class="p">(</span><span class="n">emailConfirmTextField</span><span class="p">,</span> <span class="nv">errorLabel</span><span class="p">:</span> <span class="n">emailConfirmErrorLabel</span><span class="p">,</span> <span class="nv">rules</span><span class="p">:</span> <span class="p">[</span><span class="kt">ConfirmationRule</span><span class="p">(</span><span class="nv">confirmField</span><span class="p">:</span> <span class="n">emailTextField</span><span class="p">)])</span>
|
||||
|
||||
<span class="c1">// You can now pass in regex and length parameters through overloaded contructors</span>
|
||||
<span class="n">validator</span><span class="o">.</span><span class="nf">registerField</span><span class="p">(</span><span class="n">phoneNumberTextField</span><span class="p">,</span> <span class="nv">errorLabel</span><span class="p">:</span> <span class="n">phoneNumberErrorLabel</span><span class="p">,</span> <span class="nv">rules</span><span class="p">:</span> <span class="p">[</span><span class="kt">RequiredRule</span><span class="p">(),</span> <span class="kt">MinLengthRule</span><span class="p">(</span><span class="nv">length</span><span class="p">:</span> <span class="mi">9</span><span class="p">)])</span>
|
||||
<span class="n">validator</span><span class="o">.</span><span class="nf">registerField</span><span class="p">(</span><span class="n">zipcodeTextField</span><span class="p">,</span> <span class="nv">errorLabel</span><span class="p">:</span> <span class="n">zipcodeErrorLabel</span><span class="p">,</span> <span class="nv">rules</span><span class="p">:</span> <span class="p">[</span><span class="kt">RequiredRule</span><span class="p">(),</span> <span class="kt">ZipCodeRule</span><span class="p">(</span><span class="n">regex</span> <span class="o">=</span> <span class="s">"</span><span class="se">\\</span><span class="s">d{5}"</span><span class="p">)])</span>
|
||||
|
||||
<span class="c1">// You can unregister a text field if you no longer want to validate it</span>
|
||||
<span class="n">validator</span><span class="o">.</span><span class="nf">unregisterField</span><span class="p">(</span><span class="n">fullNameTextField</span><span class="p">)</span>
|
||||
<span class="p">}</span>
|
||||
</code></pre>
|
||||
|
||||
<p>Validate Fields on button tap or however you would like to trigger it. </p>
|
||||
<pre class="highlight swift"><code><span class="kd">@IBAction</span> <span class="kd">func</span> <span class="nf">signupTapped</span><span class="p">(</span><span class="nv">sender</span><span class="p">:</span> <span class="kt">AnyObject</span><span class="p">)</span> <span class="p">{</span>
|
||||
<span class="n">validator</span><span class="o">.</span><span class="nf">validate</span><span class="p">(</span><span class="nv">delegate</span><span class="p">:</span><span class="k">self</span><span class="p">)</span>
|
||||
<span class="p">}</span>
|
||||
</code></pre>
|
||||
|
||||
<p>Implement the Validation Delegate in your View controller</p>
|
||||
<pre class="highlight swift"><code><span class="c1">// ValidationDelegate methods</span>
|
||||
|
||||
<span class="kd">func</span> <span class="nf">validationSuccessful</span><span class="p">()</span> <span class="p">{</span>
|
||||
<span class="c1">// submit the form</span>
|
||||
<span class="p">}</span>
|
||||
|
||||
<span class="kd">func</span> <span class="nf">validationFailed</span><span class="p">(</span><span class="nv">errors</span><span class="p">:[</span><span class="kt">UITextField</span><span class="p">:</span><span class="kt">ValidationError</span><span class="p">])</span> <span class="p">{</span>
|
||||
<span class="c1">// turn the fields to red</span>
|
||||
<span class="k">for</span> <span class="p">(</span><span class="n">field</span><span class="p">,</span> <span class="n">error</span><span class="p">)</span> <span class="k">in</span> <span class="n">validator</span><span class="o">.</span><span class="n">errors</span> <span class="p">{</span>
|
||||
<span class="n">field</span><span class="o">.</span><span class="n">layer</span><span class="o">.</span><span class="n">borderColor</span> <span class="o">=</span> <span class="kt">UIColor</span><span class="o">.</span><span class="nf">redColor</span><span class="p">()</span><span class="o">.</span><span class="kt">CGColor</span>
|
||||
<span class="n">field</span><span class="o">.</span><span class="n">layer</span><span class="o">.</span><span class="n">borderWidth</span> <span class="o">=</span> <span class="mf">1.0</span>
|
||||
<span class="n">error</span><span class="o">.</span><span class="n">errorLabel</span><span class="p">?</span><span class="o">.</span><span class="n">text</span> <span class="o">=</span> <span class="n">error</span><span class="o">.</span><span class="n">errorMessage</span> <span class="c1">// works if you added labels</span>
|
||||
<span class="n">error</span><span class="o">.</span><span class="n">errorLabel</span><span class="p">?</span><span class="o">.</span><span class="n">hidden</span> <span class="o">=</span> <span class="kc">false</span>
|
||||
<span class="p">}</span>
|
||||
<span class="p">}</span>
|
||||
|
||||
</code></pre>
|
||||
<a href='#single_field_validation' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h3 id='single_field_validation'>Single Field Validation</h3>
|
||||
|
||||
<p>You may use single field validation in some cases. This could be useful in situations such as controlling responders:</p>
|
||||
<pre class="highlight swift"><code><span class="c1">// Don't forget to use UITextFieldDelegate</span>
|
||||
<span class="c1">// and delegate yourTextField to self in viewDidLoad()</span>
|
||||
<span class="kd">func</span> <span class="nf">textFieldShouldReturn</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="o">-></span> <span class="kt">Bool</span> <span class="p">{</span>
|
||||
<span class="n">validator</span><span class="o">.</span><span class="nf">validateField</span><span class="p">(</span><span class="n">textField</span><span class="p">){</span> <span class="n">error</span> <span class="k">in</span>
|
||||
<span class="k">if</span> <span class="n">error</span> <span class="o">==</span> <span class="kc">nil</span> <span class="p">{</span>
|
||||
<span class="c1">// Field validation was successful</span>
|
||||
<span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
|
||||
<span class="c1">// Validation error occurred</span>
|
||||
<span class="p">}</span>
|
||||
<span class="p">}</span>
|
||||
<span class="k">return</span> <span class="kc">true</span>
|
||||
<span class="p">}</span>
|
||||
</code></pre>
|
||||
<a href='#custom_validation' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h2 id='custom_validation'>Custom Validation</h2>
|
||||
|
||||
<p>We will create a <code>SSNRule</code> class to show how to create your own Validation. A United States Social Security Number (or SSN) is a field that consists of XXX-XX-XXXX. </p>
|
||||
|
||||
<p>Create a class that inherits from RegexRule</p>
|
||||
<pre class="highlight swift"><code>
|
||||
<span class="kd">class</span> <span class="kt">SSNVRule</span><span class="p">:</span> <span class="kt">RegexRule</span> <span class="p">{</span>
|
||||
|
||||
<span class="kd">static</span> <span class="k">let</span> <span class="nv">regex</span> <span class="o">=</span> <span class="s">"^</span><span class="se">\\</span><span class="s">d{3}-</span><span class="se">\\</span><span class="s">d{2}-</span><span class="se">\\</span><span class="s">d{4}$"</span>
|
||||
|
||||
<span class="n">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">message</span> <span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="s">"Not a valid SSN"</span><span class="p">){</span>
|
||||
<span class="k">self</span><span class="o">.</span><span class="nf">init</span><span class="p">(</span><span class="nv">regex</span><span class="p">:</span> <span class="kt">SSNVRule</span><span class="o">.</span><span class="n">regex</span><span class="p">,</span> <span class="nv">message</span> <span class="p">:</span> <span class="n">message</span><span class="p">)</span>
|
||||
<span class="p">}</span>
|
||||
<span class="p">}</span>
|
||||
</code></pre>
|
||||
<a href='#credits' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h2 id='credits'>Credits</h2>
|
||||
|
||||
<p>Swift Validator is written and maintained by Jeff Potter <a href="http://twitter.com/jpotts18">@jpotts18</a>.</p>
|
||||
<a href='#contributing' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h2 id='contributing'>Contributing</h2>
|
||||
|
||||
<ol>
|
||||
<li><a href="https://github.com/jpotts18/SwiftValidator/fork">Fork it</a></li>
|
||||
<li>Create your feature branch <code>git checkout -b my-new-feature</code></li>
|
||||
<li>Commit your changes <code>git commit -am 'Add some feature'</code></li>
|
||||
<li>Push to the branch <code>git push origin my-new-feature</code></li>
|
||||
<li>Create a new Pull Request</li>
|
||||
</ol>
|
||||
|
||||
</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-02-14)</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>
|
||||
|
|
@ -0,0 +1,40 @@
|
|||
window.jazzy = {'docset': false}
|
||||
if (typeof window.dash != 'undefined') {
|
||||
document.documentElement.className += ' dash'
|
||||
window.jazzy.docset = true
|
||||
}
|
||||
if (navigator.userAgent.match(/xcode/i)) {
|
||||
document.documentElement.className += ' xcode'
|
||||
window.jazzy.docset = true
|
||||
}
|
||||
|
||||
// On doc load, toggle the URL hash discussion if present
|
||||
$(document).ready(function() {
|
||||
if (!window.jazzy.docset) {
|
||||
var linkToHash = $('a[href="' + window.location.hash +'"]');
|
||||
linkToHash.trigger("click");
|
||||
}
|
||||
});
|
||||
|
||||
// On token click, toggle its discussion and animate token.marginLeft
|
||||
$(".token").click(function(event) {
|
||||
if (window.jazzy.docset) {
|
||||
return;
|
||||
}
|
||||
var link = $(this);
|
||||
var animationDuration = 300;
|
||||
var tokenOffset = "15px";
|
||||
var original = link.css('marginLeft') == tokenOffset;
|
||||
link.animate({'margin-left':original ? "0px" : tokenOffset}, animationDuration);
|
||||
$content = link.parent().parent().next();
|
||||
$content.slideToggle(animationDuration);
|
||||
|
||||
// Keeps the document from jumping to the hash.
|
||||
var href = $(this).attr('href');
|
||||
if (history.pushState) {
|
||||
history.pushState({}, '', href);
|
||||
} else {
|
||||
location.hash = href;
|
||||
}
|
||||
event.preventDefault();
|
||||
});
|
||||
4
docsets/SwiftValidator.docset/Contents/Resources/Documents/js/jquery.min.js
vendored
Executable file
4
docsets/SwiftValidator.docset/Contents/Resources/Documents/js/jquery.min.js
vendored
Executable file
File diff suppressed because one or more lines are too long
Binary file not shown.
Binary file not shown.
Binary file not shown.
|
After Width: | Height: | Size: 274 B |
Binary file not shown.
|
After Width: | Height: | Size: 1.3 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 1.5 KiB |
241
index.html
241
index.html
|
|
@ -1 +1,240 @@
|
|||
<h1>SwiftValidator</h1>
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<title>SwiftValidator 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 title="SwiftValidator 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" />
|
||||
SwiftValidator 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/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/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">
|
||||
|
||||
<a href='#swiftvalidator' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h1 id='swiftvalidator'>SwiftValidator</h1>
|
||||
|
||||
<p><a href="https://travis-ci.org/jpotts18/SwiftValidator"><img src="https://travis-ci.org/jpotts18/SwiftValidator.svg?branch=travis-ci" alt="Build Status"></a> <a href="https://github.com/Carthage/Carthage"><img src="https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat" alt="Carthage compatible"></a></p>
|
||||
|
||||
<p>Swift Validator is a rule-based validation library for Swift.</p>
|
||||
|
||||
<p><img src="/swift-validator-v2.gif" alt="Swift Validator"></p>
|
||||
<a href='#core_concepts' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h2 id='core_concepts'>Core Concepts</h2>
|
||||
|
||||
<ul>
|
||||
<li><code>UITextField</code> + <code>[Rule]</code> + (and optional error <code>UILabel</code>) go into <code>Validator</code></li>
|
||||
<li><code>UITextField</code> + <code>ValidationError</code> come out of <code>Validator</code></li>
|
||||
<li><code>Validator</code> evaluates <code>[Rule]</code> sequentially and stops evaluating when a <code>Rule</code> fails.</li>
|
||||
</ul>
|
||||
<a href='#installation' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h2 id='installation'>Installation</h2>
|
||||
<pre class="highlight ruby"><code><span class="c1"># Podfile</span>
|
||||
<span class="n">source</span> <span class="s1">'https://github.com/CocoaPods/Specs.git'</span>
|
||||
<span class="n">platform</span> <span class="ss">:ios</span><span class="p">,</span> <span class="s2">"8.1"</span>
|
||||
|
||||
<span class="n">use_frameworks!</span>
|
||||
<span class="n">pod</span> <span class="s1">'SwiftValidator'</span><span class="p">,</span> <span class="s1">'3.0.3'</span>
|
||||
</code></pre>
|
||||
|
||||
<p>Install into your project:</p>
|
||||
<pre class="highlight shell"><code><span class="gp">$ </span>pod install
|
||||
</code></pre>
|
||||
|
||||
<p>Open your project in Xcode from the .xcworkspace file (not the usual project file):</p>
|
||||
<pre class="highlight shell"><code><span class="gp">$ </span>open MyProject.xcworkspace
|
||||
</code></pre>
|
||||
|
||||
<p>If you are using Carthage you will need to add this to your <code>Cartfile</code></p>
|
||||
<pre class="highlight shell"><code>github <span class="s2">"jpotts18/SwiftValidator"</span>
|
||||
</code></pre>
|
||||
<a href='#usage' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h2 id='usage'>Usage</h2>
|
||||
|
||||
<p>You can now import SwiftValidator framework into your files.</p>
|
||||
|
||||
<p>Initialize the <code>Validator</code> by setting a delegate to a View Controller or other object.</p>
|
||||
<pre class="highlight swift"><code><span class="c1">// ViewController.swift</span>
|
||||
<span class="k">let</span> <span class="nv">validator</span> <span class="o">=</span> <span class="kt">Validator</span><span class="p">()</span>
|
||||
</code></pre>
|
||||
|
||||
<p>Register the fields that you want to validate</p>
|
||||
<pre class="highlight swift"><code><span class="k">override</span> <span class="kd">func</span> <span class="nf">viewDidLoad</span><span class="p">()</span> <span class="p">{</span>
|
||||
<span class="k">super</span><span class="o">.</span><span class="nf">viewDidLoad</span><span class="p">()</span>
|
||||
|
||||
<span class="c1">// Validation Rules are evaluated from left to right.</span>
|
||||
<span class="n">validator</span><span class="o">.</span><span class="nf">registerField</span><span class="p">(</span><span class="n">fullNameTextField</span><span class="p">,</span> <span class="nv">rules</span><span class="p">:</span> <span class="p">[</span><span class="kt">RequiredRule</span><span class="p">(),</span> <span class="kt">FullNameRule</span><span class="p">()])</span>
|
||||
|
||||
<span class="c1">// You can pass in error labels with your rules</span>
|
||||
<span class="c1">// You can pass in custom error messages to regex rules (such as ZipCodeRule and EmailRule)</span>
|
||||
<span class="n">validator</span><span class="o">.</span><span class="nf">registerField</span><span class="p">(</span><span class="n">emailTextField</span><span class="p">,</span> <span class="nv">errorLabel</span><span class="p">:</span> <span class="n">emailErrorLabel</span><span class="p">,</span> <span class="nv">rules</span><span class="p">:</span> <span class="p">[</span><span class="kt">RequiredRule</span><span class="p">(),</span> <span class="kt">EmailRule</span><span class="p">(</span><span class="nv">message</span><span class="p">:</span> <span class="s">"Invalid email"</span><span class="p">)])</span>
|
||||
|
||||
<span class="c1">// You can validate against other fields using ConfirmRule</span>
|
||||
<span class="n">validator</span><span class="o">.</span><span class="nf">registerField</span><span class="p">(</span><span class="n">emailConfirmTextField</span><span class="p">,</span> <span class="nv">errorLabel</span><span class="p">:</span> <span class="n">emailConfirmErrorLabel</span><span class="p">,</span> <span class="nv">rules</span><span class="p">:</span> <span class="p">[</span><span class="kt">ConfirmationRule</span><span class="p">(</span><span class="nv">confirmField</span><span class="p">:</span> <span class="n">emailTextField</span><span class="p">)])</span>
|
||||
|
||||
<span class="c1">// You can now pass in regex and length parameters through overloaded contructors</span>
|
||||
<span class="n">validator</span><span class="o">.</span><span class="nf">registerField</span><span class="p">(</span><span class="n">phoneNumberTextField</span><span class="p">,</span> <span class="nv">errorLabel</span><span class="p">:</span> <span class="n">phoneNumberErrorLabel</span><span class="p">,</span> <span class="nv">rules</span><span class="p">:</span> <span class="p">[</span><span class="kt">RequiredRule</span><span class="p">(),</span> <span class="kt">MinLengthRule</span><span class="p">(</span><span class="nv">length</span><span class="p">:</span> <span class="mi">9</span><span class="p">)])</span>
|
||||
<span class="n">validator</span><span class="o">.</span><span class="nf">registerField</span><span class="p">(</span><span class="n">zipcodeTextField</span><span class="p">,</span> <span class="nv">errorLabel</span><span class="p">:</span> <span class="n">zipcodeErrorLabel</span><span class="p">,</span> <span class="nv">rules</span><span class="p">:</span> <span class="p">[</span><span class="kt">RequiredRule</span><span class="p">(),</span> <span class="kt">ZipCodeRule</span><span class="p">(</span><span class="n">regex</span> <span class="o">=</span> <span class="s">"</span><span class="se">\\</span><span class="s">d{5}"</span><span class="p">)])</span>
|
||||
|
||||
<span class="c1">// You can unregister a text field if you no longer want to validate it</span>
|
||||
<span class="n">validator</span><span class="o">.</span><span class="nf">unregisterField</span><span class="p">(</span><span class="n">fullNameTextField</span><span class="p">)</span>
|
||||
<span class="p">}</span>
|
||||
</code></pre>
|
||||
|
||||
<p>Validate Fields on button tap or however you would like to trigger it. </p>
|
||||
<pre class="highlight swift"><code><span class="kd">@IBAction</span> <span class="kd">func</span> <span class="nf">signupTapped</span><span class="p">(</span><span class="nv">sender</span><span class="p">:</span> <span class="kt">AnyObject</span><span class="p">)</span> <span class="p">{</span>
|
||||
<span class="n">validator</span><span class="o">.</span><span class="nf">validate</span><span class="p">(</span><span class="nv">delegate</span><span class="p">:</span><span class="k">self</span><span class="p">)</span>
|
||||
<span class="p">}</span>
|
||||
</code></pre>
|
||||
|
||||
<p>Implement the Validation Delegate in your View controller</p>
|
||||
<pre class="highlight swift"><code><span class="c1">// ValidationDelegate methods</span>
|
||||
|
||||
<span class="kd">func</span> <span class="nf">validationSuccessful</span><span class="p">()</span> <span class="p">{</span>
|
||||
<span class="c1">// submit the form</span>
|
||||
<span class="p">}</span>
|
||||
|
||||
<span class="kd">func</span> <span class="nf">validationFailed</span><span class="p">(</span><span class="nv">errors</span><span class="p">:[</span><span class="kt">UITextField</span><span class="p">:</span><span class="kt">ValidationError</span><span class="p">])</span> <span class="p">{</span>
|
||||
<span class="c1">// turn the fields to red</span>
|
||||
<span class="k">for</span> <span class="p">(</span><span class="n">field</span><span class="p">,</span> <span class="n">error</span><span class="p">)</span> <span class="k">in</span> <span class="n">validator</span><span class="o">.</span><span class="n">errors</span> <span class="p">{</span>
|
||||
<span class="n">field</span><span class="o">.</span><span class="n">layer</span><span class="o">.</span><span class="n">borderColor</span> <span class="o">=</span> <span class="kt">UIColor</span><span class="o">.</span><span class="nf">redColor</span><span class="p">()</span><span class="o">.</span><span class="kt">CGColor</span>
|
||||
<span class="n">field</span><span class="o">.</span><span class="n">layer</span><span class="o">.</span><span class="n">borderWidth</span> <span class="o">=</span> <span class="mf">1.0</span>
|
||||
<span class="n">error</span><span class="o">.</span><span class="n">errorLabel</span><span class="p">?</span><span class="o">.</span><span class="n">text</span> <span class="o">=</span> <span class="n">error</span><span class="o">.</span><span class="n">errorMessage</span> <span class="c1">// works if you added labels</span>
|
||||
<span class="n">error</span><span class="o">.</span><span class="n">errorLabel</span><span class="p">?</span><span class="o">.</span><span class="n">hidden</span> <span class="o">=</span> <span class="kc">false</span>
|
||||
<span class="p">}</span>
|
||||
<span class="p">}</span>
|
||||
|
||||
</code></pre>
|
||||
<a href='#single_field_validation' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h3 id='single_field_validation'>Single Field Validation</h3>
|
||||
|
||||
<p>You may use single field validation in some cases. This could be useful in situations such as controlling responders:</p>
|
||||
<pre class="highlight swift"><code><span class="c1">// Don't forget to use UITextFieldDelegate</span>
|
||||
<span class="c1">// and delegate yourTextField to self in viewDidLoad()</span>
|
||||
<span class="kd">func</span> <span class="nf">textFieldShouldReturn</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="o">-></span> <span class="kt">Bool</span> <span class="p">{</span>
|
||||
<span class="n">validator</span><span class="o">.</span><span class="nf">validateField</span><span class="p">(</span><span class="n">textField</span><span class="p">){</span> <span class="n">error</span> <span class="k">in</span>
|
||||
<span class="k">if</span> <span class="n">error</span> <span class="o">==</span> <span class="kc">nil</span> <span class="p">{</span>
|
||||
<span class="c1">// Field validation was successful</span>
|
||||
<span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
|
||||
<span class="c1">// Validation error occurred</span>
|
||||
<span class="p">}</span>
|
||||
<span class="p">}</span>
|
||||
<span class="k">return</span> <span class="kc">true</span>
|
||||
<span class="p">}</span>
|
||||
</code></pre>
|
||||
<a href='#custom_validation' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h2 id='custom_validation'>Custom Validation</h2>
|
||||
|
||||
<p>We will create a <code>SSNRule</code> class to show how to create your own Validation. A United States Social Security Number (or SSN) is a field that consists of XXX-XX-XXXX. </p>
|
||||
|
||||
<p>Create a class that inherits from RegexRule</p>
|
||||
<pre class="highlight swift"><code>
|
||||
<span class="kd">class</span> <span class="kt">SSNVRule</span><span class="p">:</span> <span class="kt">RegexRule</span> <span class="p">{</span>
|
||||
|
||||
<span class="kd">static</span> <span class="k">let</span> <span class="nv">regex</span> <span class="o">=</span> <span class="s">"^</span><span class="se">\\</span><span class="s">d{3}-</span><span class="se">\\</span><span class="s">d{2}-</span><span class="se">\\</span><span class="s">d{4}$"</span>
|
||||
|
||||
<span class="n">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">message</span> <span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="s">"Not a valid SSN"</span><span class="p">){</span>
|
||||
<span class="k">self</span><span class="o">.</span><span class="nf">init</span><span class="p">(</span><span class="nv">regex</span><span class="p">:</span> <span class="kt">SSNVRule</span><span class="o">.</span><span class="n">regex</span><span class="p">,</span> <span class="nv">message</span> <span class="p">:</span> <span class="n">message</span><span class="p">)</span>
|
||||
<span class="p">}</span>
|
||||
<span class="p">}</span>
|
||||
</code></pre>
|
||||
<a href='#credits' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h2 id='credits'>Credits</h2>
|
||||
|
||||
<p>Swift Validator is written and maintained by Jeff Potter <a href="http://twitter.com/jpotts18">@jpotts18</a>.</p>
|
||||
<a href='#contributing' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h2 id='contributing'>Contributing</h2>
|
||||
|
||||
<ol>
|
||||
<li><a href="https://github.com/jpotts18/SwiftValidator/fork">Fork it</a></li>
|
||||
<li>Create your feature branch <code>git checkout -b my-new-feature</code></li>
|
||||
<li>Commit your changes <code>git commit -am 'Add some feature'</code></li>
|
||||
<li>Push to the branch <code>git push origin my-new-feature</code></li>
|
||||
<li>Create a new Pull Request</li>
|
||||
</ol>
|
||||
|
||||
</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-02-14)</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>
|
||||
|
|
|
|||
|
|
@ -0,0 +1,40 @@
|
|||
window.jazzy = {'docset': false}
|
||||
if (typeof window.dash != 'undefined') {
|
||||
document.documentElement.className += ' dash'
|
||||
window.jazzy.docset = true
|
||||
}
|
||||
if (navigator.userAgent.match(/xcode/i)) {
|
||||
document.documentElement.className += ' xcode'
|
||||
window.jazzy.docset = true
|
||||
}
|
||||
|
||||
// On doc load, toggle the URL hash discussion if present
|
||||
$(document).ready(function() {
|
||||
if (!window.jazzy.docset) {
|
||||
var linkToHash = $('a[href="' + window.location.hash +'"]');
|
||||
linkToHash.trigger("click");
|
||||
}
|
||||
});
|
||||
|
||||
// On token click, toggle its discussion and animate token.marginLeft
|
||||
$(".token").click(function(event) {
|
||||
if (window.jazzy.docset) {
|
||||
return;
|
||||
}
|
||||
var link = $(this);
|
||||
var animationDuration = 300;
|
||||
var tokenOffset = "15px";
|
||||
var original = link.css('marginLeft') == tokenOffset;
|
||||
link.animate({'margin-left':original ? "0px" : tokenOffset}, animationDuration);
|
||||
$content = link.parent().parent().next();
|
||||
$content.slideToggle(animationDuration);
|
||||
|
||||
// Keeps the document from jumping to the hash.
|
||||
var href = $(this).attr('href');
|
||||
if (history.pushState) {
|
||||
history.pushState({}, '', href);
|
||||
} else {
|
||||
location.hash = href;
|
||||
}
|
||||
event.preventDefault();
|
||||
});
|
||||
File diff suppressed because one or more lines are too long
Loading…
Reference in New Issue