mirror of
https://github.com/Respect/Validation.git
synced 2026-03-17 23:59:51 +01:00
bd48bdcda4
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.
69 lines
1.5 KiB
Markdown
69 lines
1.5 KiB
Markdown
<!--
|
|
SPDX-FileCopyrightText: (c) Respect Project Contributors
|
|
SPDX-License-Identifier: MIT
|
|
-->
|
|
|
|
# BoolVal
|
|
|
|
- `BoolVal()`
|
|
|
|
Validates if the input results in a boolean value:
|
|
|
|
```php
|
|
v::boolVal()->assert('on');
|
|
// Validation passes successfully
|
|
|
|
v::boolVal()->assert('off');
|
|
// Validation passes successfully
|
|
|
|
v::boolVal()->assert('yes');
|
|
// Validation passes successfully
|
|
|
|
v::boolVal()->assert('no');
|
|
// Validation passes successfully
|
|
|
|
v::boolVal()->assert(1);
|
|
// Validation passes successfully
|
|
|
|
v::boolVal()->assert(0);
|
|
// Validation passes successfully
|
|
```
|
|
|
|
## Templates
|
|
|
|
### `BoolVal::TEMPLATE_STANDARD`
|
|
|
|
| Mode | Template |
|
|
| ---------: | :-------------------------------------- |
|
|
| `default` | {{subject}} must be a boolean value |
|
|
| `inverted` | {{subject}} must not be a boolean value |
|
|
|
|
## Template placeholders
|
|
|
|
| Placeholder | Description |
|
|
| ----------- | ---------------------------------------------------------------- |
|
|
| `subject` | The validated input or the custom validator name (if specified). |
|
|
|
|
## Categorization
|
|
|
|
- Booleans
|
|
- Types
|
|
|
|
## Changelog
|
|
|
|
| Version | Description |
|
|
| ------: | :---------- |
|
|
| 1.0.0 | Created |
|
|
|
|
## See Also
|
|
|
|
- [BoolType](BoolType.md)
|
|
- [CallableType](CallableType.md)
|
|
- [FloatType](FloatType.md)
|
|
- [FloatVal](FloatVal.md)
|
|
- [IntType](IntType.md)
|
|
- [NullType](NullType.md)
|
|
- [ObjectType](ObjectType.md)
|
|
- [ResourceType](ResourceType.md)
|
|
- [StringType](StringType.md)
|
|
- [TrueVal](TrueVal.md)
|