mirror of
https://github.com/Respect/Validation.git
synced 2026-03-15 14:55:44 +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.
71 lines
1.6 KiB
Markdown
71 lines
1.6 KiB
Markdown
<!--
|
|
SPDX-FileCopyrightText: (c) Respect Project Contributors
|
|
SPDX-License-Identifier: MIT
|
|
-->
|
|
|
|
# StringVal
|
|
|
|
- `StringVal()`
|
|
|
|
Validates whether the input can be used as a string.
|
|
|
|
```php
|
|
v::stringVal()->assert('6');
|
|
// Validation passes successfully
|
|
|
|
v::stringVal()->assert('String');
|
|
// Validation passes successfully
|
|
|
|
v::stringVal()->assert(1.0);
|
|
// Validation passes successfully
|
|
|
|
v::stringVal()->assert(42);
|
|
// Validation passes successfully
|
|
|
|
v::stringVal()->assert(false);
|
|
// Validation passes successfully
|
|
|
|
v::stringVal()->assert(true);
|
|
// Validation passes successfully
|
|
|
|
v::stringVal()->assert(new ClassWithToString());
|
|
// Validation passes successfully
|
|
```
|
|
|
|
## Templates
|
|
|
|
### `StringVal::TEMPLATE_STANDARD`
|
|
|
|
| Mode | Template |
|
|
| ---------: | :------------------------------------- |
|
|
| `default` | {{subject}} must be a string value |
|
|
| `inverted` | {{subject}} must not be a string value |
|
|
|
|
## Template placeholders
|
|
|
|
| Placeholder | Description |
|
|
| ----------- | ---------------------------------------------------------------- |
|
|
| `subject` | The validated input or the custom validator name (if specified). |
|
|
|
|
## Categorization
|
|
|
|
- Strings
|
|
- Types
|
|
|
|
## Changelog
|
|
|
|
| Version | Description |
|
|
| ------: | :---------- |
|
|
| 2.0.0 | Created |
|
|
|
|
## See Also
|
|
|
|
- [Alnum](Alnum.md)
|
|
- [BoolType](BoolType.md)
|
|
- [CallableType](CallableType.md)
|
|
- [FloatType](FloatType.md)
|
|
- [IntType](IntType.md)
|
|
- [NullType](NullType.md)
|
|
- [ObjectType](ObjectType.md)
|
|
- [ResourceType](ResourceType.md)
|
|
- [StringType](StringType.md)
|