mirror of
https://github.com/Respect/Validation.git
synced 2026-03-14 22:35:45 +01:00
16148e9593
- Remove redundant "valid" prefix: Date, DateTime, DateTimeDiff, Domain, Email, Iban, Imei, Ip, Isbn, Json, LanguageCode, LeapDate, LeapYear, Luhn, MacAddress, NfeAccessKey, Nif, Nip, Pesel, Phone, Pis, PolishIdCard, PostalCode, Roman, Slug, Tld, Url, Uuid, Version. - Remove redundant "value" suffix ArrayVal, BoolVal, Countable, FloatVal, IntVal, IterableVal, NumericVal, ScalarVal, StringVal. - Standardize "consist only of" phrasing Alnum, Alpha, Cntrl, Consonant, Digit, Graph, Lowercase, Printable, Punct, Space, Spaced, Uppercase, Vowel, Xdigit. - Improve file accessibility messages Directory, Executable, File, Image, Readable, SymbolicLink, Writable. - Improve grammar and article usage CreditCard, Extension, Mimetype, Regex, Size.
75 lines
1.8 KiB
Markdown
75 lines
1.8 KiB
Markdown
<!--
|
|
SPDX-License-Identifier: MIT
|
|
SPDX-FileCopyrightText: (c) Respect Project Contributors
|
|
SPDX-FileContributor: Alexandre Gomes Gaigalas <alganet@gmail.com>
|
|
SPDX-FileContributor: Henrique Moody <henriquemoody@gmail.com>
|
|
SPDX-FileContributor: yoshihiro suzuki <yoshihiro_suzuki@voyagegroup.com>
|
|
-->
|
|
|
|
# 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 |
|
|
| `inverted` | {{subject}} must not be a string |
|
|
|
|
## Template placeholders
|
|
|
|
| Placeholder | Description |
|
|
| ----------- | ---------------------------------------------------------------- |
|
|
| `subject` | The validated input or the custom validator name (if specified). |
|
|
|
|
## Categorization
|
|
|
|
- Strings
|
|
- Types
|
|
|
|
## Changelog
|
|
|
|
| Version | Description |
|
|
| ------: | :---------------- |
|
|
| 3.0.0 | Templates changed |
|
|
| 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)
|