IPResult.php

<?php

declare(strict_types=1);

namespace AndrewBreksa\ExtremeIPLookup;

use ArrayAccess;
use JsonSerializable;

/**
 * Class IPResult
 * @package    AndrewBreksa\ExtremeIPLookup
 * @author     Andrew Breksa <andrew@andrewbreksa.com>
 * @implements ArrayAccess<string, string>
 *
 * @property string $businessName
 * @property string $businessWebsite
 * @property string $city
 * @property string $continent
 * @property string $country
 * @property string $countryCode
 * @property string $ipName
 * @property string $ipType
 * @property string $isp
 * @property string $lat
 * @property string $lon
 * @property string $org
 * @property string $region
 * @property string $timezone
 * @property string $utcOffset
 */
class IPResult implements JsonSerializable, ArrayAccess
{
    /**
     * @var array<string, string>
     */
    protected $data = [];

    /**
     * IPResult constructor.
     * @param array<string, string> $data
     */
    public function __construct(array $data)
    {
        $this->data = $data;
    }

    /**
     * @param string $key
     * @param null   $default
     * @return string|null
     */
    public function get(string $key, $default = null)
    {
        if (!$this->has($key)) {
            return $default;
        }

        return $this->offsetGet($key);
    }

    /**
     * @param string $key
     * @return bool
     */
    public function has(string $key): bool
    {
        return $this->offsetExists($key);
    }

    /**
     * @param string $offset
     * @return bool
     */
    #[\ReturnTypeWillChange]
    public function offsetExists($offset)
    {
        return array_key_exists($offset, $this->data);
    }

    /**
     * @param string $offset
     * @return mixed
     */
    #[\ReturnTypeWillChange]
    public function offsetGet($offset)
    {
        return $this->data[$offset];
    }

    /**
     * @return array<string, string>
     */
    #[\ReturnTypeWillChange]
    public function jsonSerialize()
    {
        return $this->data;
    }

    /**
     * @param string $offset
     */
    #[\ReturnTypeWillChange]
    public function offsetUnset($offset)
    {
        unset($this->data[$offset]);
    }

    /**
     * @param string $key
     * @return string
     */
    public function __get(string $key)
    {
        return $this->offsetGet($key);
    }

    /**
     * @param string $key
     * @param string $value
     */
    public function __set(string $key, string $value): void
    {
        $this->offsetSet($key, $value);
    }

    /**
     * @param string $offset
     * @param string $value
     */
    #[\ReturnTypeWillChange]
    public function offsetSet($offset, $value)
    {
        $this->data[$offset] = $value;
    }

    /**
     * @param string $key
     * @return bool
     */
    public function __isset(string $key)
    {
        return $this->offsetExists($key);
    }
}