Rule class abstract

A validation rule. passes returns null on success or a message reference on failure: either a translation key such as min.string (resolved with parameters) or a literal message containing a space.

Implementers

• AlphaDashRule
• AlphaNumRule
• AlphaRule
• AsciiRule
• BailRule
• BetweenRule
• BooleanRule
• ClosureRule
• ConfirmedRule
• DateCompareRule
• DateFormatRule
• DateRule
• DigitsBetweenRule
• DigitsRule
• DistinctRule
• EmailRule
• EndsWithRule
• ExistsRule
• ExtensionsRule
• FileRule
• FilledRule
• InRule
• IntegerRule
• IpRule
• JsonRule
• ListRule
• LowercaseRule
• MapRule
• MaxRule
• MimesRule
• MimetypesRule
• MinRule
• NullableRule
• NumericRule
• PasswordRule
• PresentRule
• ProhibitedRule
• RegexRule
• RequiredIfRule
• RequiredRule
• RequiredUnlessRule
• RequiredWithoutRule
• RequiredWithRule
• SameRule
• SizeRule
• SometimesRule
• StartsWithRule
• StringRule
• UlidRule
• UniqueRule
• UppercaseRule
• UrlRule
• UuidRule

Available extensions

• RuleChain

Constructors

Rule()

const

Properties

hashCode → int

The hash code for this object.

no setter, inherited

implicit → bool

Implicit rules run even when the attribute is absent or empty (required*, present, prohibited*).

no setter

name → String

Rule identifier used in messages and the string DSL (required).

no setter

parameters → Map<String, Object?>

Placeholder values for messages (:min, :other, :values).

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

schemaHint → Map<String, Object?>

Hint for OpenAPI generation ({'type': 'string', 'maxLength': 32}).

no setter

Methods

after(String dateOrField) → RuleBuilder

Available on Rule, provided by the RuleChain extension

afterOrEqual(String dateOrField) → RuleBuilder

Available on Rule, provided by the RuleChain extension

alpha() → RuleBuilder

Available on Rule, provided by the RuleChain extension

alphaDash() → RuleBuilder

Available on Rule, provided by the RuleChain extension

alphaNum() → RuleBuilder

Available on Rule, provided by the RuleChain extension

ascii() → RuleBuilder

Available on Rule, provided by the RuleChain extension

bail() → RuleBuilder

Available on Rule, provided by the RuleChain extension

before(String dateOrField) → RuleBuilder

Available on Rule, provided by the RuleChain extension

beforeOrEqual(String dateOrField) → RuleBuilder

Available on Rule, provided by the RuleChain extension

between(num min, num max) → RuleBuilder

Available on Rule, provided by the RuleChain extension

boolean() → RuleBuilder

Available on Rule, provided by the RuleChain extension

confirmed([String? field]) → RuleBuilder

Available on Rule, provided by the RuleChain extension

custom(FutureOr<String?> check(ValidationContext context), {String name = 'custom'}) → RuleBuilder

Available on Rule, provided by the RuleChain extension

date() → RuleBuilder

Available on Rule, provided by the RuleChain extension

different(String other) → RuleBuilder

Available on Rule, provided by the RuleChain extension

digits(int length) → RuleBuilder

Available on Rule, provided by the RuleChain extension

digitsBetween(int min, int max) → RuleBuilder

Available on Rule, provided by the RuleChain extension

distinct() → RuleBuilder

Available on Rule, provided by the RuleChain extension

email() → RuleBuilder

Available on Rule, provided by the RuleChain extension

endsWith(List<String> suffixes) → RuleBuilder

Available on Rule, provided by the RuleChain extension

enumValues<E extends Enum>(List<E> values) → RuleBuilder

Available on Rule, provided by the RuleChain extension

exists(String table, [String? column]) → RuleBuilder

Available on Rule, provided by the RuleChain extension

extensions(List<String> extensions) → RuleBuilder

Available on Rule, provided by the RuleChain extension

file() → RuleBuilder

Available on Rule, provided by the RuleChain extension

filled() → RuleBuilder

Available on Rule, provided by the RuleChain extension

image({bool allowSvg = false}) → RuleBuilder

Available on Rule, provided by the RuleChain extension

inList(List<Object?> values) → RuleBuilder

Available on Rule, provided by the RuleChain extension

integer() → RuleBuilder

Available on Rule, provided by the RuleChain extension

ip() → RuleBuilder

Available on Rule, provided by the RuleChain extension

ipv4() → RuleBuilder

Available on Rule, provided by the RuleChain extension

ipv6() → RuleBuilder

Available on Rule, provided by the RuleChain extension

json() → RuleBuilder

Available on Rule, provided by the RuleChain extension

list() → RuleBuilder

Available on Rule, provided by the RuleChain extension

lowercase() → RuleBuilder

Available on Rule, provided by the RuleChain extension

map() → RuleBuilder

Available on Rule, provided by the RuleChain extension

max(num value) → RuleBuilder

Available on Rule, provided by the RuleChain extension

mimes(List<String> extensions) → RuleBuilder

Available on Rule, provided by the RuleChain extension

mimetypes(List<String> types) → RuleBuilder

Available on Rule, provided by the RuleChain extension

min(num value) → RuleBuilder

Available on Rule, provided by the RuleChain extension

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

notIn(List<Object?> values) → RuleBuilder

Available on Rule, provided by the RuleChain extension

notRegex(RegExp pattern) → RuleBuilder

Available on Rule, provided by the RuleChain extension

nullable() → RuleBuilder

Available on Rule, provided by the RuleChain extension

numeric() → RuleBuilder

Available on Rule, provided by the RuleChain extension

passes(ValidationContext context) → FutureOr<String?>

password({int min = 8, bool letters = false, bool mixedCase = false, bool numbers = false, bool symbols = false}) → RuleBuilder

Available on Rule, provided by the RuleChain extension

present() → RuleBuilder

Available on Rule, provided by the RuleChain extension

prohibited() → RuleBuilder

Available on Rule, provided by the RuleChain extension

regex(RegExp pattern) → RuleBuilder

Available on Rule, provided by the RuleChain extension

required() → RuleBuilder

Available on Rule, provided by the RuleChain extension

requiredIf(String other, Object? value) → RuleBuilder

Available on Rule, provided by the RuleChain extension

requiredUnless(String other, Object? value) → RuleBuilder

Available on Rule, provided by the RuleChain extension

requiredWith(List<String> others) → RuleBuilder

Available on Rule, provided by the RuleChain extension

requiredWithout(List<String> others) → RuleBuilder

Available on Rule, provided by the RuleChain extension

same(String other) → RuleBuilder

Available on Rule, provided by the RuleChain extension

size(num value) → RuleBuilder

Available on Rule, provided by the RuleChain extension

sometimes() → RuleBuilder

Available on Rule, provided by the RuleChain extension

startsWith(List<String> prefixes) → RuleBuilder

Available on Rule, provided by the RuleChain extension

string() → RuleBuilder

Available on Rule, provided by the RuleChain extension

toString() → String

A string representation of this object.

inherited

ulid() → RuleBuilder

Available on Rule, provided by the RuleChain extension

unique(String table, [String? column, Object? ignore, String idColumn = 'id']) → RuleBuilder

Available on Rule, provided by the RuleChain extension

uppercase() → RuleBuilder

Available on Rule, provided by the RuleChain extension

url() → RuleBuilder

Available on Rule, provided by the RuleChain extension

uuid() → RuleBuilder

Available on Rule, provided by the RuleChain extension

Operators

operator ==(Object other) → bool

The equality operator.

inherited