Search by 
meklis / ipv4-subnet-calculator
Network calculator for subnet mask and other classless (CIDR) network information.
3.2
2022-01-23 17:38 UTC
Requires
- php: >=5.5.0
Requires (Dev)
- phploc/phploc: *
- phpmd/phpmd: ^2.6
- phpstan/phpstan: *
- phpunit/phpunit: 6.*
- satooshi/php-coveralls: ^2.0
- squizlabs/php_codesniffer: 2.*
This package is not auto-updated.
Last update: 2024-04-29 03:57:22 UTC
README
Network calculator for subnet mask and other classless (CIDR) network information.
Features
Given an IP address and CIDR network size, it calculates the network information and provides all-in-one aggregated reports.
Calculations
- IP address
- Network size
- Subnet mask
- Network portion
- Host portion
- Number of IP addresses in the network
- Number of addressable hosts in the network
- IP address range
- Broadcast address
- Min and max host
- All IP addresses
- Is an IP address in the subnet
Provides each data in dotted quads, hexadecimal, and binary formats, as well as array of quads.
Aggregated Network Calculation Reports
- Associative array
- JSON
- String
- Printed to STDOUT
Standard Interfaces
- JsonSerializable
Setup
Add the library to your composer.json file in your project:
{ "require": { "markrogoyski/ipv4-subnet-calculator": "3.*" } }
Use composer to install the library:
$ php composer.phar install
Composer will install IPv4 Subnet Calculator inside your vendor folder. Then you can add the following to your .php files to the use library with Autoloading.
require_once(__DIR__ . '/vendor/autoload.php');
Alternatively, use composer on the command line to require and install IPv4 SubnetCalculator:
$ php composer.phar require markrogoyski/ipv4-subnet-calculator:3.*
Minimum Requirements
- PHP 5.5
Usage
Create New SubnetCalculator
// For network 192.168.112.203/23 $sub = new IPv4\SubnetCalculator('192.168.112.203', 23);
Various Network Information
$number_ip_addresses = $sub->getNumberIPAddresses(); // 512 $number_hosts = $sub->getNumberAddressableHosts(); // 510 $address_range = $sub->getIPAddressRange(); // [192.168.112.0, 192.168.113.255] $addressable_host_range = $sub->getAddressableHostRange(); // [192.168.112.1, 192.168.113.254] $network_size = $sub->getNetworkSize(); // 23 $broadcast_address = $sub->getBroadcastAddress(); // 192.168.113.255
IP Address
$ip_address = $sub->getIPAddress(); // 192.168.112.203 $ip_address_quads = $sub->getIPAddressQuads(); // [192, 168, 112, 203] $ip_address_hex = $sub->getIPAddressHex(); // C0A870CB $ip_address_binary = $sub->getIPAddressBinary(); // 11000000101010000111000011001011
Subnet Mask
$subnet_mask = $sub->getSubnetMask(); // 255.255.254.0 $subnet_mask_quads = $sub->getSubnetMaskQuads(); // [255, 255, 254, 0] $subnet_mask_hex = $sub->getSubnetMaskHex(); // FFFFFE00 $subnet_mask_binary = $sub->getSubnetMaskBinary(); // 11111111111111111111111000000000
Network Portion
$network = $sub->getNetworkPortion(); // 192.168.112.0 $network_quads = $sub->getNetworkPortionQuads(); // [192, 168, 112, 0] $network_hex = $sub->getNetworkPortionHex(); // C0A87000 $network_binary = $sub->getNetworkPortionBinary(); // 11000000101010000111000000000000
Host Portion
$host = $sub->getHostPortion(); // 0.0.0.203 $host_quads = $sub->getHostPortionQuads(); // [0, 0, 0, 203] $host_hex = $sub->getHostPortionHex(); // 000000CB $host_binary = $sub->getHostPortionBinary(); // 00000000000000000000000011001011
Min and Max Host
$min_host = $sub->getMinHost(); // 192.168.112.1 $min_host_quads = $sub->getMinHostQuads(); // [192, 168, 112, 1] $min_host_hex = $sub->getMinHostHex(); // C0A87001 $min_host_binary = $sub->getMinHostBinary(); // 11000000101010000111000000000001 $max_host = $sub->getMaxHost(); // 192.168.113.254 $max_host_quads = $sub->getMaxHostQuads(); // [192, 168, 113, 254] $max_host_hex = $sub->getMaxHostHex(); // C0A871FE $max_host_binary = $sub->getMaxHostBinary(); // 11000000101010000111000111111110
All IP Addresses
foreach ($sub->getAllIPAddresses() as $ip_address) { echo $ip_address; } foreach ($sub->getAllHostIPAddresses() as $host_address) { echo $host_address; }
Is IP Address in Subnet
$bool_true = $sub->isIPAddressInSubnet('192.168.112.5'); $bool_false = $sub->isIPAddressInSubnet('192.168.111.5');
Reports
Printed Report
$sub->printSubnetReport(); /* 192.168.112.203/23 Quads Hex Binary ------------------ --------------- -------- -------------------------------- IP Address: 192.168.112.203 C0A870CB 11000000101010000111000011001011 Subnet Mask: 255.255.254.0 FFFFFE00 11111111111111111111111000000000 Network Portion: 192.168.112.0 C0A87000 11000000101010000111000000000000 Host Portion: 0.0.0.203 000000CB 00000000000000000000000011001011 Number of IP Addresses: 512 Number of Addressable Hosts: 510 IP Address Range: 192.168.112.0 - 192.168.113.255 Broadcast Address: 192.168.113.255 Min Host: 192.168.112.1 Max Host: 192.168.113.254 */
Array Report
$sub->getSubnetArrayReport(); /* Array ( [ip_address_with_network_size] => 192.168.112.203/23 [ip_address] => Array ( [quads] => 192.168.112.203 [hex] => C0A870CB [binary] => 11000000101010000111000011001011 ) [subnet_mask] => Array ( [quads] => 255.255.254.0 [hex] => FFFFFE00 [binary] => 11111111111111111111111000000000 ) [network_portion] => Array ( [quads] => 192.168.112.0 [hex] => C0A87000 [binary] => 11000000101010000111000000000000 ) [host_portion] => Array ( [quads] => 0.0.0.203 [hex] => 000000CB [binary] => 00000000000000000000000011001011 ) [network_size] => 23 [number_of_ip_addresses] => 512 [number_of_addressable_hosts] => 510 [ip_address_range] => Array ( [0] => 192.168.112.0 [1] => 192.168.113.255 ) [broadcast_address] => 192.168.113.255 [min_host] => 192.168.112.1 [max_host] => 192.168.113.254 ) */
JSON Report
$sub->getSubnetJSONReport(); /* { "ip_address_with_network_size": "192.168.112.203/23", "ip_address": { "quads": "192.168.112.203", "hex": "C0A870CB", "binary": "11000000101010000111000011001011" }, "subnet_mask": { "quads": "255.255.254.0", "hex": "FFFFFE00", "binary": "11111111111111111111111000000000" }, "network_portion": { "quads": "192.168.112.0", "hex": "C0A87000", "binary": "11000000101010000111000000000000" }, "host_portion": { "quads": "0.0.0.203", "hex": "000000CB", "binary": "00000000000000000000000011001011" }, "network_size": 23, "number_of_ip_addresses": 512, "number_of_addressable_hosts": 510, "ip_address_range": [ "192.168.112.0", "192.168.113.255" ], "broadcast_address": "192.168.113.255", "min_host": "192.168.112.1", "max_host": "192.168.113.254" } */
String Report
$string_report = $sub->getPrintableReport(); /* 192.168.112.203/23 Quads Hex Binary ------------------ --------------- -------- -------------------------------- IP Address: 192.168.112.203 C0A870CB 11000000101010000111000011001011 Subnet Mask: 255.255.254.0 FFFFFE00 11111111111111111111111000000000 Network Portion: 192.168.112.0 C0A87000 11000000101010000111000000000000 Host Portion: 0.0.0.203 000000CB 00000000000000000000000011001011 Number of IP Addresses: 512 Number of Addressable Hosts: 510 IP Address Range: 192.168.112.0 - 192.168.113.255 Broadcast Address: 192.168.113.255 Min Host: 192.168.112.1 Max Host: 192.168.113.254 */
Printing - String Representation
print($sub); /* 192.168.112.203/23 Quads Hex Binary ------------------ --------------- -------- -------------------------------- IP Address: 192.168.112.203 C0A870CB 11000000101010000111000011001011 Subnet Mask: 255.255.254.0 FFFFFE00 11111111111111111111111000000000 Network Portion: 192.168.112.0 C0A87000 11000000101010000111000000000000 Host Portion: 0.0.0.203 000000CB 00000000000000000000000011001011 Number of IP Addresses: 512 Number of Addressable Hosts: 510 IP Address Range: 192.168.112.0 - 192.168.113.255 Broadcast Address: 192.168.113.255 Min Host: 192.168.112.1 Max Host: 192.168.113.254 */
Standard Interfaces
JsonSerializable
$json = json_encode($sub);
Unit Tests
$ cd tests
$ phpunit
Standards
IPv4 Subnet Calculator (PHP) conforms to the following standards:
- PSR-1 - Basic coding standard (http://www.php-fig.org/psr/psr-1/)
- PSR-2 - Coding style guide (http://www.php-fig.org/psr/psr-2/)
- PSR-4 - Autoloader (http://www.php-fig.org/psr/psr-4/)
License
IPv4 Subnet Calculator (PHP) is licensed under the MIT License.