Skip to content

class Athena::Validator::Constraints::EqualTo(ValueType)
inherits Athena::Validator::Constraint #

Validates that a value is equal to another.

class Project
  include AVD::Validatable

  def initialize(@name : String); end

  @[Assert::EqualTo("Athena")]
  property name : String
end

Configuration#

Required Arguments#

value#

Defines the value that the value being validated should be compared to.

Optional Arguments#

message#

Type: String Default: This value should be equal to {{ compared_value }}.

The message that will be shown if the value is not equal to the comparison value.

Placeholders#

The following placeholders can be used in this message:

  • {{ value }} - The current (invalid) value.
  • {{ compared_value }} - The expected value.
  • {{ compared_value_type }} - The type of the expected 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.

Included modules

Athena::Validator::Constraints::AbstractComparison

Constants#

NOT_EQUAL_ERROR = "47d83d11-15d5-4267-b469-1444f80fd169"#

Constructors#

.new(value : ValueType, message : String = default_error_message, groups : Array(String) | String | Nil = nil, payload : Hash(String, String) | Nil = nil)#

View source

Methods#

#default_error_message : String#

Returns the AVD::Constraint#message for this constraint.

View source

#validated_by : AVD::ConstraintValidator.class#

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

View source