README

Yii Network Utilities

The package contains various network utilities useful for:

• getting info about IP address;
• checking if IP is in a certain range;
• expanding IPv6;
• converting IP to bits representation;
• checking DNS record availability.

Requirements

• PHP 7.4 - 8.5.

Installation

The package could be installed with Composer:

composer require yiisoft/network-utilities

General usage

IpHelper

use Yiisoft\NetworkUtilities\IpHelper;

// Check IP version.
$version = IpHelper::getIpVersion('192.168.1.1');
if ($version === IpHelper::IPV4) {
    // ...
}

// Check if IP is in a certain range.
if (!IpHelper::inRange('192.168.1.21/32', '192.168.1.0/24')) {
    throw new \RuntimeException('Access denied!');
}

// Expand IP v6.
echo IpHelper::expandIPv6('2001:db8::1');

// Convert IP to bits representation.
echo IpHelper::ip2bin('192.168.1.1');

// Get bits from CIDR Notation.
echo IpHelper::getCidrBits('192.168.1.21/32');

DnsHelper

use Yiisoft\NetworkUtilities\DnsHelper;

// Check DNS record availability.
if (!DnsHelper::existsA('yiiframework.com')) {
  // Record not found.
}

IpRanges

use Yiisoft\NetworkUtilities\IpRanges;

$ipRanges = new IpRanges(
    [
        '10.0.1.0/24',
        '2001:db0:1:2::/64',
        IpRanges::LOCALHOST,
        'myNetworkEu',
        '!' . IpRanges::ANY,
    ],
    [
        'myNetworkEu' => ['1.2.3.4/10', '5.6.7.8'],
    ],
);

$ipRanges->isAllowed('10.0.1.28/28'); // true
$ipRanges->isAllowed('1.2.3.4'); // true
$ipRanges->isAllowed('192.168.0.1'); // false

Documentation

• Internals

If you need help or have a question, the Yii Forum is a good place for that. You may also check out other Yii Community Resources.

License

The Yii Network Utilities is free software. It is released under the terms of the BSD License. Please see LICENSE for more information.

Maintained by Yii Software.

Support the project

Follow updates