webklex/laravel-geoip

Laravel GeoIP client

1.0.1 2020-10-17 23:48 UTC

This package is auto-updated.

Last update: 2022-09-10 20:47:36 UTC


README

Latest Version on Packagist Software License Build Status Total Downloads Hits

Description

Laravel-GeoIP provides you with the ability to gather open source ip intelligence by using the open api provided by GoGeoIP.

Table of Contents

Installation

1.) Install the Laravel-GeoIP package by running the following command:

composer require webklex/laravel-geoip

2.) If you're using Laravel >= 5.5, package discovery will configure the service provider and GeoIP alias out of the box. Otherwise, for Laravel <= 5.4, edit your config/app.php file and:

  • add the following to the providers array:
\Webklex\LaravelGeoIP\Providers\GeoIPServiceProvider::class,
  • add the following to the aliases array:
'GeoIP' => \Webklex\LaravelGeoIP\Facades\GeoIP::class,

3.) Run the command below to publish the package config file config/geoip.php:

php artisan vendor:publish --provider="Webklex\LaravelGeoIP\Providers\GeoIPServiceProvider"

Usage

Basic usage example

This is a basic example, which will dump the geoip information for the current user ip as well as for the ip "205.13.135.36".

use Webklex\LaravelGeoIP\Facades\GeoIP;

var_dump(GeoIP::current());
var_dump(GeoIP::get("205.13.135.36"));

If you want to use your own instance of GoGeoIP, just update the endpoint provided in the config file.

Response:

{
  "network": {
    "ip": "208.13.138.36",
    "as": {
      "number": 209,
      "name": "CenturyLink Communications, LLC"
    },
    "isp": "",
    "domain": "",
    "tld": [".us"],
    "bot": false,
    "tor": false,
    "proxy": false,
    "proxy_type": "",
    "last_seen": 0,
    "usage_type": ""
  },
  "location": {
    "region_code": "NV",
    "region_name": "",
    "city": "Las Vegas",
    "zip_code": "89129",
    "time_zone": "America/Los_Angeles",
    "longitude": -115.2821,
    "latitude": 36.2473,
    "accuracy_radius": 20,
    "metro_code": 839,
    "country": {
      "code": "US",
      "cioc": "USA",
      "ccn3": "840",
      "call_code": ["1"],
      "international_prefix": "011",
      "capital": "Washington D.C.",
      "name": "United States",
      "full_name": "United States of America",
      "area": 9372610,
      "borders": ["CAN", "MEX"],
      "latitude": 39.443256,
      "longitude": -98.95734,
      "max_latitude": 71.441055,
      "max_longitude": -66.885414,
      "min_latitude": 17.831509,
      "min_longitude": -179.23108,
      "currency": [{
          "code": "USD",
          "name": ""
       }, {
          "code": "USN",
          "name": ""
       }, {
          "code": "USS",
          "name": ""
      }],
      "continent": {
        "code": "",
        "name": "North America",
        "sub_region": ""
      }
    }
  }
}

Support

If you encounter any problems or if you find a bug, please don't hesitate to create a new issue. However please be aware that it might take some time to get an answer. Off topic, rude or abusive issues will be deleted without any notice.

If you need immediate or commercial support, feel free to send me a mail at github@webklex.com.

A little notice

If you write source code in your issue, please consider to format it correctly. This makes it so much nicer to read and people are more likely to comment and help :)

``` php

echo 'your php code...';

```

will turn into:

echo 'your php code...';

Features & pull requests

Everyone can contribute to this project. Every pull request will be considered but it can also happen to be declined. To prevent unnecessary work, please consider to create a feature issue first, if you're planning to do bigger changes. Of course you can also create a new feature issue if you're just wishing a feature ;)

Change log

Please see CHANGELOG for more information what has changed recently.

Security

If you discover any security related issues, please email github@webklex.com instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.