Rule
class Rule
Traits
Constants
| UNDOTTED_DATA_CONTEXT_KEY |
CoroutineContext key for caching the undotted data in Rule::compile(). Set by ValidationRuleParser::explodeWildcardRulesCompilable() to avoid repeated Arr::undot() calls when Rule::forEach expands wildcard items. |
Properties
| static protected array | $macros | The registered string macros. |
from Macroable |
Methods
Mix another object into the class.
Dynamically handle calls to the class.
Dynamically handle calls to the class.
Apply the given rules if the given condition is truthy.
Apply the given rules if the given condition is falsy.
Get a unique constraint builder instance.
Get an exists constraint builder instance.
Get an accepted validation rule.
Get an active_url validation rule.
Get a base64 validation rule.
Get a bail validation rule.
Get a boolean validation rule.
Get a declined validation rule.
Get an exclude validation rule.
Get a filled validation rule.
Get a hex_color validation rule.
Get a json validation rule.
Get a list validation rule.
Get a mac_address validation rule.
Get a missing validation rule.
Get a nullable validation rule.
Get a present validation rule.
Get a prohibited validation rule.
Get a required validation rule.
Get a sometimes validation rule.
Get an ulid validation rule.
Get an accepted_if rule builder instance.
Get a declined_if rule builder instance.
Get a missing_if rule builder instance.
Get a missing_unless rule builder instance.
Get a present_if rule builder instance.
Get a present_unless rule builder instance.
Get a current_password rule builder instance.
Get an exclude_with rule builder instance.
Get an exclude_without rule builder instance.
Get an in_array_keys rule builder instance.
Get a missing_with rule builder instance.
Get a missing_with_all rule builder instance.
Get a present_with rule builder instance.
Get a present_with_all rule builder instance.
Get a prohibited_if_accepted rule builder instance.
Get a prohibited_if_declined rule builder instance.
Get a required_array_keys rule builder instance.
Get a required_if_accepted rule builder instance.
Get a required_if_declined rule builder instance.
Get a required_with rule builder instance.
Get a required_with_all rule builder instance.
Get a required_without rule builder instance.
Get a required_without_all rule builder instance.
Get a dimensions rule builder instance.
Get a string rule builder instance.
Compile a set of rules for an attribute.
Flush all static state.
Details
in
Macroable at line 30
static void
macro(string $name, callable|object $macro)
Register a custom macro.
Macros persist in a static property for the worker lifetime and apply to every subsequent call on the macroable class.
in
Macroable at line 44
static void
mixin(object $mixin, bool $replace = true)
Mix another object into the class.
Delegates to macro() for each method; registered macros persist in a static property for the worker lifetime.
in
Macroable at line 61
static bool
hasMacro(string $name)
Check if macro is registered.
in
Macroable at line 72
static void
flushMacros()
Flush the existing macros.
Clears worker-wide macros; concurrent coroutines may resolve different methods depending on timing.
in
Macroable at line 83
static mixed
__callStatic(string $method, array $parameters)
Dynamically handle calls to the class.
in
Macroable at line 108
mixed
__call(string $method, array $parameters)
Dynamically handle calls to the class.
at line 90
static Can
can(string $ability, mixed ...$arguments)
Get a can constraint builder instance.
at line 98
static ConditionalRules
when(bool|callable $condition, array|Closure|Rule|string|Stringable|ValidationRule $rules, array|Closure|Rule|string|Stringable|ValidationRule $defaultRules = [])
Apply the given rules if the given condition is truthy.
at line 109
static ConditionalRules
unless(bool|callable $condition, array|Closure|Rule|string|Stringable|ValidationRule $rules, array|Closure|Rule|string|Stringable|ValidationRule $defaultRules = [])
Apply the given rules if the given condition is falsy.
at line 120
static ArrayRule
array(mixed $keys = null)
Get an array rule builder instance.
at line 128
static ArrayKeys
arrayKeys(array|Arrayable|UnitEnum|int|string $keys)
Get an array keys rule builder instance.
at line 136
static NestedRules
forEach(Closure $callback)
Create a new nested rule set.
at line 144
static Unique
unique(string $table, string $column = 'NULL')
Get a unique constraint builder instance.
at line 152
static Exists
exists(string $table, string $column = 'NULL')
Get an exists constraint builder instance.
at line 168
static NotIn
notIn(array|Arrayable|UnitEnum|string $values)
Get a not_in rule builder instance.
at line 176
static string
accepted()
Get an accepted validation rule.
at line 184
static string
activeUrl()
Get an active_url validation rule.
at line 192
static string
base64()
Get a base64 validation rule.
at line 200
static string
bail()
Get a bail validation rule.
at line 208
static string
boolean(bool $strict = false)
Get a boolean validation rule.
at line 216
static string
declined()
Get a declined validation rule.
at line 224
static string
exclude()
Get an exclude validation rule.
at line 232
static string
filled()
Get a filled validation rule.
at line 240
static string
hexColor()
Get a hex_color validation rule.
at line 248
static string
json()
Get a json validation rule.
at line 256
static string
list()
Get a list validation rule.
at line 264
static string
macAddress()
Get a mac_address validation rule.
at line 272
static string
missing()
Get a missing validation rule.
at line 280
static string
nullable()
Get a nullable validation rule.
at line 288
static string
present()
Get a present validation rule.
at line 296
static string
prohibited()
Get a prohibited validation rule.
at line 304
static string
required()
Get a required validation rule.
at line 312
static string
sometimes()
Get a sometimes validation rule.
at line 320
static string
ulid()
Get an ulid validation rule.
at line 328
static AcceptedIf
acceptedIf(string $anotherField, array|string|int|float|bool|null $value)
Get an accepted_if rule builder instance.
at line 336
static DeclinedIf
declinedIf(string $anotherField, array|string|int|float|bool|null $value)
Get a declined_if rule builder instance.
at line 344
static MissingIf
missingIf(string $anotherField, array|string|int|float|bool|null $value)
Get a missing_if rule builder instance.
at line 352
static MissingUnless
missingUnless(string $anotherField, array|string|int|float|bool|null $value)
Get a missing_unless rule builder instance.
at line 360
static PresentIf
presentIf(string $anotherField, array|string|int|float|bool|null $value)
Get a present_if rule builder instance.
at line 368
static PresentUnless
presentUnless(string $anotherField, array|string|int|float|bool|null $value)
Get a present_unless rule builder instance.
at line 376
static Confirmed
confirmed()
Get a confirmed rule builder instance.
at line 384
static CurrentPassword
currentPassword()
Get a current_password rule builder instance.
at line 392
static Distinct
distinct()
Get a distinct rule builder instance.
at line 400
static ExcludeWith
excludeWith(string $anotherField)
Get an exclude_with rule builder instance.
at line 408
static ExcludeWithout
excludeWithout(array|string $anotherField)
Get an exclude_without rule builder instance.
at line 416
static InArray
inArray(string $otherField)
Get an in_array rule builder instance.
at line 424
static InArrayKeys
inArrayKeys(array|string $keys)
Get an in_array_keys rule builder instance.
at line 432
static IpAddress
ip()
Get an IP address rule builder instance.
at line 440
static MissingWith
missingWith(array|string $fields)
Get a missing_with rule builder instance.
at line 448
static MissingWithAll
missingWithAll(array|string $fields)
Get a missing_with_all rule builder instance.
at line 456
static PresentWith
presentWith(array|string $fields)
Get a present_with rule builder instance.
at line 464
static PresentWithAll
presentWithAll(array|string $fields)
Get a present_with_all rule builder instance.
at line 472
static ProhibitedIfAccepted
prohibitedIfAccepted(string $field)
Get a prohibited_if_accepted rule builder instance.
at line 480
static ProhibitedIfDeclined
prohibitedIfDeclined(string $field)
Get a prohibited_if_declined rule builder instance.
at line 488
static Prohibits
prohibits(array|string $fields)
Get a prohibits rule builder instance.
at line 496
static Regex
regex(string $pattern)
Get a regex rule builder instance.
at line 504
static NotRegex
notRegex(string $pattern)
Get a not_regex rule builder instance.
at line 512
static RequiredArrayKeys
requiredArrayKeys(array|string $keys)
Get a required_array_keys rule builder instance.
at line 520
static RequiredIfAccepted
requiredIfAccepted(string $field)
Get a required_if_accepted rule builder instance.
at line 528
static RequiredIfDeclined
requiredIfDeclined(string $field)
Get a required_if_declined rule builder instance.
at line 536
static RequiredWith
requiredWith(array|string $fields)
Get a required_with rule builder instance.
at line 544
static RequiredWithAll
requiredWithAll(array|string $fields)
Get a required_with_all rule builder instance.
at line 552
static RequiredWithout
requiredWithout(array|string $fields)
Get a required_without rule builder instance.
at line 560
static RequiredWithoutAll
requiredWithoutAll(array|string $fields)
Get a required_without_all rule builder instance.
at line 568
static Timezone
timezone(array|null $arguments = null)
Get a timezone rule builder instance.
at line 576
static Url
url()
Get a URL rule builder instance.
at line 584
static Uuid
uuid()
Get a UUID rule builder instance.
at line 594
static RequiredIf
requiredIf(bool|Closure|null $callback)
Get a required_if rule builder instance.
at line 604
static RequiredUnless
requiredUnless(bool|Closure|null $callback)
Get a required_unless rule builder instance.
at line 614
static ExcludeIf
excludeIf(bool|Closure $callback)
Get an exclude_if rule builder instance.
at line 624
static ExcludeUnless
excludeUnless(bool|Closure $callback)
Get an exclude_unless rule builder instance.
at line 634
static ProhibitedIf
prohibitedIf(bool|Closure $callback)
Get a prohibited_if rule builder instance.
at line 644
static ProhibitedUnless
prohibitedUnless(bool|Closure $callback)
Get a prohibited_unless rule builder instance.
at line 652
static Date
date()
Get a date rule builder instance.
at line 660
static Date
dateTime()
Get a datetime rule builder instance.
at line 668
static Email
email()
Get an email rule builder instance.
at line 678
static Enum
enum(string $type)
Get an enum rule builder instance.
at line 686
static File
file()
Get a file rule builder instance.
at line 694
static ImageFile
imageFile(bool $allowSvg = false)
Get an image file rule builder instance.
at line 702
static Dimensions
dimensions(array $constraints = [])
Get a dimensions rule builder instance.
at line 710
static StringRule
string()
Get a string rule builder instance.
at line 718
static Numeric
numeric(bool $strict = false)
Get a numeric rule builder instance.
at line 728
static AnyOf
anyOf(array $rules)
Get an "any of" rule builder instance.
at line 736
static Contains
contains(array|Arrayable|UnitEnum|string $values)
Get a contains rule builder instance.
at line 744
static DoesntContain
doesntContain(array|Arrayable|UnitEnum|string $values)
Get a doesnt_contain rule builder instance.
at line 752
static object
compile(string $attribute, mixed $rules, array|null $data = null)
Compile a set of rules for an attribute.
at line 783
static void
flushState()
Flush all static state.