class `Athena::Validator::Constraints::IsFalse`
inherits `Athena::Validator::Constraint` #

Validates that a value is false.

class Post
  include AVD::Validatable

  def initialize(@is_published : Bool); end

  @[Assert::IsFalse]
  property is_published : Bool
end

Configuration#

Optional Arguments#

message#

Type: String Default: This value should be false.

The message that will be shown if the value is not false.

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#

`NOT_FALSE_ERROR = "55c076a0-dbaf-453c-90cf-b94664276dbc"`#

Constructors#

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

View source

Methods#

`#validated_by : AVD::ConstraintValidator.class`#

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