Shlinkio\Shlink\Common\Util\IpAddress

Complexity

Total Complexity

6

Size/Duplication

Total Lines	67
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

95.24%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	fromString()	0	13	2
A	getObfuscatedCopy()	0	6	2
A	__toString()	0	9	1

<?php
declare(strict_types=1);

namespace Shlinkio\Shlink\Common\Util;

use Shlinkio\Shlink\Common\Exception\WrongIpException;

final class IpAddress
{
    private const IPV4_PARTS_COUNT = 4;
    private const OBFUSCATED_OCTET = '0';
    public const LOCALHOST = '127.0.0.1';

    /**
     * @var string
     */
    private $firstOctet;
    /**
     * @var string
     */
    private $secondOctet;
    /**
     * @var string
     */
    private $thirdOctet;
    /**
     * @var string
     */
    private $fourthOctet;
    /**
     * @var bool
     */
    private $isLocalhost;

    private function __construct()
    {
    }

    /**
     * @param string $address
     * @return IpAddress
     * @throws WrongIpException
     */
    public static function fromString(string $address): self
    {
        $address = \trim($address);
        $parts = \explode('.', $address);
        if (\count($parts) !== self::IPV4_PARTS_COUNT) {
            throw WrongIpException::fromIpAddress($address);
        }

        $instance = new self();
        $instance->isLocalhost = $address === self::LOCALHOST;
        [$instance->firstOctet, $instance->secondOctet, $instance->thirdOctet, $instance->fourthOctet] = $parts;
        return $instance;
    }

    public function getObfuscatedCopy(): self
    {
        $copy = clone $this;
        $copy->fourthOctet = $this->isLocalhost ? $this->fourthOctet : self::OBFUSCATED_OCTET;
        return $copy;
    }

    public function __toString(): string
    {
        return \implode('.', [
            $this->firstOctet,
            $this->secondOctet,
            $this->thirdOctet,
            $this->fourthOctet,
        ]);
    }
}