respect-validation/docs/validators/Control.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

55 lines
1.6 KiB
Markdown

# Control
- `Control()`
- `Control(string ...$additionalChars)`
Validates if all of the characters in the provided string, are control
characters.
```php
v::control()->assert("\n\r\t");
// Validation passes successfully
```
## Templates
### `Control::TEMPLATE_STANDARD`
| Mode | Template |
| ---------- | ------------------------------------------------ |
| `default` | {{subject}} must only contain control characters |
| `inverted` | {{subject}} must not contain control characters |
### `Control::TEMPLATE_EXTRA`
| Mode | Template |
| ---------- | ------------------------------------------------------------------------ |
| `default` | {{subject}} must only contain control characters and {{additionalChars}} |
| `inverted` | {{subject}} must not contain control characters or {{additionalChars}} |
## Template placeholders
| Placeholder | Description |
| ----------------- | ---------------------------------------------------------------- |
| `additionalChars` | Additional characters that are considered valid. |
| `subject` | The validated input or the custom validator name (if specified). |
## Categorization
- Strings
## Changelog
| Version | Description |
| ------: | --------------------------------- |
| 2.0.0 | Renamed from `Cntrl` to `Control` |
| 0.5.0 | Created |
---
See also:
- [Alnum](Alnum.md)
- [Printable](Printable.md)
- [Punct](Punct.md)
- [Space](Space.md)