Download the PHP package hampel/tlds without Composer
On this page you can find all versions of the php package hampel/tlds. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Package tlds
Short Description Fetches the latest list of Top Level Domains from IANA, plus Laravel classes for validating TLDs
License MIT
Homepage https://github.com/hampel/tlds
Informations about the package tlds
Top Level Domain Fetcher for Laravel
This package provides a mechanism for retrieving a list of the current Top Level Domains (TLDs) managed by IANA. It also provides several Laravel classes to validate domain names and TLDs.
By Simon Hampel
Compatibility
- Laravel 9.x - use hampel/tlds 1.10.x
- Laravel 10.x - use hampel/tlds 2.x
- Laravel 11.x - use hampel/tlds 2.1.x
Installation
To install using composer, run the following command:
composer require hampel/tlds
If you want to change the default Tlds configuration, first publish it using the command:
The config files can then be found in config/tlds.php
.
Configuration
Refer to the configuration file for more details about configuration options.
tlds.cache.expiry - sets the cache expiry time in seconds
tlds.cache.key - sets the key used to store the TLD data in the cache
tlds.source - set this to 'url' to retrieve the data from a website (eg IANA), set it to 'filesystem' to retrieve the data from a local source (you'll need to configure a Laravel filesystem 'disk' to make this work).
tlds.url - if source is set to 'url', enter the URL to retrieve the data from. By default this is set to the IANA source file
tlds.disk - if source is set to 'filesystem', enter the name of the Laravel filesystem disk you have configured in the 'filesystems.disks' configuration option
tlds.path - if source is set to 'filesystem', enter the path to the data file relative to the root path configured for the disk in the 'fileystems.disks' configuration option (eg. 'tlds/tlds-alpha-by-domain.txt')
Usage
The Tlds package provides a simple mechanism for reading a data file containing a list of Top Level Domains, one per line and returning an array of data. This data may optionally be cached for performance.
The data file can be retrieved directly from the Internet Assigned Numbers Authority (IANA) website, using Guzzle, or if you have a different source or prefer to fetch the data file yourself and then read it from a local source you can reconfigure the Tlds package to read the data file from any Laravel supported filesystem (using Flysystem).
There is also an artisan command available which can be used to fetch the latest data file to refresh the cache. This is ideal for automating the retrieval of data using a cron job or similar.
The simplest way to call the package is using the Facade:
This returns a "fresh" copy of the data (bypassing the cache) as an array of TLDs.
To fetch the TLD array from the cache or have it update automatically if the cached data has expired
To run the artisan console command to update the cache:
Validators
This package adds additional validators for Laravel v10.x and above - refer to Laravel Documentation - Validation for general usage instructions.
Domain
The field under validation must be a valid domain name. The Top Level Domain (TLD) is checked against a list of all acceptable TLDs, including internationalised domains in punycode notation
Example:
DomainIn([<array of TLDs>])
The field under validation must be a valid domain with a TLD from one of the specified options
Example:
Tld
The field under validation must end in a valid Top Level Domain (TLD). The TLD is checked against a list of all acceptable TLDs, including internationalised domains in punycode notation
If no dots are contained in the supplied value, it will be assumed to be only a TLD.
If the value contains dots, only the part after the last dot will be validated.
Example:
TldIn([<array of TLDs>])
The field under validation must end in a TLD from one of the specified options
If no dots are contained in the supplied value, it will be assumed to be only a TLD.
If the value contains dots, only the part after the last dot will be validated.
Example: