Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arubacao/tld-checker
Top Level Domain (TLD) validation library for PHP
https://github.com/arubacao/tld-checker
domain iana laravel php tld
Last synced: 3 days ago
JSON representation
Top Level Domain (TLD) validation library for PHP
- Host: GitHub
- URL: https://github.com/arubacao/tld-checker
- Owner: arubacao
- License: mit
- Created: 2017-09-18T18:30:27.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-05-19T04:01:30.000Z (8 months ago)
- Last Synced: 2024-05-20T04:47:49.739Z (8 months ago)
- Topics: domain, iana, laravel, php, tld
- Language: PHP
- Homepage:
- Size: 593 KB
- Stars: 69
- Watchers: 4
- Forks: 15
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Top Level Domain (TLD) validation library for PHP
[](https://packagist.org/packages/arubacao/tld-checker)
[](https://travis-ci.com/arubacao/tld-checker)
[](https://codecov.io/gh/arubacao/tld-checker)
[](https://scrutinizer-ci.com/g/arubacao/tld-checker)
[](https://packagist.org/packages/arubacao/tld-checker)
This package allows **validation** of **top level domains** against the official [The DNS Root Zone](https://www.iana.org/domains/root) database from [iana.org](https://www.iana.org/).
Use this to validate e.g. **domains** or **email addresses**.
> [The DNS Root Zone](https://www.iana.org/domains/root) is the upper-most part of the DNS hierarchy, and involves delegating administrative responsibility of “top-level domains”, which are the last segment of a domain name, such as .com, .uk and .nz.
*The database is stored [locally](src/RootZoneDatabase.php) and automatically updated for new database versions.*
## Installation
Install this package via composer:
```bash
composer require arubacao/tld-checker
```
#### Laravel
If you would like to use `arubacao/tld-checker` with the [Laravel Validator](https://laravel.com/docs/validation/latest), you must also register the service provider:
*(only required for Laravel `<=5.4`, for Laravel `>=5.5` [auto-discovery](composer.json#L36) is enabled.)*
```PHP
// config/app.php
'providers' => [
// Other Service Providers
Arubacao\TldChecker\TldCheckerServiceProvider::class,
],
```
Notes:
- `arubacao/tld-checker` is functional and fully [tested](https://travis-ci.com/arubacao/tld-checker) for PHP `7.0` - `8.0` & Laravel `5.0` - `8.x`.
## Usage
Check a TLD using `Validator::isTld()`:
``` php
use Arubacao\TldChecker\Validator;
Validator::isTld('com'); // true
Validator::isTld('CN'); // true (case insensitiv)
Validator::isTld('москва'); // true (works with internationalized domain name (IDN) | unicode)
Validator::isTld('XN--CZRS0T'); // true (works with encoded IDN | 商店)
Validator::isTld('.org'); // true (allows dot prefix)
Validator::isTld('apricot'); // false
```
Check if a string ends with a valid TLD using `Validator::endsWithTld()`:
``` php
use Arubacao\TldChecker\Validator;
Validator::endsWithTld('apple.com'); // true
Validator::endsWithTld('NEWS.CN'); // true (case insensitiv)
Validator::endsWithTld('müller.vermögensberater'); // true (works with internationalized domain name (IDN) | unicode)
Validator::endsWithTld('xn--mller-kva.xn--vermgensberater-ctb');// true (works with encoded IDN | müller.vermögensberater)
Validator::endsWithTld('farming.apricot'); // false
```
This package extends the [Laravel Validator](https://laravel.com/docs/validation/latest) with these 2 methods:
- `is_tld`
- `ends_with_tld`
Use them as follows:
```PHP
$request->validate([
'tld' => 'required|is_tld',
'email' => 'required|ends_with_tld'
]);
```
## Testing
``` bash
composer test
```
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Credits
- [Christopher Lass](https://github.com/arubacao)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.