respect-validation/docs/rules/EndsWith.md
Henrique Moody be72a54845
Add templates to each rule documentation
They only know what message a rule produces when they try running it.
Including the messages in the documentation will make it easier for
people to know what to expect.

There are a couple of undocumented placeholders, but I can live with
that for now.
2024-12-06 00:21:47 +01:00

1.3 KiB

EndsWith

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

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

For strings:

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

For arrays:

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

A second parameter may be passed for identical comparison instead of equal comparison.

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

Templates

EndsWith::TEMPLATE_STANDARD

Mode Template
default {{name}} must end with {{endValue}}
inverted {{name}} must not end with {{endValue}}

Template placeholders

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

Categorization

  • Arrays
  • Strings

Changelog

Version Description
0.3.9 Created

See also: