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

50 lines
1.2 KiB
Markdown

# TrueVal
- `TrueVal()`
Validates if a value is considered as `true`.
```php
v::trueVal()->isValid(true); // true
v::trueVal()->isValid(1); // true
v::trueVal()->isValid('1'); // true
v::trueVal()->isValid('true'); // true
v::trueVal()->isValid('on'); // true
v::trueVal()->isValid('yes'); // true
v::trueVal()->isValid('0.5'); // false
v::trueVal()->isValid('2'); // false
```
## Templates
### `TrueVal::TEMPLATE_STANDARD`
| Mode | Template |
| ---------- | --------------------------------------- |
| `default` | {{subject}} must evaluate to `true` |
| `inverted` | {{subject}} must not evaluate to `true` |
## Template placeholders
| Placeholder | Description |
| ----------- | ---------------------------------------------------------------- |
| `subject` | The validated input or the custom validator name (if specified). |
## Categorization
- Booleans
## Changelog
| Version | Description |
| ------: | -------------------------------- |
| 1.0.0 | Renamed from `True` to `TrueVal` |
| 0.8.0 | Created as `True` |
---
See also:
- [BoolType](BoolType.md)
- [BoolVal](BoolVal.md)
- [FalseVal](FalseVal.md)