Download the PHP package mugomes/mgcep without Composer
On this page you can find all versions of the php package mugomes/mgcep. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download mugomes/mgcep
More information about mugomes/mgcep
Files in mugomes/mgcep
Package mgcep
Short Description É uma biblioteca leve e simples em PHP para consulta de CEP utilizando a API pública do ViaCEP.
License LGPL-2.1-only
Informations about the package mgcep
MGCEP
É uma biblioteca leve e simples em PHP para consulta de CEP utilizando a API pública do ViaCEP, com suporte a cache local em arquivos para melhorar desempenho e reduzir requisições externas.
Ideal para aplicações que precisam de consultas rápidas de endereço, com baixo consumo de recursos e fácil integração.
✨ Características
- Consulta de CEP via ViaCEP
- Cache local em arquivos (
.json) - Configuração de tempo de cache (TTL)
- API simples e direta
- Zero dependências externas
- Compatível com PHP 8+
📦 Instalação
Manual
Copie a classe MGCEP.php para seu projeto e utilize via require ou autoload:
⚙️ Configuração
Antes de utilizar, é recomendado configurar o diretório de cache:
📮 Consulta de CEP
🧠 Métodos Públicos
📁 setCacheDir
Define o diretório onde os arquivos de cache serão armazenados.
Parâmetros:
string $path→ Caminho do diretórioint $permission→ Permissão (padrão:0777)
⏱️ setCacheTTL
Define o tempo de vida do cache em segundos.
🔍 getCEP
Realiza a consulta do CEP.
Retorno:
false→ Sucessostring→ Mensagem de erro
📍 Métodos de Dados
Após uma consulta bem-sucedida (getCEP), os dados podem ser acessados:
🏠 Endereço
🌆 Localização
🏛️ Informações adicionais
💡 Exemplo completo
⚠️ Observações
- É necessário chamar
getCEP()antes de acessar os métodos de dados - O cache é baseado no hash da URL
- Arquivos expirados são removidos automaticamente
- Requer conexão com internet na primeira consulta
💙 Apoie
👤 Autor
Murilo Gomes Julio
📺 https://youtube.com/@mugomesoficial
License
The MGCEP is provided under:
SPDX-License-Identifier: LGPL-2.1-only
Beign under the terms of the GNU Lesser General Public License version 2.1 only.
All contributions to the MGCEP are subject to this license.