respect-validation/docs/validators/Contains.md
Henrique Moody d2198dfd01
Replace isValid() calls with assert()
There's more value on showing how `assert()` displays the validation
messages than simply showing if `isValid()` returns `true` or `false`.

However, that increases the chances of having outdated documentation, so
I created a doc linter that updates the Markdown files with the
correct message.
2026-01-13 23:37:06 -07:00

1.5 KiB

Contains

  • Contains(mixed $containsValue)
  • Contains(mixed $containsValue, bool $identical)

Validates if the input contains some value.

For strings:

v::contains('ipsum')->assert('lorem ipsum');
// Validation passes successfully

For arrays:

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

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

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

Templates

Contains::TEMPLATE_STANDARD

Mode Template
default {{subject}} must contain {{containsValue}}
inverted {{subject}} must not contain {{containsValue}}

Template placeholders

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

Categorization

  • Arrays
  • Strings

Changelog

Version Description
0.3.9 Created

See also: