Download the PHP package stargrid/laravel-calendario-feriados without Composer
On this page you can find all versions of the php package stargrid/laravel-calendario-feriados. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download stargrid/laravel-calendario-feriados
More information about stargrid/laravel-calendario-feriados
Files in stargrid/laravel-calendario-feriados
Package laravel-calendario-feriados
Short Description Pacote desenvolvido e mantido pela StarGrid (https://stargrid.pro) para facilitar a integração com a API (http://www.calendario.com.br/api_feriados_municipais_estaduais_nacionais.php) para a busca de feriados nacionais, estaduais e municipais.
License AGPL-3.0-only
Informations about the package laravel-calendario-feriados
Calendário nacional de feriados.
Este projeto foi iniciado pela StarGrid para ajudar os usuários do Laravel que pretendem integrar seus sistemas com a API http://www.calendario.com.br para busca de feriados nacionais, estaduais e municipais.
Instalação
Para instalar a dependência através do composer, através do terminal, entre na pasta de seu projeto e digite:
Obs: Caso esteja usando versões inferiores:
Após a instalação do pacote, execute o próximo comando:
Agora é necessário configurar no o seu token de acesso da API:
Utilização
Para utilizar basta primeiramente instânciar a classe StarGrid\LaravelHolidayCalendar\HolidayClient
conforme o exemplo a seguir:
Antes de efetuar as chamadas da API, é necessário definir o tipo de retorno (Response). A API Calendário permite dois formatos, JSON ou XML.
Para definir o retorno do tipo JSON:
Para definir o retorno do tipo XML:
Finalmente para fazer a chamada da API, exitem dois tipos de consultas.
Consulta através do código do IBGE do município:
- O primeiro parâmetro é o ano para a consulta dos feriados.
- O segundo parâmetro é o código do IBGE.
Consulta através do nome do município:
- O primeiro parâmetro é o ano para a consulta dos feriados.
- O segundo parâmetro é o nome da cidade a ser consultada.
- O terceiro parâmetro é a sigla do estado (UF).
Obs: Não é necessário se preocupar com os acentos e letras minúsculas ou maiúsculas, este tratamento é feito diretamente pelo pacote.
No final o resultado será um array de objetos .
Esse objeto possuí os seguintes métodos para se obter os dados (getters
):
Também possuí seus respectivos setters
.
Service-Provider e Facade
É possível utilizar o DI do próprio Laravel para se obter uma instância de StarGrid\LaravelHolidayCalendar\HolidayClient
, se você estiver em uma controller, por exemplo:
Ou utiliza-lo através do Facade do próprio pacote:
All versions of laravel-calendario-feriados with dependencies
eloquent/enumeration Version ^6.0
illuminate/support Version ^7.0