nfephp-org/sped-ibge

Librery to access the services of IBGE to obtain the codes used by the system SPED

dev-master / 1.0.x-dev 2018-07-09 12:58 UTC

README

Esta classe usa a API do IBGE para buscar os estados e seus códigos e as cidades desses estados e seus codigos. Para uso dos projetos SPED da Receita Federal e das SEFAZ.

Build Status Coverage Status Quality Score

Latest Stable Version License Total Downloads

Issues Forks Stars

O intuito desse projeto é prover uma fonte de dados para serem usados na manutenção das bases de dados dos aplicativos que emitem documentos para o projetos SPED.

NOTA: Esse serviço do IBGE não deve ser acessado diretamente a cada consulta de seu cliente, pois será mais lento e instável que buscar isso na sua própria base de dados.

Esta classe possui 2 métodos principais e vários modificadores.

Métodos principais

function estados()

function municipios($uf)

IMPORTANTE: a pasta "storage" deve ter permissões de escrita pelo usuário que executa o PHP.

Install

Este pacote está listado no Packgist foi desenvolvido para uso do Composer, portanto não será explicitada nenhuma alternativa de instalação.

E deve ser instalado com:

composer require nfephp-org/sped-ibge

Ou ainda alterando o composer.json do seu aplicativo inserindo:

"require": {
    "nfephp-org/sped-ibge" : "^1.0"
}

Para utilizar o pacote em desenvolvimento (branch master) deve ser instalado com:

composer require nfephp-org/sped-ibge:dev-master

Ou ainda alterando o composer.json do seu aplicativo inserindo:

"require": {
    "nfephp-org/sped-ibge" : "dev-master"
}

NOTA: Ao utilizar este pacote na versão em desenvolvimento não se esqueça de alterar o composer.json da sua aplicação para aceitar pacotes em desenvolvimento, alterando a propriedade "minimum-stability" de "stable" para "dev".

"minimum-stability": "dev"

Requirements

Para que este pacote possa funcionar são necessários os seguintes requisitos do PHP e outros pacotes dos quais esse depende.