Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jansenfelipe/cidades-gratis
Com esse pacote você poderá consultar, gratuitamente, Cidades diretamente no site do IBGE.
https://github.com/jansenfelipe/cidades-gratis
Last synced: about 2 months ago
JSON representation
Com esse pacote você poderá consultar, gratuitamente, Cidades diretamente no site do IBGE.
- Host: GitHub
- URL: https://github.com/jansenfelipe/cidades-gratis
- Owner: jansenfelipe
- Created: 2015-08-20T21:55:45.000Z (over 9 years ago)
- Default Branch: 1.0
- Last Pushed: 2016-01-08T11:56:25.000Z (almost 9 years ago)
- Last Synced: 2024-10-23T16:38:43.941Z (2 months ago)
- Language: PHP
- Size: 58.6 KB
- Stars: 40
- Watchers: 5
- Forks: 18
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Cidades Grátis
[![Latest Stable Version](https://poser.pugx.org/jansenfelipe/cidades-gratis/v/stable.svg)](https://packagist.org/packages/jansenfelipe/cidades-gratis)
[![Total Downloads](https://poser.pugx.org/jansenfelipe/cidades-gratis/downloads.svg)](https://packagist.org/packages/jansenfelipe/cidades-gratis)
[![Latest Unstable Version](https://poser.pugx.org/jansenfelipe/cidades-gratis/v/unstable.svg)](https://packagist.org/packages/jansenfelipe/cidades-gratis)
[![MIT license](https://poser.pugx.org/jansenfelipe/nfephp-serialize/license.svg)](http://opensource.org/licenses/MIT)Com esse pacote você poderá consultar, gratuitamente, Cidades diretamente no site do IBGE.
### Como utilizar
Adicione a library
```sh
$ composer require jansenfelipe/cidades-gratis
```Adicione o autoload.php do composer no seu arquivo PHP.
```php
require_once 'vendor/autoload.php';
```### Métodos
##### Buscar UFs
Use o método `getUfs()` para retornar a lista de UFs com seus respecivos códigos
```php
$ufs = JansenFelipe\CidadesGratis\Cidades::getUfs();
```##### Buscar Cidades
Use o método `getCidades()` para retornar a lista de Cidades com seus respecivos códigos de uma determinada UF
```php
$cidades = JansenFelipe\CidadesGratis\Cidades::getCidades(31);
```##### Buscar detalhes de uma cidade
Use o método `getCidadeDetalhes()` para retornar a detalhes de uma determinada cidade
```php
$detalhes = JansenFelipe\CidadesGratis\Cidades::getCidadeDetalhes(310620);
```### Builds
Dentro da pasta `build/` existe dois arquivos: `ufs.json` e `cidades.json`. Eles foram gerados no dia 20/08/2015
### Gostou? Conheça também
* [CnpjGratis](https://github.com/jansenfelipe/cnpj-gratis)
* [CpfGratis](https://github.com/jansenfelipe/cpf-gratis)
* [CepGratis](https://github.com/jansenfelipe/cep-gratis)
* [NFePHPSerialize](https://github.com/jansenfelipe/nfephp-serialize)### License
The MIT License (MIT)