Skip to content

class Athena::Validator::Constraints::NotBlank
inherits Athena::Validator::Constraint #

Validates that a value is not blank; meaning not equal to a blank string, an empty Iterable, false, or optionally nil.

class User
  include AVD::Validatable

  def initialize(@name : String); end

  @[Assert::NotBlank]
  property name : String
end

Configuration#

Optional Arguments#

allow_nil#

Type: Bool Default: false

If set to true, nil values are considered valid and will not trigger a violation.

message#

Type: String Default: This value should not be blank.

The message that will be shown if the value is blank.

Placeholders#

The following placeholders can be used in this message:

  • {{ value }} - The current (invalid) value.

groups#

Type: Array(String) | String | Nil Default: nil

The validation groups this constraint belongs to. AVD::Constraint::DEFAULT_GROUP is assumed if nil.

payload#

Type: Hash(String, String)? Default: nil

Any arbitrary domain-specific data that should be stored with this constraint. The payload is not used by Athena::Validator, but its processing is completely up to you.

Constants#

IS_BLANK_ERROR = "0d0c3254-3642-4cb0-9882-46ee5918e6e3"#

Constructors#

.new(allow_nil : Bool = false, message : String = "This value should not be blank.", groups : Array(String) | String | Nil = nil, payload : Hash(String, String) | Nil = nil)#

View source

Methods#

#allow_nil? : Bool#

View source

#validated_by : AVD::ConstraintValidator.class#

Returns the AVD::ConstraintValidator.class that should handle validating self.

View source