php postcodes

Codes postaux PHP

Cette bibliothèque gère diverses tâches liées au code postal au Royaume-Uni.

Caractéristiques

• Recherche d'adresse par code postal
• Validation du code postal
• Générer des codes postaux britanniques valides
• Obtenez les codes extérieurs et intérieurs d'un code postal

Installation

Pour installer, exécutez simplement la commande Composer suivante.

composer require divineomega/php-postcodes

Installation

Services de recherche de code postal

L'utilisation de certaines des fonctionnalités de recherche de données fournies par cette bibliothèque nécessite un service de recherche de code postal. Il prend actuellement en charge les services de recherche de code postal suivants.

• Codes postaux idéaux - https://ideal-postcodes.co.uk
• Code postal Anywhere (PCA Prédire) - https://www.pcapredict.com/
• Postcodes.io - http://postcodes.io/

Inscrivez-vous sur le site Web respectif si vous avez besoin d'utiliser ces fonctionnalités.

Vous pouvez ensuite utiliser le code suivant pour obtenir un objet de service de recherche de code postal approprié.

 $ postcodeLookupService = new  DivineOmega  Postcodes  Objects  IdealPostcodes ( ' API_KEY ' );
// OR
$ postcodeLookupService = new  DivineOmega  Postcodes  Objects  PostcodeAnywhere ( ' API_KEY ' );
// OR
$ postcodeLookupService = new  DivineOmega  Postcodes  Objects  PostcodesIo ();

Usage

Obtenez des adresses par code postal

Pour récupérer les adresses associées à un code postal britannique, passez-la simplement à la méthode ci-dessous. Vous recevrez un tableau d'objets d'adresse, divisé de manière appropriée par leurs lignes d'adresse et autres détails.

 $ addresses = $ postcodeLookupService -> getAddressesByPostcode ( ' ST163DP ' );

Valider le code postal

Vous pouvez valider un code postal britannique est correct à l'aide de la classe d'utilité Validator . Un exemple de la façon de le faire est illustré ci-dessous.

 $ validated =  DivineOmega  Postcodes  Utils Validator:: validatePostcode ( ' ST163DP ' );

Veuillez noter que la validation du code postal est insensible au cas.

Générer un code postal

Cette bibliothèque vous permet de générer un code postal britannique aléatoire et valide. Cela utilise la classe d'utilité Generator , comme indiqué ci-dessous.

 $ postcode =  DivineOmega  Postcodes  Utils Generator:: generatePostcode ();

Obtenez des codes vers l'extérieur et vers l'intérieur

La première partie du code postal PO1 est appelée le code extérieur car il identifie la ville ou le district à laquelle la lettre doit être envoyée pour un tri ultérieur. La deuxième partie du code postal EG 1EB est appelée le code intérieur.

 $ outwardCode =  DivineOmega  Postcodes  Utils Tokenizer:: outward ( ' ST163DP ' ); // Returns ST16
$ inwardCode =  DivineOmega  Postcodes  Utils Tokenizer:: inward ( ' ST163DP ' ); // Returns 3DP