Pamo\IPGeotag\IPGeotag

Complexity

Total Complexity

19

Size/Duplication

Total Lines	135
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	init()	0	7	4
A	getAllDataSorted()	0	12	2
A	getAllData()	0	10	2
B	getClientIP()	0	30	8
A	build()	0	11	3

<?php

namespace Pamo\IPGeotag;

/**
 * IP validator
 */
class IPGeotag
{
    /**
     * @var string $baseAddress for the API.
     * @var string $apiKey for authentication.
     * @var array $allData to store Geotag data.
     * @var string $clientIP for the current IP Address.
     */
    private $baseAddress;
    private $apiKey;
    private $allData;
    private $clientIP;



    /**
     * Geotag current IP
     *
     * @param string $baseAddress for the API.
     * @param string $accessKey for authentication.
     *
     */
    public function init()
    {
        $filename = ANAX_INSTALL_PATH . "/config/api.php";
        $api =  file_exists($filename) ? require $filename : null;
        $this->baseAddress = $api ? $api["url"]["geoTag"] : getenv("API_URL_GEOTAG");
        $this->apiKey = $api ? $api["key"]["geoTag"] : getenv("API_KEY_GEOTAG");
        $this->allData = [];
    }



    /**
     * Valide an IP Address.
     *
     * @param string $ipAddress is the IP Address to validate.
     *
     * @return object
     */
    public function getAllData(string $ipAddress = null) : object
    {
        $ipAddress = ($ipAddress ? $ipAddress : $this->clientIP);
        $data = file_get_contents(
            "$this->baseAddress/$ipAddress?access_key=$this->apiKey"
        );

        $dataJson = json_decode($data);

        return $dataJson;
    }



    /**
     * Valide an IP Address.
     *
     * @param string $ipAddress is the IP Address to validate.
     *
     * @return array
     */
    public function getAllDataSorted(string $ipAddress = null) : array
    {
        $ipAddress = ($ipAddress ? $ipAddress : $this->clientIP);
        $result = file_get_contents(
            "$this->baseAddress/$ipAddress?access_key=$this->apiKey"
        );

        $resultArray = json_decode($result, true);

        array_walk_recursive($resultArray, array('self', 'build'));

        return $this->allData;
    }



    /**
     * Build array with arrays, recursive
     *
     * @param string $value
     * @param string $key
     *
     */
    public function build($value, $key)
    {
        $key = str_replace("_", " ", $key);

        if ($value) {
            if (in_array($key, ["code", "name", "native"])) {
                $key = "Language " . $key;
            } else {
                $key = ucfirst($key);
            }
            $this->allData[$key] = $value;
        }
    }



    /**
     * Get client IP Address
     *
     * @return string
     */
    public function getClientIP($test = null) : string
    {
        if ($test) {
            return $test;
        } else {
            switch (true) {
                case (isset($_SERVER['HTTP_CLIENT_IP'])):
                    $ipAddress = $_SERVER['HTTP_CLIENT_IP'];
                    break;
                case (isset($_SERVER['HTTP_X_FORWARDED_FOR'])):
                    $ipAddress = $_SERVER['HTTP_X_FORWARDED_FOR'];
                    break;
                case (isset($_SERVER['HTTP_X_FORWARDED'])):
                    $ipAddress = $_SERVER['HTTP_X_FORWARDED'];
                    break;
                case (isset($_SERVER['HTTP_FORWARDED_FOR'])):
                    $ipAddress = $_SERVER['HTTP_FORWARDED_FOR'];
                    break;
                case (isset($_SERVER['HTTP_FORWARDED'])):
                    $ipAddress = $_SERVER['HTTP_FORWARDED'];
                    break;
                case (isset($_SERVER['REMOTE_ADDR'])):
                    $ipAddress = $_SERVER['REMOTE_ADDR'];
                    break;
                default:
                    $ipAddress = 'unknown';
            }
        }

        return $ipAddress;
    }
}