respect-validation/docs/validators/StartsWith.md
Alexandre Gomes Gaigalas ec16b3d2df Refactor case sensitiveness support
This is a mid-size refactor that affects several validators.

Most prominently, the ones that had an `$identical` parameter
to deal with case sensitiveness.

This parameter was confusing, effectively making validators such
as `Contains` behave very differently for arrays versus strings.

In arrays, `$identical` meant "the same type", while it in strings
it meant "case sensitive".

That parameter was removed, and the default behavior is now to
always compare **case sensitive** and strict typing.

A document explaining how to combine other validators in order
to achieve case _insensitive_ comparisons was added.

Additionally, the `Call` validator was refactored back to be
suitable to take on the task of being a fast, quick composable
validator.

With the introduction of `Circuit`, we can shift the responsibility
of dealing with possible mismatches to the user. This kind of type
handling is demonstrated in how I refactored `Tld` to account for
the type mismatch without setting error handlers.
2026-01-30 17:11:13 +00:00

1.6 KiB

StartsWith

  • StartsWith(mixed $startValue)

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')->assert('lorem ipsum');
// Validation passes successfully

For arrays:

v::startsWith('lorem')->assert(['lorem', 'ipsum']);
// Validation passes successfully

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
3.0.0 Case-insensitive comparison removed
0.3.9 Created

See Also