Shlinkio\Shlink\Common\Util\IpAddress

Complexity

Total Complexity

6

Size/Duplication

Total Lines	57
Duplicated Lines	0 %

Test Coverage

Coverage

92%

Importance

Changes	2
Bugs	0	Features	0

5 Methods

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

<?php

declare(strict_types=1);

namespace Shlinkio\Shlink\Common\Util;

use Shlinkio\Shlink\Common\Exception\InvalidArgumentException;

use function count;
use function explode;
use function implode;
use function sprintf;
use function trim;

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

    private string $firstOctet;
    private string $secondOctet;
    private string $thirdOctet;
    private string $fourthOctet;

    private function __construct(string $firstOctet, string $secondOctet, string $thirdOctet, string $fourthOctet)
    {
        $this->firstOctet = $firstOctet;
        $this->secondOctet = $secondOctet;
        $this->thirdOctet = $thirdOctet;
        $this->fourthOctet = $fourthOctet;
    }

    /**
     * @return IpAddress
     * @throws InvalidArgumentException
     */
    public static function fromString(string $address): self
    {
        $address = trim($address);
        $parts = explode('.', $address);
        if (count($parts) !== self::IPV4_PARTS_COUNT) {
            throw new InvalidArgumentException(sprintf('Provided IP "%s" is invalid', $address));
        }

        return new self(...$parts);
    }

    public function getAnonymizedCopy(): self
    {
        return new self(
            $this->firstOctet,
            $this->secondOctet,
            $this->thirdOctet,
            self::ANONYMIZED_OCTET,
        );
    }

    /** @deprecated Use getAnonymizedCopy instead */
    public function getObfuscatedCopy(): self
    {
        return $this->getAnonymizedCopy();
    }

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