Download the PHP package marksamp/ibge-localidades without Composer
On this page you can find all versions of the php package marksamp/ibge-localidades. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download marksamp/ibge-localidades
More information about marksamp/ibge-localidades
Files in marksamp/ibge-localidades
Package ibge-localidades
Short Description Biblioteca PHP para consumir APIs do IBGE, com foco inicial em localidades (Estados e Municípios)
License MIT
Informations about the package ibge-localidades
IBGE Localidades PHP Library
Uma biblioteca PHP moderna e extensível para consumir as APIs do IBGE, com foco inicial na API de localidades (Estados e Municípios).
Características
- ✅ PHP 8.0.7+: Compatível com versões estáveis do PHP 8
- ✅ PSR-4: Autoloading compatível com padrões PSR
- ✅ Arquitetura extensível: Facilmente extensível para outras APIs do IBGE
- ✅ Tratamento de erros: Exceptions específicas para diferentes tipos de erro
- ✅ Type Safety: Tipagem forte em todos os métodos e propriedades
- ✅ Zero dependências externas: Usa apenas extensões nativas do PHP
- ✅ Modelos ricos: Classes de modelo com métodos utilitários
Instalação
Via Composer
Requisitos
- PHP 8.0.7 ou superior
- Extensão cURL
- Extensão JSON
Uso Básico
API de Estados
Métodos Disponíveis
Exemplo com Estados
API de Municípios
Métodos Disponíveis
Exemplo com Municípios
Tratamento de Erros
A biblioteca fornece uma hierarquia de exceptions bem definida:
Hierarquia de Exceptions
Estrutura dos Modelos
Estado
Município
Região
Customização
Cliente HTTP Personalizado
Você pode injetar seu próprio cliente HTTP implementando a interface HttpClientInterface
:
Ordenação dos Resultados
Por padrão, todos os métodos que retornam arrays (lista de estados ou municípios) ordenam os resultados alfabeticamente por nome. Isso facilita a apresentação em interfaces de usuário.
Ordenação Padrão (Alfabética)
Ordenações Alternativas
Extensibilidade
A biblioteca foi projetada para ser facilmente extensível. Para adicionar suporte a outras APIs do IBGE:
- Crie novos modelos na pasta
src/Models/
- Crie novos serviços na pasta
src/Services/
estendendoBaseService
- Adicione os serviços ao
IbgeClient
Exemplo de extensão para API de CEP:
Exemplos Avançados
Busca de Municípios por População
Cache de Resultados
Contribuição
Contribuições são bem-vindas! Por favor:
- Faça um fork do projeto
- Crie uma branch para sua feature
- Faça commit das suas mudanças
- Faça push para a branch
- Abra um Pull Request
Licença
Este projeto está licenciado sob a licença MIT. Veja o arquivo LICENSE para detalhes.
APIs do IBGE Suportadas
Atual
- ✅ Localidades (Estados e Municípios)
Planejadas
- 🔄 CEP
- 🔄 Distritos
- 🔄 Subdistritos
- 🔄 Regiões
Links Úteis
Changelog
v1.0.0
- Implementação inicial
- Suporte para Estados e Municípios
- Arquitetura extensível
- Documentação completa
All versions of ibge-localidades with dependencies
ext-curl Version *
ext-json Version *