php postcodes

Códigos postais PHP

Esta biblioteca lida com várias tarefas relacionadas ao código postal do Reino Unido.

Características

• Pesquisa de endereço por código postal
• Validação do código postal
• Gerar códigos postais válidos do Reino Unido
• Obtenha códigos para fora e interior de um código postal

Instalação

Para instalar, basta executar o seguinte comando composer.

composer require divineomega/php-postcodes

Configurar

Serviços de pesquisa de código postal

O uso de alguns dos recursos de recuperação de dados fornecidos por esta biblioteca requer um serviço de pesquisa de código postal. Atualmente, ele suporta os seguintes serviços de pesquisa de código postal.

• Códigos postais ideais - https://ideal-postcodes.co.uk
• Código postal em qualquer lugar (PCA prevê) - https://www.pcapredict.com/
• Postcodes.io - http://postcodes.io/

Inscreva -se no respectivo site se precisar usar esses recursos.

Você pode usar o código a seguir para obter um objeto de serviço de pesquisa de código postal apropriado.

 $ 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

Obtenha endereços por código postal

Para recuperar os endereços associados a um código postal do Reino Unido, basta passar ao método mostrado abaixo. Você receberá uma variedade de objetos de endereço, divididos adequadamente por suas linhas de endereço e outros detalhes.

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

Valide o código postal

Você pode validar um código postal do Reino Unido está correto usando a classe Utilitário Validator . Um exemplo de como fazer isso é mostrado abaixo.

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

Observe que a validação do código postal é insensível ao caso.

Gerar código postal

Esta biblioteca permite gerar um código postal aleatório e válido do Reino Unido. Isso faz uso da classe de utilitário Generator , como mostrado abaixo.

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

Vá para os códigos externos e internos

A primeira parte do código postal, por exemplo, PO1, é chamado de código externo, pois identifica a cidade ou distrito para o qual a carta deve ser enviada para classificação adicional. A segunda parte do código postal, por exemplo, 1Eb é chamado de código interno.

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