MallardDuck\Whois\WhoisServerList\AbstractLocator

Complexity

Total Complexity

2

Size/Duplication

Total Lines	60
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	getLastMatch()	0	3	1
A	__construct()	0	5	1

<?php

namespace MallardDuck\Whois\WhoisServerList;

use Illuminate\Support\Collection;

/**
 * Whois Server List Locator Class
 *
 * This class loads a TLD whois list and allows for easy look up.
 *
 * @author mallardduck <dpock32509@gmail.com>
 *
 * @copyright lucidinternets.com 2018
 *
 * @version 1.0.0
 */
abstract class AbstractLocator
{
    /**
     * The path where the tld json file exists.
     *
     * @var string
     */
    protected string $whoisListPath;

    /**
     * A collection of the TLDs and whois server list.
     *
     * @var Collection
     */
    protected Collection $whoisCollection;

    /**
     * The results of the last looked up domain.
     *
     * @var string
     */
    protected string $lastMatch;

    /**
     * Build the TLD Whois Server Locator class.
     */
    public function __construct()
    {
        $fileData = file_get_contents($this->whoisListPath);
        $tldData = json_decode($fileData, true);
        $this->whoisCollection = collect($tldData);
    }

    /**
     * Gets and returns the last match looked up.
     *
     * @return string The results of the last looked up domain.
     */
    public function getLastMatch(): string
    {
        return $this->lastMatch;
    }

    /**
     * Finds and returns the last match looked up.
     *
     * @param string $domain Either an ID or a username.
     *
     * @return self Returns the same instance for fluent usage.
     */
    abstract public function findWhoisServer(string $domain): self;

    /**
     * Get the Whois server of the domain provided, or previously found domain.
     *
     * @param  string $domain The domain being looked up via whois.
     *
     * @return string         Returns the domain name of the whois server.
     */
    abstract public function getWhoisServer(string $domain = ''): string;
}