class Athena::Validator::Constraints::Positive

Overview

Validates that a value is a positive number. Use AVD::Constraints::PositiveOrZero if you wish to also allow 0.

Configuration

Optional Arguments

message

Type: String Default: This value should be positive.

The message that will be shown if the value is not greater than 0.

Placeholders

The following placeholders can be used in this message:

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.

Defined in:

constraints/positive.cr

Constructors

Instance Method Summary

Instance methods inherited from class Athena::Validator::Constraints::GreaterThan(Int32)

default_error_message : String default_error_message, validated_by : AVD::ConstraintValidator.class validated_by

Constructor methods inherited from class Athena::Validator::Constraints::GreaterThan(Int32)

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

Instance methods inherited from module Athena::Validator::Constraints::AbstractComparison(Int32)

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(Int32)

new(value : ValueType, message : String = default_error_message, groups : Array(String) | String | Nil = nil, payload : Hash(String, String)? = 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)? 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) new

Class methods inherited from class Athena::Validator::Constraint

error_name(error_code : String) : String error_name

Constructor Detail

def self.new(message : String = "This value should be positive.", groups : Array(String) | String | Nil = nil, payload : Hash(String, String)? = nil) #

[View source]

Instance Method Detail

def validated_by : AVD::ConstraintValidator.class #

:inherit:


[View source]