Back to Validation

Undef

docs/validators/Undef.md

3.1.12.3 KB
Original Source
<!-- SPDX-License-Identifier: MIT SPDX-FileCopyrightText: (c) Respect Project Contributors SPDX-FileContributor: Alexandre Gomes Gaigalas <[email protected]> SPDX-FileContributor: Henrique Moody <[email protected]> -->

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 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

ModeTemplate
default{{subject}} must be undefined
inverted{{subject}} must be defined

Template placeholders

PlaceholderDescription
subjectThe validated input or the custom validator name (if specified).

Categorization

  • Miscellaneous

Changelog

VersionDescription
3.0.0Renamed to Undef and changed the behavior
1.0.0Created as NotOptional

See Also