mirror of
https://github.com/Respect/Validation.git
synced 2026-03-16 23:35:45 +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.
53 lines
1.4 KiB
Markdown
53 lines
1.4 KiB
Markdown
<!--
|
|
SPDX-FileCopyrightText: (c) Respect Project Contributors
|
|
SPDX-License-Identifier: MIT
|
|
-->
|
|
|
|
# Instance
|
|
|
|
- `Instance(class-string $class)`
|
|
|
|
Validates if the input is an instance of the given class or interface.
|
|
|
|
```php
|
|
v::instance('DateTime')->assert(new DateTime);
|
|
// Validation passes successfully
|
|
|
|
v::instance('Traversable')->assert(new ArrayObject);
|
|
// Validation passes successfully
|
|
```
|
|
|
|
Message template for this validator includes `{{instanceName}}`.
|
|
|
|
## Templates
|
|
|
|
### `Instance::TEMPLATE_STANDARD`
|
|
|
|
| Mode | Template |
|
|
| ---------: | :---------------------------------------------------------- |
|
|
| `default` | {{subject}} must be an instance of {{class|quote}} |
|
|
| `inverted` | {{subject}} must not be an instance of {{class|quote}} |
|
|
|
|
## Template placeholders
|
|
|
|
| Placeholder | Description |
|
|
| ----------- | ---------------------------------------------------------------- |
|
|
| `class` | |
|
|
| `subject` | 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)
|