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

54 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()->isValid("\n\r\t"); // true
```
## 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)