Form Validation

After reading this reference, you will know:

• How to configure form validation
• How to render validation errors

Example

Below is a simple validation example:

fields:
  properties:
    title:
      validation:
        presence: true

A form is only considered valid if the property is included in the request unless the property has already been set in the object passed to the form.

Validation Types

You can use the validation types detailed in this section.

presence

title:
  validation:
    presence: true

unique

fields:
  properties:
    slug:
      validation:
        presence: true
        unique:
          scope:
            - other_property
          message: Must be unique

confirmation

This validation is used when the same value must be entered twice.

Setting it to makes the system mandate the transmission of a second form value for validation, designated as .

As an illustration, when the attribute is set for a password field, the values entered in both the and fields must match.

This behavior means you must add the field to your form configuration. Because it does not have to be saved into the database, it can be set as a virtual field.

The default error message for this validator is the 'doesn't match %{attribute}'.

password:
  validation:
    confirmation: true
password_confirmation:
  property_options:
    virtual: true

email

Checks if the provided value is a valid email address.

author_email:
  validation:
    email: true

inclusion/exclusion

malpractice_history:
   validation:
     inclusion:
       in: [true, false]
       message: disclosure is required

format

Tries to match the provided value with regexp defined in .

A blank value will produce a validation error when is set to . To avoid that, use .

phone:
  validation:
    presence: false
    format:
      with: A[+]?[d -()]+z
      allow_blank: true
      message: This is an invalid phone number. Please try using numbers only

length

attachments:
  validation:
    length:
      is: 2
      message: You need to include Frontside and Backside Photo ID

The possible length constraint options are:

numericality

rate_amount:
  validation:
    presence: true
    numericality:
      greater_than_or_equal_to: 0

Available options are:

datetime

Datetime is a date with the exact time down to the second. For example, .

The system can convert human phrases (for example, , , , ) to datetime so that you can write them easier.

Note: will take yesterday's date at midnight; if you want to preserve the time of the day, use

my_date:
  validation:
    datetime:
      after: "10 minutes ago"
      message: "Must not be earlier than 10 minutes ago."

my_date2:
  validation:
    datetime:
      before: "now"
      message: "Must be in the past"

The possible date constraint options are:

All default error messages are in a format where the first is the validation name (is_at, before etc.), and the second is the argument of this validation. Suppose the provided argument is not a valid datetime (for example, ). A 501 error is raised in that case, and a Log is created with a Date/Time Validation Error description.

date

my_date:
  validation:
    date:
      after: "1 day from now"
      message: "Must be at least one day in the future"

The possible date constraint options are:

All default error messages are in a format where the first is the validation name (is_at, before etc.), and the second is the argument of this validation. If the provided argument is not a valid date (for example, ), a 501 error is raised, and a Log is created with the Date/Time Validation Error description.

Conditional validation

It is possible to validate attributes based on the state of other attributes from the form.

expiry_year:
  validation:
    presence:
      if: '{% if form.expires %}true{% endif %}'

Common validation options

This section details common validation options you can use on your code.

message

It is possible to overwrite the default message with additional fields:

fields:
  properties:
    expertise:
      validation:
        presence:
          message: Expertise is required.

allow_nil

The option skips the validation when the value being validated is nil.

allow_blank

Allows passing an empty string.

Validation errors

When a form validation error is raised, an error message is added to the object that contains errors corresponding to fields.

If you need errors for a particular field, access them through:

{{ form.errors.<field_name> }}

Example:

{{ form.errors.name }}

Translation

Each error message can be translated with the Insites translation mechanism.

Please visit Translations: System Messages for more information.