respect-validation/docs/rules/StartsWith.md

46 lines
807 B
Markdown
Raw Permalink Normal View History

2015-01-30 09:40:06 +01:00
# StartsWith
- `StartsWith(mixed $value)`
- `StartsWith(mixed $value, bool $identical)`
2015-01-30 09:40:06 +01:00
Validates whether the input starts with a given value.
This validator is similar to [Contains](Contains.md), but validates only
if the value is at the beginning of the input.
2015-01-30 09:40:06 +01:00
For strings:
```php
v::startsWith('lorem')->validate('lorem ipsum'); // true
2015-01-30 09:40:06 +01:00
```
For arrays:
```php
v::startsWith('lorem')->validate(['lorem', 'ipsum']); // true
2015-01-30 09:40:06 +01:00
```
`true` may be passed as a parameter to indicate identical comparison
instead of equal.
Message template for this validator includes `{{startValue}}`.
## Categorization
- Arrays
- Strings
## Changelog
Version | Description
--------|-------------
0.3.9 | Created
***
2015-01-30 09:40:06 +01:00
See also:
- [Contains](Contains.md)
2018-12-11 13:31:50 +01:00
- [EndsWith](EndsWith.md)
- [In](In.md)
2018-12-11 13:31:50 +01:00
- [Regex](Regex.md)