ValidatesAttributes
trait ValidatesAttributes (View source)
Methods
Validate that an attribute was "accepted".
Validate that an attribute was "accepted" when another attribute has a given value.
Validate that an attribute was "declined".
Validate that an attribute was "declined" when another attribute has a given value.
Validate that an attribute is an active URL.
Get the DNS records for the given hostname.
Validate that an attribute is 7 bit ASCII.
"Break" on first validation fail.
Validate the date is before a given date.
Validate the date is before or equal a given date.
Validate the date is after a given date.
Validate the date is equal or after a given date.
Compare a given date against another using an operator.
Get the date format for an attribute if it has one.
Get the date timestamp.
Given two date/time strings, check that one is after the other.
Get a DateTime instance from a string.
Get a DateTime instance from a string with no format.
Validate that an attribute contains only alphabetic characters.
Validate that an attribute contains only alpha-numeric characters, dashes, and underscores.
Validate that an attribute contains only alpha-numeric characters.
Validate that an attribute is an array.
Validate that an attribute is a list.
Validate that an array has all of the given keys.
Validate the size of an attribute is between a set of values.
Validate that an attribute is a boolean.
Validate that an attribute has a matching confirmation.
Validate an attribute contains a list of values.
Validate an attribute does not contain a list of values.
Validate that the password of the currently authenticated user matches the given value.
Validate that an attribute is a valid date.
Validate that an attribute matches a date format.
Validate that an attribute is equal to another date.
Validate that an attribute has a given number of decimal places.
Validate that an attribute is different from another attribute.
Validate that an attribute has a given number of digits.
Validate that an attribute is between a given number of digits.
Validate the dimensions of an image matches the given values.
Test if the given width and height fail any conditions.
Determine if the given parameters fail a dimension ratio check.
Validate an attribute is unique among other values.
Get the values to distinct between.
Extract the distinct values from the data.
Validate that an attribute is a valid e-mail address.
Validate the encoding of an attribute.
Validate the existence of an attribute value in a database table.
Get the number of records that exist in storage.
Validate the uniqueness of an attribute value on a given database table.
Get the excluded ID column and value for the unique rule.
Prepare the given ID for querying.
Get the extra conditions for a unique rule.
Parse the connection / table for the unique / exists rules.
Get the column name for an exists / unique query.
Guess the database column from the given attribute name.
Get the extra conditions for a unique / exists rule.
Validate the extension of a file upload attribute is in a set of defined extensions.
Validate the given value is a valid file.
Validate the given attribute is filled if it is present.
Validate that an attribute is greater than another attribute.
Validate that an attribute is less than another attribute.
Validate that an attribute is greater than or equal another attribute.
Validate that an attribute is less than or equal another attribute.
Validate that an attribute is lowercase.
Validate that an attribute is uppercase.
Validate that an attribute is a valid HEX color.
Validate the MIME type of a file is an image MIME type.
Validate an attribute is contained within a list of values.
Validate that the values of an attribute are in another attribute.
Validate that an array has at least one of the given keys.
Validate that an attribute is an integer.
Validate that an attribute is a valid IP.
Validate that an attribute is a valid IPv4.
Validate that an attribute is a valid IPv6.
Validate that an attribute is a valid MAC address.
Validate the attribute is a valid JSON string.
Validate the size of an attribute is less than or equal to a maximum value.
Validate that an attribute has a maximum number of digits.
Validate the guessed extension of a file upload is in a set of file extensions.
Validate the MIME type of a file upload attribute is in a set of MIME types.
Check if PHP uploads are explicitly allowed.
Validate the size of an attribute is greater than or equal to a minimum value.
Validate that an attribute has a minimum number of digits.
Validate that an attribute is missing.
Validate that an attribute is missing when another attribute has a given value.
Validate that an attribute is missing unless another attribute has a given value.
Validate that an attribute is missing when any given attribute is present.
Validate that an attribute is missing when all given attributes are present.
Validate the value of an attribute is a multiple of a given value.
"Indicate" validation should pass if value is null.
Validate an attribute is not contained within a list of values.
Validate that an attribute is numeric.
Validate that an attribute exists even if not filled.
Validate that an attribute is present when another attribute has a given value.
Validate that an attribute is present unless another attribute has a given value.
Validate that an attribute is present when any given attribute is present.
Validate that an attribute is present when all given attributes are present.
Validate that an attribute passes a regular expression check.
Validate that an attribute does not pass a regular expression check.
Validate that a required attribute exists.
Validate that an attribute exists when another attribute has a given value.
Validate that an attribute exists when another attribute was "accepted".
Validate that an attribute exists when another attribute was "declined".
Validate that an attribute does not exist or is an empty string.
Validate that an attribute does not exist when another attribute has a given value.
Validate that an attribute does not exist when another attribute was "accepted".
Validate that an attribute does not exist when another attribute was "declined".
Validate that an attribute does not exist unless another attribute has a given value.
Validate that other attributes do not exist when this attribute exists.
Indicate that an attribute is excluded.
Indicate that an attribute should be excluded when another attribute has a given value.
Indicate that an attribute should be excluded when another attribute does not have a given value.
Validate that an attribute exists when another attribute does not have a given value.
Indicate that an attribute should be excluded when another attribute presents.
Indicate that an attribute should be excluded when another attribute is missing.
Prepare the values and the other value for validation.
Check if parameter should be converted to boolean.
Convert the given values to boolean if they are string "true" / "false".
Convert the given values to null if they are string "null".
Validate that an attribute exists when any other attribute exists.
Validate that an attribute exists when all other attributes exist.
Validate that an attribute exists when another attribute does not.
Validate that an attribute exists when all other attributes do not.
Determine if any of the given attributes fail the required test.
Determine if all of the given attributes fail the required test.
Validate that two attributes match.
Validate the size of an attribute.
"Validate" optional attributes.
Validate the attribute starts with a given substring.
Validate the attribute does not start with a given substring.
Validate the attribute ends with a given substring.
Validate the attribute does not end with a given substring.
Validate that an attribute is a string.
Validate that an attribute is a valid timezone.
Validate that an attribute is a valid URL.
Validate that an attribute is a valid ULID.
Validate that an attribute is a valid UUID.
Get the size of an attribute.
Check that the given value is a valid file instance.
Determine if a comparison passes between the given values.
Parse named parameters to $key => $value items.
Require a certain number of parameters to be present.
Check if the parameters are of the same type.
Adds the existing rule to the numericRules array if the attribute's value is numeric.
Trim the value if it is a string.
Ensure the exponent is within the allowed range.
Details
bool
validateAccepted(string $attribute, mixed $value)
Validate that an attribute was "accepted".
This validation rule implies the attribute is "required".
bool
validateAcceptedIf(string $attribute, mixed $value, mixed $parameters)
Validate that an attribute was "accepted" when another attribute has a given value.
bool
validateDeclined(string $attribute, mixed $value)
Validate that an attribute was "declined".
This validation rule implies the attribute is "required".
bool
validateDeclinedIf(string $attribute, mixed $value, mixed $parameters)
Validate that an attribute was "declined" when another attribute has a given value.
bool
validateActiveUrl(string $attribute, mixed $value)
Validate that an attribute is an active URL.
protected array|false
getDnsRecords(string $hostname, int $type)
Get the DNS records for the given hostname.
bool
validateAscii(string $attribute, mixed $value)
Validate that an attribute is 7 bit ASCII.
bool
validateBail()
"Break" on first validation fail.
Always returns true, just lets us put "bail" in rules.
bool
validateBefore(string $attribute, mixed $value, array<int,int|string> $parameters)
Validate the date is before a given date.
bool
validateBeforeOrEqual(string $attribute, mixed $value, array<int,int|string> $parameters)
Validate the date is before or equal a given date.
bool
validateAfter(string $attribute, mixed $value, array<int,int|string> $parameters)
Validate the date is after a given date.
bool
validateAfterOrEqual(string $attribute, mixed $value, array<int,int|string> $parameters)
Validate the date is equal or after a given date.
protected bool
compareDates(string $attribute, mixed $value, array<int,int|string> $parameters, string $operator)
Compare a given date against another using an operator.
protected string|null
getDateFormat(string $attribute)
Get the date format for an attribute if it has one.
protected int|null
getDateTimestamp(mixed $value)
Get the date timestamp.
protected bool
checkDateTimeOrder(string $format, string $first, string $second, string $operator)
Given two date/time strings, check that one is after the other.
protected DateTime|null
getDateTimeWithOptionalFormat(string $format, string $value)
Get a DateTime instance from a string.
protected DateTime|null
getDateTime(string $value)
Get a DateTime instance from a string with no format.
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.
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.
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.
bool
validateArray(string $attribute, mixed $value, array<int,int|string> $parameters = [])
Validate that an attribute is an array.
bool
validateList(string $attribute, mixed $value)
Validate that an attribute is a list.
bool
validateRequiredArrayKeys(string $attribute, mixed $value, array<int,int|string> $parameters)
Validate that an array has all of the given keys.
bool
validateBetween(string $attribute, mixed $value, array<int,int|string> $parameters)
Validate the size of an attribute is between a set of values.
bool
validateBoolean(string $attribute, mixed $value, $parameters)
Validate that an attribute is a boolean.
bool
validateConfirmed(string $attribute, mixed $value, $parameters)
Validate that an attribute has a matching confirmation.
bool
validateContains(string $attribute, mixed $value, array<int,int|string> $parameters)
Validate an attribute contains a list of values.
bool
validateDoesntContain(string $attribute, mixed $value, array<int,int|string> $parameters)
Validate an attribute does not contain a list of values.
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.
bool
validateDate(string $attribute, mixed $value)
Validate that an attribute is a valid date.
bool
validateDateFormat(string $attribute, mixed $value, array<int,int|string> $parameters)
Validate that an attribute matches a date format.
bool
validateDateEquals(string $attribute, mixed $value, array<int,int|string> $parameters)
Validate that an attribute is equal to another date.
bool
validateDecimal(string $attribute, mixed $value, array<int,int|string> $parameters)
Validate that an attribute has a given number of decimal places.
bool
validateDifferent(string $attribute, mixed $value, array<int,int|string> $parameters)
Validate that an attribute is different from another attribute.
bool
validateDigits(string $attribute, mixed $value, array<int,int|string> $parameters)
Validate that an attribute has a given number of digits.
bool
validateDigitsBetween(string $attribute, mixed $value, array<int,int|string> $parameters)
Validate that an attribute is between a given number of digits.
bool
validateDimensions(string $attribute, mixed $value, array<int,int|string> $parameters)
Validate the dimensions of an image matches the given values.
protected bool
failsBasicDimensionChecks(array<string,string> $parameters, int $width, int $height)
Test if the given width and height fail any conditions.
protected bool
failsRatioCheck(array<string,string> $parameters, int $width, int $height)
Determine if the given parameters fail a dimension ratio check.
bool
validateDistinct(string $attribute, mixed $value, array<int,int|string> $parameters)
Validate an attribute is unique among other values.
protected array
getDistinctValues(string $attribute)
Get the values to distinct between.
protected array
extractDistinctValues(string $attribute)
Extract the distinct values from the data.
bool
validateEmail(string $attribute, mixed $value, array<int,int|string> $parameters)
Validate that an attribute is a valid e-mail address.
bool
validateEncoding(string $attribute, mixed $value, array<int,int|string> $parameters)
Validate the encoding of an attribute.
bool
validateExists(string $attribute, mixed $value, array<int,int|string> $parameters)
Validate the existence of an attribute value in a database table.
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.
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.
protected array
getUniqueIds(string|null $idColumn, array<int,int|string> $parameters)
Get the excluded ID column and value for the unique rule.
protected int
prepareUniqueId(mixed $id)
Prepare the given ID for querying.
protected array
getUniqueExtra(array<int,int|string> $parameters)
Get the extra conditions for a unique rule.
array
parseTable(string $table)
Parse the connection / table for the unique / exists rules.
int|string
getQueryColumn(array<int,int|string> $parameters, string $attribute)
Get the column name for an exists / unique query.
string
guessColumnForQuery(string $attribute)
Guess the database column from the given attribute name.
protected array
getExtraConditions(array $segments)
Get the extra conditions for a unique / exists rule.
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.
bool
validateFile(string $attribute, mixed $value)
Validate the given value is a valid file.
bool
validateFilled(string $attribute, mixed $value)
Validate the given attribute is filled if it is present.
bool
validateGt(string $attribute, mixed $value, array<int,int|string> $parameters)
Validate that an attribute is greater than another attribute.
bool
validateLt(string $attribute, mixed $value, array<int,int|string> $parameters)
Validate that an attribute is less than another attribute.
bool
validateGte(string $attribute, mixed $value, array<int,int|string> $parameters)
Validate that an attribute is greater than or equal another attribute.
bool
validateLte(string $attribute, mixed $value, array<int,int|string> $parameters)
Validate that an attribute is less than or equal another attribute.
bool
validateLowercase(string $attribute, mixed $value, array<int,int|string> $parameters)
Validate that an attribute is lowercase.
bool
validateUppercase(string $attribute, mixed $value, array<int,int|string> $parameters)
Validate that an attribute is uppercase.
bool
validateHexColor(string $attribute, mixed $value)
Validate that an attribute is a valid HEX color.
bool
validateImage(string $attribute, mixed $value, array<int,string> $parameters = [])
Validate the MIME type of a file is an image MIME type.
bool
validateIn(string $attribute, mixed $value, array<int,int|string> $parameters)
Validate an attribute is contained within a list of values.
bool
validateInArray(string $attribute, mixed $value, array<int,int|string> $parameters)
Validate that the values of an attribute are in another attribute.
bool
validateInArrayKeys(string $attribute, mixed $value, array<int,int|string> $parameters)
Validate that an array has at least one of the given keys.
bool
validateInteger(string $attribute, mixed $value, array $parameters = [])
Validate that an attribute is an integer.
bool
validateIp(string $attribute, mixed $value)
Validate that an attribute is a valid IP.
bool
validateIpv4(string $attribute, mixed $value)
Validate that an attribute is a valid IPv4.
bool
validateIpv6(string $attribute, mixed $value)
Validate that an attribute is a valid IPv6.
bool
validateMacAddress(string $attribute, mixed $value)
Validate that an attribute is a valid MAC address.
bool
validateJson(string $attribute, mixed $value)
Validate the attribute is a valid JSON string.
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.
bool
validateMaxDigits(string $attribute, mixed $value, array<int,int|string> $parameters)
Validate that an attribute has a maximum number of digits.
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.
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.
protected bool
shouldBlockPhpUpload(mixed $value, array<int,int|string> $parameters)
Check if PHP uploads are explicitly allowed.
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.
bool
validateMinDigits(string $attribute, mixed $value, array<int,int|string> $parameters)
Validate that an attribute has a minimum number of digits.
bool
validateMissing(string $attribute, mixed $value, array<int,int|string> $parameters)
Validate that an attribute is missing.
bool
validateMissingIf(string $attribute, mixed $value, array<int,int|string> $parameters)
Validate that an attribute is missing when another attribute has a given value.
bool
validateMissingUnless(string $attribute, mixed $value, array<int,int|string> $parameters)
Validate that an attribute is missing unless another attribute has a given value.
bool
validateMissingWith(string $attribute, mixed $value, array<int,int|string> $parameters)
Validate that an attribute is missing when any given attribute is present.
bool
validateMissingWithAll(string $attribute, mixed $value, array<int,int|string> $parameters)
Validate that an attribute is missing when all given attributes are present.
bool
validateMultipleOf(string $attribute, mixed $value, array<int,int|string> $parameters)
Validate the value of an attribute is a multiple of a given value.
bool
validateNullable()
"Indicate" validation should pass if value is null.
Always returns true, just lets us put "nullable" in rules.
bool
validateNotIn(string $attribute, mixed $value, array<int,int|string> $parameters)
Validate an attribute is not contained within a list of values.
bool
validateNumeric(string $attribute, mixed $value, array $parameters)
Validate that an attribute is numeric.
bool
validatePresent(string $attribute, mixed $value)
Validate that an attribute exists even if not filled.
bool
validatePresentIf(string $attribute, mixed $value, array<int,int|string> $parameters)
Validate that an attribute is present when another attribute has a given value.
bool
validatePresentUnless(string $attribute, mixed $value, array<int,int|string> $parameters)
Validate that an attribute is present unless another attribute has a given value.
bool
validatePresentWith(string $attribute, mixed $value, array<int,int|string> $parameters)
Validate that an attribute is present when any given attribute is present.
bool
validatePresentWithAll(string $attribute, mixed $value, array<int,int|string> $parameters)
Validate that an attribute is present when all given attributes are present.
bool
validateRegex(string $attribute, mixed $value, array<int,int|string> $parameters)
Validate that an attribute passes a regular expression check.
bool
validateNotRegex(string $attribute, mixed $value, array<int,int|string> $parameters)
Validate that an attribute does not pass a regular expression check.
bool
validateRequired(string $attribute, mixed $value)
Validate that a required attribute exists.
bool
validateRequiredIf(string $attribute, mixed $value, mixed $parameters)
Validate that an attribute exists when another attribute has a given value.
bool
validateRequiredIfAccepted(string $attribute, mixed $value, mixed $parameters)
Validate that an attribute exists when another attribute was "accepted".
bool
validateRequiredIfDeclined(string $attribute, mixed $value, mixed $parameters)
Validate that an attribute exists when another attribute was "declined".
bool
validateProhibited(string $attribute, mixed $value)
Validate that an attribute does not exist or is an empty string.
bool
validateProhibitedIf(string $attribute, mixed $value, mixed $parameters)
Validate that an attribute does not exist when another attribute has a given value.
bool
validateProhibitedIfAccepted(string $attribute, mixed $value, mixed $parameters)
Validate that an attribute does not exist when another attribute was "accepted".
bool
validateProhibitedIfDeclined(string $attribute, mixed $value, mixed $parameters)
Validate that an attribute does not exist when another attribute was "declined".
bool
validateProhibitedUnless(string $attribute, mixed $value, mixed $parameters)
Validate that an attribute does not exist unless another attribute has a given value.
bool
validateProhibits(string $attribute, mixed $value, mixed $parameters)
Validate that other attributes do not exist when this attribute exists.
bool
validateExclude()
Indicate that an attribute is excluded.
bool
validateExcludeIf(string $attribute, mixed $value, mixed $parameters)
Indicate that an attribute should be excluded when another attribute has a given value.
bool
validateExcludeUnless(string $attribute, mixed $value, mixed $parameters)
Indicate that an attribute should be excluded when another attribute does not have a given value.
bool
validateRequiredUnless(string $attribute, mixed $value, mixed $parameters)
Validate that an attribute exists when another attribute does not have a given value.
bool
validateExcludeWith(string $attribute, mixed $value, mixed $parameters)
Indicate that an attribute should be excluded when another attribute presents.
bool
validateExcludeWithout(string $attribute, mixed $value, mixed $parameters)
Indicate that an attribute should be excluded when another attribute is missing.
array
parseDependentRuleParameters(array<int,int|string> $parameters)
Prepare the values and the other value for validation.
protected bool
shouldConvertToBoolean(string $parameter)
Check if parameter should be converted to boolean.
protected array
convertValuesToBoolean(array $values)
Convert the given values to boolean if they are string "true" / "false".
protected array
convertValuesToNull(array $values)
Convert the given values to null if they are string "null".
bool
validateRequiredWith(string $attribute, mixed $value, mixed $parameters)
Validate that an attribute exists when any other attribute exists.
bool
validateRequiredWithAll(string $attribute, mixed $value, mixed $parameters)
Validate that an attribute exists when all other attributes exist.
bool
validateRequiredWithout(string $attribute, mixed $value, mixed $parameters)
Validate that an attribute exists when another attribute does not.
bool
validateRequiredWithoutAll(string $attribute, mixed $value, mixed $parameters)
Validate that an attribute exists when all other attributes do not.
protected bool
anyFailingRequired(array $attributes)
Determine if any of the given attributes fail the required test.
protected bool
allFailingRequired(array $attributes)
Determine if all of the given attributes fail the required test.
bool
validateSame(string $attribute, mixed $value, array<int,int|string> $parameters)
Validate that two attributes match.
bool
validateSize(string $attribute, mixed $value, array<int,int|string> $parameters)
Validate the size of an attribute.
bool
validateSometimes()
"Validate" optional attributes.
Always returns true, just lets us put sometimes in rules.
bool
validateStartsWith(string $attribute, mixed $value, array<int,int|string> $parameters)
Validate the attribute starts with a given substring.
bool
validateDoesntStartWith(string $attribute, mixed $value, array<int,int|string> $parameters)
Validate the attribute does not start with a given substring.
bool
validateEndsWith(string $attribute, mixed $value, array<int,int|string> $parameters)
Validate the attribute ends with a given substring.
bool
validateDoesntEndWith(string $attribute, mixed $value, array<int,int|string> $parameters)
Validate the attribute does not end with a given substring.
bool
validateString(string $attribute, mixed $value)
Validate that an attribute is a string.
bool
validateTimezone(string $attribute, mixed $value, array<string,null|string> $parameters = [])
Validate that an attribute is a valid timezone.
bool
validateUrl(string $attribute, mixed $value, array<int,string> $parameters = [])
Validate that an attribute is a valid URL.
bool
validateUlid(string $attribute, mixed $value)
Validate that an attribute is a valid ULID.
bool
validateUuid(string $attribute, mixed $value, $parameters)
Validate that an attribute is a valid UUID.
protected int|string
getSize(string $attribute, mixed $value)
Get the size of an attribute.
bool
isValidFileInstance(mixed $value)
Check that the given value is a valid file instance.
protected bool
compare(mixed $first, mixed $second, string $operator)
Determine if a comparison passes between the given values.
array
parseNamedParameters(array<int,int|string> $parameters)
Parse named parameters to $key => $value items.
void
requireParameterCount(int $count, array<int,int|string> $parameters, string $rule)
Require a certain number of parameters to be present.
protected bool
isSameType(mixed $first, mixed $second)
Check if the parameters are of the same type.
protected void
shouldBeNumeric(string $attribute, string $rule)
Adds the existing rule to the numericRules array if the attribute's value is numeric.
protected string
trim(mixed $value)
Trim the value if it is a string.
protected mixed
ensureExponentWithinAllowedRange(string $attribute, mixed $value)
Ensure the exponent is within the allowed range.