README

Laravel package to consume the Tunisian Municipality API.

composer require kefivitch/tunisian-municipality-api

If your Laravel version does not support package auto-discovery, register the service provider and facade:

// config/app.php
'providers' => [
    TunisianMunicipality\\TunisianMunicipalityServiceProvider::class,
],

'aliases' => [
    'TunisianMunicipality' => TunisianMunicipality\\Facades\\TunisianMunicipality::class,
],

Usage

Basic example

use TunisianMunicipality\\Facades\\TunisianMunicipality;

$municipalities = TunisianMunicipality::getMunicipalities();
// $municipalities is an Illuminate\\Support\\Collection instance

Filtering results

Pass an associative array of query parameters to getMunicipalities to filter the results returned from the API:

// Retrieve municipalities that match the provided filters
$filtered = TunisianMunicipality::getMunicipalities([
    'name' => 'Tunis',    // filter by municipality name
    // other supported filters can be passed here
]);

Custom client or base URL

use GuzzleHttp\\Client;
use TunisianMunicipality\\TunisianMunicipality as MunicipalityClient;

$client = new MunicipalityClient(new Client(), 'https://tn-municipality-api.vercel.app/api');
$all = $client->getMunicipalities();

Testing

Run the package tests with PHPUnit:

composer test