GeoModelTrait::setOpencageUrl() - Code Metrics - Graudusk/callurl - Measure and Improve Code Quality continuously with Scrutinizer

GeoModelTrait::setOpencageUrl() A
last analyzed 2018-12-13 11:42 UTC

↳ Parent: GeoModelTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	1
dl	0
loc	3
ccs	2
cts	2
cp	1
crap	1
rs	10
c	0
b	0
f	0

<?php
/**
 * Showing off a standard class with methods and properties.
 */
namespace Erjh17\CallUrlModel;

/**
 * A trait implementing GeoModelTrait.
 */
trait GeoModelTrait
{
    // use \Erjh17\CallUrl;
    /**
     * @var int        $ip  The ip address.
     * @var string     $message  The message.
     * @var boolean    $valid  If the ip address is valid.
     * @var string     $host  The ip adress' host.
     */

    private $continent_name;
    private $country_name;
    private $city;
    private $zip;
    private $latitude;
    private $ipUrl;
    private $longitude;
    private $openCageUrl;
    private $opencagekey;
    public $dataList = [
        "continent_name",
        "country_name",
        "city",
        "zip",
        "latitude",
        "longitude",
        "lat",
        "lon",
        "display_name"
    ];

    abstract public function isValidIp();
    abstract public function validateIp();
    abstract public function getInfo();
    abstract public function fillInfo($result, $keys);

    /**
     * Sets ipstackurl property.
     *
     * @param string $url ipstack url.
     */
    public function setIpstackUrl($url)
    {
        $this->ipUrl = $url;
    }

    /**
     * Sets opencageurl property.
     *
     * @param string $url opencage url.
     */
    public function setOpencageUrl($url)
    {
        $this->openCageUrl = $url;
    }

    /**
     * Sets opencagekey property.
     *
     * @param string $key opencage key.
     */
    public function setOpencageKey($key)
    {
        $this->opencagekey = $key;
    }

    /**
     * Returns specific fetched key properties.
     *
     * @return array Geographic data
     */
    public function getGeoInfo()
    {
        return array_merge(
            array(
                'continent_name' => $this->continent_name,
                'country_name' => $this->country_name,
                'city' => $this->city,
                'zip' => $this->zip,
                'latitude' => str_replace(",", ".", $this->latitude),
                'longitude' => str_replace(",", ".", $this->longitude),
                'mapUrl' => "https://www.openstreetmap.org/#map=12/$this->latitude/$this->longitude&layers=H"
            ),
            $this->getZoomLevel()
        );
    }

    /**
     * Calculates zoom level and radius for the map and returns it.
     *
     * @return array Array containing zoom level and marker radius.
     */
    public function getZoomLevel()
    {
        $retArray = array();
        if (!$this->isValidIp()) {
            $retArray = array("zoomLevel" => "12", "radius" => "600");
        } elseif ($this->city !== null) {
            $retArray = array("zoomLevel" => "12", "radius" => "600");
        } else {
            $retArray = array("zoomLevel" => "3", "radius" => "400000");
        }
        return $retArray;
    }

    /**
     * Returns geographic info together with IP-info
     *
     * @return array Ip-info + geographic info
     */
    public function getAllInfo()
    {
        return array_merge($this->getInfo(), $this->getGeoInfo());
    }

    /**
     * Validates provided coordinate with regexp.
     *
     * @param string $subject Coordinate.
     *
     * @return integer
     */
    public function isCoord($subject)
    {
        $pattern = "/\d+\.\d+[\,\ ]+\d+\.\d+/";
        return preg_match($pattern, $subject);
    }

    /**
     * Fetches geographic information from callUrl module using ip address.
     *
     * @return array Data array with geographic info.
     */
    public function getGeoFromIp()
    {
        $cUrl = $this->di->get("callurl");
        $query = ["access_key" => $this->ipstackkey];
        $url = $this->ipUrl . $this->ipAddress;
        return $cUrl->fetch($url, $query);
    }

    /**
     * Fetches and returns Geographic info from multiple sources.
     *
     * @return array Geographic data.
     */
    public function fetchGeoInfo()
    {
        $cUrl = $this->di->get("callurl");
        $this->validateIp();
        if (!$this->isValidIp() && $this->isCoord($this->ipAddress)) {
            $this->setCoord();
        } elseif ($this->isValidIp()) {
            $apiResult = $this->getGeoFromIp();

            if (!empty($apiResult)) {
                $this->fillInfo($apiResult, $this->dataList);
            } else {
                $this->setErrorMessage("Ingen positionsdata kunde hämtas utifrån platsnamnet.");
            }
        } else {
            $query = [
                "key" => $this->opencagekey,
                "q" => $this->ipAddress,
                "pretty" => "1",
                "language" => "sv"
            ];
            $url = $this->openCageUrl;
            $geocode = $cUrl->fetch($url, $query);

            if (isset($geocode["results"][0])) {
                $this->latitude = $geocode["results"][0]["geometry"]["lat"];
                $this->longitude = $geocode["results"][0]["geometry"]["lng"];
                $nodeType = $geocode["results"][0]["components"]["_type"];
                if (isset($geocode["results"][0]["components"][$nodeType])) {
                    $this->city = $geocode["results"][0]["components"][$nodeType];
                }
                if (isset($geocode["results"][0]["components"]["country"])) {
                    $this->country_name = $geocode["results"][0]["components"]["country"];
                }
                if (isset($geocode["results"][0]["components"]["postcode"])) {
                    $this->zip = $geocode["results"][0]["components"]["postcode"];
                }
            } else {
                $this->setErrorMessage("Ingen positionsdata kunde hämtas utifrån platsnamnet.");
            }
        }
        $this->validateCoord();
        return $this->getAllInfo();
    }


    /**
     * Sets the error message provided.
     *
     * @param string $msg Error message
     */
    public function setErrorMessage($msg)
    {
        $this->errorMsg .= $msg . "\n";
    }

    /**
     * Checks wether the coordinate is within the map bounds
     *
     * @return boolean
     */
    public function validateCoord()
    {
        $lat = str_replace(".", ",", $this->latitude);
        $lon = str_replace(".", ",", $this->longitude);
        if (!$lat && !$lon) {
            $this->setErrorMessage("Kunde inte hämta position utifrån den angivna platsen.");
        }
        if ($lat < -85.05112878 || $lat > 85.05112878) {
            $this->setErrorMessage("Y-koordinaten är utanför maxgränsen.");
        }
        if ($lon < -180 || $lon > 180) {
            $this->setErrorMessage("X-koordinaten är utanför maxgränsen.");
        }
    }

    /**
     * Turns the provided string into a map coordinate.
     *
     * @return void
     */
    public function setCoord()
    {
        if ($this->ipAddress) {
            $latLon = explode(",", $this->ipAddress);
            $this->latitude = $latLon[0];
            $this->longitude = $latLon[1];
        }
    }
}


1		<?php
2		/**
3		* Showing off a standard class with methods and properties.
4		*/
5		namespace Erjh17\CallUrlModel;
6
7		/**
8		* A trait implementing GeoModelTrait.
9		*/
10		trait GeoModelTrait
11		{
12		// use \Erjh17\CallUrl;
13		/**
14		* @var int $ip The ip address.
15		* @var string $message The message.
16		* @var boolean $valid If the ip address is valid.
17		* @var string $host The ip adress' host.
18		*/
19
20		private $continent_name;
21		private $country_name;
22		private $city;
23		private $zip;
24		private $latitude;
25		private $ipUrl;
26		private $longitude;
27		private $openCageUrl;
28		private $opencagekey;
29		public $dataList = [
30		"continent_name",
31		"country_name",
32		"city",
33		"zip",
34		"latitude",
35		"longitude",
36		"lat",
37		"lon",
38		"display_name"
39		];
40
41		abstract public function isValidIp();
42		abstract public function validateIp();
43		abstract public function getInfo();
44		abstract public function fillInfo($result, $keys);
45
46		/**
47		* Sets ipstackurl property.
48		*
49		* @param string $url ipstack url.
50		*/
51	27	public function setIpstackUrl($url)
52		{
53	27	$this->ipUrl = $url;
54	27	}
55
56		/**
57		* Sets opencageurl property.
58		*
59		* @param string $url opencage url.
60		*/
61	27	public function setOpencageUrl($url)
62		{
63	27	$this->openCageUrl = $url;
64	27	}
65
66		/**
67		* Sets opencagekey property.
68		*
69		* @param string $key opencage key.
70		*/
71	27	public function setOpencageKey($key)
72		{
73	27	$this->opencagekey = $key;
74	27	}
75
76		/**
77		* Returns specific fetched key properties.
78		*
79		* @return array Geographic data
80		*/
81	18	public function getGeoInfo()
82		{
83	18	return array_merge(
84		array(
85	18	'continent_name' => $this->continent_name,
86	18	'country_name' => $this->country_name,
87	18	'city' => $this->city,
88	18	'zip' => $this->zip,
89	18	'latitude' => str_replace(",", ".", $this->latitude),
90	18	'longitude' => str_replace(",", ".", $this->longitude),
91	18	'mapUrl' => "https://www.openstreetmap.org/#map=12/$this->latitude/$this->longitude&layers=H"
92		),
93	18	$this->getZoomLevel()
94		);
95		}
96
97		/**
98		* Calculates zoom level and radius for the map and returns it.
99		*
100		* @return array Array containing zoom level and marker radius.
101		*/
102	18	public function getZoomLevel()
103		{
104	18	$retArray = array();
105	18	if (!$this->isValidIp()) {
106	6	$retArray = array("zoomLevel" => "12", "radius" => "600");
107	12	} elseif ($this->city !== null) {
108	4	$retArray = array("zoomLevel" => "12", "radius" => "600");
109		} else {
110	8	$retArray = array("zoomLevel" => "3", "radius" => "400000");
111		}
112	18	return $retArray;
113		}
114
115		/**
116		* Returns geographic info together with IP-info
117		*
118		* @return array Ip-info + geographic info
119		*/
120	18	public function getAllInfo()
121		{
122	18	return array_merge($this->getInfo(), $this->getGeoInfo());
123		}
124
125		/**
126		* Validates provided coordinate with regexp.
127		*
128		* @param string $subject Coordinate.
129		*
130		* @return integer
131		*/
132	6	public function isCoord($subject)
133		{
134	6	$pattern = "/\d+\.\d+[\,\ ]+\d+\.\d+/";
135	6	return preg_match($pattern, $subject);
136		}
137
138		/**
139		* Fetches geographic information from callUrl module using ip address.
140		*
141		* @return array Data array with geographic info.
142		*/
143	12	public function getGeoFromIp()
144		{
145	12	$cUrl = $this->di->get("callurl");
146	12	$query = ["access_key" => $this->ipstackkey];
147	12	$url = $this->ipUrl . $this->ipAddress;
148	12	return $cUrl->fetch($url, $query);
149		}
150
151		/**
152		* Fetches and returns Geographic info from multiple sources.
153		*
154		* @return array Geographic data.
155		*/
156	18	public function fetchGeoInfo()
157		{
158	18	$cUrl = $this->di->get("callurl");
159	18	$this->validateIp();
160	18	if (!$this->isValidIp() && $this->isCoord($this->ipAddress)) {
161	3	$this->setCoord();
162	15	} elseif ($this->isValidIp()) {
163	12	$apiResult = $this->getGeoFromIp();
164
165	12	if (!empty($apiResult)) {
166	12	$this->fillInfo($apiResult, $this->dataList);
167		} else {
168	12	$this->setErrorMessage("Ingen positionsdata kunde hämtas utifrån platsnamnet.");
169		}
170		} else {
171		$query = [
172	3	"key" => $this->opencagekey,
173	3	"q" => $this->ipAddress,
174	3	"pretty" => "1",
175	3	"language" => "sv"
176		];
177	3	$url = $this->openCageUrl;
178	3	$geocode = $cUrl->fetch($url, $query);
179
180	3	if (isset($geocode["results"][0])) {
181	2	$this->latitude = $geocode["results"][0]["geometry"]["lat"];
182	2	$this->longitude = $geocode["results"][0]["geometry"]["lng"];
183	2	$nodeType = $geocode["results"][0]["components"]["_type"];
184	2	if (isset($geocode["results"][0]["components"][$nodeType])) {
185		$this->city = $geocode["results"][0]["components"][$nodeType];
186		}
187	2	if (isset($geocode["results"][0]["components"]["country"])) {
188	2	$this->country_name = $geocode["results"][0]["components"]["country"];
189		}
190	2	if (isset($geocode["results"][0]["components"]["postcode"])) {
191	2	$this->zip = $geocode["results"][0]["components"]["postcode"];
192		}
193		} else {
194	1	$this->setErrorMessage("Ingen positionsdata kunde hämtas utifrån platsnamnet.");
195		}
196		}
197	18	$this->validateCoord();
198	18	return $this->getAllInfo();
199		}
200
201
202		/**
203		* Sets the error message provided.
204		*
205		* @param string $msg Error message
206		*/
207	10	public function setErrorMessage($msg)
208		{
209	10	$this->errorMsg .= $msg . "\n";
210	10	}
211
212		/**
213		* Checks wether the coordinate is within the map bounds
214		*
215		* @return boolean
216		*/
217	18	public function validateCoord()
218		{
219	18	$lat = str_replace(".", ",", $this->latitude);
220	18	$lon = str_replace(".", ",", $this->longitude);
221	18	if (!$lat && !$lon) {
222	9	$this->setErrorMessage("Kunde inte hämta position utifrån den angivna platsen.");
223		}
224	18	if ($lat < -85.05112878 \|\| $lat > 85.05112878) {
225	1	$this->setErrorMessage("Y-koordinaten är utanför maxgränsen.");
226		}
227	18	if ($lon < -180 \|\| $lon > 180) {
228	1	$this->setErrorMessage("X-koordinaten är utanför maxgränsen.");
229		}
230	18	}
231
232		/**
233		* Turns the provided string into a map coordinate.
234		*
235		* @return void
236		*/
237	3	public function setCoord()
238		{
239	3	if ($this->ipAddress) {
240	3	$latLon = explode(",", $this->ipAddress);
241	3	$this->latitude = $latLon[0];
242	3	$this->longitude = $latLon[1];
243		}
244	3	}
245		}
246

Graudusk / callurl

GeoModelTrait::setOpencageUrl() A last analyzed 2018-12-13 11:42 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

GeoModelTrait::setOpencageUrl() A
last analyzed 2018-12-13 11:42 UTC