README

Bibliothèque PHP fournissant l’ensemble des départements, arrondissements, communes et sections communales d’Haïti, ainsi que des méthodes pour filtrer et rechercher ces localités.

Table des matières

• Installation
• Utilisation
  • Initialisation
  • Récupérer les données principales
    • Départements
    • Arrondissements
    • Communes
    • Sections Communales
  • Méthodes de filtrage
  • Recherche
• Exemple complet
• Tests
• Contributing
• Changelog
• License

Installation

composer require azteck/haiti-localities

Utilisation

Initialisation

require 'vendor/autoload.php';

$h = new \Azteck\HaitiLocalities();

Récupérer les données principales

Départements

$departements = $h->getDepartements();
echo $departements;

Exemple de sortie :

[
  {"name":"Artibonite","parent":"HAITI","type":"Departements"},
  {"name":"Centre","parent":"HAITI","type":"Departements"},
  {"name":"Grand'Anse","parent":"HAITI","type":"Departements"},
  {"name":"Nippes","parent":"HAITI","type":"Departements"},
  {"name":"Nord","parent":"HAITI","type":"Departements"},
  {"name":"Nord Est","parent":"HAITI","type":"Departements"},
  {"name":"Nord Ouest","parent":"HAITI","type":"Departements"},
  {"name":"Ouest","parent":"HAITI","type":"Departements"},
  {"name":"Sud","parent":"HAITI","type":"Departements"},
  {"name":"Sud Est","parent":"HAITI","type":"Departements"}
]

Arrondissements

$arrondissements = $h->getArrondissements();
echo $arrondissements;

Exemple de sortie :

[
  {"name":"Dessalines","parent":"Artibonite"},
  {"name":"Gonaïves","parent":"Artibonite"},
  {"name":"Gros Morne","parent":"Artibonite"},
  {"name":"Marmelade","parent":"Artibonite"},
  {"name":"Saint Marc","parent":"Artibonite"}
]

Communes

$communes = $h->getCommunes();
echo $communes;

Exemple de sortie :

[
  {"name":"Dessalines","parent":"Dessalines"},
  {"name":"Desdunes","parent":"Dessalines"},
  {"name":"Grande Saline","parent":"Dessalines"},
  {"name":"Petite Rivière de l'Artibonite","parent":"Dessalines"}
]

Sections Communales

$sections = $h->getSectionCommunales();
echo $sections;

Exemple de sortie :

[
  {"name":"Villard","parent":"Dessalines"},
  {"name":"Fosse Naboth","parent":"Dessalines"},
  {"name":"Ogé","parent":"Dessalines"},
  {"name":"Poste Pierrot","parent":"Dessalines"},
  {"name":"Fiéfè Petit Cahos","parent":"Dessalines"},
  {"name":"ll Croix","parent":"Dessalines"}
]

Méthodes de filtrage

Arrondissements d’un département

echo $h->getArrondissementsByDepartement("Artibonite");

Communes d’un arrondissement

echo $h->getCommuneByArrondissements("Dessalines");

Sections communales d’une commune

echo $h->getSectionCommunaleByCommune("Dessalines");

Recherche

Recherche partielle insensible à la casse :

echo $h->find("rivi");

Exemple de résultats :

[
  {"name":"Rivière de Bayonnais","parent":"Gonaïves","type":"SectionCommunales"},
  {"name":"Rivière Mancelle","parent":"Gros Morne","type":"SectionCommunales"},
  {"name":"Rivière Blanche","parent":"Gros Morne","type":"SectionCommunales"},
  {"name":"Rivière Canot Canot ous","parent":"Saut d'Eau","type":"SectionCommunales"},
  {"name":"Petite Rivière","parent":"Léogâne","type":"SectionCommunales"},
  {"name":"Grande Rivière Joly","parent":"Anse à Veau","type":"SectionCommunales"}
]

Exemple complet

<?php
require "vendor/autoload.php";

$h = new \Azteck\HaitiLocalities();

$d = $h->getDepartements();
$a = $h->getArrondissements();
$c = $h->getCommunes();
$s = $h->getSectionCommunales();

print $d;
print PHP_EOL.PHP_EOL.PHP_EOL.PHP_EOL;

foreach (json_decode($d) as $item) {
    print $h->getArrondissementsByDepartement($item->name);
    break;
}

print PHP_EOL.PHP_EOL.PHP_EOL.PHP_EOL;

foreach (json_decode($a) as $item) {
    print $h->getCommuneByArrondissements($item->name);
    break;
}

print PHP_EOL.PHP_EOL.PHP_EOL.PHP_EOL;

foreach (json_decode($c) as $item) {
    print $h->getSectionCommunaleByCommune($item->name);
    break;
}

print PHP_EOL.PHP_EOL.PHP_EOL.PHP_EOL;

print $h->find("rivi");
print PHP_EOL.PHP_EOL.PHP_EOL.PHP_EOL;
?>

Tests

Les tests PHPUnit sont inclus dans /tests :

composer test

Contributing

1. Forkez le projet
2. Créez votre branche (git checkout -b feature/ma-nouvelle-fonction)
3. Committez vos modifications (git commit -am 'Ajout d’une fonctionnalité')
4. Poussez votre branche (git push origin feature/ma-nouvelle-fonction)
5. Ouvrez une Pull Request

Merci de suivre les bonnes pratiques de code PHP et PSR-12.

Changelog

1.0.0

• Première version stable
• Méthodes pour récupérer départements, arrondissements, communes et sections communales
• Méthodes de filtrage et recherche
• Tests unitaires PHPUnit inclus

License

MIT License. Voir le fichier LICENSE.