W3cubDocs

/Laravel 11

Validator

class Validator implements Validator (View source)

Traits

FormatsMessages
ValidatesAttributes
ReplacesAttributes

Properties

protected Translator $translator

The Translator implementation.
protected Container $container

The container instance.
protected PresenceVerifierInterface $presenceVerifier

The Presence Verifier implementation.
protected array $failedRules

The failed validation rules.
protected array $excludeAttributes

Attributes that should be excluded from the validated data.
protected MessageBag $messages

The message bag instance.
protected array $data

The data under validation.
protected array $initialRules

The initial rules provided.
protected array $rules

The rules to be applied to the data.
protected string $currentRule

The current rule that is validating.
protected array $implicitAttributes

The array of wildcard attributes with their asterisks expanded.
protected callable|null $implicitAttributesFormatter

The callback that should be used to format the attribute.
protected array $distinctValues

The cached data for the "distinct" rule.
protected array $after

All of the registered "after" callbacks.
array $customMessages

The array of custom error messages.
array $fallbackMessages

The array of fallback error messages.
array $customAttributes

The array of custom attribute names.
array $customValues

The array of custom displayable values.
protected bool $stopOnFirstFailure

Indicates if the validator should stop on the first rule failure.
bool $excludeUnvalidatedArrayKeys

Indicates that unvalidated array keys should be excluded, even if the parent array was validated.
array $extensions

All of the custom validator extensions.
array $replacers

All of the custom replacer extensions.
protected string[] $fileRules

The validation rules that may be applied to files.
protected string[] $implicitRules

The validation rules that imply the field is required.
protected string[] $dependentRules

The validation rules which depend on other fields as parameters.
protected string[] $excludeRules

The validation rules that can exclude an attribute.
protected string[] $sizeRules

The size related validation rules.
protected string[] $numericRules

The numeric related validation rules.
protected string[] $defaultNumericRules

The default numeric related validation rules.
protected string $dotPlaceholder

The current placeholder for dots in rule keys.
protected string $exception

The exception to throw upon failure.
protected callable|null $ensureExponentWithinAllowedRangeUsing

The custom callback to determine if an exponent is within allowed range.

Methods

string replaceAcceptedIf(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the accepted_if rule.

 from ReplacesAttributes
string replaceDeclinedIf(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the declined_if rule.

 from ReplacesAttributes
string replaceBetween(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the between rule.

 from ReplacesAttributes
string replaceDateFormat(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the date_format rule.

 from ReplacesAttributes
string replaceDecimal(string $message, string $attribute, string $rule, array<int,int> $parameters)

Replace all place-holders for the decimal rule.

 from ReplacesAttributes
string replaceDifferent(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the different rule.

 from ReplacesAttributes
string replaceDigits(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the digits rule.

 from ReplacesAttributes
string replaceDigitsBetween(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the digits (between) rule.

 from ReplacesAttributes
string replaceExtensions(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the extensions rule.

 from ReplacesAttributes
string replaceMin(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the min rule.

 from ReplacesAttributes
string replaceMinDigits(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the min digits rule.

 from ReplacesAttributes
string replaceMax(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the max rule.

 from ReplacesAttributes
string replaceMaxDigits(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the max digits rule.

 from ReplacesAttributes
string replaceMissingIf(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the missing_if rule.

 from ReplacesAttributes
string replaceMissingUnless(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the missing_unless rule.

 from ReplacesAttributes
string replaceMissingWith(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the missing_with rule.

 from ReplacesAttributes
string replaceMissingWithAll(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the missing_with_all rule.

 from ReplacesAttributes
string replaceMultipleOf(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the multiple_of rule.

 from ReplacesAttributes
string replaceIn(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the in rule.

 from ReplacesAttributes
string replaceNotIn(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the not_in rule.

 from ReplacesAttributes
string replaceInArray(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the in_array rule.

 from ReplacesAttributes
string replaceRequiredArrayKeys(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the required_array_keys rule.

 from ReplacesAttributes
string replaceMimetypes(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the mimetypes rule.

 from ReplacesAttributes
string replaceMimes(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the mimes rule.

 from ReplacesAttributes
string replacePresentIf(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the present_if rule.

 from ReplacesAttributes
string replacePresentUnless(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the present_unless rule.

 from ReplacesAttributes
string replacePresentWith(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the present_with rule.

 from ReplacesAttributes
string replacePresentWithAll(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the present_with_all rule.

 from ReplacesAttributes
string replaceRequiredWith(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the required_with rule.

 from ReplacesAttributes
string replaceRequiredWithAll(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the required_with_all rule.

 from ReplacesAttributes
string replaceRequiredWithout(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the required_without rule.

 from ReplacesAttributes
string replaceRequiredWithoutAll(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the required_without_all rule.

 from ReplacesAttributes
string replaceSize(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the size rule.

 from ReplacesAttributes
string replaceGt(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the gt rule.

 from ReplacesAttributes
string replaceLt(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the lt rule.

 from ReplacesAttributes
string replaceGte(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the gte rule.

 from ReplacesAttributes
string replaceLte(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the lte rule.

 from ReplacesAttributes
string replaceRequiredIf(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the required_if rule.

 from ReplacesAttributes
string replaceRequiredIfAccepted(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the required_if_accepted rule.

 from ReplacesAttributes
string replaceRequiredIfDeclined(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the required_if_declined rule.

 from ReplacesAttributes
string replaceRequiredUnless(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the required_unless rule.

 from ReplacesAttributes
string replaceProhibitedIf(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the prohibited_if rule.

 from ReplacesAttributes
string replaceProhibitedUnless(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the prohibited_unless rule.

 from ReplacesAttributes
string replaceProhibits(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the prohibited_with rule.

 from ReplacesAttributes
string replaceSame(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the same rule.

 from ReplacesAttributes
string replaceBefore(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the before rule.

 from ReplacesAttributes
string replaceBeforeOrEqual(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the before_or_equal rule.

 from ReplacesAttributes
string replaceAfter(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the after rule.

 from ReplacesAttributes
string replaceAfterOrEqual(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the after_or_equal rule.

 from ReplacesAttributes
string replaceDateEquals(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the date_equals rule.

 from ReplacesAttributes
string replaceDimensions(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the dimensions rule.

 from ReplacesAttributes
string replaceEndsWith(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the ends_with rule.

 from ReplacesAttributes
string replaceDoesntEndWith(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the doesnt_end_with rule.

 from ReplacesAttributes
string replaceStartsWith(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the starts_with rule.

 from ReplacesAttributes
string replaceDoesntStartWith(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the doesnt_start_with rule.

 from ReplacesAttributes
string getMessage(string $attribute, string $rule)

Get the validation message for an attribute and rule.

 from FormatsMessages
string|null getInlineMessage(string $attribute, string $rule)

Get the proper inline error message for standard and size rules.

 from FormatsMessages
string|null getFromLocalArray(string $attribute, string $lowerRule, array|null $source = null)

Get the inline message for a rule if it exists.

 from FormatsMessages
string getCustomMessageFromTranslator(array|string $keys)

Get the custom error message from the translator.

 from FormatsMessages
string getWildcardCustomMessages(array $messages, string $search, string $default)

Check the given messages for a wildcard key.

 from FormatsMessages
string getSizeMessage(string $attribute, string $rule)

Get the proper error message for an attribute and size rule.

 from FormatsMessages
string getAttributeType(string $attribute)

Get the data type of the given attribute.

 from FormatsMessages
string makeReplacements(string $message, string $attribute, string $rule, array $parameters)

Replace all error message place-holders with actual values.

 from FormatsMessages
string getDisplayableAttribute(string $attribute)

Get the displayable name of the attribute.

 from FormatsMessages
string|null getAttributeFromTranslations(string $name)

Get the given attribute from the attribute translations.

 from FormatsMessages
string|null getAttributeFromLocalArray(string $attribute, array|null $source = null)

Get the custom name for an attribute if it exists in the given array.

 from FormatsMessages
string replaceAttributePlaceholder(string $message, string $value)

Replace the :attribute placeholder in the given message.

 from FormatsMessages
string replaceIndexPlaceholder(string $message, string $attribute)

Replace the :index placeholder in the given message.

 from FormatsMessages
string replacePositionPlaceholder(string $message, string $attribute)

Replace the :position placeholder in the given message.

 from FormatsMessages
string replaceIndexOrPositionPlaceholder(string $message, string $attribute, string $placeholder, Closure|null $modifier = null)

Replace the :index or :position placeholder in the given message.

 from FormatsMessages
string numberToIndexOrPositionWord(int $value)

Get the word for a index or position segment.

 from FormatsMessages
string replaceInputPlaceholder(string $message, string $attribute)

Replace the :input placeholder in the given message.

 from FormatsMessages
string getDisplayableValue(string $attribute, mixed $value)

Get the displayable name of the value.

 from FormatsMessages
array getAttributeList(array $values)

Transform an array of attributes to their displayable form.

 from FormatsMessages
string|null callReplacer(string $message, string $attribute, string $rule, array $parameters, Validator $validator)

Call a custom validator message replacer.

 from FormatsMessages
string callClassBasedReplacer(string $callback, string $message, string $attribute, string $rule, array $parameters, Validator $validator)

Call a class based validator message replacer.

 from FormatsMessages
bool validateAccepted(string $attribute, mixed $value)

Validate that an attribute was "accepted".

 from ValidatesAttributes
bool validateAcceptedIf(string $attribute, mixed $value, mixed $parameters)

Validate that an attribute was "accepted" when another attribute has a given value.

 from ValidatesAttributes
bool validateDeclined(string $attribute, mixed $value)

Validate that an attribute was "declined".

 from ValidatesAttributes
bool validateDeclinedIf(string $attribute, mixed $value, mixed $parameters)

Validate that an attribute was "declined" when another attribute has a given value.

 from ValidatesAttributes
bool validateActiveUrl(string $attribute, mixed $value)

Validate that an attribute is an active URL.

 from ValidatesAttributes
array|false getDnsRecords(string $hostname, int $type)

Get the DNS records for the given hostname.

 from ValidatesAttributes
bool validateAscii(string $attribute, mixed $value)

Validate that an attribute is 7 bit ASCII.

 from ValidatesAttributes
bool validateBail()

"Break" on first validation fail.

 from ValidatesAttributes
bool validateBefore(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate the date is before a given date.

 from ValidatesAttributes
bool validateBeforeOrEqual(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate the date is before or equal a given date.

 from ValidatesAttributes
bool validateAfter(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate the date is after a given date.

 from ValidatesAttributes
bool validateAfterOrEqual(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate the date is equal or after a given date.

 from ValidatesAttributes
bool compareDates(string $attribute, mixed $value, array<int,int|string> $parameters, string $operator)

Compare a given date against another using an operator.

 from ValidatesAttributes
string|null getDateFormat(string $attribute)

Get the date format for an attribute if it has one.

 from ValidatesAttributes
int getDateTimestamp(mixed $value)

Get the date timestamp.

 from ValidatesAttributes
bool checkDateTimeOrder(string $format, string $first, string $second, string $operator)

Given two date/time strings, check that one is after the other.

 from ValidatesAttributes
DateTime|null getDateTimeWithOptionalFormat(string $format, string $value)

Get a DateTime instance from a string.

 from ValidatesAttributes
DateTime|null getDateTime(string $value)

Get a DateTime instance from a string with no format.

 from ValidatesAttributes
bool validateAlpha(string $attribute, mixed $value, $parameters)

Validate that an attribute contains only alphabetic characters.

 from ValidatesAttributes
bool validateAlphaDash(string $attribute, mixed $value, $parameters)

Validate that an attribute contains only alpha-numeric characters, dashes, and underscores.

 from ValidatesAttributes
bool validateAlphaNum(string $attribute, mixed $value, $parameters)

Validate that an attribute contains only alpha-numeric characters.

 from ValidatesAttributes
bool validateArray(string $attribute, mixed $value, array<int,int|string> $parameters = [])

Validate that an attribute is an array.

 from ValidatesAttributes
bool validateList(string $attribute, mixed $value)

Validate that an attribute is a list.

 from ValidatesAttributes
bool validateRequiredArrayKeys(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an array has all of the given keys.

 from ValidatesAttributes
bool validateBetween(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate the size of an attribute is between a set of values.

 from ValidatesAttributes
bool validateBoolean(string $attribute, mixed $value)

Validate that an attribute is a boolean.

 from ValidatesAttributes
bool validateConfirmed(string $attribute, mixed $value)

Validate that an attribute has a matching confirmation.

 from ValidatesAttributes
bool validateContains(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate an attribute contains a list of values.

 from ValidatesAttributes
bool validateCurrentPassword(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that the password of the currently authenticated user matches the given value.

 from ValidatesAttributes
bool validateDate(string $attribute, mixed $value)

Validate that an attribute is a valid date.

 from ValidatesAttributes
bool validateDateFormat(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute matches a date format.

 from ValidatesAttributes
bool validateDateEquals(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute is equal to another date.

 from ValidatesAttributes
bool validateDecimal(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute has a given number of decimal places.

 from ValidatesAttributes
bool validateDifferent(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute is different from another attribute.

 from ValidatesAttributes
bool validateDigits(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute has a given number of digits.

 from ValidatesAttributes
bool validateDigitsBetween(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute is between a given number of digits.

 from ValidatesAttributes
bool validateDimensions(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate the dimensions of an image matches the given values.

 from ValidatesAttributes
bool failsBasicDimensionChecks(array<string,string> $parameters, int $width, int $height)

Test if the given width and height fail any conditions.

 from ValidatesAttributes
bool failsRatioCheck(array<string,string> $parameters, int $width, int $height)

Determine if the given parameters fail a dimension ratio check.

 from ValidatesAttributes
bool validateDistinct(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate an attribute is unique among other values.

 from ValidatesAttributes
array getDistinctValues(string $attribute)

Get the values to distinct between.

 from ValidatesAttributes
array extractDistinctValues(string $attribute)

Extract the distinct values from the data.

 from ValidatesAttributes
bool validateEmail(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute is a valid e-mail address.

 from ValidatesAttributes
bool validateExists(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate the existence of an attribute value in a database table.

 from ValidatesAttributes
int getExistCount(mixed $connection, string $table, string $column, mixed $value, array<int,int|string> $parameters)

Get the number of records that exist in storage.

 from ValidatesAttributes
bool validateUnique(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate the uniqueness of an attribute value on a given database table.

 from ValidatesAttributes
array getUniqueIds(string|null $idColumn, array<int,int|string> $parameters)

Get the excluded ID column and value for the unique rule.

 from ValidatesAttributes
int prepareUniqueId(mixed $id)

Prepare the given ID for querying.

 from ValidatesAttributes
array getUniqueExtra(array<int,int|string> $parameters)

Get the extra conditions for a unique rule.

 from ValidatesAttributes
array parseTable(string $table)

Parse the connection / table for the unique / exists rules.

 from ValidatesAttributes
bool getQueryColumn(array<int,int|string> $parameters, string $attribute)

Get the column name for an exists / unique query.

 from ValidatesAttributes
string guessColumnForQuery(string $attribute)

Guess the database column from the given attribute name.

 from ValidatesAttributes
array getExtraConditions(array $segments)

Get the extra conditions for a unique / exists rule.

 from ValidatesAttributes
bool validateExtensions(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate the extension of a file upload attribute is in a set of defined extensions.

 from ValidatesAttributes
bool validateFile(string $attribute, mixed $value)

Validate the given value is a valid file.

 from ValidatesAttributes
bool validateFilled(string $attribute, mixed $value)

Validate the given attribute is filled if it is present.

 from ValidatesAttributes
bool validateGt(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute is greater than another attribute.

 from ValidatesAttributes
bool validateLt(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute is less than another attribute.

 from ValidatesAttributes
bool validateGte(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute is greater than or equal another attribute.

 from ValidatesAttributes
bool validateLte(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute is less than or equal another attribute.

 from ValidatesAttributes
bool validateLowercase(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute is lowercase.

 from ValidatesAttributes
bool validateUppercase(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute is uppercase.

 from ValidatesAttributes
bool validateHexColor(string $attribute, mixed $value)

Validate that an attribute is a valid HEX color.

 from ValidatesAttributes
bool validateImage(string $attribute, mixed $value)

Validate the MIME type of a file is an image MIME type.

 from ValidatesAttributes
bool validateIn(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate an attribute is contained within a list of values.

 from ValidatesAttributes
bool validateInArray(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that the values of an attribute are in another attribute.

 from ValidatesAttributes
bool validateInteger(string $attribute, mixed $value)

Validate that an attribute is an integer.

 from ValidatesAttributes
bool validateIp(string $attribute, mixed $value)

Validate that an attribute is a valid IP.

 from ValidatesAttributes
bool validateIpv4(string $attribute, mixed $value)

Validate that an attribute is a valid IPv4.

 from ValidatesAttributes
bool validateIpv6(string $attribute, mixed $value)

Validate that an attribute is a valid IPv6.

 from ValidatesAttributes
bool validateMacAddress(string $attribute, mixed $value)

Validate that an attribute is a valid MAC address.

 from ValidatesAttributes
bool validateJson(string $attribute, mixed $value)

Validate the attribute is a valid JSON string.

 from ValidatesAttributes
bool validateMax(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate the size of an attribute is less than or equal to a maximum value.

 from ValidatesAttributes
bool validateMaxDigits(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute has a maximum number of digits.

 from ValidatesAttributes
bool validateMimes(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate the guessed extension of a file upload is in a set of file extensions.

 from ValidatesAttributes
bool validateMimetypes(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate the MIME type of a file upload attribute is in a set of MIME types.

 from ValidatesAttributes
bool shouldBlockPhpUpload(mixed $value, array<int,int|string> $parameters)

Check if PHP uploads are explicitly allowed.

 from ValidatesAttributes
bool validateMin(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate the size of an attribute is greater than or equal to a minimum value.

 from ValidatesAttributes
bool validateMinDigits(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute has a minimum number of digits.

 from ValidatesAttributes
bool validateMissing(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute is missing.

 from ValidatesAttributes
bool validateMissingIf(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute is missing when another attribute has a given value.

 from ValidatesAttributes
bool validateMissingUnless(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute is missing unless another attribute has a given value.

 from ValidatesAttributes
bool validateMissingWith(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute is missing when any given attribute is present.

 from ValidatesAttributes
bool validateMissingWithAll(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute is missing when all given attributes are present.

 from ValidatesAttributes
bool validateMultipleOf(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate the value of an attribute is a multiple of a given value.

 from ValidatesAttributes
bool validateNullable()

"Indicate" validation should pass if value is null.

 from ValidatesAttributes
bool validateNotIn(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate an attribute is not contained within a list of values.

 from ValidatesAttributes
bool validateNumeric(string $attribute, mixed $value)

Validate that an attribute is numeric.

 from ValidatesAttributes
bool validatePresent(string $attribute, mixed $value)

Validate that an attribute exists even if not filled.

 from ValidatesAttributes
bool validatePresentIf(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute is present when another attribute has a given value.

 from ValidatesAttributes
bool validatePresentUnless(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute is present unless another attribute has a given value.

 from ValidatesAttributes
bool validatePresentWith(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute is present when any given attribute is present.

 from ValidatesAttributes
bool validatePresentWithAll(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute is present when all given attributes are present.

 from ValidatesAttributes
bool validateRegex(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute passes a regular expression check.

 from ValidatesAttributes
bool validateNotRegex(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute does not pass a regular expression check.

 from ValidatesAttributes
bool validateRequired(string $attribute, mixed $value)

Validate that a required attribute exists.

 from ValidatesAttributes
bool validateRequiredIf(string $attribute, mixed $value, mixed $parameters)

Validate that an attribute exists when another attribute has a given value.

 from ValidatesAttributes
bool validateRequiredIfAccepted(string $attribute, mixed $value, mixed $parameters)

Validate that an attribute exists when another attribute was "accepted".

 from ValidatesAttributes
bool validateRequiredIfDeclined(string $attribute, mixed $value, mixed $parameters)

Validate that an attribute exists when another attribute was "declined".

 from ValidatesAttributes
bool validateProhibited(string $attribute, mixed $value)

Validate that an attribute does not exist or is an empty string.

 from ValidatesAttributes
bool validateProhibitedIf(string $attribute, mixed $value, mixed $parameters)

Validate that an attribute does not exist when another attribute has a given value.

 from ValidatesAttributes
bool validateProhibitedUnless(string $attribute, mixed $value, mixed $parameters)

Validate that an attribute does not exist unless another attribute has a given value.

 from ValidatesAttributes
bool validateProhibits(string $attribute, mixed $value, mixed $parameters)

Validate that other attributes do not exist when this attribute exists.

 from ValidatesAttributes
bool validateExclude()

Indicate that an attribute is excluded.

 from ValidatesAttributes
bool validateExcludeIf(string $attribute, mixed $value, mixed $parameters)

Indicate that an attribute should be excluded when another attribute has a given value.

 from ValidatesAttributes
bool validateExcludeUnless(string $attribute, mixed $value, mixed $parameters)

Indicate that an attribute should be excluded when another attribute does not have a given value.

 from ValidatesAttributes
bool validateRequiredUnless(string $attribute, mixed $value, mixed $parameters)

Validate that an attribute exists when another attribute does not have a given value.

 from ValidatesAttributes
bool validateExcludeWith(string $attribute, mixed $value, mixed $parameters)

Indicate that an attribute should be excluded when another attribute presents.

 from ValidatesAttributes
bool validateExcludeWithout(string $attribute, mixed $value, mixed $parameters)

Indicate that an attribute should be excluded when another attribute is missing.

 from ValidatesAttributes
array parseDependentRuleParameters(array<int,int|string> $parameters)

Prepare the values and the other value for validation.

 from ValidatesAttributes
bool shouldConvertToBoolean(string $parameter)

Check if parameter should be converted to boolean.

 from ValidatesAttributes
array convertValuesToBoolean(array $values)

Convert the given values to boolean if they are string "true" / "false".

 from ValidatesAttributes
array convertValuesToNull(array $values)

Convert the given values to null if they are string "null".

 from ValidatesAttributes
bool validateRequiredWith(string $attribute, mixed $value, mixed $parameters)

Validate that an attribute exists when any other attribute exists.

 from ValidatesAttributes
bool validateRequiredWithAll(string $attribute, mixed $value, mixed $parameters)

Validate that an attribute exists when all other attributes exist.

 from ValidatesAttributes
bool validateRequiredWithout(string $attribute, mixed $value, mixed $parameters)

Validate that an attribute exists when another attribute does not.

 from ValidatesAttributes
bool validateRequiredWithoutAll(string $attribute, mixed $value, mixed $parameters)

Validate that an attribute exists when all other attributes do not.

 from ValidatesAttributes
bool anyFailingRequired(array $attributes)

Determine if any of the given attributes fail the required test.

 from ValidatesAttributes
bool allFailingRequired(array $attributes)

Determine if all of the given attributes fail the required test.

 from ValidatesAttributes
bool validateSame(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that two attributes match.

 from ValidatesAttributes
bool validateSize(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate the size of an attribute.

 from ValidatesAttributes
bool validateSometimes()

"Validate" optional attributes.

 from ValidatesAttributes
bool validateStartsWith(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate the attribute starts with a given substring.

 from ValidatesAttributes
bool validateDoesntStartWith(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate the attribute does not start with a given substring.

 from ValidatesAttributes
bool validateEndsWith(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate the attribute ends with a given substring.

 from ValidatesAttributes
bool validateDoesntEndWith(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate the attribute does not end with a given substring.

 from ValidatesAttributes
bool validateString(string $attribute, mixed $value)

Validate that an attribute is a string.

 from ValidatesAttributes
bool validateTimezone(string $attribute, mixed $value, array<string,null|string> $parameters = [])

Validate that an attribute is a valid timezone.

 from ValidatesAttributes
bool validateUrl(string $attribute, mixed $value, array<int,string> $parameters = [])

Validate that an attribute is a valid URL.

 from ValidatesAttributes
bool validateUlid(string $attribute, mixed $value)

Validate that an attribute is a valid ULID.

 from ValidatesAttributes
bool validateUuid(string $attribute, mixed $value)

Validate that an attribute is a valid UUID.

 from ValidatesAttributes
int|float|string getSize(string $attribute, mixed $value)

Get the size of an attribute.

 from ValidatesAttributes
bool isValidFileInstance(mixed $value)

Check that the given value is a valid file instance.

 from ValidatesAttributes
bool compare(mixed $first, mixed $second, string $operator)

Determine if a comparison passes between the given values.

 from ValidatesAttributes
array parseNamedParameters(array<int,int|string> $parameters)

Parse named parameters to $key => $value items.

 from ValidatesAttributes
void requireParameterCount(int $count, array<int,int|string> $parameters, string $rule)

Require a certain number of parameters to be present.

 from ValidatesAttributes
bool isSameType(mixed $first, mixed $second)

Check if the parameters are of the same type.

 from ValidatesAttributes
void shouldBeNumeric(string $attribute, string $rule)

Adds the existing rule to the numericRules array if the attribute's value is numeric.

 from ValidatesAttributes
mixed trim(mixed $value)

Trim the value if it is a string.

 from ValidatesAttributes
mixed ensureExponentWithinAllowedRange(string $attribute, mixed $value)

Ensure the exponent is within the allowed range.

 from ValidatesAttributes
void __construct(Translator $translator, array $data, array $rules, array $messages = [], array $attributes = [])

Create a new Validator instance.
array parseData(array $data)

Parse the data array, converting dots and asterisks.
array replacePlaceholders(array $data)

Replace the placeholders used in data keys.
string replacePlaceholderInString(string $value)

Replace the placeholders in the given string.
$this after(callable|string $callback)

Add an after validation callback.
bool passes()

Determine if the data passes the validation rules.
bool fails()

Determine if the data fails the validation rules.
bool shouldBeExcluded(string $attribute)

Determine if the attribute should be excluded.
void removeAttribute(string $attribute)

Remove the given attribute.
array validate()

Run the validator's rules against its data.
array validateWithBag(string $errorBag)

Run the validator's rules against its data.
ValidatedInput|array safe(array|null $keys = null)

Get a validated input container for the validated input.
array validated()

Get the attributes and values that were validated.
void validateAttribute(string $attribute, string $rule)

Validate a given attribute against a rule.
bool dependsOnOtherFields(string $rule)

Determine if the given rule depends on other fields.
array getExplicitKeys(string $attribute)

Get the explicit keys from an attribute flattened with dot notation.
string getPrimaryAttribute(string $attribute)

Get the primary attribute name.
array replaceDotInParameters(array $parameters)

Replace each field parameter which has an escaped dot with the dot placeholder.
array replaceAsterisksInParameters(array $parameters, array $keys)

Replace each field parameter which has asterisks with the given keys.
bool isValidatable(object|string $rule, string $attribute, mixed $value)

Determine if the attribute is validatable.
bool presentOrRuleIsImplicit(object|string $rule, string $attribute, mixed $value)

Determine if the field is present, or the rule implies required.
bool isImplicit(object|string $rule)

Determine if a given rule implies the attribute is required.
bool passesOptionalCheck(string $attribute)

Determine if the attribute passes any optional check.
bool isNotNullIfMarkedAsNullable(string $rule, string $attribute)

Determine if the attribute fails the nullable check.
bool hasNotFailedPreviousRuleIfPresenceRule(string $rule, string $attribute)

Determine if it's a necessary presence validation.
void validateUsingCustomRule(string $attribute, mixed $value, Rule $rule)

Validate an attribute using a custom rule object.
bool shouldStopValidating(string $attribute)

Check if we should stop further validations on a given attribute.
void addFailure(string $attribute, string $rule, array $parameters = [])

Add a failed rule and error message to the collection.
void excludeAttribute(string $attribute)

Add the given attribute to the list of excluded attributes.
array valid()

Returns the data which was valid.
array invalid()

Returns the data which was invalid.
array attributesThatHaveMessages()

Generate an array of all attributes that have messages.
array failed()

Get the failed validation rules.
MessageBag messages()

Get the message container for the validator.
MessageBag errors()

An alternative more semantic shortcut to the message container.
MessageBag getMessageBag()

Get the messages for the instance.
bool hasRule(string $attribute, string|array $rules)

Determine if the given attribute has a rule in the given set.
array|null getRule(string $attribute, string|array $rules)

Get a rule and its parameters for a given attribute.
array attributes()

Get the data under validation.
array getData()

Get the data under validation.
$this setData(array $data)

Set the data under validation.
mixed getValue(string $attribute)

Get the value of a given attribute.
void setValue(string $attribute, mixed $value)

Set the value of a given attribute.
array getRules()

Get the validation rules.
array getRulesWithoutPlaceholders()

Get the validation rules with key placeholders removed.
$this setRules(array $rules)

Set the validation rules.
void addRules(array $rules)

Parse the given rules and merge them into current rules.
$this sometimes(string|array $attribute, string|array $rules, callable $callback)

Add conditions to a given field based on a Closure.
$this stopOnFirstFailure(bool $stopOnFirstFailure = true)

Instruct the validator to stop validating after the first rule failure.
void addExtensions(array $extensions)

Register an array of custom validator extensions.
void addImplicitExtensions(array $extensions)

Register an array of custom implicit validator extensions.
void addDependentExtensions(array $extensions)

Register an array of custom dependent validator extensions.
void addExtension(string $rule, Closure|string $extension)

Register a custom validator extension.
void addImplicitExtension(string $rule, Closure|string $extension)

Register a custom implicit validator extension.
void addDependentExtension(string $rule, Closure|string $extension)

Register a custom dependent validator extension.
void addReplacers(array $replacers)

Register an array of custom validator message replacers.
void addReplacer(string $rule, Closure|string $replacer)

Register a custom validator message replacer.
$this setCustomMessages(array $messages)

Set the custom messages for the validator.
$this setAttributeNames(array $attributes)

Set the custom attributes on the validator.
$this addCustomAttributes(array $attributes)

Add custom attributes to the validator.
$this setImplicitAttributesFormatter(callable|null $formatter = null)

Set the callback that used to format an implicit attribute.
$this setValueNames(array $values)

Set the custom values on the validator.
$this addCustomValues(array $customValues)

Add the custom values for the validator.
void setFallbackMessages(array $messages)

Set the fallback messages for the validator.
PresenceVerifierInterface getPresenceVerifier(string|null $connection = null)

Get the Presence Verifier implementation.
void setPresenceVerifier(PresenceVerifierInterface $presenceVerifier)

Set the Presence Verifier implementation.
string getException()

Get the exception to throw upon failed validation.
$this setException(string $exception)

Set the exception to throw upon failed validation.
$this ensureExponentWithinAllowedRangeUsing($callback)

Ensure exponents are within range using the given callback.
Translator getTranslator()

Get the Translator implementation.
void setTranslator(Translator $translator)

Set the Translator implementation.
void setContainer(Container $container)

Set the IoC container instance.
bool|null callExtension(string $rule, array $parameters)

Call a custom validator extension.
bool callClassBasedExtension(string $callback, array $parameters)

Call a class based validator extension.
mixed __call(string $method, array $parameters)

Handle dynamic calls to class methods.

Details

protected string replaceAcceptedIf(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the accepted_if rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replaceDeclinedIf(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the declined_if rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replaceBetween(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the between rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replaceDateFormat(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the date_format rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replaceDecimal(string $message, string $attribute, string $rule, array<int,int> $parameters)

Replace all place-holders for the decimal rule.

Parameters

string $message
string $attribute
string $rule
array<int,int> $parameters

Return Value

string

protected string replaceDifferent(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the different rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replaceDigits(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the digits rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replaceDigitsBetween(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the digits (between) rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replaceExtensions(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the extensions rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replaceMin(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the min rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replaceMinDigits(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the min digits rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replaceMax(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the max rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replaceMaxDigits(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the max digits rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replaceMissingIf(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the missing_if rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replaceMissingUnless(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the missing_unless rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replaceMissingWith(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the missing_with rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replaceMissingWithAll(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the missing_with_all rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replaceMultipleOf(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the multiple_of rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replaceIn(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the in rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replaceNotIn(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the not_in rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replaceInArray(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the in_array rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replaceRequiredArrayKeys(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the required_array_keys rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replaceMimetypes(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the mimetypes rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replaceMimes(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the mimes rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replacePresentIf(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the present_if rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replacePresentUnless(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the present_unless rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replacePresentWith(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the present_with rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replacePresentWithAll(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the present_with_all rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replaceRequiredWith(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the required_with rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replaceRequiredWithAll(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the required_with_all rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replaceRequiredWithout(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the required_without rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replaceRequiredWithoutAll(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the required_without_all rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replaceSize(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the size rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replaceGt(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the gt rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replaceLt(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the lt rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replaceGte(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the gte rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replaceLte(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the lte rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replaceRequiredIf(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the required_if rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replaceRequiredIfAccepted(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the required_if_accepted rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

string replaceRequiredIfDeclined(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the required_if_declined rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replaceRequiredUnless(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the required_unless rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replaceProhibitedIf(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the prohibited_if rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replaceProhibitedUnless(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the prohibited_unless rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replaceProhibits(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the prohibited_with rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replaceSame(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the same rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replaceBefore(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the before rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replaceBeforeOrEqual(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the before_or_equal rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replaceAfter(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the after rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replaceAfterOrEqual(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the after_or_equal rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replaceDateEquals(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the date_equals rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replaceDimensions(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the dimensions rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replaceEndsWith(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the ends_with rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replaceDoesntEndWith(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the doesnt_end_with rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replaceStartsWith(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the starts_with rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string replaceDoesntStartWith(string $message, string $attribute, string $rule, array<int,string> $parameters)

Replace all place-holders for the doesnt_start_with rule.

Parameters

string $message
string $attribute
string $rule
array<int,string> $parameters

Return Value

string

protected string getMessage(string $attribute, string $rule)

Get the validation message for an attribute and rule.

Parameters

string $attribute
string $rule

Return Value

string

protected string|null getInlineMessage(string $attribute, string $rule)

Get the proper inline error message for standard and size rules.

Parameters

string $attribute
string $rule

Return Value

string|null

protected string|null getFromLocalArray(string $attribute, string $lowerRule, array|null $source = null)

Get the inline message for a rule if it exists.

Parameters

string $attribute
string $lowerRule
array|null $source

Return Value

string|null

protected string getCustomMessageFromTranslator(array|string $keys)

Get the custom error message from the translator.

Parameters

array|string $keys

Return Value

string

protected string getWildcardCustomMessages(array $messages, string $search, string $default)

Check the given messages for a wildcard key.

Parameters

array $messages
string $search
string $default

Return Value

string

protected string getSizeMessage(string $attribute, string $rule)

Get the proper error message for an attribute and size rule.

Parameters

string $attribute
string $rule

Return Value

string

protected string getAttributeType(string $attribute)

Get the data type of the given attribute.

Parameters

string $attribute

Return Value

string

string makeReplacements(string $message, string $attribute, string $rule, array $parameters)

Replace all error message place-holders with actual values.

Parameters

string $message
string $attribute
string $rule
array $parameters

Return Value

string

string getDisplayableAttribute(string $attribute)

Get the displayable name of the attribute.

Parameters

string $attribute

Return Value

string

protected string|null getAttributeFromTranslations(string $name)

Get the given attribute from the attribute translations.

Parameters

string $name

Return Value

string|null

protected string|null getAttributeFromLocalArray(string $attribute, array|null $source = null)

Get the custom name for an attribute if it exists in the given array.

Parameters

string $attribute
array|null $source

Return Value

string|null

protected string replaceAttributePlaceholder(string $message, string $value)

Replace the :attribute placeholder in the given message.

Parameters

string $message
string $value

Return Value

string

protected string replaceIndexPlaceholder(string $message, string $attribute)

Replace the :index placeholder in the given message.

Parameters

string $message
string $attribute

Return Value

string

protected string replacePositionPlaceholder(string $message, string $attribute)

Replace the :position placeholder in the given message.

Parameters

string $message
string $attribute

Return Value

string

protected string replaceIndexOrPositionPlaceholder(string $message, string $attribute, string $placeholder, Closure|null $modifier = null)

Replace the :index or :position placeholder in the given message.

Parameters

string $message
string $attribute
string $placeholder
Closure|null $modifier

Return Value

string

protected string numberToIndexOrPositionWord(int $value)

Get the word for a index or position segment.

Parameters

int $value

Return Value

string

protected string replaceInputPlaceholder(string $message, string $attribute)

Replace the :input placeholder in the given message.

Parameters

string $message
string $attribute

Return Value

string

string getDisplayableValue(string $attribute, mixed $value)

Get the displayable name of the value.

Parameters

string $attribute
mixed $value

Return Value

string

protected array getAttributeList(array $values)

Transform an array of attributes to their displayable form.

Parameters

array $values

Return Value

array

protected string|null callReplacer(string $message, string $attribute, string $rule, array $parameters, Validator $validator)

Call a custom validator message replacer.

Parameters

string $message
string $attribute
string $rule
array $parameters
Validator $validator

Return Value

string|null

protected string callClassBasedReplacer(string $callback, string $message, string $attribute, string $rule, array $parameters, Validator $validator)

Call a class based validator message replacer.

Parameters

string $callback
string $message
string $attribute
string $rule
array $parameters
Validator $validator

Return Value

string

bool validateAccepted(string $attribute, mixed $value)

Validate that an attribute was "accepted".

This validation rule implies the attribute is "required".

Parameters

string $attribute
mixed $value

Return Value

bool

bool validateAcceptedIf(string $attribute, mixed $value, mixed $parameters)

Validate that an attribute was "accepted" when another attribute has a given value.

Parameters

string $attribute
mixed $value
mixed $parameters

Return Value

bool

bool validateDeclined(string $attribute, mixed $value)

Validate that an attribute was "declined".

This validation rule implies the attribute is "required".

Parameters

string $attribute
mixed $value

Return Value

bool

bool validateDeclinedIf(string $attribute, mixed $value, mixed $parameters)

Validate that an attribute was "declined" when another attribute has a given value.

Parameters

string $attribute
mixed $value
mixed $parameters

Return Value

bool

bool validateActiveUrl(string $attribute, mixed $value)

Validate that an attribute is an active URL.

Parameters

string $attribute
mixed $value

Return Value

bool

protected array|false getDnsRecords(string $hostname, int $type)

Get the DNS records for the given hostname.

Parameters

string $hostname
int $type

Return Value

array|false

bool validateAscii(string $attribute, mixed $value)

Validate that an attribute is 7 bit ASCII.

Parameters

string $attribute
mixed $value

Return Value

bool

bool validateBail()

"Break" on first validation fail.

Always returns true, just lets us put "bail" in rules.

Return Value

bool

bool validateBefore(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate the date is before a given date.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

bool validateBeforeOrEqual(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate the date is before or equal a given date.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

bool validateAfter(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate the date is after a given date.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

bool validateAfterOrEqual(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate the date is equal or after a given date.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

protected bool compareDates(string $attribute, mixed $value, array<int,int|string> $parameters, string $operator)

Compare a given date against another using an operator.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters
string $operator

Return Value

bool

protected string|null getDateFormat(string $attribute)

Get the date format for an attribute if it has one.

Parameters

string $attribute

Return Value

string|null

protected int getDateTimestamp(mixed $value)

Get the date timestamp.

Parameters

mixed $value

Return Value

int

protected bool checkDateTimeOrder(string $format, string $first, string $second, string $operator)

Given two date/time strings, check that one is after the other.

Parameters

string $format
string $first
string $second
string $operator

Return Value

bool

protected DateTime|null getDateTimeWithOptionalFormat(string $format, string $value)

Get a DateTime instance from a string.

Parameters

string $format
string $value

Return Value

DateTime|null

protected DateTime|null getDateTime(string $value)

Get a DateTime instance from a string with no format.

Parameters

string $value

Return Value

DateTime|null

bool validateAlpha(string $attribute, mixed $value, $parameters)

Validate that an attribute contains only alphabetic characters.

If the 'ascii' option is passed, validate that an attribute contains only ascii alphabetic characters.

Parameters

string $attribute
mixed $value
$parameters

Return Value

bool

bool validateAlphaDash(string $attribute, mixed $value, $parameters)

Validate that an attribute contains only alpha-numeric characters, dashes, and underscores.

If the 'ascii' option is passed, validate that an attribute contains only ascii alpha-numeric characters, dashes, and underscores.

Parameters

string $attribute
mixed $value
$parameters

Return Value

bool

bool validateAlphaNum(string $attribute, mixed $value, $parameters)

Validate that an attribute contains only alpha-numeric characters.

If the 'ascii' option is passed, validate that an attribute contains only ascii alpha-numeric characters.

Parameters

string $attribute
mixed $value
$parameters

Return Value

bool

bool validateArray(string $attribute, mixed $value, array<int,int|string> $parameters = [])

Validate that an attribute is an array.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

bool validateList(string $attribute, mixed $value)

Validate that an attribute is a list.

Parameters

string $attribute
mixed $value

Return Value

bool

bool validateRequiredArrayKeys(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an array has all of the given keys.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

bool validateBetween(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate the size of an attribute is between a set of values.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

bool validateBoolean(string $attribute, mixed $value)

Validate that an attribute is a boolean.

Parameters

string $attribute
mixed $value

Return Value

bool

bool validateConfirmed(string $attribute, mixed $value)

Validate that an attribute has a matching confirmation.

Parameters

string $attribute
mixed $value

Return Value

bool

bool validateContains(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate an attribute contains a list of values.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

protected bool validateCurrentPassword(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that the password of the currently authenticated user matches the given value.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

bool validateDate(string $attribute, mixed $value)

Validate that an attribute is a valid date.

Parameters

string $attribute
mixed $value

Return Value

bool

bool validateDateFormat(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute matches a date format.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

bool validateDateEquals(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute is equal to another date.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

bool validateDecimal(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute has a given number of decimal places.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

bool validateDifferent(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute is different from another attribute.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

bool validateDigits(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute has a given number of digits.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

bool validateDigitsBetween(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute is between a given number of digits.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

bool validateDimensions(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate the dimensions of an image matches the given values.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

protected bool failsBasicDimensionChecks(array<string,string> $parameters, int $width, int $height)

Test if the given width and height fail any conditions.

Parameters

array<string,string> $parameters
int $width
int $height

Return Value

bool

protected bool failsRatioCheck(array<string,string> $parameters, int $width, int $height)

Determine if the given parameters fail a dimension ratio check.

Parameters

array<string,string> $parameters
int $width
int $height

Return Value

bool

bool validateDistinct(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate an attribute is unique among other values.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

protected array getDistinctValues(string $attribute)

Get the values to distinct between.

Parameters

string $attribute

Return Value

array

protected array extractDistinctValues(string $attribute)

Extract the distinct values from the data.

Parameters

string $attribute

Return Value

array

bool validateEmail(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute is a valid e-mail address.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

bool validateExists(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate the existence of an attribute value in a database table.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

protected int getExistCount(mixed $connection, string $table, string $column, mixed $value, array<int,int|string> $parameters)

Get the number of records that exist in storage.

Parameters

mixed $connection
string $table
string $column
mixed $value
array<int,int|string> $parameters

Return Value

int

bool validateUnique(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate the uniqueness of an attribute value on a given database table.

If a database column is not specified, the attribute will be used.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

protected array getUniqueIds(string|null $idColumn, array<int,int|string> $parameters)

Get the excluded ID column and value for the unique rule.

Parameters

string|null $idColumn
array<int,int|string> $parameters

Return Value

array

protected int prepareUniqueId(mixed $id)

Prepare the given ID for querying.

Parameters

mixed $id

Return Value

int

protected array getUniqueExtra(array<int,int|string> $parameters)

Get the extra conditions for a unique rule.

Parameters

array<int,int|string> $parameters

Return Value

array

array parseTable(string $table)

Parse the connection / table for the unique / exists rules.

Parameters

string $table

Return Value

array

bool getQueryColumn(array<int,int|string> $parameters, string $attribute)

Get the column name for an exists / unique query.

Parameters

array<int,int|string> $parameters
string $attribute

Return Value

bool

string guessColumnForQuery(string $attribute)

Guess the database column from the given attribute name.

Parameters

string $attribute

Return Value

string

protected array getExtraConditions(array $segments)

Get the extra conditions for a unique / exists rule.

Parameters

array $segments

Return Value

array

bool validateExtensions(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate the extension of a file upload attribute is in a set of defined extensions.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

bool validateFile(string $attribute, mixed $value)

Validate the given value is a valid file.

Parameters

string $attribute
mixed $value

Return Value

bool

bool validateFilled(string $attribute, mixed $value)

Validate the given attribute is filled if it is present.

Parameters

string $attribute
mixed $value

Return Value

bool

bool validateGt(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute is greater than another attribute.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

bool validateLt(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute is less than another attribute.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

bool validateGte(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute is greater than or equal another attribute.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

bool validateLte(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute is less than or equal another attribute.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

bool validateLowercase(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute is lowercase.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

bool validateUppercase(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute is uppercase.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

bool validateHexColor(string $attribute, mixed $value)

Validate that an attribute is a valid HEX color.

Parameters

string $attribute
mixed $value

Return Value

bool

bool validateImage(string $attribute, mixed $value)

Validate the MIME type of a file is an image MIME type.

Parameters

string $attribute
mixed $value

Return Value

bool

bool validateIn(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate an attribute is contained within a list of values.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

bool validateInArray(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that the values of an attribute are in another attribute.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

bool validateInteger(string $attribute, mixed $value)

Validate that an attribute is an integer.

Parameters

string $attribute
mixed $value

Return Value

bool

bool validateIp(string $attribute, mixed $value)

Validate that an attribute is a valid IP.

Parameters

string $attribute
mixed $value

Return Value

bool

bool validateIpv4(string $attribute, mixed $value)

Validate that an attribute is a valid IPv4.

Parameters

string $attribute
mixed $value

Return Value

bool

bool validateIpv6(string $attribute, mixed $value)

Validate that an attribute is a valid IPv6.

Parameters

string $attribute
mixed $value

Return Value

bool

bool validateMacAddress(string $attribute, mixed $value)

Validate that an attribute is a valid MAC address.

Parameters

string $attribute
mixed $value

Return Value

bool

bool validateJson(string $attribute, mixed $value)

Validate the attribute is a valid JSON string.

Parameters

string $attribute
mixed $value

Return Value

bool

bool validateMax(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate the size of an attribute is less than or equal to a maximum value.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

bool validateMaxDigits(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute has a maximum number of digits.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

bool validateMimes(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate the guessed extension of a file upload is in a set of file extensions.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

bool validateMimetypes(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate the MIME type of a file upload attribute is in a set of MIME types.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

protected bool shouldBlockPhpUpload(mixed $value, array<int,int|string> $parameters)

Check if PHP uploads are explicitly allowed.

Parameters

mixed $value
array<int,int|string> $parameters

Return Value

bool

bool validateMin(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate the size of an attribute is greater than or equal to a minimum value.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

bool validateMinDigits(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute has a minimum number of digits.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

bool validateMissing(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute is missing.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

bool validateMissingIf(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute is missing when another attribute has a given value.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

bool validateMissingUnless(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute is missing unless another attribute has a given value.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

bool validateMissingWith(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute is missing when any given attribute is present.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

bool validateMissingWithAll(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute is missing when all given attributes are present.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

bool validateMultipleOf(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate the value of an attribute is a multiple of a given value.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

bool validateNullable()

"Indicate" validation should pass if value is null.

Always returns true, just lets us put "nullable" in rules.

Return Value

bool

bool validateNotIn(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate an attribute is not contained within a list of values.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

bool validateNumeric(string $attribute, mixed $value)

Validate that an attribute is numeric.

Parameters

string $attribute
mixed $value

Return Value

bool

bool validatePresent(string $attribute, mixed $value)

Validate that an attribute exists even if not filled.

Parameters

string $attribute
mixed $value

Return Value

bool

bool validatePresentIf(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute is present when another attribute has a given value.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

bool validatePresentUnless(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute is present unless another attribute has a given value.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

bool validatePresentWith(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute is present when any given attribute is present.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

bool validatePresentWithAll(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute is present when all given attributes are present.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

bool validateRegex(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute passes a regular expression check.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

bool validateNotRegex(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that an attribute does not pass a regular expression check.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

bool validateRequired(string $attribute, mixed $value)

Validate that a required attribute exists.

Parameters

string $attribute
mixed $value

Return Value

bool

bool validateRequiredIf(string $attribute, mixed $value, mixed $parameters)

Validate that an attribute exists when another attribute has a given value.

Parameters

string $attribute
mixed $value
mixed $parameters

Return Value

bool

bool validateRequiredIfAccepted(string $attribute, mixed $value, mixed $parameters)

Validate that an attribute exists when another attribute was "accepted".

Parameters

string $attribute
mixed $value
mixed $parameters

Return Value

bool

bool validateRequiredIfDeclined(string $attribute, mixed $value, mixed $parameters)

Validate that an attribute exists when another attribute was "declined".

Parameters

string $attribute
mixed $value
mixed $parameters

Return Value

bool

bool validateProhibited(string $attribute, mixed $value)

Validate that an attribute does not exist or is an empty string.

Parameters

string $attribute
mixed $value

Return Value

bool

bool validateProhibitedIf(string $attribute, mixed $value, mixed $parameters)

Validate that an attribute does not exist when another attribute has a given value.

Parameters

string $attribute
mixed $value
mixed $parameters

Return Value

bool

bool validateProhibitedUnless(string $attribute, mixed $value, mixed $parameters)

Validate that an attribute does not exist unless another attribute has a given value.

Parameters

string $attribute
mixed $value
mixed $parameters

Return Value

bool

bool validateProhibits(string $attribute, mixed $value, mixed $parameters)

Validate that other attributes do not exist when this attribute exists.

Parameters

string $attribute
mixed $value
mixed $parameters

Return Value

bool

bool validateExclude()

Indicate that an attribute is excluded.

Return Value

bool

bool validateExcludeIf(string $attribute, mixed $value, mixed $parameters)

Indicate that an attribute should be excluded when another attribute has a given value.

Parameters

string $attribute
mixed $value
mixed $parameters

Return Value

bool

bool validateExcludeUnless(string $attribute, mixed $value, mixed $parameters)

Indicate that an attribute should be excluded when another attribute does not have a given value.

Parameters

string $attribute
mixed $value
mixed $parameters

Return Value

bool

bool validateRequiredUnless(string $attribute, mixed $value, mixed $parameters)

Validate that an attribute exists when another attribute does not have a given value.

Parameters

string $attribute
mixed $value
mixed $parameters

Return Value

bool

bool validateExcludeWith(string $attribute, mixed $value, mixed $parameters)

Indicate that an attribute should be excluded when another attribute presents.

Parameters

string $attribute
mixed $value
mixed $parameters

Return Value

bool

bool validateExcludeWithout(string $attribute, mixed $value, mixed $parameters)

Indicate that an attribute should be excluded when another attribute is missing.

Parameters

string $attribute
mixed $value
mixed $parameters

Return Value

bool

array parseDependentRuleParameters(array<int,int|string> $parameters)

Prepare the values and the other value for validation.

Parameters

array<int,int|string> $parameters

Return Value

array

protected bool shouldConvertToBoolean(string $parameter)

Check if parameter should be converted to boolean.

Parameters

string $parameter

Return Value

bool

protected array convertValuesToBoolean(array $values)

Convert the given values to boolean if they are string "true" / "false".

Parameters

array $values

Return Value

array

protected array convertValuesToNull(array $values)

Convert the given values to null if they are string "null".

Parameters

array $values

Return Value

array

bool validateRequiredWith(string $attribute, mixed $value, mixed $parameters)

Validate that an attribute exists when any other attribute exists.

Parameters

string $attribute
mixed $value
mixed $parameters

Return Value

bool

bool validateRequiredWithAll(string $attribute, mixed $value, mixed $parameters)

Validate that an attribute exists when all other attributes exist.

Parameters

string $attribute
mixed $value
mixed $parameters

Return Value

bool

bool validateRequiredWithout(string $attribute, mixed $value, mixed $parameters)

Validate that an attribute exists when another attribute does not.

Parameters

string $attribute
mixed $value
mixed $parameters

Return Value

bool

bool validateRequiredWithoutAll(string $attribute, mixed $value, mixed $parameters)

Validate that an attribute exists when all other attributes do not.

Parameters

string $attribute
mixed $value
mixed $parameters

Return Value

bool

protected bool anyFailingRequired(array $attributes)

Determine if any of the given attributes fail the required test.

Parameters

array $attributes

Return Value

bool

protected bool allFailingRequired(array $attributes)

Determine if all of the given attributes fail the required test.

Parameters

array $attributes

Return Value

bool

bool validateSame(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate that two attributes match.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

bool validateSize(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate the size of an attribute.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

bool validateSometimes()

"Validate" optional attributes.

Always returns true, just lets us put sometimes in rules.

Return Value

bool

bool validateStartsWith(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate the attribute starts with a given substring.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

bool validateDoesntStartWith(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate the attribute does not start with a given substring.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

bool validateEndsWith(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate the attribute ends with a given substring.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

bool validateDoesntEndWith(string $attribute, mixed $value, array<int,int|string> $parameters)

Validate the attribute does not end with a given substring.

Parameters

string $attribute
mixed $value
array<int,int|string> $parameters

Return Value

bool

bool validateString(string $attribute, mixed $value)

Validate that an attribute is a string.

Parameters

string $attribute
mixed $value

Return Value

bool

bool validateTimezone(string $attribute, mixed $value, array<string,null|string> $parameters = [])

Validate that an attribute is a valid timezone.

Parameters

string $attribute
mixed $value
array<string,null|string> $parameters

Return Value

bool

bool validateUrl(string $attribute, mixed $value, array<int,string> $parameters = [])

Validate that an attribute is a valid URL.

Parameters

string $attribute
mixed $value
array<int,string> $parameters

Return Value

bool

bool validateUlid(string $attribute, mixed $value)

Validate that an attribute is a valid ULID.

Parameters

string $attribute
mixed $value

Return Value

bool

bool validateUuid(string $attribute, mixed $value)

Validate that an attribute is a valid UUID.

Parameters

string $attribute
mixed $value

Return Value

bool

protected int|float|string getSize(string $attribute, mixed $value)

Get the size of an attribute.

Parameters

string $attribute
mixed $value

Return Value

int|float|string

bool isValidFileInstance(mixed $value)

Check that the given value is a valid file instance.

Parameters

mixed $value

Return Value

bool

protected bool compare(mixed $first, mixed $second, string $operator)

Determine if a comparison passes between the given values.

Parameters

mixed $first
mixed $second
string $operator

Return Value

bool

Exceptions

InvalidArgumentException

array parseNamedParameters(array<int,int|string> $parameters)

Parse named parameters to $key => $value items.

Parameters

array<int,int|string> $parameters

Return Value

array

void requireParameterCount(int $count, array<int,int|string> $parameters, string $rule)

Require a certain number of parameters to be present.

Parameters

int $count
array<int,int|string> $parameters
string $rule

Return Value

void

Exceptions

InvalidArgumentException

protected bool isSameType(mixed $first, mixed $second)

Check if the parameters are of the same type.

Parameters

mixed $first
mixed $second

Return Value

bool

protected void shouldBeNumeric(string $attribute, string $rule)

Adds the existing rule to the numericRules array if the attribute's value is numeric.

Parameters

string $attribute
string $rule

Return Value

void

protected mixed trim(mixed $value)

Trim the value if it is a string.

Parameters

mixed $value

Return Value

mixed

protected mixed ensureExponentWithinAllowedRange(string $attribute, mixed $value)

Ensure the exponent is within the allowed range.

Parameters

string $attribute
mixed $value

Return Value

mixed

void __construct(Translator $translator, array $data, array $rules, array $messages = [], array $attributes = [])

Create a new Validator instance.

Parameters

Translator $translator
array $data
array $rules
array $messages
array $attributes

Return Value

void

array parseData(array $data)

Parse the data array, converting dots and asterisks.

Parameters

array $data

Return Value

array

protected array replacePlaceholders(array $data)

Replace the placeholders used in data keys.

Parameters

array $data

Return Value

array

protected string replacePlaceholderInString(string $value)

Replace the placeholders in the given string.

Parameters

string $value

Return Value

string

$this after(callable|string $callback)

Add an after validation callback.

Parameters

callable|string $callback

Return Value

$this

bool passes()

Determine if the data passes the validation rules.

Return Value

bool

bool fails()

Determine if the data fails the validation rules.

Return Value

bool

protected bool shouldBeExcluded(string $attribute)

Determine if the attribute should be excluded.

Parameters

string $attribute

Return Value

bool

protected void removeAttribute(string $attribute)

Remove the given attribute.

Parameters

string $attribute

Return Value

void

array validate()

Run the validator's rules against its data.

Return Value

array

Exceptions

ValidationException

array validateWithBag(string $errorBag)

Run the validator's rules against its data.

Parameters

string $errorBag

Return Value

array

Exceptions

ValidationException

ValidatedInput|array safe(array|null $keys = null)

Get a validated input container for the validated input.

Parameters

array|null $keys

Return Value

ValidatedInput|array

array validated()

Get the attributes and values that were validated.

Return Value

array

Exceptions

ValidationException

protected void validateAttribute(string $attribute, string $rule)

Validate a given attribute against a rule.

Parameters

string $attribute
string $rule

Return Value

void

protected bool dependsOnOtherFields(string $rule)

Determine if the given rule depends on other fields.

Parameters

string $rule

Return Value

bool

protected array getExplicitKeys(string $attribute)

Get the explicit keys from an attribute flattened with dot notation.

E.g. 'foo.1.bar.spark.baz' -> [1, 'spark'] for 'foo..bar..baz'

Parameters

string $attribute

Return Value

array

protected string getPrimaryAttribute(string $attribute)

Get the primary attribute name.

For example, if "name.0" is given, "name.*" will be returned.

Parameters

string $attribute

Return Value

string

protected array replaceDotInParameters(array $parameters)

Replace each field parameter which has an escaped dot with the dot placeholder.

Parameters

array $parameters

Return Value

array

protected array replaceAsterisksInParameters(array $parameters, array $keys)

Replace each field parameter which has asterisks with the given keys.

Parameters

array $parameters
array $keys

Return Value

array

protected bool isValidatable(object|string $rule, string $attribute, mixed $value)

Determine if the attribute is validatable.

Parameters

object|string $rule
string $attribute
mixed $value

Return Value

bool

protected bool presentOrRuleIsImplicit(object|string $rule, string $attribute, mixed $value)

Determine if the field is present, or the rule implies required.

Parameters

object|string $rule
string $attribute
mixed $value

Return Value

bool

protected bool isImplicit(object|string $rule)

Determine if a given rule implies the attribute is required.

Parameters

object|string $rule

Return Value

bool

protected bool passesOptionalCheck(string $attribute)

Determine if the attribute passes any optional check.

Parameters

string $attribute

Return Value

bool

protected bool isNotNullIfMarkedAsNullable(string $rule, string $attribute)

Determine if the attribute fails the nullable check.

Parameters

string $rule
string $attribute

Return Value

bool

protected bool hasNotFailedPreviousRuleIfPresenceRule(string $rule, string $attribute)

Determine if it's a necessary presence validation.

This is to avoid possible database type comparison errors.

Parameters

string $rule
string $attribute

Return Value

bool

protected void validateUsingCustomRule(string $attribute, mixed $value, Rule $rule)

Validate an attribute using a custom rule object.

Parameters

string $attribute
mixed $value
Rule $rule

Return Value

void

protected bool shouldStopValidating(string $attribute)

Check if we should stop further validations on a given attribute.

Parameters

string $attribute

Return Value

bool

void addFailure(string $attribute, string $rule, array $parameters = [])

Add a failed rule and error message to the collection.

Parameters

string $attribute
string $rule
array $parameters

Return Value

void

protected void excludeAttribute(string $attribute)

Add the given attribute to the list of excluded attributes.

Parameters

string $attribute

Return Value

void

array valid()

Returns the data which was valid.

Return Value

array

array invalid()

Returns the data which was invalid.

Return Value

array

protected array attributesThatHaveMessages()

Generate an array of all attributes that have messages.

Return Value

array

array failed()

Get the failed validation rules.

Return Value

array

MessageBag messages()

Get the message container for the validator.

Return Value

MessageBag

MessageBag errors()

An alternative more semantic shortcut to the message container.

Return Value

MessageBag

MessageBag getMessageBag()

Get the messages for the instance.

Return Value

MessageBag

bool hasRule(string $attribute, string|array $rules)

Determine if the given attribute has a rule in the given set.

Parameters

string $attribute
string|array $rules

Return Value

bool

protected array|null getRule(string $attribute, string|array $rules)

Get a rule and its parameters for a given attribute.

Parameters

string $attribute
string|array $rules

Return Value

array|null

array attributes()

Get the data under validation.

Return Value

array

array getData()

Get the data under validation.

Return Value

array

$this setData(array $data)

Set the data under validation.

Parameters

array $data

Return Value

$this

mixed getValue(string $attribute)

Get the value of a given attribute.

Parameters

string $attribute

Return Value

mixed

void setValue(string $attribute, mixed $value)

Set the value of a given attribute.

Parameters

string $attribute
mixed $value

Return Value

void

array getRules()

Get the validation rules.

Return Value

array

array getRulesWithoutPlaceholders()

Get the validation rules with key placeholders removed.

Return Value

array

$this setRules(array $rules)

Set the validation rules.

Parameters

array $rules

Return Value

$this

void addRules(array $rules)

Parse the given rules and merge them into current rules.

Parameters

array $rules

Return Value

void

$this sometimes(string|array $attribute, string|array $rules, callable $callback)

Add conditions to a given field based on a Closure.

Parameters

string|array $attribute
string|array $rules
callable $callback

Return Value

$this

$this stopOnFirstFailure(bool $stopOnFirstFailure = true)

Instruct the validator to stop validating after the first rule failure.

Parameters

bool $stopOnFirstFailure

Return Value

$this

void addExtensions(array $extensions)

Register an array of custom validator extensions.

Parameters

array $extensions

Return Value

void

void addImplicitExtensions(array $extensions)

Register an array of custom implicit validator extensions.

Parameters

array $extensions

Return Value

void

void addDependentExtensions(array $extensions)

Register an array of custom dependent validator extensions.

Parameters

array $extensions

Return Value

void

void addExtension(string $rule, Closure|string $extension)

Register a custom validator extension.

Parameters

string $rule
Closure|string $extension

Return Value

void

void addImplicitExtension(string $rule, Closure|string $extension)

Register a custom implicit validator extension.

Parameters

string $rule
Closure|string $extension

Return Value

void

void addDependentExtension(string $rule, Closure|string $extension)

Register a custom dependent validator extension.

Parameters

string $rule
Closure|string $extension

Return Value

void

void addReplacers(array $replacers)

Register an array of custom validator message replacers.

Parameters

array $replacers

Return Value

void

void addReplacer(string $rule, Closure|string $replacer)

Register a custom validator message replacer.

Parameters

string $rule
Closure|string $replacer

Return Value

void

$this setCustomMessages(array $messages)

Set the custom messages for the validator.

Parameters

array $messages

Return Value

$this

$this setAttributeNames(array $attributes)

Set the custom attributes on the validator.

Parameters

array $attributes

Return Value

$this

$this addCustomAttributes(array $attributes)

Add custom attributes to the validator.

Parameters

array $attributes

Return Value

$this

$this setImplicitAttributesFormatter(callable|null $formatter = null)

Set the callback that used to format an implicit attribute.

Parameters

callable|null $formatter

Return Value

$this

$this setValueNames(array $values)

Set the custom values on the validator.

Parameters

array $values

Return Value

$this

$this addCustomValues(array $customValues)

Add the custom values for the validator.

Parameters

array $customValues

Return Value

$this

void setFallbackMessages(array $messages)

Set the fallback messages for the validator.

Parameters

array $messages

Return Value

void

PresenceVerifierInterface getPresenceVerifier(string|null $connection = null)

Get the Presence Verifier implementation.

Parameters

string|null $connection

Return Value

PresenceVerifierInterface

Exceptions

RuntimeException

void setPresenceVerifier(PresenceVerifierInterface $presenceVerifier)

Set the Presence Verifier implementation.

Parameters

PresenceVerifierInterface $presenceVerifier

Return Value

void

string getException()

Get the exception to throw upon failed validation.

Return Value

string

$this setException(string $exception)

Set the exception to throw upon failed validation.

Parameters

string $exception

Return Value

$this

Exceptions

InvalidArgumentException

$this ensureExponentWithinAllowedRangeUsing($callback)

Ensure exponents are within range using the given callback.

Parameters

$callback

Return Value

$this

Translator getTranslator()

Get the Translator implementation.

Return Value

Translator

void setTranslator(Translator $translator)

Set the Translator implementation.

Parameters

Translator $translator

Return Value

void

void setContainer(Container $container)

Set the IoC container instance.

Parameters

Container $container

Return Value

void

protected bool|null callExtension(string $rule, array $parameters)

Call a custom validator extension.

Parameters

string $rule
array $parameters

Return Value

bool|null

protected bool callClassBasedExtension(string $callback, array $parameters)

Call a class based validator extension.

Parameters

string $callback
array $parameters

Return Value

bool

mixed __call(string $method, array $parameters)

Handle dynamic calls to class methods.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Validation/Validator.html