| Methods |
public
|
__construct(Translator $translator, array $data, array $rules, array $messages = [], array $attributes = []): void
Create a new Validator instance.
Create a new Validator instance.
|
#
|
public
|
parseData(array $data): array
Parse the data array, converting dots and asterisks.
Parse the data array, converting dots and asterisks.
|
#
|
protected
|
replacePlaceholders(array $data): array
Replace the placeholders used in data keys.
Replace the placeholders used in data keys.
|
#
|
protected
|
replacePlaceholderInString(string $value): string
Replace the placeholders in the given string.
Replace the placeholders in the given string.
|
#
|
protected
|
replaceDotPlaceholderInParameters(array $parameters): array
Replace each field parameter dot placeholder with dot.
Replace each field parameter dot placeholder with dot.
|
#
|
public
|
after(callable|array|string $callback): $this
Add an after validation callback.
Add an after validation callback.
Implements
|
#
|
public
|
passes(): bool
Determine if the data passes the validation rules.
Determine if the data passes the validation rules.
|
#
|
public
|
fails(): bool
Determine if the data fails the validation rules.
Determine if the data fails the validation rules.
Implements
|
#
|
protected
|
shouldBeExcluded(string $attribute): bool
Determine if the attribute should be excluded.
Determine if the attribute should be excluded.
|
#
|
protected
|
removeAttribute(string $attribute): void
Remove the given attribute.
Remove the given attribute.
|
#
|
public
|
validate(): array
Run the validator's rules against its data.
Run the validator's rules against its data.
Throws
Implements
|
#
|
public
|
validateWithBag(string $errorBag): array
Run the validator's rules against its data.
Run the validator's rules against its data.
Throws
|
#
|
public
|
safe(array|null $keys = null): ValidatedInput|array
Get a validated input container for the validated input.
Get a validated input container for the validated input.
|
#
|
public
|
validated(): array
Get the attributes and values that were validated.
Get the attributes and values that were validated.
Throws
Implements
|
#
|
protected
|
validateAttribute(string $attribute, string $rule): void
Validate a given attribute against a rule.
Validate a given attribute against a rule.
|
#
|
protected
|
dependsOnOtherFields(string $rule): bool
Determine if the given rule depends on other fields.
Determine if the given rule depends on other fields.
|
#
|
protected
|
getExplicitKeys(string $attribute): array
Get the explicit keys from an attribute flattened with dot notation.
Get the explicit keys from an attribute flattened with dot notation.
E.g. 'foo.1.bar.spark.baz' -> [1, 'spark'] for 'foo..bar..baz'
|
#
|
protected
|
getPrimaryAttribute(string $attribute): string
Get the primary attribute name.
Get the primary attribute name.
For example, if "name.0" is given, "name.*" will be returned.
|
#
|
protected
|
replaceDotInParameters(array $parameters): array
Replace each field parameter which has an escaped dot with the dot placeholder.
Replace each field parameter which has an escaped dot with the dot placeholder.
|
#
|
protected
|
replaceAsterisksInParameters(array $parameters, array $keys): array
Replace each field parameter which has asterisks with the given keys.
Replace each field parameter which has asterisks with the given keys.
|
#
|
protected
|
isValidatable(object|string $rule, string $attribute, mixed $value): bool
Determine if the attribute is validatable.
Determine if the attribute is validatable.
|
#
|
protected
|
presentOrRuleIsImplicit(object|string $rule, string $attribute, mixed $value): bool
Determine if the field is present, or the rule implies required.
Determine if the field is present, or the rule implies required.
|
#
|
protected
|
isImplicit(object|string $rule): bool
Determine if a given rule implies the attribute is required.
Determine if a given rule implies the attribute is required.
|
#
|
protected
|
passesOptionalCheck(string $attribute): bool
Determine if the attribute passes any optional check.
Determine if the attribute passes any optional check.
|
#
|
protected
|
isNotNullIfMarkedAsNullable(string $rule, string $attribute): bool
Determine if the attribute fails the nullable check.
Determine if the attribute fails the nullable check.
|
#
|
protected
|
hasNotFailedPreviousRuleIfPresenceRule(string $rule, string $attribute): bool
Determine if it's a necessary presence validation.
Determine if it's a necessary presence validation.
This is to avoid possible database type comparison errors.
|
#
|
protected
|
validateUsingCustomRule(string $attribute, mixed $value, Rule $rule): void
Validate an attribute using a custom rule object.
Validate an attribute using a custom rule object.
|
#
|
protected
|
shouldStopValidating(string $attribute): bool
Check if we should stop further validations on a given attribute.
Check if we should stop further validations on a given attribute.
|
#
|
public
|
addFailure(string $attribute, string $rule, array $parameters = []): void
Add a failed rule and error message to the collection.
Add a failed rule and error message to the collection.
|
#
|
protected
|
excludeAttribute(string $attribute): void
Add the given attribute to the list of excluded attributes.
Add the given attribute to the list of excluded attributes.
|
#
|
public
|
valid(): array
Returns the data which was valid.
Returns the data which was valid.
|
#
|
public
|
invalid(): array
Returns the data which was invalid.
Returns the data which was invalid.
|
#
|
protected
|
attributesThatHaveMessages(): array
Generate an array of all attributes that have messages.
Generate an array of all attributes that have messages.
|
#
|
public
|
failed(): array
Get the failed validation rules.
Get the failed validation rules.
Implements
|
#
|
public
|
messages(): MessageBag
Get the message container for the validator.
Get the message container for the validator.
|
#
|
public
|
errors(): MessageBag
An alternative more semantic shortcut to the message container.
An alternative more semantic shortcut to the message container.
Implements
|
#
|
public
|
getMessageBag(): MessageBag
Get the messages for the instance.
Get the messages for the instance.
Implements
|
#
|
public
|
hasRule(string $attribute, string|array $rules): bool
Determine if the given attribute has a rule in the given set.
Determine if the given attribute has a rule in the given set.
|
#
|
protected
|
getRule(string $attribute, string|array $rules): array|null
Get a rule and its parameters for a given attribute.
Get a rule and its parameters for a given attribute.
|
#
|
public
|
attributes(): array
Get the data under validation.
Get the data under validation.
|
#
|
public
|
getData(): array
Get the data under validation.
Get the data under validation.
|
#
|
public
|
setData(array $data): $this
Set the data under validation.
Set the data under validation.
|
#
|
public
|
getValue(string $attribute): mixed
Get the value of a given attribute.
Get the value of a given attribute.
|
#
|
public
|
setValue(string $attribute, mixed $value): void
Set the value of a given attribute.
Set the value of a given attribute.
|
#
|
public
|
getRules(): array
Get the validation rules.
Get the validation rules.
|
#
|
public
|
getRulesWithoutPlaceholders(): array
Get the validation rules with key placeholders removed.
Get the validation rules with key placeholders removed.
|
#
|
public
|
setRules(array $rules): $this
Set the validation rules.
Set the validation rules.
|
#
|
public
|
addRules(array $rules): void
Parse the given rules and merge them into current rules.
Parse the given rules and merge them into current rules.
|
#
|
public
|
sometimes(string|array $attribute, string|array $rules, callable $callback): $this
Add conditions to a given field based on a Closure.
Add conditions to a given field based on a Closure.
Implements
|
#
|
public
|
stopOnFirstFailure(bool $stopOnFirstFailure = true): $this
Instruct the validator to stop validating after the first rule failure.
Instruct the validator to stop validating after the first rule failure.
|
#
|
public
|
addExtensions(array $extensions): void
Register an array of custom validator extensions.
Register an array of custom validator extensions.
|
#
|
public
|
addImplicitExtensions(array $extensions): void
Register an array of custom implicit validator extensions.
Register an array of custom implicit validator extensions.
|
#
|
public
|
addDependentExtensions(array $extensions): void
Register an array of custom dependent validator extensions.
Register an array of custom dependent validator extensions.
|
#
|
public
|
addExtension(string $rule, Closure|string $extension): void
Register a custom validator extension.
Register a custom validator extension.
|
#
|
public
|
addImplicitExtension(string $rule, Closure|string $extension): void
Register a custom implicit validator extension.
Register a custom implicit validator extension.
|
#
|
public
|
addDependentExtension(string $rule, Closure|string $extension): void
Register a custom dependent validator extension.
Register a custom dependent validator extension.
|
#
|
public
|
addReplacers(array $replacers): void
Register an array of custom validator message replacers.
Register an array of custom validator message replacers.
|
#
|
public
|
addReplacer(string $rule, Closure|string $replacer): void
Register a custom validator message replacer.
Register a custom validator message replacer.
|
#
|
public
|
setCustomMessages(array $messages): $this
Set the custom messages for the validator.
Set the custom messages for the validator.
|
#
|
public
|
setAttributeNames(array $attributes): $this
Set the custom attributes on the validator.
Set the custom attributes on the validator.
|
#
|
public
|
addCustomAttributes(array $attributes): $this
Add custom attributes to the validator.
Add custom attributes to the validator.
|
#
|
public
|
setImplicitAttributesFormatter(callable|null $formatter = null): $this
Set the callback that used to format an implicit attribute.
Set the callback that used to format an implicit attribute.
|
#
|
public
|
setValueNames(array $values): $this
Set the custom values on the validator.
Set the custom values on the validator.
|
#
|
public
|
addCustomValues(array $customValues): $this
Add the custom values for the validator.
Add the custom values for the validator.
|
#
|
public
|
setFallbackMessages(array $messages): void
Set the fallback messages for the validator.
Set the fallback messages for the validator.
|
#
|
public
|
getPresenceVerifier(string|null $connection = null): PresenceVerifierInterface
Get the Presence Verifier implementation.
Get the Presence Verifier implementation.
Throws
|
#
|
public
|
setPresenceVerifier(PresenceVerifierInterface $presenceVerifier): void
Set the Presence Verifier implementation.
Set the Presence Verifier implementation.
|
#
|
public
|
getException(): class-string<ValidationException>
Get the exception to throw upon failed validation.
Get the exception to throw upon failed validation.
|
#
|
public
|
setException(class-string<ValidationException> $exception): $this
Set the exception to throw upon failed validation.
Set the exception to throw upon failed validation.
Throws
|
#
|
public
|
ensureExponentWithinAllowedRangeUsing($callback): $this
Ensure exponents are within range using the given callback.
Ensure exponents are within range using the given callback.
|
#
|
public
|
getTranslator(): Translator
Get the Translator implementation.
Get the Translator implementation.
|
#
|
public
|
setTranslator(Translator $translator): void
Set the Translator implementation.
Set the Translator implementation.
|
#
|
public
|
setContainer(Container $container): void
Set the IoC container instance.
Set the IoC container instance.
|
#
|
protected
|
callExtension(string $rule, array $parameters): bool|null
Call a custom validator extension.
Call a custom validator extension.
|
#
|
protected
|
callClassBasedExtension(string $callback, array $parameters): bool
Call a class based validator extension.
Call a class based validator extension.
|
#
|
public
|
__call(string $method, array $parameters): mixed
Handle dynamic calls to class methods.
Handle dynamic calls to class methods.
Throws
|
#
|
| Properties |
protected
|
Translator
|
$translator
|
#
|
protected
|
Container
|
$container
|
#
|
protected
|
PresenceVerifierInterface
|
$presenceVerifier
|
#
|
protected
|
array
|
$failedRules = []
|
#
|
protected
|
array
|
$excludeAttributes = []
|
#
|
protected
|
MessageBag
|
$messages
|
#
|
protected
|
array
|
$data
|
#
|
protected
|
array
|
$initialRules
|
#
|
protected
|
array
|
$rules
|
#
|
protected
|
string
|
$currentRule
|
#
|
protected
|
array
|
$implicitAttributes = []
|
#
|
protected
|
callable|null
|
$implicitAttributesFormatter
|
#
|
protected
|
array
|
$distinctValues = []
|
#
|
protected
|
array
|
$after = []
|
#
|
public
|
array
|
$customMessages = []
|
#
|
public
|
array
|
$fallbackMessages = []
|
#
|
public
|
array
|
$customAttributes = []
|
#
|
public
|
array
|
$customValues = []
|
#
|
protected
|
bool
|
$stopOnFirstFailure = false
|
#
|
public
|
bool
|
$excludeUnvalidatedArrayKeys = false
|
#
|
public
|
array
|
$extensions = []
|
#
|
public
|
array
|
$replacers = []
|
#
|
protected
|
string[]
|
$fileRules = ['Between', 'Dimensions', 'Extensions', 'File', 'Image', 'Max', 'Mimes', 'Mimetypes', 'Min', 'Size']
|
#
|
protected
|
string[]
|
$implicitRules = [
'Accepted',
'AcceptedIf',
'Declined',
'DeclinedIf',
'Filled',
'Missing',
'MissingIf',
'MissingUnless',
'MissingWith',
'MissingWithAll',
'Present',
'PresentIf',
'PresentUnless',
'PresentWith',
'PresentWithAll',
'Required',
'RequiredIf',
'RequiredIfAccepted',
'RequiredIfDeclined',
'RequiredUnless',
'RequiredWith',
'RequiredWithAll',
'RequiredWithout',
'RequiredWithoutAll',
]
|
#
|
protected
|
string[]
|
$dependentRules = [
'After',
'AfterOrEqual',
'Before',
'BeforeOrEqual',
'Confirmed',
'Different',
'ExcludeIf',
'ExcludeUnless',
'ExcludeWith',
'ExcludeWithout',
'Gt',
'Gte',
'Lt',
'Lte',
'AcceptedIf',
'DeclinedIf',
'RequiredIf',
'RequiredIfAccepted',
'RequiredIfDeclined',
'RequiredUnless',
'RequiredWith',
'RequiredWithAll',
'RequiredWithout',
'RequiredWithoutAll',
'PresentIf',
'PresentUnless',
'PresentWith',
'PresentWithAll',
'Prohibited',
'ProhibitedIf',
'ProhibitedIfAccepted',
'ProhibitedIfDeclined',
'ProhibitedUnless',
'Prohibits',
'MissingIf',
'MissingUnless',
'MissingWith',
'MissingWithAll',
'Same',
'Unique',
]
|
#
|
protected
|
string[]
|
$excludeRules = ['Exclude', 'ExcludeIf', 'ExcludeUnless', 'ExcludeWith', 'ExcludeWithout']
|
#
|
protected
|
string[]
|
$sizeRules = ['Size', 'Between', 'Min', 'Max', 'Gt', 'Lt', 'Gte', 'Lte']
|
#
|
protected
|
string[]
|
$numericRules = ['Numeric', 'Integer', 'Decimal']
|
#
|
protected
|
string[]
|
$defaultNumericRules = ['Numeric', 'Integer', 'Decimal']
|
#
|
protected
static
|
string
|
$placeholderHash
|
#
|
protected
|
class-string<ValidationException>
|
$exception = ValidationException::class
|
#
|
protected
|
callable|null
|
$ensureExponentWithinAllowedRangeUsing
|
#
|