class Athena::Validator::Constraints::URL
inherits Athena::Validator::Constraint
#
Validates that a value is a valid URL string.
The underlying value is converted to a string via #to_s before being validated.
Note
As with most other constraints, nil and empty strings are considered valid values, in order to allow the value to be optional.
If the value is required, consider combining this constraint with AVD::Constraints::NotBlank.
Configuration#
Optional Arguments#
protocols#
Type: Array(String) Default: ["http", "https"]
The protocols considered to be valid for the URL.
relative_protocol#
Type: Bool Default: false
If true the protocol is considered optional.
message#
Type: String Default: This value is not a valid URL.
The message that will be shown if the URL is not valid.
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#
INVALID_URL_ERROR = "e87ceba6-a896-4906-9957-b102045272ee"#
Constructors#
.new(protocols : Array(String) = ["http", "https"], relative_protocol : Bool = false, message : String = "This value is not a valid URL.", groups : Array(String) | String | Nil = nil, payload : Hash(String, String) | Nil = nil)#
Methods#
#validated_by : AVD::ConstraintValidator.class#
Returns the AVD::ConstraintValidator.class that should handle validating self.