class Athena::Validator::Constraints::LessThanOrEqual(ValueType)
- Athena::Validator::Constraints::LessThanOrEqual(ValueType)
- Athena::Validator::Constraint
- Reference
- Object
Overview
Validates that a value is less than or equal to another.
Configuration
Required Arguments
value
Type: Number | String | Time
Defines the value that the value being validated should be compared to.
Optional Arguments
message
Type: String Default: This value should be less than or equal to {{ compared_value }}.
The message that will be shown if the value is not less than or 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][Athena::Validator::Constraint--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][Athena::Validator::Constraint--payload] is not used by Athena::Validator, but its processing is completely up to you.
Included Modules
Direct Known Subclasses
Defined in:
constraints/less_than_or_equal.crConstant Summary
- 
        TOO_HIGH_ERROR = "515a12ff-82f2-4434-9635-137164d5b467"
Constructors
Instance Method Summary
- 
        #default_error_message : String
        
          Returns the AVD::Constraint#messagefor this constraint.
- 
        #validated_by : AVD::ConstraintValidator.class
        
          Returns the AVD::ConstraintValidator.classthat should handle validatingself.
Instance methods inherited from module Athena::Validator::Constraints::AbstractComparison(ValueType)
  
  
    
      default_error_message : String
    default_error_message, 
    
  
    
      value : ValueType
    value, 
    
  
    
      value_type : ValueType.class
    value_type
    
  
    
  Constructor methods inherited from module Athena::Validator::Constraints::AbstractComparison(ValueType)
  
  
    
      new(value : ValueType, message : String = default_error_message, groups : Array(String) | String | Nil = nil, payload : Hash(String, String) | Nil = nil)
    new
    
  
    
  
    
  Instance methods inherited from class Athena::Validator::Constraint
  
  
    
      add_implicit_group(group : String) : Nil
    add_implicit_group, 
    
  
    
      groups : Array(String)
    groups, 
    
  
    
      groups=(groups : Array(String))
    groups=, 
    
  
    
      message : String
    message, 
    
  
    
      payload : Hash(String, String) | Nil
    payload, 
    
  
    
      validated_by : AVD::ConstraintValidator.class
    validated_by
    
  
    
  Constructor methods inherited from class Athena::Validator::Constraint
  
  
    
      new(message : String, groups : Array(String) | String | Nil = nil, payload : Hash(String, String) | Nil = nil)
    new
    
  
    
  Class methods inherited from class Athena::Validator::Constraint
  
  
    
      error_name(error_code : String) : String
    error_name
    
  
  
    
    
    
  
    
    
    
  
Constructor Detail
Instance Method Detail
Returns the AVD::Constraint#message for this constraint.
Returns the AVD::ConstraintValidator.class that should handle validating self.