blob-domain is a simple PHP library for parsing and validating domain names.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
build
lib/blobfolio/domain
npm_scripts
tests
.gitattributes
.gitignore
.travis.yml
LICENSE
README.md
composer.json
package.json
phpunit.xml.dist

README.md

blob-domain

blob-domain is a simple PHP library for parsing and validating domain names. It supports the full Public Suffix ruleset, translates Unicode to ASCII or vice versa (if the PHP extension INTL is present), and can break down a host into its constituent parts: subdomain, domain, and suffix.

Build Status

 

Table of Contents

  1. Requirements
  2. Installation
  3. Reference
  1. License

 

Requirements

blob-domain and its dependencies require PHP 7.0+ with the following modules:

  • BCMath
  • DOM
  • Fileinfo
  • Filter
  • JSON
  • MBString
  • INTL

 

Installation

Use Composer:

composer require "blobfolio/blob-domain:dev-master"

 

Reference

First up, the basics.

Basic Usage:

// Initialize the object by passing a host-like string.
$domain = new blobfolio\domain\domain('www.Google.com');

// Access the sanitized host by typecasting as a string.
echo (string) $domain; //www.google.com

// Get it all. If a part is not applicable, its value will be NULL.
$data = $domain->get_data();
/*
array(
    host => www.google.com
    subdomain => www
    domain => google
    suffix => com
)
*/

// Or each part using `get_KEY()`.
echo $domain->get_host(); //www.google.com
echo $domain->get_subdomain(); //www
echo $domain->get_domain(); //google
echo $domain->get_suffix(); //com

// By default, Unicode domains are converted to ASCII.
$domain = new blobfolio\domain\domain('http://☺.com');
echo $domain->get_host(); //xn--74h.com

// Convert them back by passing `TRUE` to the getters.
echo $domain->get_host(true); //☺.com

 

The following static methods exist if you don't want to initialize an object.

::parse_host()

Parse the hostname part of an arbitrary string, which might be a hostname, IP address, URL, etc.

Note: this will convert Unicode to ASCII.

Arguments

  • (string) Host

Returns

Returns the processed hostname or FALSE on failure.

Example

$foo = blobfolio\domain\domain::parse_host('http://☺.com'); //xn--74h.com
$foo = blobfolio\domain\domain::parse_host('co.uk'); //FALSE

::parse_host_parts()

Pull out the different parts of a host name, i.e. what you'd get running get_data() on a domain object.

Note: this will convert Unicode to ASCII.

Arguments

  • (string) Host

Returns

Returns an array containing the processed parts or FALSE on failure.

Example

$foo = blobfolio\domain\domain::parse_host_parts('www.Google.com');
/*
array(
    host => www.google.com
    subdomain => www
    domain => google
    suffix => com
)
*/

 

The object also comes with public methods. Aside from the various get_*() functions already demonstrated, you've got the following.

is_valid()

Is the host valid? This will be TRUE unless:

  • The host string is malformed;
  • The host string contains Unicode and the INTL extension is missing;
  • The host contains no domain portion;
  • The $dns option is passed but the host is not a FQDN or is missing an A record;

Arguments

  • (bool) (optional) Reachable DNS. If TRUE, the host must either be a public IP address or have an A record in its DNS table. Default: FALSE

Returns

Returns TRUE or FALSE.

is_ascii()

Whether or not a host is ASCII, like google.com. Unicode domains are still a bit unknown in many parts of the Western world and can cause problems with native PHP functions or databases, so good to know what you've got.

Note: IP addresses are considered ASCII for the purposes of this function.

Note: The various get_*() functions will always return the host in ASCII format by default. Passing TRUE to those functions will return Unicode hosts in their original Unicode, e.g. ☺.com.

Arguments

N/A

Returns

Returns TRUE or FALSE.

Example

// ☺.com
$domain->is_ascii(); //FALSE

// xn--74h.com
$domain->is_ascii(); //FALSE

// google.com
$domain->is_ascii(); //TRUE

is_fdqn()

Checks to see whether the host is a Fully-Qualified Domain Name (or at least a public IP address). In other words, can it be seen by the outside world?

Note: this does not imply the host actually exists.

Arguments

N/A

Returns

Returns TRUE or FALSE.

is_ip()

Is the host an IP address?

Arguments

  • (bool) (optional) Allow restricted/private. Default: TRUE

Returns

Returns TRUE or FALSE.

is_unicode()

Whether or not a host is Unicode, like ☺.com. Unicode hosts can cause problems with native PHP functions and databases, so might be a good thing to know.

Note: The various get_*() functions will return an ASCIIfied version of a Unicode domain by default, like xn--74h.com. Passing TRUE will de-convert them back to the original Unicode.

Arguments

N/A

Returns

Returns TRUE or FALSE.

Example

// ☺.com
$domain->is_unicode(); //TRUE

// xn--74h.com
$domain->is_unicode(); //TRUE

// google.com
$domain->is_unicode(); //FALSE

has_dns()

Does this host have an A record in its DNS table or is it a public IP address?

Note: the A record cannot point to a restricted/reserved IP like 127.0.0.1 or the function will return FALSE.

Arguments

N/A

Returns

Returns TRUE or FALSE.

strip_www()

This removes the leading www. subdomain, if any, from the parsed result. You can also have this run automatically at initialization by passing a second argument to the constructor, TRUE.

Arguments

N/A

Returns

Returns TRUE or FALSE, indicating whether or not a change was made.

Example

// As separate actions.
$foo = new blobfolio\domain\domain('www.Google.com');
/*
array(
    host => www.google.com
    subdomain => www
    domain => google
    suffix => com
)
*/
$foo->strip_www();
/*
array(
    host => google.com
    subdomain => NULL
    domain => google
    suffix => com
)
*/

// Or you can do this at initializing by passing TRUE as a second argument.
$foo = new blobfolio\domain\domain('www.Google.com', true);

 

License

Copyright © 2018 Blobfolio, LLC <hello@blobfolio.com>

This work is free. You can redistribute it and/or modify it under the terms of the Do What The Fuck You Want To Public License, Version 2.

DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
Version 2, December 2004

Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>

Everyone is permitted to copy and distribute verbatim or modified
copies of this license document, and changing it is allowed as long
as the name is changed.

DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

0. You just DO WHAT THE FUCK YOU WANT TO.

Donations

Bitcoin QR If you have found this work useful and would like to contribute financially, Bitcoin tips are always welcome!

1Af56Nxauv8M1ChyQxtBe1yvdp2jtaB1GF