JAAulde\IP\V4\Block

Complexity

Total Complexity

20

Size/Duplication

Total Lines	165
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	3

Importance

Changes	12
Bugs	2	Features	1

10 Methods

Rating	Name	Duplication	Size	Complexity
C	__construct()	0	38	11
A	isNetworkAddress()	0	4	1
A	isBroadcastAddress()	0	4	1
A	getNetworkAddress()	0	4	1
A	getBroadcastAddress()	0	4	1
A	getSubnetMask()	0	4	1
A	getAddressCount()	0	4	1
A	getUsableAddressCount()	0	4	1
A	calculateNetworkAddress()	0	4	1
A	calculateBroadcastAddress()	0	4	1

<?php

namespace JAAulde\IP\V4;

/**
 * Represents a block (network) of IPV4 addresses.
 *
 * @author Jim Auldridge <auldridgej@gmail.com>
 * @copyright 2006-2015 Jim Auldridge
 * @license MIT
 */
class Block extends Range
{
    /**
     * @var \JAAulde\IP\V4\SubnetMask The subnet mask of the represented block
     */
    protected $subnetMask;

    /**
     * Constructor
     *
     * @param \JAAulde\IP\V4\Address|string                               $a1 The base address with which the network and broadcast addresses of this block will be calculated. This can be an
     *                                                                        an instance of \JAAulde\IP\V4\Address, in which case the second parameter will be required, or a string in dot-notated format with optional CIDR
     *                                                                        slash prefix. If a string without CIDR slash prefix, second parameter is required. If there is a CIDR slash prefix, second parameter will be ignored.
     * @param \JAAulde\IP\V4\SubnetMask|int|string|\JAAulde\IP\V4\Address $a2 Optional depending on what was given as the first parameter. This is a subnet mask
     *                                                                        to determine the size of this block, or a CIDR prefix for calculating a subnet mask, or a second \JAAulde\IP\V4\Address instance to fit into the derived
     *                                                                        block.
     *
     * @throws Exception
     */
    public function __construct($a1, $a2 = null)
    {
        $subnetMask = null;

        if (is_string($a1)) {
            $a1parts = explode('/', $a1, 2);
            $a1sub1 = $a1parts[0];
            $a1sub2 = isset($a1parts[1]) ? $a1parts[1] : null;

            $a1 = new Address($a1sub1);

            if ($a1sub2 !== null) {
                $a2 = (int) $a1sub2;
            }
        }

        if ($a2 instanceof SubnetMask) {
            $subnetMask = $a2;
        } else {
            if ($a2 instanceof Address) {
                $a2 = SubnetMask::calculateCIDRToFit($a1, $a2);
            }

            if (is_string($a2) && count(explode('.', $a2)) === 4) {
                $subnetMask = new SubnetMask($a2);
            } elseif (is_int($a2) || is_string($a2)) {
                $subnetMask = SubnetMask::fromCIDRPrefix((int) preg_replace('/[^\d]/', '', (string) $a2));
            }
        }

        if (!($subnetMask instanceof SubnetMask)) {
            throw new \Exception(__METHOD__.' could not derive a subnet mask. See documentation for second param, $a2.');
        }

        $this->subnetMask = $subnetMask;

        parent::__construct(self::calculateNetworkAddress($a1, $subnetMask), self::calculateBroadcastAddress($a1, $subnetMask));
    }

    /**
     * Determine if a given IPV4 address is this block's network address (first address in range).
     *
     * @param \JAAulde\IP\V4\Address $address The address we want to know about
     *
     * @return bool
     */
    public function isNetworkAddress(Address $address)
    {
        return $address->get() === $this->firstAddress->get();
    }

    /**
     * Determine if a given IPV4 address is this block's broadcast address (last address in range).
     *
     * @param \JAAulde\IP\V4\Address $address The address we want to know about
     *
     * @return bool
     */
    public function isBroadcastAddress(Address $address)
    {
        return $address->get() === $this->lastAddress->get();
    }

    /**
     * Retrieve the block's network address (first address in range) (Alias to \JAAulde\IP\V4\Range::getFirstAddress).
     *
     * @uses \JAAulde\IP\V4\Range::getFirstAddress
     *
     * @return \JAAulde\IP\V4\Address
     */
    public function getNetworkAddress()
    {
        return $this->getFirstAddress();
    }

    /**
     * Retrieve the block's broadcast address (last address in range). (Alias to \JAAulde\IP\V4\Range::getLastAddress).
     *
     * @uses \JAAulde\IP\V4\Range::getLastAddress
     *
     * @return \JAAulde\IP\V4\Address
     */
    public function getBroadcastAddress()
    {
        return $this->getLastAddress();
    }

    /**
     * Retrieve the block's subnet mask.
     *
     * @return \JAAulde\IP\V4\SubnetMask
     */
    public function getSubnetMask()
    {
        return $this->subnetMask;
    }

    /**
     * Retrieve the total number of IPV4 addresses represented in this block.
     *
     * @return int
     */
    public function getAddressCount()
    {
        return pow(2, $this->subnetMask->getHostBitsCount());
    }

    /**
     * Retrieve the total number of usable IPV4 addresses represented in this block.
     *
     * The total number of usable addresses is generally considered to be 2 less than the total number represented by the block.
     * This accounts for the fact that the first and last addresses in a block are used for the network and broadcast addresses.
     *
     * @return int
     */
    public function getUsableAddressCount()
    {
        return $this->getAddressCount() - 2;
    }

    /**
     * Calculate the network address of a Block given an IPV4 network address and SubnetMask.
     *
     * @param \JAAulde\IP\V4\Address    $address    The IP address from which a network address will be derived
     * @param \JAAulde\IP\V4\SubnetMask $subnetMask The subnet mask (in address form) used in the derivation
     *
     * @return \JAAulde\IP\V4\Address
     */
    public static function calculateNetworkAddress(Address $address, SubnetMask $subnetMask)
    {
        return new Address($address->get() & $subnetMask->get());
    }

    /**
     * Calculate the broadcast address of a Block given an IPV4 network address and SubnetMask.
     *
     * @param \JAAulde\IP\V4\Address    $address    The IP address from which a broadcast address will be derived
     * @param \JAAulde\IP\V4\SubnetMask $subnetMask The subnet mask (in address form) used in the derivation
     *
     * @return \JAAulde\IP\V4\Address
     */
    public static function calculateBroadcastAddress(Address $address, SubnetMask $subnetMask)
    {
        return new Address($address->get() | ~$subnetMask->get());
    }
}