respect-validation/docs/validators/FalseVal.md
Henrique Moody 7c681fec66
Fix SPDX headers in all files
I ran the `bin/console spdx --fix` with different strategies for
different files. For most of the core classes, since they've been
drastically rebuilt, I've run it with the `git-blame` strategy, for for
the `src/Validators`, in which the API changed completely but the logic
remains the same, I use the `git-log` strategy.
2026-02-03 15:23:23 +01:00

68 lines
1.6 KiB
Markdown

<!--
SPDX-License-Identifier: MIT
SPDX-FileCopyrightText: (c) Respect Project Contributors
SPDX-FileContributor: Alexandre Gomes Gaigalas <alganet@gmail.com>
SPDX-FileContributor: Henrique Moody <henriquemoody@gmail.com>
-->
# FalseVal
- `FalseVal()`
Validates if a value is considered as `false`.
```php
v::falseVal()->assert(false);
// Validation passes successfully
v::falseVal()->assert(0);
// Validation passes successfully
v::falseVal()->assert('0');
// Validation passes successfully
v::falseVal()->assert('false');
// Validation passes successfully
v::falseVal()->assert('off');
// Validation passes successfully
v::falseVal()->assert('no');
// Validation passes successfully
v::falseVal()->assert('0.5');
// → "0.5" must evaluate to `false`
v::falseVal()->assert('2');
// → "2" must evaluate to `false`
```
## Templates
### `FalseVal::TEMPLATE_STANDARD`
| Mode | Template |
| ---------: | :--------------------------------------- |
| `default` | {{subject}} must evaluate to `false` |
| `inverted` | {{subject}} must not evaluate to `false` |
## 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 `False` to `FalseVal` |
| 0.8.0 | Created as `False` |
## See Also
- [TrueVal](TrueVal.md)