Sypexgeo.php

<?php
/**
 * Class Sypexgeo.
 *
 * Provide GeoIP through SypexGeo API
 * @link http://sypexgeo.net/
 *
 * @author Igor Cherkashin aka JiSoft <jisoft.dn@gmail.com
 * @created 11.06.14  18:14
 * @version 0.1.0
 * @since 2.0
 */

namespace jisoft\sypexgeo;

class Sypexgeo
{
    /**
     * @var \SxGeo instance.
     */
    private $_sypex = null;

    /**
     * @var string $ip remote client IP-address
     */
    public $ip = '';
    /**
     * @var int $ipAsLong remote client IP-address as integer value
     */
    public $ipAsLong = 0;
    /**
     * @var array $city geo information about city
     */
    public $city = [];
    /**
     * @var array $region geo information about region
     */
    public $region = [];
    /**
     * @var array $country geo information about country
     */
    public $country = [];

    /**
     * Get full geo info by remote IP-address
     * @param string $ip source ip, if empty then determine
     * @return array geo info|false if error
     * result array example:
     *  ```php
     *    [
     *       'city' => [
     *           'id' => 709717,
     *           'lat' => 48.023000000000003,
     *           'lon' => 37.802239999999998,
     *           'name_ru' => 'Донецк',
     *           'name_en' => 'Donets\'k',
     *           'okato' => '14101',
     *       ],
     *       'region' => [
     *           'id' => 709716,
     *           'lat' => 48,
     *           'lon' => 37.5,
     *           'name_ru' => 'Донецкая область',
     *           'name_en' => 'Donets\'ka Oblast\'',
     *           'iso' => 'UA-14',
     *           'timezone' => 'Europe/Zaporozhye',
     *           'okato' => '14',
     *       ],
     *       'country' => [
     *           'id' => 222,
     *           'iso' => 'UA',
     *           'continent' => 'EU',
     *           'lat' => 49,
     *           'lon' => 32,
     *           'name_ru' => 'Украина',
     *           'name_en' => 'Ukraine',
     *           'timezone' => 'Europe/Kiev',
     *       ],
     *   ]
     *  ```
     */
    public function get($ip='')
    {
        if (empty($ip))
            $this->getIP();
        else if (!filter_var($ip, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4)) {
            return false;
        } else {
            $this->ip = $ip;
            $this->ipAsLong = sprintf('%u', ip2long($ip));
        }

        $this->getSypexGeo();
        $data = $this->_sypex->getCityFull($this->ip);
        if (isset($data['city']))
            $this->city = $data['city'];
        if (isset($data['region']))
            $this->region = $data['region'];
        if (isset($data['country']))
            $this->country = $data['country'];
        return empty($data) ? false : $data;
    }

    /**
     * Detect client IP address
     * @return string IP
     */
    public function getIP()
    {
        if(getenv('HTTP_CLIENT_IP'))
            $ip = getenv('HTTP_CLIENT_IP');
        elseif(getenv('HTTP_X_FORWARDED_FOR'))
            $ip = getenv('HTTP_X_FORWARDED_FOR');
        elseif(getenv('HTTP_X_FORWARDED'))
            $ip = getenv('HTTP_X_FORWARDED');
        elseif(getenv('HTTP_FORWARDED_FOR'))
            $ip = getenv('HTTP_FORWARDED_FOR');
        elseif(getenv('HTTP_FORWARDED'))
            $ip = getenv('HTTP_FORWARDED');
        else
            $ip = getenv('REMOTE_ADDR');

        $this->ip = $ip;
        $this->ipAsLong = sprintf('%u', ip2long($ip));
        return $ip;
    }

    /**
     * @return \SxGeo instance.
     */
    public function getSypexGeo()
    {
        if (!is_object($this->_sypex)) {
            $this->_sypex = $this->createSxGeo();
        }

        return $this->_sypex;
    }

    /**
     * Creates SxGeo instance.
     * @return \SxGeo instance.
     */
    protected function createSxGeo()
    {
        return new \jisoft\sypexgeo\SxGeo();
    }

}