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

51 lines
1.5 KiB
Markdown

# Punct
- `Punct()`
- `Punct(string ...$additionalChars)`
Validates whether the input composed by only punctuation characters.
```php
v::punct()->isValid('&,.;[]'); // true
```
## Templates
### `Punct::TEMPLATE_STANDARD`
| Mode | Template |
| ---------- | ---------------------------------------------------- |
| `default` | {{subject}} must contain only punctuation characters |
| `inverted` | {{subject}} must not contain punctuation characters |
### `Punct::TEMPLATE_EXTRA`
| Mode | Template |
| ---------- | ---------------------------------------------------------------------------- |
| `default` | {{subject}} must contain only punctuation characters and {{additionalChars}} |
| `inverted` | {{subject}} must not contain punctuation 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 |
| ------: | ----------- |
| 0.5.0 | Created |
---
See also:
- [Control](Control.md)
- [Graph](Graph.md)
- [Printable](Printable.md)