respect-validation/docs/rules/Instance.md
2024-12-09 01:34:50 +01:00

47 lines
1.3 KiB
Markdown

# Instance
- `Instance(string $instanceName)`
Validates if the input is an instance of the given class or interface.
```php
v::instance('DateTime')->isValid(new DateTime); // true
v::instance('Traversable')->isValid(new ArrayObject); // true
```
Message template for this validator includes `{{instanceName}}`.
## Templates
### `Instance::TEMPLATE_STANDARD`
| Mode | Template |
|------------|----------------------------------------------------------|
| `default` | {{name}} must be an instance of `{{class|raw}}` |
| `inverted` | {{name}} must not be an instance of `{{class|raw}}` |
## Template placeholders
| Placeholder | Description |
|-------------|------------------------------------------------------------------|
| `class` | |
| `name` | The validated input or the custom validator name (if specified). |
## Categorization
- Objects
## Changelog
| Version | Description |
|--------:|-------------|
| 0.3.9 | Created |
***
See also:
- [Countable](Countable.md)
- [IterableType](IterableType.md)
- [IterableVal](IterableVal.md)
- [ObjectType](ObjectType.md)
- [Type](Type.md)