Download the PHP package stevebauman/location without Composer

On this page you can find all versions of the php package stevebauman/location. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

Please rate this library. Is it a good library?

All versions of location with dependencies

Informations about the package location

Location

GitHub Actions Scrutinizer Code Quality Latest Stable Version Total Downloads License

Retrieve a user's location from their IP address using external web services, or through a flat-file database hosted on your server.

Requirements

Installation

Install location using composer require:

Add the service provider in config/app.php:

Important: If you're using Laravel 5.5 or above, you can skip the registration of the service provider, as it is registered automatically.

Publish the configuration file (this will create a location.php file inside the config/ directory):

Usage

Retrieve a client's location

Note: This method retrieves the user's IP address via request()->ip():

Retrieve the location of a specific IP address

Drivers

Available Drivers

Available drivers at the moment are:

Setting up MaxMind with a self-hosted database (optional)

We encourage setting up MaxMind as a fallback driver using a local database, as it allows you to bypass any throttling that could occur from using external web services.

To set up MaxMind to retrieve the user's location from your own server, you must:

  1. Create a maxmind account.
  2. Sign in.
  3. Click "Download Files" from the left-hand navigation menu.
  4. Download the GeoLite2-City.tar.gz GZIP file.
  5. Extract the downloaded file (you may need to use an application such as 7zip if on Windows).
  6. Create a maxmind folder inside your Laravel application's database directory (database/maxmind).
  7. Place the GeoLite2-City.mmdb file into the maxmind directory. You should end up with a folder path of:
    • my-laravel-app/database/maxmind/GeoLite2-City.mmdb.
  8. Set your default location driver to Stevebauman\Location\Drivers\MaxMind::class, and you're all set!

Note: Keep in mind, you'll need to update this file on a regular basis to retrieve the most current information from clients.

Fallback Drivers

In the config file, you can specify as many fallback drivers as you wish. It is recommended to install the MaxMind database .mmdb file, so you are always retrieving some generic location information for the user.

If an exception occurs trying to grab a driver (such as a 404 error if the providers API changes), it will automatically use the next driver in line.

Creating your own drivers

To create your own driver, simply create a class in your application, and extend the abstract Driver:

Then, insert your driver class name into the configuration file:

Versioning

Location is versioned under the Semantic Versioning guidelines as much as possible.

Releases will be numbered with the following format:

And constructed with the following guidelines:

Minor versions are not maintained individually, and you're encouraged to upgrade through to the next minor version.

Major versions are maintained individually through separate branches.


Version
Requires php Version >=7.0
ext-json Version *
ext-curl Version *
illuminate/support Version ~5.0|~6.0|~7.0|~8.0
geoip2/geoip2 Version ^2.0

The package stevebauman/location contains the following files

Loading the files please wait ....