Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/s1lentium/iptools
PHP Library for manipulating network addresses (IPv4 and IPv6)
https://github.com/s1lentium/iptools
ip ip-adress ip-tools ip-utils iptools ipv4 ipv6 network networking php range subnet
Last synced: about 10 hours ago
JSON representation
PHP Library for manipulating network addresses (IPv4 and IPv6)
- Host: GitHub
- URL: https://github.com/s1lentium/iptools
- Owner: S1lentium
- License: mit
- Created: 2014-02-18T13:06:53.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2024-05-03T19:27:38.000Z (9 months ago)
- Last Synced: 2025-02-01T22:07:00.314Z (about 10 hours ago)
- Topics: ip, ip-adress, ip-tools, ip-utils, iptools, ipv4, ipv6, network, networking, php, range, subnet
- Language: PHP
- Homepage:
- Size: 81.1 KB
- Stars: 226
- Watchers: 16
- Forks: 54
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# IPTools
PHP Library for manipulating network addresses (IPv4 and IPv6).
[](https://travis-ci.org/S1lentium/IPTools)
[](https://coveralls.io/github/S1lentium/IPTools?branch=master)
[](https://codeclimate.com/github/S1lentium/IPTools)
[](http://php.net)
[](http://php.net)
[](http://php.net)
## Installation
Composer:
Run in command line:
```
composer require s1lentium/iptools
```
or put in composer.json:
```json
{
"require": {
"s1lentium/iptools": "*"
}
}
```
## Usage
### IP Operations
```php
$ip = new IP('192.168.1.1');
echo $ip->version;// IPv4
```
```php
$ip = new IP('fc00::');
echo $ip->version; // IPv6
```
**Parsing IP from integer, binary and hex:**
```php
echo (string)IP::parse(2130706433); // 127.0.0.1
echo (string)IP::parse('0b11000000101010000000000100000001') // 192.168.1.1
echo (string)IP::parse('0x0a000001'); // 10.0.0.1
```
or:
```php
echo (string)IP::parseLong(2130706433); // 127.0.0.1
echo (string)IP::parseBin('11000000101010000000000100000001'); // 192.168.1.1
echo (string)IP::parseHex('0a000001'); // 10.0.0.1
```
**Converting IP to other formats:**
```php
echo IP::parse('192.168.1.1')->bin // 11000000101010000000000100000001
echo IP::parse('10.0.0.1')->hex // 0a000001
echo IP::parse('127.0.0.1')->long // 2130706433
```
#### Other public properties:
`maxPrefixLength`
The max number of bits in the address representation: 32 for IPv4, 128 for IPv6.
`octetsCount`
The count of octets in IP address: 4 for IPv4, 16 for IPv6
`reversePointer`
The name of the reverse DNS PTR for the address:
```php
echo new IP::parse('192.0.2.5')->reversePointer // 5.2.0.192.in-addr.arpa
echo new IP::parse('2001:db8::567:89ab')->reversePointer // b.a.9.8.7.6.5.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.8.b.d.0.1.0.0.2.ip6.arpa
```
### Network Operations
```php
echo Network::parse('192.0.0.1 255.0.0.0')->CIDR; // 192.0.0.0/8
echo (string)Network::parse('192.0.0.1/8')->netmask; // 255.0.0.0
echo (string)Network::parse('192.0.0.1'); // 192.0.0.1/32
```
**Exclude IP from Network:**
```php
$excluded = Network::parse('192.0.0.0/8')->exclude(new IP('192.168.1.1'));
foreach($excluded as $network) {
echo (string)$network . '
';
}
```
192.0.0.0/9
192.128.0.0/11
192.160.0.0/13
192.168.0.0/24
192.168.1.0/32
192.168.1.2/31
...
192.192.0.0/10
**Exclude Subnet from Network:**
```php
$excluded = Network::parse('192.0.0.0/8')->exclude(new Network('192.168.1.0/24'));
foreach($excluded as $network) {
echo (string)$network . '
';
}
```
192.0.0.0/9
192.128.0.0/11
192.160.0.0/13
192.168.0.0/24
192.168.2.0/23
...
192.192.0.0/10
**Split network into equal subnets**
```php
$networks = Network::parse('192.168.0.0/22')->moveTo('24');
foreach ($networks as $network) {
echo (string)$network . '
';
}
```
192.168.0.0/24
192.168.1.0/24
192.168.2.0/24
192.168.3.0/24
**Iterate over Network IP adresses:**
```php
$network = Network::parse('192.168.1.0/24');
foreach($network as $ip) {
echo (string)$ip . '
';
}
```
192.168.1.0
...
192.168.1.255
**Get Network hosts adresses as Range:**
```php
$hosts = Network::parse('192.168.1.0/24')->hosts // Range(192.168.1.1, 192.168.1.254);
foreach($hosts as $ip) {
echo (string)$ip . '
';
}
```
192.168.1.1
...
192.168.1.254
**Count Network IP adresses**
```php
echo count(Network::parse('192.168.1.0/24')) // 254
```
### Range Operations
**Define the range in different formats:**
```php
$range = new Range(new IP('192.168.1.0'), new IP('192.168.1.255'));
$range = Range::parse('192.168.1.0-192.168.1.255');
$range = Range::parse('192.168.1.*');
$range = Range::parse('192.168.1.0/24');
```
**Check if IP is within Range:**
```php
echo Range::parse('192.168.1.1-192.168.1.254')->contains(new IP('192.168.1.5')); // true
echo Range::parse('::1-::ffff')->contains(new IP('::1234')); // true
```
**Iterate over Range IP adresses:**
```php
$range = Range::parse('192.168.1.1-192.168.1.254');
foreach($range as $ip) {
echo (string)$ip . '
';
}
```
192.168.1.1
...
192.168.1.254
**Get Networks that fit into a specified range of IP Adresses:**
```php
$networks = Range::parse('192.168.1.1-192.168.1.254')->getNetworks();
foreach($networks as $network) {
echo (string)$network . '
';
}
```
192.168.1.1/32
192.168.1.2/31
192.168.1.4/30
192.168.1.8/29
192.168.1.16/28
192.168.1.32/27
192.168.1.64/26
192.168.1.128/26
192.168.1.192/27
192.168.1.224/28
192.168.1.240/29
192.168.1.248/30
192.168.1.252/31
192.168.1.254/32
**Count IP adresses in Range**
```php
echo count(Range::parse('192.168.1.1-192.168.1.254')) // 254
```
# License
The library is released under the [MIT](https://opensource.org/licenses/MIT).