SwiftValidator/docs/search.json

{"Structs/ValidatorDictionary.html#/s:FV14SwiftValidator19ValidatorDictionary9removeAllFT_T_":{"name":"removeAll()","abstract":"<p>Undocumented</p>","parent_name":"ValidatorDictionary"},"Structs/ValidatorDictionary.html#/s:FV14SwiftValidator19ValidatorDictionary17removeValueForKeyFPs9AnyObjectS_11Validatable_T_":{"name":"removeValueForKey(_:)","abstract":"<p>Undocumented</p>","parent_name":"ValidatorDictionary"},"Structs/ValidatorDictionary.html#/s:vV14SwiftValidator19ValidatorDictionary7isEmptySb":{"name":"isEmpty","abstract":"<p>Undocumented</p>","parent_name":"ValidatorDictionary"},"Structs/ValidatorDictionary.html#/s:FPs8Sequence12makeIteratorFT_wx8Iterator":{"name":"makeIterator()","parent_name":"ValidatorDictionary"},"Structs/ValidatorDictionary.html":{"name":"ValidatorDictionary","abstract":"<p>Undocumented</p>"},"Protocols/ValidationDelegate.html#/s:FP14SwiftValidator18ValidationDelegate20validationSuccessfulFT_T_":{"name":"validationSuccessful()","abstract":"<p>This method will be called on delegate object when validation is successful.</p>","parent_name":"ValidationDelegate"},"Protocols/ValidationDelegate.html#/s:FP14SwiftValidator18ValidationDelegate16validationFailedFGSaTPS_11Validatable_CS_15ValidationError__T_":{"name":"validationFailed(_:)","abstract":"<p>This method will be called on delegate object when validation fails.</p>","parent_name":"ValidationDelegate"},"Protocols/Validatable.html#/s:vP14SwiftValidator11Validatable14validationTextSS":{"name":"validationText","abstract":"<p>Undocumented</p>","parent_name":"Validatable"},"Protocols/Rule.html#/s:FP14SwiftValidator4Rule8validateFSSSb":{"name":"validate(_:)","abstract":"<p>Validates text of a field.</p>","parent_name":"Rule"},"Protocols/Rule.html#/s:FP14SwiftValidator4Rule12errorMessageFT_SS":{"name":"errorMessage()","abstract":"<p>Displays error message of a field that has failed validation.</p>","parent_name":"Rule"},"Protocols/Rule.html":{"name":"Rule","abstract":"<p>The <code>Rule</code> protocol declares the required methods for all objects that subscribe to it.</p>"},"Protocols/Validatable.html":{"name":"Validatable","abstract":"<p>Undocumented</p>"},"Protocols/ValidationDelegate.html":{"name":"ValidationDelegate","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>"},"Extensions/UITextField.html#/s:vE14SwiftValidatorCSo11UITextField14validationTextSS":{"name":"validationText","abstract":"<p>Undocumented</p>","parent_name":"UITextField"},"Extensions/UITextField.html":{"name":"UITextField","abstract":"<p>Undocumented</p>"},"Classes/ExactLengthRule.html#/s:FC14SwiftValidator15ExactLengthRulecFT6lengthSi7messageSS_S0_":{"name":"init(length:message:)","abstract":"<p>Initializes an <code>ExactLengthRule</code> object to validate the text of a field against an exact length.</p>","parent_name":"ExactLengthRule"},"Classes/ExactLengthRule.html#/s:FC14SwiftValidator15ExactLengthRule8validateFSSSb":{"name":"validate(_:)","abstract":"<p>Used to validate a field.</p>","parent_name":"ExactLengthRule"},"Classes/ExactLengthRule.html#/s:FC14SwiftValidator15ExactLengthRule12errorMessageFT_SS":{"name":"errorMessage()","abstract":"<p>Displays error message if a field fails validation.</p>","parent_name":"ExactLengthRule"},"Classes/MaxLengthRule.html#/s:FC14SwiftValidator13MaxLengthRulecFT_S0_":{"name":"init()","parent_name":"MaxLengthRule"},"Classes/MaxLengthRule.html#/s:FC14SwiftValidator13MaxLengthRulecFT6lengthSi7messageSS_S0_":{"name":"init(length:message:)","abstract":"<p>Initializes a <code>MaxLengthRule</code> object that is to validate the length of the text of a field.</p>","parent_name":"MaxLengthRule"},"Classes/MaxLengthRule.html#/s:FC14SwiftValidator13MaxLengthRule8validateFSSSb":{"name":"validate(_:)","abstract":"<p>Used to validate a field.</p>","parent_name":"MaxLengthRule"},"Classes/MaxLengthRule.html#/s:FC14SwiftValidator13MaxLengthRule12errorMessageFT_SS":{"name":"errorMessage()","abstract":"<p>Displays an error message if a field fails validation.</p>","parent_name":"MaxLengthRule"},"Classes/MinLengthRule.html#/s:FC14SwiftValidator13MinLengthRulecFT_S0_":{"name":"init()","parent_name":"MinLengthRule"},"Classes/MinLengthRule.html#/s:FC14SwiftValidator13MinLengthRulecFT6lengthSi7messageSS_S0_":{"name":"init(length:message:)","abstract":"<p>Initializes a <code><a href=\"36f8f5912051ae747ef441d6511ca4cbClasses/MaxLengthRule.html\">MaxLengthRule</a></code> object that is to validate the length of the text of a field.</p>","parent_name":"MinLengthRule"},"Classes/MinLengthRule.html#/s:FC14SwiftValidator13MinLengthRule8validateFSSSb":{"name":"validate(_:)","abstract":"<p>Validates a field.</p>","parent_name":"MinLengthRule"},"Classes/MinLengthRule.html#/s:FC14SwiftValidator13MinLengthRule12errorMessageFT_SS":{"name":"errorMessage()","abstract":"<p>Displays error message when field has failed validation.</p>","parent_name":"MinLengthRule"},"Classes/AlphaRule.html#/s:FC14SwiftValidator9AlphaRulecFT7messageSS_S0_":{"name":"init(message:)","abstract":"<p>Initializes an <code>AlphaRule</code> object to verify that a field has valid set of alpha characters.</p>","parent_name":"AlphaRule"},"Classes/IntegerRule.html#/s:FC14SwiftValidator11IntegerRulecFT7messageSS_S0_":{"name":"init(message:)","abstract":"<p>Initializes a <code>IntegerRule</code> object to validate that the text of a field is only Integer.</p>","parent_name":"IntegerRule"},"Classes/IntegerRule.html#/s:FC14SwiftValidator11IntegerRule8validateFSSSb":{"name":"validate(_:)","abstract":"<p>Used to validate field.</p>","parent_name":"IntegerRule"},"Classes/IntegerRule.html#/s:FC14SwiftValidator11IntegerRule12errorMessageFT_SS":{"name":"errorMessage()","abstract":"<p>Displays error message when field fails validation.</p>","parent_name":"IntegerRule"},"Classes/RegexRule.html#/s:FC14SwiftValidator9RegexRulecFT5regexSS7messageSS_S0_":{"name":"init(regex:message:)","abstract":"<p>Method used to initialize <code>RegexRule</code> object.</p>","parent_name":"RegexRule"},"Classes/RegexRule.html#/s:FC14SwiftValidator9RegexRule8validateFSSSb":{"name":"validate(_:)","abstract":"<p>Method used to validate field.</p>","parent_name":"RegexRule"},"Classes/RegexRule.html#/s:FC14SwiftValidator9RegexRule12errorMessageFT_SS":{"name":"errorMessage()","abstract":"<p>Method used to dispaly error message when field fails validation.</p>","parent_name":"RegexRule"},"Classes/RequiredRule.html#/s:FC14SwiftValidator12RequiredRulecFT7messageSS_S0_":{"name":"init(message:)","abstract":"<p>Initializes <code>RequiredRule</code> object with error message. Used to validate a field that requires text.</p>","parent_name":"RequiredRule"},"Classes/RequiredRule.html#/s:FC14SwiftValidator12RequiredRule8validateFSSSb":{"name":"validate(_:)","abstract":"<p>Validates a field.</p>","parent_name":"RequiredRule"},"Classes/RequiredRule.html#/s:FC14SwiftValidator12RequiredRule12errorMessageFT_SS":{"name":"errorMessage()","abstract":"<p>Used to display error message when validation fails.</p>","parent_name":"RequiredRule"},"Classes/ValidationError.html#/s:vC14SwiftValidator15ValidationError5fieldPs9AnyObjectS_11Validatable_":{"name":"field","abstract":"<p>the Validatable field of the field</p>","parent_name":"ValidationError"},"Classes/ValidationError.html#/s:vC14SwiftValidator15ValidationError10errorLabelGSqCSo7UILabel_":{"name":"errorLabel","abstract":"<p>the error label of the field</p>","parent_name":"ValidationError"},"Classes/ValidationError.html#/s:vC14SwiftValidator15ValidationError12errorMessageSS":{"name":"errorMessage","abstract":"<p>the error message of the field</p>","parent_name":"ValidationError"},"Classes/ValidationError.html#/s:FC14SwiftValidator15ValidationErrorcFT5fieldPs9AnyObjectS_11Validatable_10errorLabelGSqCSo7UILabel_5errorSS_S0_":{"name":"init(field:errorLabel:error:)","abstract":"<p>Initializes <code>ValidationError</code> object with a field, errorLabel, and errorMessage.</p>","parent_name":"ValidationError"},"Classes/ISBNRule.html#/s:FC14SwiftValidator8ISBNRulecFT7messageSS_S0_":{"name":"init(message:)","abstract":"<p>Initializes a <code>ISBNRule</code> object to verify that field has text that is a ISBN number.</p>","parent_name":"ISBNRule"},"Classes/ISBNRule.html#/s:FC14SwiftValidator8ISBNRule8validateFSSSb":{"name":"validate(_:)","abstract":"<p>Method used to validate field.</p>","parent_name":"ISBNRule"},"Classes/ISBNRule.html#/s:FC14SwiftValidator8ISBNRule12errorMessageFT_SS":{"name":"errorMessage()","abstract":"<p>Method used to dispaly error message when field fails validation.</p>","parent_name":"ISBNRule"},"Classes/IPV4Rule.html#/s:FC14SwiftValidator8IPV4RulecFT7messageSS_S0_":{"name":"init(message:)","abstract":"<p>Initializes a <code>IPV4Rule</code> object to verify that field has text is an IPV4Rule address.</p>","parent_name":"IPV4Rule"},"Classes/ConfirmationRule.html#/s:FC14SwiftValidator16ConfirmationRulecFT12confirmFieldPs9AnyObjectS_11Validatable_7messageSS_S0_":{"name":"init(confirmField:message:)","abstract":"<p>Initializes a <code>ConfirmationRule</code> object to validate the text of a field that should equal the text of another field.</p>","parent_name":"ConfirmationRule"},"Classes/ConfirmationRule.html#/s:FC14SwiftValidator16ConfirmationRule8validateFSSSb":{"name":"validate(_:)","abstract":"<p>Used to validate a field.</p>","parent_name":"ConfirmationRule"},"Classes/ConfirmationRule.html#/s:FC14SwiftValidator16ConfirmationRule12errorMessageFT_SS":{"name":"errorMessage()","abstract":"<p>Displays an error message when text field fails validation.</p>","parent_name":"ConfirmationRule"},"Classes/ValidationRule.html#/s:vC14SwiftValidator14ValidationRule5fieldPs9AnyObjectS_11Validatable_":{"name":"field","abstract":"<p>the field of the field</p>","parent_name":"ValidationRule"},"Classes/ValidationRule.html#/s:vC14SwiftValidator14ValidationRule10errorLabelGSqCSo7UILabel_":{"name":"errorLabel","abstract":"<p>the errorLabel of the field</p>","parent_name":"ValidationRule"},"Classes/ValidationRule.html#/s:vC14SwiftValidator14ValidationRule5rulesGSaPS_4Rule__":{"name":"rules","abstract":"<p>the rules of the field</p>","parent_name":"ValidationRule"},"Classes/ValidationRule.html#/s:FC14SwiftValidator14ValidationRulecFT5fieldPs9AnyObjectS_11Validatable_5rulesGSaPS_4Rule__10errorLabelGSqCSo7UILabel__S0_":{"name":"init(field:rules:errorLabel:)","abstract":"<p>Initializes <code>ValidationRule</code> instance with field, rules, and errorLabel.</p>","parent_name":"ValidationRule"},"Classes/ValidationRule.html#/s:FC14SwiftValidator14ValidationRule13validateFieldFT_GSqCS_15ValidationError_":{"name":"validateField()","abstract":"<p>Used to validate field against its validation rules.</p>","parent_name":"ValidationRule"},"Classes/Validator.html#/s:vC14SwiftValidator9Validator11validationsGVS_19ValidatorDictionaryCS_14ValidationRule_":{"name":"validations","abstract":"<p>Dictionary to hold all fields (and accompanying rules) that will undergo validation.</p>","parent_name":"Validator"},"Classes/Validator.html#/s:vC14SwiftValidator9Validator6errorsGVS_19ValidatorDictionaryCS_15ValidationError_":{"name":"errors","abstract":"<p>Dictionary to hold fields (and accompanying errors) that were unsuccessfully validated.</p>","parent_name":"Validator"},"Classes/Validator.html#/s:FC14SwiftValidator9ValidatorcFT_S0_":{"name":"init()","parent_name":"Validator"},"Classes/Validator.html#/s:FC14SwiftValidator9Validator13validateFieldFTPs9AnyObjectS_11Validatable_8callbackFGSqCS_15ValidationError_T__T_":{"name":"validateField(_:callback:)","abstract":"<p>This method is used to validate a single field registered to Validator. If validation is unsuccessful,","parent_name":"Validator"},"Classes/Validator.html#/s:FC14SwiftValidator9Validator17styleTransformersFT7successGSqFCS_14ValidationRuleT__5errorGSqFCS_15ValidationErrorT___T_":{"name":"styleTransformers(success:error:)","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>","parent_name":"Validator"},"Classes/Validator.html#/s:FC14SwiftValidator9Validator13registerFieldFTPs9AnyObjectS_11Validatable_10errorLabelGSqCSo7UILabel_5rulesGSaPS_4Rule___T_":{"name":"registerField(_:errorLabel:rules:)","abstract":"<p>This method is used to add a field to validator.</p>","parent_name":"Validator"},"Classes/Validator.html#/s:FC14SwiftValidator9Validator15unregisterFieldFPs9AnyObjectS_11Validatable_T_":{"name":"unregisterField(_:)","abstract":"<p>This method is for removing a field validator.</p>","parent_name":"Validator"},"Classes/Validator.html#/s:FC14SwiftValidator9Validator8validateFPS_18ValidationDelegate_T_":{"name":"validate(_:)","abstract":"<p>This method checks to see if all fields in validator are valid.</p>","parent_name":"Validator"},"Classes/Validator.html#/s:FC14SwiftValidator9Validator8validateFFGSaTPS_11Validatable_CS_15ValidationError__T_T_":{"name":"validate(_:)","abstract":"<p>This method validates all fields in validator and sets any errors to errors parameter of callback.</p>","parent_name":"Validator"},"Classes/HexColorRule.html#/s:FC14SwiftValidator12HexColorRulecFT7messageSS_S0_":{"name":"init(message:)","abstract":"<p>Initializes a <code>HexaColorRule</code> object to verify that field has text in hexadecimal color format.</p>","parent_name":"HexColorRule"},"Classes/FloatRule.html#/s:FC14SwiftValidator9FloatRulecFT7messageSS_S0_":{"name":"init(message:)","abstract":"<p>Initializes a <code>FloatRule</code> object to validate that the text of a field is a floating point number.</p>","parent_name":"FloatRule"},"Classes/FloatRule.html#/s:FC14SwiftValidator9FloatRule8validateFSSSb":{"name":"validate(_:)","abstract":"<p>Used to validate field.</p>","parent_name":"FloatRule"},"Classes/FloatRule.html#/s:FC14SwiftValidator9FloatRule12errorMessageFT_SS":{"name":"errorMessage()","abstract":"<p>Displays error message when field fails validation.</p>","parent_name":"FloatRule"},"Classes/PhoneNumberRule.html#/s:FC14SwiftValidator15PhoneNumberRulecFT7messageSS_S0_":{"name":"init(message:)","abstract":"<p>Initializes a <code>PhoneNumberRule</code> object. Used to validate that a field has a valid phone number.</p>","parent_name":"PhoneNumberRule"},"Classes/CharacterSetRule.html#/s:FC14SwiftValidator16CharacterSetRulecFT12characterSetV10Foundation12CharacterSet7messageSS_S0_":{"name":"init(characterSet:message:)","abstract":"<p>Initializes a <code>CharacterSetRule</code> object to verify that field has valid set of characters.</p>","parent_name":"CharacterSetRule"},"Classes/CharacterSetRule.html#/s:FC14SwiftValidator16CharacterSetRule8validateFSSSb":{"name":"validate(_:)","abstract":"<p>Used to validate field.</p>","parent_name":"CharacterSetRule"},"Classes/CharacterSetRule.html#/s:FC14SwiftValidator16CharacterSetRule12errorMessageFT_SS":{"name":"errorMessage()","abstract":"<p>Displays error message when field fails validation.</p>","parent_name":"CharacterSetRule"},"Classes/AlphaNumericRule.html#/s:FC14SwiftValidator16AlphaNumericRulecFT7messageSS_S0_":{"name":"init(message:)","abstract":"<p>Initializes a <code>AlphaNumericRule</code> object to verify that field has valid set of alphanumeric characters.</p>","parent_name":"AlphaNumericRule"},"Classes/PasswordRule.html#/s:FC14SwiftValidator12PasswordRulecFT7messageSS_S0_":{"name":"init(message:)","abstract":"<p>Initializes a <code>PasswordRule</code> object that will validate a field is a valid password.</p>","parent_name":"PasswordRule"},"Classes/ZipCodeRule.html#/s:FC14SwiftValidator11ZipCodeRulecFT7messageSS_S0_":{"name":"init(message:)","abstract":"<p>Initializes a <code>ZipCodeRule</code> object.</p>","parent_name":"ZipCodeRule"},"Classes/FullNameRule.html#/s:FC14SwiftValidator12FullNameRulecFT7messageSS_S0_":{"name":"init(message:)","abstract":"<p>Initializes a <code>FullNameRule</code> object that is used to verify that text in field is a full name.</p>","parent_name":"FullNameRule"},"Classes/FullNameRule.html#/s:FC14SwiftValidator12FullNameRule8validateFSSSb":{"name":"validate(_:)","abstract":"<p>Used to validate a field.</p>","parent_name":"FullNameRule"},"Classes/FullNameRule.html#/s:FC14SwiftValidator12FullNameRule12errorMessageFT_SS":{"name":"errorMessage()","abstract":"<p>Used to display error message of a field that has failed validation.</p>","parent_name":"FullNameRule"},"Classes/EmailRule.html#/s:FC14SwiftValidator9EmailRulecFT7messageSS_S0_":{"name":"init(message:)","abstract":"<p>Initializes an <code>EmailRule</code> object to validate an email field.</p>","parent_name":"EmailRule"},"Classes/EmailRule.html":{"name":"EmailRule","abstract":"<p><code>EmailRule</code> is a subclass of RegexRule that defines how a email is validated.</p>"},"Classes/FullNameRule.html":{"name":"FullNameRule","abstract":"<p><code>FullNameRule</code> is a subclass of Rule that defines how a full name is validated.</p>"},"Classes/ZipCodeRule.html":{"name":"ZipCodeRule","abstract":"<p><code>ZipCodeRule</code> is a subclass of <code><a href=\"36f8f5912051ae747ef441d6511ca4cbClasses/RegexRule.html\">RegexRule</a></code> that represents how zip codes are to be validated.</p>"},"Classes/PasswordRule.html":{"name":"PasswordRule","abstract":"<p><code>PasswordRule</code> is a subclass of RegexRule that defines how a password is validated.</p>"},"Classes/AlphaNumericRule.html":{"name":"AlphaNumericRule","abstract":"<p><code>AlphaNumericRule</code> is a subclass of <code><a href=\"36f8f5912051ae747ef441d6511ca4cbClasses/CharacterSetRule.html\">CharacterSetRule</a></code>. It is used to verify that a field has a"},"Classes/CharacterSetRule.html":{"name":"CharacterSetRule","abstract":"<p><code>CharacterSetRule</code> is a subclass of <code><a href=\"36f8f5912051ae747ef441d6511ca4cbProtocols/Rule.html\">Rule</a></code>. It is used to validate IPV4 address fields.</p>"},"Classes/PhoneNumberRule.html":{"name":"PhoneNumberRule","abstract":"<p><code>PhoneNumberRule</code> is a subclass of Rule that defines how a phone number is validated.</p>"},"Classes/FloatRule.html":{"name":"FloatRule","abstract":"<p><code>FloatRule</code> is a subclass of Rule that defines how check if a value is a floating point value.</p>"},"Classes/HexColorRule.html":{"name":"HexColorRule","abstract":"<p><code>HexColorRule</code> is a subclass of <code><a href=\"36f8f5912051ae747ef441d6511ca4cbClasses/RegexRule.html\">RegexRule</a></code>. It is used to verify whether a field is a hexadecimal color.</p>"},"Classes/Validator.html":{"name":"Validator","abstract":"<p>Class that makes <code>Validator</code> objects. Should be added as a parameter to ViewController that will display"},"Classes/ValidationRule.html":{"name":"ValidationRule","abstract":"<p><code>ValidationRule</code> is a class that creates an object which holds validation info of a field.</p>"},"Classes/ConfirmationRule.html":{"name":"ConfirmationRule","abstract":"<p><code>ConfirmationRule</code> is a subclass of Rule that defines how a field that has to be equal"},"Classes/IPV4Rule.html":{"name":"IPV4Rule","abstract":"<p><code>IPV4Rule</code> is a subclass of RegexRule that defines how a IPV4 address validated.</p>"},"Classes/ISBNRule.html":{"name":"ISBNRule","abstract":"<p><code>ISBNRule</code> is a subclass of <code><a href=\"36f8f5912051ae747ef441d6511ca4cbProtocols/Rule.html\">Rule</a></code>. It is used to verify whether a field is a valid ISBN number.</p>"},"Classes/ValidationError.html":{"name":"ValidationError","abstract":"<p>The <code>ValidationError</code> class is used for representing errors of a failed validation. It contains the field, error label, and error message of a failed validation.</p>"},"Classes/RequiredRule.html":{"name":"RequiredRule","abstract":"<p><code>RequiredRule</code> is a subclass of Rule that defines how a required field is validated.</p>"},"Classes/RegexRule.html":{"name":"RegexRule","abstract":"<p><code>RegexRule</code> is a subclass of Rule that defines how a regular expression is validated.</p>"},"Classes/IntegerRule.html":{"name":"IntegerRule","abstract":"<p><code>IntegerRule</code> is a subclass of Rule that is used to make sure a the text of a field is an integer.</p>"},"Classes/AlphaRule.html":{"name":"AlphaRule","abstract":"<p><code>AlphaRule</code> is a subclass of <code><a href=\"36f8f5912051ae747ef441d6511ca4cbClasses/CharacterSetRule.html\">CharacterSetRule</a></code>. It is used to verify that a field has a"},"Classes/MinLengthRule.html":{"name":"MinLengthRule","abstract":"<p><code>MinLengthRule</code> is a subclass of Rule that defines how minimum character length is validated.</p>"},"Classes/MaxLengthRule.html":{"name":"MaxLengthRule","abstract":"<p><code>MaxLengthRule</code> is a subclass of <code><a href=\"36f8f5912051ae747ef441d6511ca4cbProtocols/Rule.html\">Rule</a></code> that defines how maximum character length is validated.</p>"},"Classes/ExactLengthRule.html":{"name":"ExactLengthRule","abstract":"<p><code>ExactLengthRule</code> is a subclass of Rule that is used to make sure a the text of a field is an exact length.</p>"},"Classes.html":{"name":"Classes","abstract":"<p>The following classes are available globally.</p>"},"Extensions.html":{"name":"Extensions","abstract":"<p>The following extensions are available globally.</p>"},"Protocols.html":{"name":"Protocols","abstract":"<p>The following protocols are available globally.</p>"},"Structs.html":{"name":"Structs","abstract":"<p>The following structs are available globally.</p>"}}