respect-validation/docs/validators/FalseVal.md
Alexandre Gomes Gaigalas bd48bdcda4 Lint Changelog format in validator docs
Introduces a Markdown linter for checking the Changelog format.

"See Also" was transformed into a section to make it easier to
handle it with the `Content` class. The "Related" linter was
simplified to reflect that change too.

An additional "alignment" parameter was added to markdown table
generators, allowing the padding and headers to be explicitly
marked with a specific left (-1), middle (0) or right(1)
alignment.

Existing files were fixed using the `fix` option after the
changes.
2026-01-26 19:11:00 +00:00

66 lines
1.5 KiB
Markdown

<!--
SPDX-FileCopyrightText: (c) Respect Project Contributors
SPDX-License-Identifier: MIT
-->
# 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)