php postcodes

Códigos postales de PHP

Esta biblioteca maneja varias tareas relacionadas con el código postal del Reino Unido.

Características

• Búsqueda de direcciones por código postal
• Validación de código postal
• Generar códigos postales válidos del Reino Unido
• Obtenga los códigos de un código postal hacia afuera y hacia adentro

Instalación

Para instalar, simplemente ejecute el siguiente comando compositor.

composer require divineomega/php-postcodes

Configuración

Servicios de búsqueda de código postal

El uso de algunas de las características de recuperación de datos proporcionadas por esta biblioteca requiere un servicio de búsqueda de código postal. Actualmente admite los siguientes servicios de búsqueda de código postal.

• Códigos postales ideales - https://ideal-postcodes.co.uk
• PostCode Anywhere (PCA Predicto) - https://www.pcapredict.com/
• Postcodes.io - http://postcodes.io/

Regístrese en el sitio web respectivo si necesita usar estas funciones.

Luego puede usar el siguiente código para obtener un objeto de servicio de búsqueda de código postal apropiado.

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

Uso

Obtener direcciones por código postal

Para recuperar las direcciones asociadas con un código postal del Reino Unido, simplemente pase al método que se muestra a continuación. Recibirá una variedad de objetos de dirección, divididos adecuadamente por sus líneas de dirección y otros detalles.

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

Validar el código postal

Puede validar que un código postal del Reino Unido es correcto utilizando la clase de utilidad Validator . A continuación se muestra un ejemplo de cómo hacerlo.

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

Tenga en cuenta que la validación del código postal no es insensible.

Generar código postal

Esta biblioteca le permite generar un código postal aleatorio y válido del Reino Unido. Esto hace uso de la clase de utilidad Generator , como se muestra a continuación.

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

Conseguir códigos hacia afuera y hacia adentro

La primera parte del código postal, por ejemplo, PO1 se llama el código externo, ya que identifica la ciudad o distrito al que se enviará la carta para una mayor clasificación. La segunda parte del código postal, por ejemplo, se llama código interno.

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