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.
98 lines
2.2 KiB
Markdown
98 lines
2.2 KiB
Markdown
<!--
|
|
SPDX-FileCopyrightText: (c) Respect Project Contributors
|
|
SPDX-License-Identifier: MIT
|
|
-->
|
|
|
|
# Undef
|
|
|
|
- `Undef()`
|
|
|
|
Validates if the given input is undefined. By _undefined_ we consider `null` or an empty string (`''`).
|
|
|
|
We recommend you to check [Comparing empty values](../comparing-empty-values.md) for more details.
|
|
|
|
```php
|
|
v::undef()->assert('');
|
|
// Validation passes successfully
|
|
|
|
v::undef()->assert(null);
|
|
// Validation passes successfully
|
|
```
|
|
|
|
Other values similar to _undefined_ values are considered _defined_:
|
|
|
|
```php
|
|
v::undef()->assert([]);
|
|
// → `[]` must be undefined
|
|
|
|
v::undef()->assert(' ');
|
|
// → " " must be undefined
|
|
|
|
v::undef()->assert(0);
|
|
// → 0 must be undefined
|
|
|
|
v::undef()->assert('0');
|
|
// → "0" must be undefined
|
|
|
|
v::undef()->assert('0.0');
|
|
// → "0.0" must be undefined
|
|
|
|
v::undef()->assert(false);
|
|
// → `false` must be undefined
|
|
|
|
v::undef()->assert(['']);
|
|
// → `[""]` must be undefined
|
|
|
|
v::undef()->assert([' ']);
|
|
// → `[" "]` must be undefined
|
|
|
|
v::undef()->assert([0]);
|
|
// → `[0]` must be undefined
|
|
|
|
v::undef()->assert(['0']);
|
|
// → `["0"]` must be undefined
|
|
|
|
v::undef()->assert([false]);
|
|
// → `[false]` must be undefined
|
|
|
|
v::undef()->assert([[''], [0]]);
|
|
// → `[[""], [0]]` must be undefined
|
|
|
|
v::undef()->assert(new stdClass());
|
|
// → `stdClass {}` must be undefined
|
|
```
|
|
|
|
## Templates
|
|
|
|
### `Undef::TEMPLATE_STANDARD`
|
|
|
|
| Mode | Template |
|
|
| ---------: | :---------------------------- |
|
|
| `default` | {{subject}} must be undefined |
|
|
| `inverted` | {{subject}} must be defined |
|
|
|
|
## Template placeholders
|
|
|
|
| Placeholder | Description |
|
|
| ----------- | ---------------------------------------------------------------- |
|
|
| `subject` | The validated input or the custom validator name (if specified). |
|
|
|
|
## Categorization
|
|
|
|
- Miscellaneous
|
|
|
|
## Changelog
|
|
|
|
| Version | Description |
|
|
| ------: | :------------------------------------------ |
|
|
| 3.0.0 | Renamed to `Undef` and changed the behavior |
|
|
| 1.0.0 | Created as `NotOptional` |
|
|
|
|
## See Also
|
|
|
|
- [Blank](Blank.md)
|
|
- [Falsy](Falsy.md)
|
|
- [NullType](NullType.md)
|
|
- [Number](Number.md)
|
|
- [Spaced](Spaced.md)
|
|
- [UndefOr](UndefOr.md)
|