respect-validation/docs/rules/StartsWith.md
Henrique Moody 48405271c5
Replace placeholder "name" with "subject"
The `{{name}}` placeholder could represent different things depending on
the state of the Result, and referring to it as `{{name}}` seems
arbitrary. This commit changes it to `{{subject}}`, which is much more
generic and it describes well what that placeholder can mean.
2025-12-26 21:30:01 +01:00

1.5 KiB

StartsWith

  • StartsWith(mixed $value)
  • StartsWith(mixed $value, bool $identical)

Validates whether the input starts with a given value.

This validator is similar to Contains, but validates only if the value is at the beginning of the input.

For strings:

v::startsWith('lorem')->isValid('lorem ipsum'); // true

For arrays:

v::startsWith('lorem')->isValid(['lorem', 'ipsum']); // true

true may be passed as a parameter to indicate identical comparison instead of equal.

Message template for this validator includes {{startValue}}.

Templates

StartsWith::TEMPLATE_STANDARD

Mode Template
default {{subject}} must start with {{startValue}}
inverted {{subject}} must not start with {{startValue}}

Template placeholders

Placeholder Description
subject The validated input or the custom validator name (if specified).
startValue

Categorization

  • Arrays
  • Strings

Changelog

Version Description
0.3.9 Created

See also: