respect-validation/docs/validators/Domain.md
Alexandre Gomes Gaigalas bd48bdcda4 Lint Changelog format in validator docs
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.
2026-01-26 19:11:00 +00:00

75 lines
2.1 KiB
Markdown

<!--
SPDX-FileCopyrightText: (c) Respect Project Contributors
SPDX-License-Identifier: MIT
-->
# Domain
- `Domain()`
- `Domain(bool $tldCheck)`
Validates whether the input is a valid domain name or not.
```php
v::domain()->assert('google.com');
// Validation passes successfully
```
You can skip _top level domain_ (TLD) checks to validate internal
domain names:
```php
v::domain(false)->assert('dev.machine.local');
// Validation passes successfully
```
This is a composite validator, it validates several validators
internally:
- If input is an IP address, it fails.
- If input contains whitespace, it fails.
- If input does not contain any dots, it fails.
- If input has less than two parts, it fails.
- Input must end with a top-level-domain to pass (if not skipped).
- Each part must be alphanumeric and not start with an hyphen.
- [PunnyCode][] is accepted for [Internationalizing Domain Names in Applications][IDNA].
Messages for this validator will reflect validators above.
## Templates
### `Domain::TEMPLATE_STANDARD`
| Mode | Template |
| ---------: | :------------------------------------- |
| `default` | {{subject}} must be a valid domain |
| `inverted` | {{subject}} must not be a valid domain |
## Template placeholders
| Placeholder | Description |
| ----------- | ---------------------------------------------------------------- |
| `subject` | The validated input or the custom validator name (if specified). |
## Categorization
- Internet
## Changelog
| Version | Description |
| ------: | :---------------------- |
| 0.6.0 | Allow to skip TLD check |
| 0.3.9 | Created |
## See Also
- [Ip](Ip.md)
- [Json](Json.md)
- [MacAddress](MacAddress.md)
- [PublicDomainSuffix](PublicDomainSuffix.md)
- [Tld](Tld.md)
- [Url](Url.md)
[PunnyCode]: http://en.wikipedia.org/wiki/Punycode "Wikipedia: Punnycode"
[IDNA]: http://en.wikipedia.org/wiki/Internationalized_domain_name#Internationalizing_Domain_Names_in_Applications "Wikipedia: Internationalized domain name"