laralabs/geo-sorter

Postcode distance sorting package for Laravel Eloquent Collections.

Geo Sorter for Laravel

Postcode distance sorting package for Laravel Collections., _(*1)

UNITED KINGDOM POSTCODES ONLY, _(*2)

:rocket: Quick Start

Installation

Require the package in the composer.json of your project., _(*3)

composer require laralabs/geo-sorter

Publish the configuration file., _(*4)

php artisan vendor:publish --tag=geosorter-config

Edit the configuration file and set your desired settings. If you want to use a custom database table name, set it here and cache your config before moving onto the next step., _(*5)

Create the postcodes table by running the following command:, _(*6)

php artisan migrate

Once the database table has been created, run the following command to populate it with the latest UK Postcode District data., _(*7)

php artisan geosorter:update

Usage

A helper function and facade are available, choose your preferred method. The sortByPostcode method accepts three arguments, the third argument being an optional $sort which can be used to override the sort order defined in the config., _(*8)

Facade:, _(*9)

<?php
$collection = Addresses::all();
$postcode   = 'B61 XYZ';

$collection = GeoSorter::sortByPostcode($collection, $postcode, 'ASC');

Helper:, _(*10)

<?php
$collection = Addresses::all();
$postcode   = 'B61 XYZ';

$collection = geo_sorter()->sortByPostcode($collection, $postcode);

The above code would sort the Addresses collection in distance from the given postcode B61 XYZ., _(*11)

:pushpin: Credits

Ayeo/Geo is used to calculate the distance between coordinates., _(*12)

:speech_balloon: Support

Please raise an issue on GitHub if there is a problem., _(*13)

:key: License

This is open-sourced software licensed under the MIT License., _(*14)